ApiKeys

Returns a list of API keys.

SecurityApiKeyAuth
Responses
200

OK

get/api-keys
Response samples
application/json
[
  • {
    }
]

Create a new API key. If no API key exists yet, or all tokens for existing API keys have been lost, the application container can be TEMPORARILY started with the API_KEY_CREATE environment variable set to string "true" and the application will create a new API key when starting and print the corresponding token to the logs. API keys created using the environment variable mechanism should only be used to boostrap the creation of other - more secure - API keys and be discarded.

SecurityApiKeyAuth
Request
Request Body schema: application/json
required
name
required
string [ 1 .. 1024 ] characters

The name of the API key.

Responses
201

Created

400

Invalid Input provided.

post/api-keys
Request samples
application/json
{
  • "name": "string"
}
Response samples
application/json
{
  • "api_key_id": 0,
  • "token": "string"
}

Get an API key by id

SecurityApiKeyAuth
Request
path Parameters
apiKeyId
required
integer <int64>

Numeric ID of the Api key

Responses
200

OK

404

Object Not Found.

get/api-keys/{apiKeyId}
Response samples
application/json
{
  • "id": 0,
  • "name": "string"
}

Delete an API key

SecurityApiKeyAuth
Request
path Parameters
apiKeyId
required
integer <int64>

Numeric ID of the Api key

Responses
200

OK

404

Object Not Found.

delete/api-keys/{apiKeyId}
➔ Next to JobExecution