OrkStageOrkStage
API referenceInstances

GET /instances/{id}

GET /instances/{id}: OrkStage Control API v1 endpoint reference.

GET
/api/v1/instances/{id}

Authorization

headerAuthorizationBearer <token>

Organization API key (scoped). Sessions use the cookie instead.

Path Parameters

id*string

Header Parameters

x-orkstage-csrf?unknown

Cookie sessions: send "1" on POST/PATCH/PUT/DELETE. Not needed with an API key.

Response Body

curl -X GET 'http://localhost:4300/api/v1/instances/string'
Empty
Edit on GitHub

POST /instances POST

POST /instances: OrkStage Control API v1 endpoint reference.

PATCH /instances/{id} PATCH

PATCH /instances/{id}: OrkStage Control API v1 endpoint reference.