OrkStageOrkStage
API referenceInstances

POST /instances/{id}/simulate

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

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

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
resourceId*string
Length1 <= length
health?|null
drift?boolean

Response Body

curl -X POST 'http://localhost:4300/api/v1/instances/string/simulate' \  -H 'Content-Type: application/json' \  -d '{  "resourceId": "string"}'
Empty