Skip to content
Port OS

Route

HTTP API schema

← HTTP API reference

Route fields

pluginProfileIdstring

Stable profile ID selected from the registered plugin declaration. Required for V2 plugin discovery; retained with the route for admission and presentation.

minLength: 1

idstringRequired

The persisted Port OS route identifier. Synchronized routes can receive a backend-generated, owner-scoped value here even when the discovery payload supplied an explicit route `id`; do not use this field as the stable plugin-owned route identity unless the synchronizing implementation explicitly documents preservation. Provider discovery and synchronization input use ProviderDiscoveredRoute, whose optional advisory ID does not carry this persisted-identity rule.

pattern: "^port1/[^/]+/[^/]+/routes/[^/]+$"

associatedPluginIdstringRequired

The ID of the associated plugin

associatedPluginRouteIdstringRequired

The stable plugin-owned route identifier associated with this Port OS route. For synchronized plugin capability contracts and fixture parity checks, use this field to match a route from enumeration back to the discovery payload.

externalIdstringRequired

The external ID of the route given by the reporting system

associatedAuthLinkIdstringRequired

The ID of the associated auth link

associatedEndpointIdstringRequired

The ID of the associated endpoint

nameTypeValue

The name of the route as a human readable string or a localizable asset. This is either a raw string or a localizable asset reference.

interfacesarray<RouteInterface>Required

List of interfaces supported by the route. These denote what the route is capable of performing such as turning off/on, etc.

ontologicalTypesarray<string>Required

List of ontological types for the route. These are used mostly for customers to know what an endpoint is, like if its a lightbulb, or a speaker, etc.

pluginCustomMetadataobject

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

descriptionTypeValue

The description of the route as a human readable string or a localizable asset.

manufacturerTypeValue

The manufacturer of the route as a human readable string or a localizable asset.

modelTypeValue

The model of the route as a human readable string or a localizable asset.

serialNumberTypeValue

The serial number of the route as a human readable string or a localizable asset.

View source specification ↗