Create an APM agent key

Server: https://{kibana_url}

POST /api/apm/agent_keys

Create a new agent key for APM. The user creating an APM agent API key must have at least the manage_own_api_key cluster privilege and the APM application-level privileges that it wishes to grant. After it is created, you can copy the API key (Base64 encoded) and use it to to authorize requests from APM agents to the APM Server.

Request

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

Examples

Run POST /api/apm/agent_keys to create an APM agent API key with the specified privileges.

Request Console 1 / 2 languages

Console Kibana Dev Tools

POST /api/apm/agent_keys
{
  "name": "apm-key",
  "privileges": [
    "event:write",
    "config_agent:read"
  ]
}

curl Shell

curl -X POST "https://{kibana_url}/api/apm/agent_keys" \
  -H "elastic-api-version: string" \
  -H "kbn-xsrf: true" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "apm-key",
  "privileges": [
    "event:write",
    "config_agent:read"
  ]
}'

Response

{
  "agentKey": {
    "api_key": "PjGloCGOTzaZr8ilUPvkjA",
    "encoded": "M0RDTG1uMEIzWk1oTFVhN1dCRzk6UGpHbG9DR09UemFacjhpbFVQdmtqQQ==",
    "id": "3DCLmn0B3ZMhLUa7WBG9",
    "name": "apm-key"
  }
}

{
  "error": "Bad Request",
  "message": "[request body]: expected value of type [string] but got [undefined]",
  "statusCode": 400
}

{
  "error": "Unauthorized",
  "message": "[security_exception]: missing authentication credentials for REST request",
  "statusCode": 401
}

{
  "error": "Forbidden",
  "message": "Insufficient privileges to perform this action. The APM and User Experience feature requires \u0060all\u0060 privileges.",
  "statusCode": 403
}

{
  "error": "Internal Server Error",
  "message": "An internal server error occurred. Check the Kibana server logs for details.",
  "statusCode": 500
}

Request { name , privileges , }

Responses

Request