OrkStageOrkStage
API referenceInstances

POST /instances

POST /instances: OrkStage Control API v1 endpoint reference.

POST
/api/v1/instances

Authorization

headerAuthorizationBearer <token>

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

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
tenantId*string
Match^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Formatuuid
name*string
Length2 <= length <= 80
slug*string
Match^[a-z][a-z0-9-]{1,40}$
environment?string
Default"production"
Value in"production""staging""development""sandbox"
templateVersionId*string
Match^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Formatuuid
variables?
Default{}
bindings?
Default{}
profileId?string
Match^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Formatuuid

Response Body

curl -X POST 'http://localhost:4300/api/v1/instances' \  -H 'Content-Type: application/json' \  -d '{  "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",  "name": "string",  "slug": "string",  "templateVersionId": "9c8cdef7-7ed4-4683-9325-fcbf62aceeab"}'
Empty
Edit on GitHub

GET /instances GET

GET /instances: OrkStage Control API v1 endpoint reference.

GET /instances/{id} GET

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