IMPORTANT: No additional bug fixes or documentation updates
will be released for this version. For the latest information, see the
current release documentation.
Search configuration
editSearch configuration
editRequest
editPOST /api/apm/settings/agent-configuration/search
Request body
edit-
service
-
(required, object) Service identifying the configuration.
Properties of
service
-
name
- (required, string) Name of service
-
environment
- (optional, string) Environment of service
-
-
etag
-
(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 totrue
. Every time a configuration is editedapplied_by_agent
is reset tofalse
.
Response body
edit{ "_index": ".apm-agent-configuration", "_id": "CIaqXXABmQCdPphWj8EJ", "_score": 2, "_source": { "agent_name": "nodejs", "service": { "name": "frontend" }, "settings": { "transaction_sample_rate": "1", }, "@timestamp": 1582031336265, "applied_by_agent": false, "etag": "5080ed25785b7b19f32713681e79f46996801a5b" } }
Example
editPOST /api/apm/settings/agent-configuration/search { "etag": "1e58c178efeebae15c25c539da740d21dee422fc", "service" : { "name": "frontend", "environment": "production" } }