Skip to content

EndpointGroupsSetNameOperation

HTTP API schema

← HTTP API reference

Renames a group. The name is a user override that survives rediscovery. A user group name is `{"type": "PLAIN", "value": ...}` whose value is non-blank UTF-8 text of at most 256 bytes with no control characters; anything else is rejected with BAD_REQUEST.

EndpointGroupsSetNameOperation fields

requestIdBatchOperationRequestIdRequired

requestId: Reference BatchOperationRequestId

operationstringRequired

Operation discriminator.

Allowed values: SET_NAME.

groupIdstringRequired

The endpoint group to modify.

minLength: 1

etagstringRequired

The group etag the client last read. When an earlier operation in the same request changes this group, send the etag that operation reports instead: every operation that changes the group advances its etag by one, and one that changes nothing keeps it.

minLength: 1

nameTypeValueRequired

name: Reference TypeValue

View source specification ↗