OrkStageOrkStage
API referenceAPI keys

POST /api-keys

POST /api-keys: OrkStage Control API v1 endpoint reference.

POST
/api/v1/api-keys

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
name*string
Length2 <= length <= 80
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
role*string
Value in"PlatformAdmin""PlatformOperator""CustomerAdmin""CustomerDeveloper""CustomerViewer"
scopes*array<>
Items1 <= items
expiresAt?string
Match^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
Formatdate-time
environment?string
Default"live"
Value in"live""test"

Response Body

curl -X POST 'http://localhost:4300/api/v1/api-keys' \  -H 'Content-Type: application/json' \  -d '{  "name": "string",  "role": "PlatformAdmin",  "scopes": [    "instances:read"  ]}'
Empty
Edit on GitHub

GET /api-keys GET

GET /api-keys: OrkStage Control API v1 endpoint reference.

DELETE /api-keys/{id} DELETE

DELETE /api-keys/{id}: OrkStage Control API v1 endpoint reference.