Categories:
Agent deployment plugin
Agent Deployment plugin description for aura-configuration-api
Introduction
The agent-deployment plugin defines services associated with the management of agents base in aura-configuration-api server.
All these services are defined in the _agents-deployment namespace (/agents-deployment).
Servers definition
By default, the servers defined in the swagger include the base path (for v2):
/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-deployment
- aura-services/v2/configuration/agents-deployment/{agentDeploymentId}
Endpoints
| Path | Method | Description |
|---|---|---|
| /agents-deployment/ | GET | Get all agent deployment information |
| /agents-deployment/ | POST | Add a new agent deployment |
| /agents-deployment/{agentDeploymentId} | GET | Get agent deployment information using agent deployment id |
| /agents-deployment/{agentDeploymentId} | PUT | Replace agent deployment information associated to agent deployment id |
| /agents-deployment/{agentDeploymentId} | PATCH | Update some fields of agent deployment information using agent deployment id |
| /agents-deployment/{agentDeploymentId} | DELETE | Delete agent deployment information using agent deployment id |
You can read the complete documentation of each service in the aura-configuration-api agent deployment swagger file.
Retrieving information from agents base
Retrieving specific fields from agent deployment information
It is possible to get only a specific list of fields for agent deployment 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-deployment?includeFields=id,name' \
--header 'correlator: urn:uuid:c8a604ee-29f8-7cda-2979-d2ae6189c360' \
--header 'Accept: application/json' \
--header 'Authorization: XXX'
Response example:
[
{
"id": "cd2b534c-16c3-4d89-a87e-ec45d3939232",
"name": "mongo-device-recommender-agent",
}
]
Excluding fields in agent deployment information
It is also possible to exclude agent deployment information fields using the excludeFields query parameter.
curl --location --request GET 'http://aura-configuration-api:8999/aura-services/v2/configuration/agents-deployment?excludeFields=metadata,name' \
--header 'correlator: urn:uuid:c8a604ee-29f8-7cda-2979-d2ae6189c360' \
--header 'Accept: application/json' \
--header 'Authorization: APIKEY XXX'
Response example:
[
{
"id": "1870fa4a-bcc4-4a7c-88fc-c0194555a076",
"config": {},
"secrets": {},
"image": "auraregistry.azurecr.io/aura/atria-agent-mongo-devices-recommender",
"tag": "1.0.0"
}
]
Filtering agent deployment information
It is possible to filter agent deployment information using the filter query parameter.
curl --location --request GET 'http://aura-configuration-api:8999/aura-services/v2/configuration/agents-deployment?filter=tag:1.0.0' \
--header 'correlator: urn:uuid:c8a604ee-29f8-7cda-2979-d2ae6189c360' \
--header 'Accept: application/json' \
--header 'Authorization: APIKEY XXX'
Database
The complete definition of the data model can be found in agent deployment collection section within the administration module.