API Keys
Create an API key (returns the plaintext once)
Command line
The orl CLI wraps this endpoint:
orl api-keys create --name <name>Authorization
apiKey AuthorizationBearer <token>
OpenRelay API key. Send it as Authorization: Bearer or_… (legacy vl_… keys still work).
In: header
Path Parameters
orgId*string
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/v1/orgs/string/api-keys/create" \ -H "Content-Type: application/json" \ -d '{ "name": "ci-deploy", "scopes": [ "clusters:read", "clusters:write", "vms:read" ] }'{ "id": "string", "key": "string", "keyPrefix": "string", "name": "string", "scopes": [ "string" ], "createdAt": "string", "organizationId": "string"}