Skip to content

EndpointGroupsSetGroupRouteEnablementOperation

HTTP API schema

← HTTP API reference

Enables or disables one stored provider group route. Disabling retains its observations but removes its membership and interfaces from resolution. Enabling an orphan can create or attach a group. The associated group's starting etag is required when the route has a group. Only PORTOS_ONLY is supported; another mode returns 422 PROVIDER_SYNC_UNSUPPORTED.

EndpointGroupsSetGroupRouteEnablementOperation fields

requestIdBatchOperationRequestIdRequired
operationstringRequired

Operation discriminator.

Allowed values: SET_GROUP_ROUTE_ENABLEMENT.

groupRouteIdstringRequired

The Port OS group route ID.

minLength: 1

etagstring

The associated group's starting etag; omit only for an orphaned route.

minLength: 1

enablementEnablementRequired
providerSyncstring

Only PORTOS_ONLY is supported, and it is the default.

Default: PORTOS_ONLY

Allowed values: PORTOS_ONLY, BEST_EFFORT, FAIL_ON_PROVIDER_ERROR.

View source specification ↗