Hub routes

July 30, 2026 · View on GitHub

  • Concept: hub
  • Owner: hub

Route groups

  • sequence: sequence (mounted node: sequence)
  • topics: topics, topicRead, topicWrite
  • logs: logs
  • audit: audit

Child resolver

Routes can be resolved to a child instance via:

  • Resolver key: instance
  • Path pattern: /instances/:instanceId
  • Mount path: /instances/:instanceId
  • Implementer base path: /
  • Schemas: params: instance

Child nodes

  • instance (via resolver instance)

Mounted sub-routers

The following sub-routers are mounted under this node:

  • /api/v2/spaces/:spaceId/hubs/:hubId/sequencessequence route set

Routes

OperationMethodPath (full)KindSchemas
ingressIdentityGET/api/v2/spaces/:spaceId/hubs/:hubId/ingress/identityrequestresponse: IngressIdentity
loadGET/api/v2/spaces/:spaceId/hubs/:hubId/loadrequestresponse: LoadResponse
versionGET/api/v2/spaces/:spaceId/hubs/:hubId/versionrequestresponse: VersionResponse
configGET/api/v2/spaces/:spaceId/hubs/:hubId/configrequestresponse: ConfigResponse
healthGET/api/v2/spaces/:spaceId/hubs/:hubId/healthrequestresponse: healthCheckInfo(Hub)
statusGET/api/v2/spaces/:spaceId/hubs/:hubId/statusrequestresponse: StatusResponse
sequencesGET/api/v2/spaces/:spaceId/hubs/:hubId/sequencesrequestresponse: listResponse(Sequence)
instancesGET/api/v2/spaces/:spaceId/hubs/:hubId/instancesrequestresponse: listResponse(Instance)
entitiesGET/api/v2/spaces/:spaceId/hubs/:hubId/entitiesrequestresponse: listResponse(Entity)
topicsGET/api/v2/spaces/:spaceId/hubs/:hubId/topicsrequestresponse: listResponse(Topic)
createTopicPOST/api/v2/spaces/:spaceId/hubs/:hubId/topicsrequestheaders: http, body: TopicCreatePayload, response: opResponse(TopicCreateResponse)
deleteTopicDELETE/api/v2/spaces/:spaceId/hubs/:hubId/topics/:namerequestparams: topic, response: opResponse(TopicDeleteResponse)
topicReadGET/api/v2/spaces/:spaceId/hubs/:hubId/topics/:name/streamupstreamparams: topic, headers: http, response: RestAPI2Schemas.stream
topicWritePOST/api/v2/spaces/:spaceId/hubs/:hubId/topics/:name/streamdownstreamparams: topic, headers: http, response: opResponse(TopicStreamResponse)
logsGET/api/v2/spaces/:spaceId/hubs/:hubId/logsupstreamresponse: LogRecord
auditGET/api/v2/spaces/:spaceId/hubs/:hubId/auditupstreamresponse: RestAPI2Schemas.stream

Route details

ingressIdentity

  • Operation ID: GET /api/v2/spaces/:spaceId/hubs/:hubId/ingress/identity
  • Method: GET
  • Path (full): /api/v2/spaces/:spaceId/hubs/:hubId/ingress/identity
  • Path (node-local): /ingress/identity
  • Schemas: response: IngressIdentity

load

  • Operation ID: GET /api/v2/spaces/:spaceId/hubs/:hubId/load
  • Method: GET
  • Path (full): /api/v2/spaces/:spaceId/hubs/:hubId/load
  • Path (node-local): /load
  • Schemas: response: LoadResponse

version

  • Operation ID: GET /api/v2/spaces/:spaceId/hubs/:hubId/version
  • Method: GET
  • Path (full): /api/v2/spaces/:spaceId/hubs/:hubId/version
  • Path (node-local): /version
  • Schemas: response: VersionResponse

config

  • Operation ID: GET /api/v2/spaces/:spaceId/hubs/:hubId/config
  • Method: GET
  • Path (full): /api/v2/spaces/:spaceId/hubs/:hubId/config
  • Path (node-local): /config
  • Schemas: response: ConfigResponse

health

  • Operation ID: GET /api/v2/spaces/:spaceId/hubs/:hubId/health
  • Method: GET
  • Path (full): /api/v2/spaces/:spaceId/hubs/:hubId/health
  • Path (node-local): /health
  • Schemas: response: healthCheckInfo(Hub)

status

  • Operation ID: GET /api/v2/spaces/:spaceId/hubs/:hubId/status
  • Method: GET
  • Path (full): /api/v2/spaces/:spaceId/hubs/:hubId/status
  • Path (node-local): /status
  • Schemas: response: StatusResponse

sequences

  • Operation ID: GET /api/v2/spaces/:spaceId/hubs/:hubId/sequences
  • Method: GET
  • Path (full): /api/v2/spaces/:spaceId/hubs/:hubId/sequences
  • Path (node-local): /sequences
  • Schemas: response: listResponse(Sequence)

instances

  • Operation ID: GET /api/v2/spaces/:spaceId/hubs/:hubId/instances
  • Method: GET
  • Path (full): /api/v2/spaces/:spaceId/hubs/:hubId/instances
  • Path (node-local): /instances
  • Schemas: response: listResponse(Instance)

entities

  • Operation ID: GET /api/v2/spaces/:spaceId/hubs/:hubId/entities
  • Method: GET
  • Path (full): /api/v2/spaces/:spaceId/hubs/:hubId/entities
  • Path (node-local): /entities
  • Schemas: response: listResponse(Entity)

topics

  • Operation ID: GET /api/v2/spaces/:spaceId/hubs/:hubId/topics
  • Method: GET
  • Path (full): /api/v2/spaces/:spaceId/hubs/:hubId/topics
  • Path (node-local): /topics
  • Schemas: response: listResponse(Topic)

createTopic

  • Operation ID: POST /api/v2/spaces/:spaceId/hubs/:hubId/topics
  • Method: POST
  • Path (full): /api/v2/spaces/:spaceId/hubs/:hubId/topics
  • Path (node-local): /topics
  • Schemas: headers: http, body: TopicCreatePayload, response: opResponse(TopicCreateResponse)

deleteTopic

  • Operation ID: DELETE /api/v2/spaces/:spaceId/hubs/:hubId/topics/:name
  • Method: DELETE
  • Path (full): /api/v2/spaces/:spaceId/hubs/:hubId/topics/:name
  • Path (node-local): /topics/:name
  • Schemas: params: topic, response: opResponse(TopicDeleteResponse)

topicRead

  • Operation ID: GET /api/v2/spaces/:spaceId/hubs/:hubId/topics/:name/stream
  • Method: GET
  • Path (full): /api/v2/spaces/:spaceId/hubs/:hubId/topics/:name/stream
  • Path (node-local): /topics/:name/stream
  • Kind: upstream
  • Schemas: params: topic, headers: http, response: RestAPI2Schemas.stream

topicWrite

  • Operation ID: POST /api/v2/spaces/:spaceId/hubs/:hubId/topics/:name/stream
  • Method: POST
  • Path (full): /api/v2/spaces/:spaceId/hubs/:hubId/topics/:name/stream
  • Path (node-local): /topics/:name/stream
  • Kind: downstream
  • Schemas: params: topic, headers: http, response: opResponse(TopicStreamResponse)

logs

  • Operation ID: GET /api/v2/spaces/:spaceId/hubs/:hubId/logs
  • Method: GET
  • Path (full): /api/v2/spaces/:spaceId/hubs/:hubId/logs
  • Path (node-local): /logs
  • Kind: upstream
  • Schemas: response: LogRecord

audit

  • Operation ID: GET /api/v2/spaces/:spaceId/hubs/:hubId/audit
  • Method: GET
  • Path (full): /api/v2/spaces/:spaceId/hubs/:hubId/audit
  • Path (node-local): /audit
  • Kind: upstream
  • Schemas: response: RestAPI2Schemas.stream