Skip to content
Port OS

Add members to an endpoint group

← HTTP API reference
View source specification ↗
POST /{namespace}/{principalType}/{principalId}/endpoint-groups/{groupId}/add-members

Adds one or more endpoint members to an existing endpoint group.

Required scope

group:manage

Path parameters

namespacestringRequired

The namespace of the principal

principalTypestringRequired

The type of principal

principalIdstringRequired

The ID of the principal

groupIdstringRequired

The ID of the endpoint group

Header parameters

If-MatchstringRequired

The quoted strong entity tag of the resource the client last read (its `etag` field or `ETag` response header). The mutation is applied only when it still matches: a stale value returns 412 PRECONDITION_FAILED and a missing header returns 428 PRECONDITION_REQUIRED. `*` matches any current version of an existing group (RFC 9110), for a deliberate last-writer-wins change.

minLength: 1

Request body

Fields

memberEndpointIdsarray<string>Required

List of member IDs to add to the group

Returns

202

Members addition accepted

No response body.

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 request payload

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

401 UNAUTHORIZED

Unauthorized - invalid or missing authentication token

Obtain a valid access token, then retry.

403 FORBIDDEN

Forbidden - insufficient permissions

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

404 NOT_FOUND

Endpoint group not found

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

412 PRECONDITION_FAILED

The If-Match etag does not match the current group version; re-read the group and retry

Inspect the returned code and family and follow the error handling guide.

428 PRECONDITION_REQUIRED

The If-Match header is missing

Inspect the returned code and family and follow the error handling guide.

500 INTERNAL

Internal server error

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