Create an APM agent key

Base URL: https://{kibana_url}

POST /api/apm/agent_keys
POST /s/{space_id}/api/apm/agent_keys

Refer to Spaces for more information.

Create a new agent key for APM.

Authentication

Api key

Authorization: <value>

These APIs use key-based authentication. You must create an API key and use the encoded value in the request header. For example: Authorization: ApiKey base64AccessApiKey

Basic

Authorization: Basic <credentials>

Header parameters

Request body

Responses

Agent key created successfully

application/json

Bad Request response

application/json

Unauthorized response

application/json

Forbidden response

application/json

Internal Server Error response

application/json

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Console Kibana Dev Tools

POST kbn:/api/apm/agent_keys
{
  "name": "string",
  "privileges": [
    "event:write"
  ]
}

Generated from the API spec

curl Shell

curl -X POST "${KIBANA_URL}/api/apm/agent_keys" \
  -H "elastic-api-version: 2023-10-31" \
  -H "kbn-xsrf: true" \
  -H "Authorization: ApiKey ${API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "string",
    "privileges": [
      "event:write"
    ]
  }'

Generated from the API spec

Response

No example

Authentication

Header parameters

Request body { }

Responses

Request body