OrkStageOrkStage
API referencesettings

PUT /tenants/{tenantId}/policy

PUT /tenants/{tenantId}/policy: OrkStage Control API v1 endpoint reference.

PUT
/api/v1/tenants/{tenantId}/policy

Authorization

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

Organization API key (scoped). Sessions use the cookie instead.

Path Parameters

tenantId*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
allowedRegions?array<>
Itemsitems <= 100
maxMonthlyCostUsd?number
Range0 < value <= 10000000
maxReplicas?integer
Range1 <= value <= 1000
machineSizes?array<>
Itemsitems <= 50
approvedRegistries?array<>
Itemsitems <= 50
requiredLabels?array<>
Itemsitems <= 20
minTlsVersion?string
Value in"1.2""1.3"
minLogRetentionDays?integer
Range1 <= value <= 3653

Response Body

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

GET /tenants/{tenantId}/policy GET

GET /tenants/{tenantId}/policy: OrkStage Control API v1 endpoint reference.

GET /status/{tenantId} GET

GET /status/{tenantId}: OrkStage Control API v1 endpoint reference.