Account

Create an API key

POST/api/me/api-keys

Creates a named API key for the current user and returns its secret value. Available on self-hosted installations.

Try it

Headers

Name	Type	Description
Authorizationrequired	string	Token returned by POST /api/auth/login, or an API key (`umami_…`) created under Settings → API keys (self-hosted only). `Bearer <token>`.

Request body

Name	Type	Description
namerequired	any	Display name of the resource.

Example request

{
  "name": {}
}

Responses

200The operation completed successfully.

Name	Type	Description
createdAtrequired	string	Date and time the record was created.
idrequired	string	Unique identifier of the resource.
keyrequired	string
keyPrefixrequired	string	Visible prefix used to identify an API key.
namerequired	string	Display name of the resource.

200 example

{
  "createdAt": "2024-01-15T09:30:00Z",
  "id": "string",
  "key": "string",
  "keyPrefix": "string",
  "name": "string"
}

400Bad request.

Name	Type	Description
errorrequired	object	Error details returned when the operation fails.

400 example

{
  "error": {
    "code": "bad-request",
    "message": "Bad request.",
    "status": 400
  }
}

401Unauthorized.

Name	Type	Description
errorrequired	object	Error details returned when the operation fails.

401 example

{
  "error": {
    "code": "unauthorized",
    "message": "Unauthorized.",
    "status": 401
  }
}

404Not found.

Name	Type	Description
errorrequired	object	Error details returned when the operation fails.

404 example

{
  "error": {
    "code": "not-found",
    "message": "Not found.",
    "status": 404
  }
}

Code samples

cURL

curl -X POST 'https://api.example.com/api/me/api-keys' \
  -H 'Authorization: Bearer <token>' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": {}
}'

PreviousChange my password NextDelete an API key