Create or update agent configuration

Server: https://{kibana_url}

PUT /api/apm/settings/agent-configuration
PUT /s/{space_id}/api/apm/settings/agent-configuration

Refer to Spaces for more information.

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.

Query Parameters

overwrite boolean: If the config exists ?overwrite=true is required

Request

Responses

Successful response

application/json

Bad Request response

application/json

Unauthorized response

application/json

Forbidden response

application/json

Not found response

application/json

Examples

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

Request Console 1 / 2 languages

Console Kibana Dev Tools

PUT /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"
  }
}

curl Shell

curl -X PUT "https://{kibana_url}/api/apm/settings/agent-configuration" \
  -H "elastic-api-version: string" \
  -H "kbn-xsrf: true" \
  -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"
  }
}'

Response

{}

{
  "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
}

Query Parameters

Request { agent_name , service , settings , }

Responses

Request