Create or update agent configuration

Base URL: https://{kibana_url}

PUT /api/apm/settings/agent-configuration

Create or update an agent configuration. You must have all privileges for the APM and User Experience feature in Kibana. When updating an existing configuration, the ?overwrite=true query parameter is required. If the configuration already exists and overwrite is not set to true, the API returns a 400 error. When successful and Fleet is enabled, APM package policies are synchronized accordingly.

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>

Bad Request response

application/json

Unauthorized response

application/json

Forbidden response

application/json

Not found response

application/json

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Run PUT /api/apm/settings/agent-configuration to create or update configuration details.

Console Kibana Dev Tools

PUT kbn:/api/apm/settings/agent-configuration
{
  "agent_name": "nodejs",
  "service": {
    "environment": "production",
    "name": "frontend"
  },
  "settings": {
    "capture_body": "off",
    "transaction_max_spans": "500",
    "transaction_sample_rate": "0.4"
  }
}

Generated from the API spec

curl Shell

curl -X PUT "${KIBANA_URL}/api/apm/settings/agent-configuration" \
  -H "elastic-api-version: 2023-10-31" \
  -H "kbn-xsrf: true" \
  -H "Authorization: ApiKey ${API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{
    "agent_name": "nodejs",
    "service": {
      "environment": "production",
      "name": "frontend"
    },
    "settings": {
      "capture_body": "off",
      "transaction_max_spans": "500",
      "transaction_sample_rate": "0.4"
    }
  }'

Generated from the API spec

Response

An example of a successful response from PUT /api/apm/settings/agent-configuration. The response body is intentionally empty.

{}

{
  "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": "Not Found",
  "message": "Not Found",
  "statusCode": 404
}

Create or update agent configuration

Authentication

Query parameters

Header parameters

Request body

Responses

Authentication

Query parameters

Header parameters

Request body { }

Responses

Request body