Lookup single agent configuration
Server:
https://{kibana_url}
- POST /api/apm/settings/agent-configuration/search
- POST /s/{space_id}/api/apm/settings/agent-configuration/search
Refer to Spaces for more information.
This endpoint allows to search for single agent configuration and update 'applied_by_agent' field.
Request
-
etagstring -
If etags match then
applied_by_agentfield will be set totrue -
mark_as_applied_by_agentboolean -
markAsAppliedByAgent=truemeans "force setting it to true regardless of etag". This is needed for Jaeger agent that doesn't have etags
Responses
Successful response
-
_idstring -
Identifier
-
_indexstring -
Index
-
_scorenumber -
Score
-
_source -
Agent configuration
-
@timestampnumberrequired -
Timestamp
-
agent_namestring -
Agent name
-
applied_by_agentboolean -
Applied by agent
-
etagstringrequired -
Etag
-
settingsobjectrequired -
Agent configuration settings
Bad Request response
-
errorstring -
Error type
-
messagestring -
Error message
-
statusCodenumber -
Error status code
Unauthorized response
-
errorstring -
Error type
-
messagestring -
Error message
-
statusCodenumber -
Error status code
Not found response
-
errorstring -
Error type
-
messagestring -
Error message
-
statusCodenumber -
Error status code