IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.

« Get all API keys Delete API keys of multiple users »

› › › ›

Create API key

edit

Create API key

edit

Creates a new API key.

Request

edit

POST /api/v1/users/auth/keys

Request body

edit

(CreateApiKeyRequest) (required) The request to create the API key

Responses

edit

201

(ApiKeyResponse)

The API key is created and returned in the body of the response.

400

(BasicFailedReply)

The request is invalid. Specify a different request, then try again. (code: api_keys.invalid_input)

Headers

x-cloud-error-codes (string; allowed values: [api_keys.invalid_input]): The error codes associated with the response

449

(BasicFailedReply)

Elevated permissions are required. (code: root.unauthorized.rbac.elevated_permissions_required)

Headers

x-cloud-error-codes (string; allowed values: [root.unauthorized.rbac.elevated_permissions_required]): The error codes associated with the response

Request example

edit

curl -XPOST https://{{hostname}}/api/v1/users/auth/keys \
-H "Authorization: ApiKey $ECE_API_KEY" \
-H 'Content-Type: application/json' \
-d '
{
   "authentication_token" : "string",
   "description" : "string"
}
'

« Get all API keys Delete API keys of multiple users »