OrkStageOrkStage
API referenceprofiles

POST /profiles

POST /profiles: OrkStage Control API v1 endpoint reference.

POST
/api/v1/profiles

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
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
name*string
Length2 <= length <= 80
environment*string
Value in"production""staging""development""sandbox""any"
isDefault?boolean
Defaultfalse
targets*array<>
Items1 <= items <= 20

Response Body

curl -X POST 'http://localhost:4300/api/v1/profiles' \  -H 'Content-Type: application/json' \  -d '{  "name": "string",  "environment": "production",  "targets": [    {      "targetId": "cbca1126-180e-4334-9df8-cf82289d378b"    }  ]}'
Empty
Edit on GitHub

GET /profiles GET

GET /profiles: OrkStage Control API v1 endpoint reference.

GET /profiles/{id} GET

GET /profiles/{id}: OrkStage Control API v1 endpoint reference.