It is time to say goodbye: This version of Elastic Cloud Enterprise has reached end-of-life (EOL) and is no longer supported.
The documentation for this version is no longer being maintained. If you are running this version, we strongly advise you to upgrade. For the latest information, see the current release documentation.
Create API keyedit
Creates a new API key.
Requestedit
POST /api/v1/users/auth/keys
Request bodyedit
(CreateApiKeyRequest
) (required) The request to create the API key
Responsesedit
-
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 exampleedit
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" } '