EndpointGroup
HTTP API schema
A logical grouping of endpoints that share common interfaces and ownership.
EndpointGroup fields
- id
stringRequired The unique identifier for the endpoint group
pattern: "^port1/[^/]+/[^/]+/endpoint-groups/[^/]+$"
- nameTypeValueRequired
The name of the endpoint group
- type
stringRequired The type identifier of the name value, defined as plain when not defined.
- value
stringRequired the raw value of a plain name.
- type
- ownerId
stringRequired The ID of the owner of the endpoint group
- enablementEnablementRequired
enablement: Reference Enablement
- memberEndpointIds
array<string> List of member endpoint IDs of the endpoint group
- Item
string
- Item
- interfaces
array<ApplicationInterface>Required List of interfaces supported by the endpoint group
- ItemApplicationInterface
interfaces[]: Reference ApplicationInterface
- etag
stringRequired Opaque strong entity tag of this group version, for example `"12"`. It changes on any committed write to the group, its group routes or its relationships. Send it as `If-Match` (or as the operation `etag` in `/endpoint-groups-manage`) when mutating the group.
- redirectedFrom
string Set when the group was read through a merged-away ID: the ID that was requested, which now redirects to this group. Mutations must use this group's `id`.
- parentGroupId
string The canonical parent group derived from `IS_PART_OF` relationships, when the group has one.
- childGroupIds
array<string> Canonical child groups derived from `IS_PART_OF` relationships.
- Item
string
- Item
- controllers
array<EndpointGroupController> Endpoints that declare `CAN_CONTROL` on one of this group's group routes, with the messages they support on it.
- ItemEndpointGroupController
controllers[]: Reference EndpointGroupController
- attributes
array<GroupRouteAttributeState> The group's state: every attribute value stored for its group routes, one entry per group route and attribute, tagged with the group route and provider. Populated only when the read is called with `expand=interfaces.attributes`.
- ItemGroupRouteAttributeState
attributes[]: Reference GroupRouteAttributeState