Create API key

Creates a new API key.

Request

POST /api/v1/users/auth/keys

Request body

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

Responses

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

To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.

Request example

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"
}
'