OrkStageOrkStage
API referenceCloud targets and applications

POST /cloud/targets

POST /cloud/targets: OrkStage Control API v1 endpoint reference.

POST
/api/v1/cloud/targets

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
provider*string
Value in"aws""azure""gcp""oci""digitalocean""vultr""coreweave""magalu""vercel""render""supabase""mock"
name*string
Length2 <= length <= 80
environment?string
Default"any"
Value in"production""staging""development""sandbox""any"
config*
credentialRef?string
Match^(env|aws-sm):\/\/\S+$
Lengthlength <= 300
allowedRegions*array<>
Items1 <= items
defaultRegion*string
Length2 <= length
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
maxConcurrentDeployments?integer
Range1 <= value <= 20
Default3

Response Body

curl -X POST 'http://localhost:4300/api/v1/cloud/targets' \  -H 'Content-Type: application/json' \  -d '{  "provider": "aws",  "name": "string",  "config": {    "property1": null,    "property2": null  },  "allowedRegions": [    "string"  ],  "defaultRegion": "string"}'
Empty
Edit on GitHub

GET /cloud/targets GET

GET /cloud/targets: OrkStage Control API v1 endpoint reference.

POST /cloud/targets/{id}/validate POST

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