OrkStageOrkStage
API referenceCloud targets and applications

PATCH /cloud/targets/{id}

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

PATCH
/api/v1/cloud/targets/{id}

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
name?string
Length2 <= length <= 80
config?
credentialRef?string
Match^(env|aws-sm):\/\/\S+$
Lengthlength <= 300
allowedRegions?array<>
Items1 <= items
defaultRegion?string
Length2 <= length
maxConcurrentDeployments?integer
Range1 <= value <= 20

Response Body

Example Request
curl -X PATCH 'http://localhost:4000/api/v1/cloud/targets/string' \  -H 'Content-Type: application/json' \  -d '{}'
Example Response200
Empty
Edit on GitHub

GET /cloud/targets/{id}/capabilities GET

GET /cloud/targets/{id}/capabilities: OrkStage Control API v1 endpoint reference.

GET /instances GET

GET /instances: OrkStage Control API v1 endpoint reference.