Delete agent configuration

Server: https://{kibana_url}

DELETE /api/apm/settings/agent-configuration

Delete an existing agent configuration. You must have all privileges for the APM and User Experience feature in Kibana. When successful, the configuration is removed and, if Fleet is enabled, APM package policies are synchronized accordingly.

Request

service {} required: Service

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 DELETE /api/apm/settings/agent-configuration to delete a configuration.

Request Console 1 / 2 languages

Console Kibana Dev Tools

DELETE /api/apm/settings/agent-configuration
{
  "service": {
    "environment": "production",
    "name": "frontend"
  }
}

curl Shell

curl -X DELETE "https://{kibana_url}/api/apm/settings/agent-configuration" \
  -H "elastic-api-version: string" \
  -H "kbn-xsrf: true" \
  -H "Content-Type: application/json" \
  -d '{
  "service": {
    "environment": "production",
    "name": "frontend"
  }
}'

Response

{
  "result": "deleted"
}

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