Delete agent configuration

Base URL: 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.

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

Successful response

application/json

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

Console Kibana Dev Tools

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

Generated from the API spec

curl Shell

curl -X DELETE "${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 '{
    "service": {
      "environment": "production",
      "name": "frontend"
    }
  }'

Generated from the API spec

Response

An example of a successful response from DELETE /api/apm/settings/agent-configuration.

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

Authentication

Header parameters

Request body { }

Responses

Request body