Instance routes
July 16, 2026 · View on GitHub
- Concept:
instance - Owner:
instance
Route groups
- stdio: stdio, stdioRead, stdioWrite
- events: getEvent, getNextEvent, sendEvent
- rpc: rpc (opaque)
- logs: logs
- monitoring: monitoring
Routes
| Operation | Method | Path (full) | Kind | Schemas |
|---|---|---|---|---|
info | GET | /api/v2/spaces/:spaceId/hubs/:hubId/instances/:instanceId | request | response: InstanceResponse |
deleteInstance | DELETE | /api/v2/spaces/:spaceId/hubs/:hubId/instances/:instanceId | request | body: DeleteInstancePayload, response: opResponse(DeleteInstanceResponse) |
patchInstance | PATCH | /api/v2/spaces/:spaceId/hubs/:hubId/instances/:instanceId | request | body: InstanceParametersPatch, response: opResponse(InstanceParametersResponse) |
stdio | GET | /api/v2/spaces/:spaceId/hubs/:hubId/instances/:instanceId/stdio | request | response: StdIODescriptorList |
health | GET | /api/v2/spaces/:spaceId/hubs/:hubId/instances/:instanceId/health | request | response: healthCheckInfo(Instance) |
output | GET | /api/v2/spaces/:spaceId/hubs/:hubId/instances/:instanceId/output | upstream | response: RestAPI2Schemas.stream |
logs | GET | /api/v2/spaces/:spaceId/hubs/:hubId/instances/:instanceId/logs | upstream | response: LogRecord |
monitoring | GET | /api/v2/spaces/:spaceId/hubs/:hubId/instances/:instanceId/monitoring | upstream | response: MonitoringMessage |
stdioRead | GET | /api/v2/spaces/:spaceId/hubs/:hubId/instances/:instanceId/stdio/:fd | upstream | params: readableFdParam, response: RestAPI2Schemas.stream |
input | POST | /api/v2/spaces/:spaceId/hubs/:hubId/instances/:instanceId/input | downstream | response: RestAPI2Schemas.stream |
stdioWrite | PUT | /api/v2/spaces/:spaceId/hubs/:hubId/instances/:instanceId/stdio/:fd | downstream | params: writableFdParam, response: RestAPI2Schemas.stream |
getEvent | GET | /api/v2/spaces/:spaceId/hubs/:hubId/instances/:instanceId/events/:name | request | params: event, response: EventResponse |
getNextEvent | GET | /api/v2/spaces/:spaceId/hubs/:hubId/instances/:instanceId/events/:name/once | request | params: event, response: EventResponse |
sendEvent | POST | /api/v2/spaces/:spaceId/hubs/:hubId/instances/:instanceId/events | request | body: EventMessage, response: opResponse(SendEventResponse) |
rpc | POST | /api/v2/spaces/:spaceId/hubs/:hubId/instances/:instanceId/rpc/* | duplex | body: RpcRequest, response: RpcResponse |
Route details
info
- Operation ID:
GET /api/v2/spaces/:spaceId/hubs/:hubId/instances/:instanceId - Method:
GET - Path (full):
/api/v2/spaces/:spaceId/hubs/:hubId/instances/:instanceId - Path (node-local):
/ - Schemas:
response:InstanceResponse
deleteInstance
- Operation ID:
DELETE /api/v2/spaces/:spaceId/hubs/:hubId/instances/:instanceId - Method:
DELETE - Path (full):
/api/v2/spaces/:spaceId/hubs/:hubId/instances/:instanceId - Path (node-local):
/ - Schemas:
body:DeleteInstancePayload,response:opResponse(DeleteInstanceResponse)
patchInstance
- Operation ID:
PATCH /api/v2/spaces/:spaceId/hubs/:hubId/instances/:instanceId - Method:
PATCH - Path (full):
/api/v2/spaces/:spaceId/hubs/:hubId/instances/:instanceId - Path (node-local):
/ - Schemas:
body:InstanceParametersPatch,response:opResponse(InstanceParametersResponse)
stdio
- Operation ID:
GET /api/v2/spaces/:spaceId/hubs/:hubId/instances/:instanceId/stdio - Method:
GET - Path (full):
/api/v2/spaces/:spaceId/hubs/:hubId/instances/:instanceId/stdio - Path (node-local):
/stdio - Schemas:
response:StdIODescriptorList
health
- Operation ID:
GET /api/v2/spaces/:spaceId/hubs/:hubId/instances/:instanceId/health - Method:
GET - Path (full):
/api/v2/spaces/:spaceId/hubs/:hubId/instances/:instanceId/health - Path (node-local):
/health - Schemas:
response:healthCheckInfo(Instance)
output
- Operation ID:
GET /api/v2/spaces/:spaceId/hubs/:hubId/instances/:instanceId/output - Method:
GET - Path (full):
/api/v2/spaces/:spaceId/hubs/:hubId/instances/:instanceId/output - Path (node-local):
/output - Kind:
upstream - Schemas:
response:RestAPI2Schemas.stream
logs
- Operation ID:
GET /api/v2/spaces/:spaceId/hubs/:hubId/instances/:instanceId/logs - Method:
GET - Path (full):
/api/v2/spaces/:spaceId/hubs/:hubId/instances/:instanceId/logs - Path (node-local):
/logs - Kind:
upstream - Schemas:
response:LogRecord
monitoring
- Operation ID:
GET /api/v2/spaces/:spaceId/hubs/:hubId/instances/:instanceId/monitoring - Method:
GET - Path (full):
/api/v2/spaces/:spaceId/hubs/:hubId/instances/:instanceId/monitoring - Path (node-local):
/monitoring - Kind:
upstream - Schemas:
response:MonitoringMessage
stdioRead
- Operation ID:
GET /api/v2/spaces/:spaceId/hubs/:hubId/instances/:instanceId/stdio/:fd - Method:
GET - Path (full):
/api/v2/spaces/:spaceId/hubs/:hubId/instances/:instanceId/stdio/:fd - Path (node-local):
/stdio/:fd - Kind:
upstream - Schemas:
params:readableFdParam,response:RestAPI2Schemas.stream
input
- Operation ID:
POST /api/v2/spaces/:spaceId/hubs/:hubId/instances/:instanceId/input - Method:
POST - Path (full):
/api/v2/spaces/:spaceId/hubs/:hubId/instances/:instanceId/input - Path (node-local):
/input - Kind:
downstream - Schemas:
response:RestAPI2Schemas.stream
stdioWrite
- Operation ID:
PUT /api/v2/spaces/:spaceId/hubs/:hubId/instances/:instanceId/stdio/:fd - Method:
PUT - Path (full):
/api/v2/spaces/:spaceId/hubs/:hubId/instances/:instanceId/stdio/:fd - Path (node-local):
/stdio/:fd - Kind:
downstream - Schemas:
params:writableFdParam,response:RestAPI2Schemas.stream
getEvent
- Operation ID:
GET /api/v2/spaces/:spaceId/hubs/:hubId/instances/:instanceId/events/:name - Method:
GET - Path (full):
/api/v2/spaces/:spaceId/hubs/:hubId/instances/:instanceId/events/:name - Path (node-local):
/events/:name - Schemas:
params:event,response:EventResponse
getNextEvent
- Operation ID:
GET /api/v2/spaces/:spaceId/hubs/:hubId/instances/:instanceId/events/:name/once - Method:
GET - Path (full):
/api/v2/spaces/:spaceId/hubs/:hubId/instances/:instanceId/events/:name/once - Path (node-local):
/events/:name/once - Schemas:
params:event,response:EventResponse
sendEvent
- Operation ID:
POST /api/v2/spaces/:spaceId/hubs/:hubId/instances/:instanceId/events - Method:
POST - Path (full):
/api/v2/spaces/:spaceId/hubs/:hubId/instances/:instanceId/events - Path (node-local):
/events - Schemas:
body:EventMessage,response:opResponse(SendEventResponse)
rpc
- Operation ID:
POST /api/v2/spaces/:spaceId/hubs/:hubId/instances/:instanceId/rpc/* - Method:
POST - Path (full):
/api/v2/spaces/:spaceId/hubs/:hubId/instances/:instanceId/rpc/* - Path (node-local):
/rpc/* - Kind:
duplex - Schemas:
body:RpcRequest,response:RpcResponse