Categories:
Agent plugin
Agent plugin description for aura-configuration-api
Introduction
The agent plugin defines services associated with the management of agents in aura-configuration-api server.
All these services are defined in the agents namespace (/agents).
Servers definition
By default, the servers defined in the swagger include the base path (for v1):
/aura-services/v2/configuration.
Therefore, in order to access the services, the base path and service path must be used.
Examples:
- aura-services/v2/configuration/agents
- aura-services/v2/configuration/agents/{agentId}
Endpoints
| Path | Method | Description |
|---|---|---|
| /agents/ | GET | Get all agent information |
| /agents/ | POST | Add a new agent |
| /agents/{agentId} | GET | Get agent information using agent id |
| /agents/{agentId} | PUT | Replace agent information associated to agent id |
| /agents/{agentId} | PATCH | Update some fields of agent information using agent id |
| /agents/{agentId} | DELETE | Delete agent information using agent id |
You can read the complete documentation of each service in the aura-configuration-api agent swagger file.
Retrieving information from agents
Retrieving specific fields from agent information
It is possible to get only a specific list of fields for agent information, reducing the amount of data transmitted when necessary, using the includeFields query parameter.
curl --location --request GET 'http://aura-configuration-api:8999/aura-services/v2/configuration/agents?includeFields=id,name' \
--header 'correlator: urn:uuid:c8a604ee-29f8-7cda-2979-d2ae6189c360' \
--header 'Accept: application/json' \
--header 'Authorization: XXX'
Response example:
[
{
"id": "ab744582-c5a6-48e1-95bb-f509bdb55512",
"name": "agent-pid-1"
}
]
Excluding fields in agent information
It is also possible to exclude agent information fields using the excludeFields query parameter.
curl --location --request GET 'http://aura-configuration-api:8999/aura-services/v2/configuration/agents?excludeFields=metadata,name' \
--header 'correlator: urn:uuid:c8a604ee-29f8-7cda-2979-d2ae6189c360' \
--header 'Accept: application/json' \
--header 'Authorization: APIKEY XXX'
Response example:
[
{
"id": "ab744582-c5a6-48e1-95bb-f509bdb55512",
"name": "agent-pid-1"
}
]
Database
The complete definition of the data model can be found in Agent collection section within the administration module.