OrkStageOrkStage
API referenceInstances

POST /instances/{id}/rollback

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

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

Authorization

headerAuthorizationBearer <ork_<env>_<id>_<secret>>

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
Default{}
deploymentId?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

Example Request
curl -X POST 'http://localhost:4000/api/v1/instances/string/rollback' \  -H 'Content-Type: application/json' \  -d '{}'
Example Response202
Empty
Edit on GitHub

POST /instances/preview POST

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

POST /instances/{id}/trigger-runs/{runId}/approve POST

POST /instances/{id}/trigger-runs/{runId}/approve: OrkStage Control API v1 endpoint reference.