Create API key

Base URL: https://api.elastic-cloud.com/api/v1

POST /users/auth/keys

Creates a new API key.

Request body

The request to create the API key

description string required: API key description. Useful if there are multiple keys
expiration string: The optional expiration for the API key, provided as a duration (ex: '1d', '3h')
role_assignments object: Roles assigned to users, API keys or organization invitations. Currently unavailable in self-hosted ECE.

Responses

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

application/json

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

application/json

Base URL: https://api.elastic-cloud.com/api/v1

Examples

Request curl 1 / 1 language

curl Shell

curl -X POST "https://api.elastic-cloud.com/api/v1/users/auth/keys" \
  -H "Content-Type: application/json" \
  -d '{
    "description": "string"
  }'

Generated from the API spec

Response

No example

Request body { }

Responses

Response headers

Request body