API Keys

API key object

Sample API key object

You can see all elements of the API key object at the json below.

{
"workspaceId": "2c2adE47-d85D-8BbD-AD8c-55f5fd1B0Cb8",
"internal": false,
"key": "0b76a034ff28abcacc0c24a07ade2b04",
"createdAt": "2020-05-18T02:17:29.997Z",
"id": "2cbFB8b9-a511-82C6-64f6-Bd9073eEE58F"
}

Endpoints


Get API keys

GET/apikeys

Roles:

apikeys:read

Arguments

HEADERS
  • Authorization
    • JWT

Returns

Returns a list of API keys

{
"status": "ok",
"data": [
{
"workspaceId": "2c2adE47-d85D-8BbD-AD8c-55f5fd1B0Cb8",
"internal": false,
"key": "in",
"createdAt": "1975-05-18T02:17:29.997Z",
"id": "2cbFB8b9-a511-82C6-64f6-Bd9073eEE58F"
},
{
"workspaceId": "2c2adE47-d85D-8BbD-AD8c-55f5fd1B0Cb8",
"internal": false,
"key": "in",
"createdAt": "1975-05-18T02:17:29.997Z",
"id": "2cbFB8b9-a511-82C6-64f6-Bd9073eEE58F"
}
]
}

Create an API key

POST/apikeys

Roles:

apikeys:write

Arguments

HEADERS
  • Authorization
    • JWT

Returns

Returns id of the API Key

{
"status": "ok",
"insertedItem": "2cbFB8b9-a511-82C6-64f6-Bd9073eEE58F"
}

Delete API key

DELETE/apikeys/:id

Roles:

apikeys:delete

Arguments

HEADERS
  • Authorization
    • JWT
PATH PARAMETERS
  • :id required Id of the API key

Returns

Returns a success message

{
"status": "ok",
"message": "Deleted"
}