OrkStageOrkStage
API referenceInstances

POST /instances/{id}/upgrade

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

POST
/api/v1/instances/{id}/upgrade

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
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

Response Body

curl -X POST 'http://localhost:4300/api/v1/instances/string/upgrade' \  -H 'Content-Type: application/json' \  -d '{  "templateVersionId": "9c8cdef7-7ed4-4683-9325-fcbf62aceeab"}'
Empty
Edit on GitHub

POST /instances/{id}/deploy POST

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

POST /instances/{id}/destroy POST

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