Skip to main content

REST reference

Canonical OpenAPI 3.1: federation-v3.yaml (same bytes as packages/federation-sdk/openapi/federation-v3.yaml).

Registered paths (8): validate-credentials, project upsert, metron origin, accessible-collections, members, invites, usage events, CREATION notification visibility.

Example operation​

GET /api/platform/provisioning/accessible-collections

Auth: service secret + federation contract + X-Plexon-User-Id.

AreaSpecStatus
Viewer catalog GET /api/platform/productsspecs/api/platform-products-viewer.mdnot in OpenAPI registry
Profile GET/PATCH /api/services/profileauth-profile specsnot in OpenAPI registry
Notifications feedspecs/api/platform-notifications.mdpartial (visibility only)
System bannersspecs/api/platform-system-banners.mdnot in OpenAPI registry

No interactive Try-it in this portal (DIP-651). After registry changes run npm run federation:openapi + federation:openapi:check.