OrkStageOrkStage
API referenceInstances

PATCH /instances/{id}

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

PATCH
/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.

Request Body

application/json
  1. body
name?string
Length2 <= length <= 80
variables?
bindings?
protectedFromDestroy?boolean

Response Body

curl -X PATCH 'http://localhost:4300/api/v1/instances/string' \  -H 'Content-Type: application/json' \  -d '{}'
Empty
Edit on GitHub

GET /instances/{id} GET

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

POST /instances/{id}/preview POST

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