Skip to content
Port OS

Get a group route

← HTTP API reference
View source specification ↗
GET /{namespace}/{principalType}/{principalId}/group-routes/{groupId}

Reads the stored native route and its current strong etag.

Required scope

group:read

Path parameters

namespacestringRequired

The namespace of the principal

principalTypestringRequired

The type of principal

principalIdstringRequired

The ID of the principal

groupIdstringRequired

The ID of the group route to retrieve

Returns

200

Group route retrieved

Fields

EndpointGroupRoute

Response headers

ETagstring

Opaque strong entity tag of the returned resource version. Send it back in `If-Match` on the next mutation of the same resource.

Errors

400 BAD_REQUEST

Invalid route ID

Check the request fields and any validation details, then correct the payload.

401 UNAUTHORIZED

Authentication required

Obtain a valid access token, then retry.

403 FORBIDDEN

Insufficient permissions

Check the linked account and its permissions for the device or resource.

404 NOT_FOUND

Group route not found

Verify the target identifier and that its endpoint or plugin route still exists.

500 INTERNAL

Internal server error

Retry with backoff only when the operation is safe to repeat. Include the error code when reporting persistent failures.