Create API key

POST

/api-keys

Issues a new API key for the organization. Body: { name: string (1-255 chars, required), permissions?: string[] (default []), canImpersonate?: boolean (default false) }. The plaintext key value is returned ONCE in this 201 response and is never retrievable again. Authorization: organization administrators only. Returns 400 on an invalid body.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.

namestringRequired1-255 characters

permissionslist of stringsOptional

Defaults to [].

canImpersonatebooleanOptional

Defaults to false.

Response

The created API key, including its one-time plaintext value.

idstring

namestring

permissionslist of strings

canImpersonateboolean

lastUsedAtdatetime or null

createdAtdatetime

valuestring

The plaintext key. Returned ONCE, at creation, and never retrievable again.

$	curl -X POST https://api.cloudraker.com/api-keys \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"name": "CI pipeline"
>	}'

1	{
2	"id": "key_01H7X9Z3Q4W5E6R7T8Y9",
3	"name": "CI pipeline",
4	"permissions": [
5	"read:builds",
6	"write:deployments"
7	],
8	"canImpersonate": true,
9	"lastUsedAt": "2024-01-15T09:30:00Z",
10	"createdAt": "2024-01-15T09:30:00Z",
11	"value": "sk_4f8b7c9d2e3a1b0c"
12	}