Skip to content
Port OS

GroupRouteAttributeState

HTTP API schema

← HTTP API reference

One attribute value reported for one group route of an endpoint group. A group's state is the set of its group routes' values; values from different providers are never aggregated, so each entry names the group route and the provider that reported it. When a forced read reaches the provider and the provider answers without a value for a declared attribute, the entry carries no `value` and an `error` with code `PROVIDER_NO_STATE` instead of being omitted.

GroupRouteAttributeState fields

groupRouteIdstringRequired

The typed ID of the group route the value was reported for.

pluginIdstringRequired

The plugin that owns the group route and reported the value.

providerstringRequired

The display name of that plugin.

namespacestringRequired

The capability interface namespace for this attribute

namestringRequired

The name of the attribute within the namespace

versionstringRequired

The capability interface version the value conforms to.

valueobject

The attribute value payload, structure depends on the attribute schema. Omitted when `error` is present.

errorError

error: Reference Error

sampledAtstring

When the provider observed the value. Omitted when the provider did not say.

format: "date-time"

View source specification ↗