EndpointGroupRoute

HTTP API schema

← HTTP API reference

A route within an endpoint group linking a plugin route to a group with interface metadata.

EndpointGroupRoute fields

pluginProfileIdstring

Stable profile ID selected from the registered plugin declaration.

minLength: 1

ontologicalTypesarray<string>

Actual classifications of this native group route.

idstringRequired

The unique identifier for the group route

pattern: "^port1/[^/]+/[^/]+/endpoint-group-routes/[^/]+$"

associatedGroupIdstringRequired

The ID of the associated endpoint group

pattern: "^port1/[^/]+/[^/]+/endpoint-groups/[^/]+$"

associatedPluginIdstringRequired

The ID of the associated plugin

associatedPluginRouteIdstringRequired

The stable plugin-owned route identifier associated with this group route. Use this value, not the Port OS group route `id`, when matching group route membership back to synchronized plugin or fixture route identities.

associatedAuthLinkIdstringRequired

The ID of the associated auth link

ownerIdstringRequired

The ID of the owner of the group route

memberPluginRouteIdsarray<string>

List of member plugin route IDs of the group route

interfacesarray<RouteInterface>Required

List of interfaces supported by the group route

pluginCustomMetadataobject

A set of custom metadata that the plugin uses and attaches to the group route, this is meant specifically for the plugin to use.

View source specification ↗