Create an API key

Api Keys

Authorization

Bearer

AuthorizationBearer <token>

API key (rlay_live_* or rlay_test_*)

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name*string

Name for the API key

Length1 <= length <= 255

expires_in_days?integer

Number of days until the key expires

Range1 <= value <= 365

permission?string

Permission level: read_write (default) or read_only

Default"read_write"

Value in

"read_write"
"read_only"

workspace_scope?|array<string>

Workspace access: 'all' for unrestricted, or array of workspace IDs

Default"all"

Response Body

`application/json`

curl -X POST "https://example.com/v1/api-keys" \  -H "Content-Type: application/json" \  -d '{    "name": "string"  }'

{  "id": "string",  "key": "string",  "name": "string",  "prefix": "string",  "created_at": "2019-08-24T14:15:22Z",  "expires_at": "2019-08-24T14:15:22Z",  "permission": "read_write",  "workspace_scope": "all"}

{  "error": {    "code": "string",    "message": "string",    "details": {      "property1": null,      "property2": null    }  }}

{  "error": {    "code": "string",    "message": "string",    "details": {      "property1": null,      "property2": null    }  }}

Found something wrong? Help us improve this page.

Report an issue Edit this page on GitHub

Api Keys

Delete an API key DELETE

Create an API key

Authorization

Request Body

Response Body

201application/json

400application/json

401application/json

`application/json`

`application/json`

`application/json`