Headers

• elastic-api-version string Required

  The version of the API to use

  Value is 2023-10-31. Default value is 2023-10-31.

Query parameters

• name string

  Service name

• environment string

  Service environment

Responses

• 200 application/json

  Successful response

  Hide response attributes Show response attributes object

  • id string Required
  • @timestamp number Required

    Timestamp

  • agent_name string

    Agent name

  • applied_by_agent boolean

    Applied by agent

  • etag string Required

    etag is sent by the APM agent to indicate the etag of the last successfully applied configuration. If the etag matches an existing configuration its applied_by_agent property will be set to true. Every time a configuration is edited applied_by_agent is reset to false.

  • service object Required

    Service

    Hide service attributes Show service attributes object

    • environment string

      The environment of the service.

    • name string

      The name of the service.

  • settings object Required

    Agent configuration settings

    Hide settings attribute Show settings attribute object

    • * string Additional properties
• 400 application/json

  Bad Request response

  Hide response attributes Show response attributes object

  • error string

    Error type

  • message string

    Error message

  • statusCode number

    Error status code

• 401 application/json

  Unauthorized response

  Hide response attributes Show response attributes object

  • error string

    Error type

  • message string

    Error message

  • statusCode number

    Error status code

• 404 application/json

  Not found response

  Hide response attributes Show response attributes object

  • error string

    Error type

  • message string

    Error message

  • statusCode number

    Error status code