Hub REST API
Guidelines
The Guidelines operations of the Hub REST API (2 operations).
For BuildersOpen-source podSynap CloudGenerated from Synap-core/backend@c31e261ab (main)
GET
bearerAuthheader
AuthorizationBearer <API key>Pod API key (Bearer) issued via /api/hub/setup/agent or pod admin tooling. Browser/web clients may use the X-Session-Token header instead. See GET /api/hub/auth/status to introspect the calling key.
workKind?stringValue in
"credential""permission""capability""policy""decision""physical"sourceKind?stringentityKind?stringworkspaceId?stringFormat
uuidMatching guidelines (possibly none). A workKind-only call returns {workKind, guidelines:[{id,text}]}; a data-type call returns {guidelines:[{id,version,text,scopeKind,scopeRef}]} for the requested rungs only.
application/json- response
workKind?stringValue in
"credential""permission""capability""policy""decision""physical"guidelines*array<|>curl -X GET 'https://pod.example.com/api/hub/guidelines'Example Response
{ "workKind": "credential", "guidelines": [ { "id": "string", "version": 0, "text": "string", "scopeKind": "string", "scopeRef": "string" } ]}GET
bearerAuthheader
AuthorizationBearer <API key>Pod API key (Bearer) issued via /api/hub/setup/agent or pod admin tooling. Browser/web clients may use the X-Session-Token header instead. See GET /api/hub/auth/status to introspect the calling key.
id*stringFormat
uuidVersions, newest first
application/json- response
versions*array<>curl -X GET 'https://pod.example.com/api/hub/guidelines/497f6eca-6276-4993-bfeb-53cbbbba6f08/history'Example Response
{ "versions": [ { "id": "string", "version": 0, "text": "string", "scopeKind": "string", "scopeRef": "string", "supersedesId": "string", "revokedAt": "string", "createdAt": "string" } ]}