Use this endpoint to get a list of automation agents.
curl --location --request POST 'https://caas.digicert.com/automationws/v1/agent/list' \
--header 'X-DC-DEVKEY: {{api_key}}' \
--header 'Content-Type: application/json' \
--data-raw '{
"accountId": 5153184,
"searchCriteriaList": [],
"divisionIds": [],
"startIndex": 1,
"pageSize": 50,
"sorting": {
"AGENTNAME": "ASC"
}
}'
{
"error": null,
"data": {
"agentList": [
{
"agentId": 1974,
"accountId": "5153184",
"divisionId": "677793",
"hostname": "WIN-H4E1BFB5PE2",
"agentName": "upgrade109-10110",
"status": "Not Configured",
"sensorName": "upgrade109-10110",
"type": "Agent",
"agentLicense": "4C78FD86EA557866",
"updatePreference": 0,
"updateAvailable": false
},
{
"agentId": 2017,
"accountId": "5153184",
"divisionId": "677793",
"hostname": "cws1-w16-m1-dap",
"agentName": "SOWAgent-28sep",
"status": "Not Configured",
"sensorName": "SOWAgent-28sep",
"type": "Agent",
"agentLicense": "853029630D211D8D",
"updatePreference": 1,
"updateAvailable": false
},
{
"agentId": 2012,
"accountId": "5153184",
"divisionId": "677793",
"hostname": "gp2lab-f5.sbolab.blu.digicert.com",
"agentName": "SOW-f5-10.100.192.227_7",
"status": "Configured",
"sensorLicenseKey": "C3FD89C967E92173",
"sensorName": "SOWjanyaSensor",
"type": "Agentless",
"updateAvailable": false,
"managementIp": "10.100.192.227"
},
{
"agentId": 2018,
"accountId": "5153184",
"divisionId": "677793",
"hostname": "gp2lab-thunder.sbolab.blu.digicert.com",
"agentName": "SOW-A10-10.100.192.228",
"status": "Configured",
"sensorLicenseKey": "C3FD89C967E92173",
"sensorName": "SOWjanyaSensor",
"type": "Agentless",
"updateAvailable": false,
"managementIp": "10.100.192.228"
},
{
"agentId": 1417,
"accountId": "5153184",
"divisionId": "677793",
"hostname": "WIN-H4E1BFB5PE2",
"agentName": "Proxyagent",
"status": "Error",
"sensorName": "Proxyagent",
"type": "Agent",
"agentLicense": "C9A67959E7CBD5E2",
"updatePreference": 0,
"updateAvailable": false
},
{
"agentId": 1393,
"accountId": "5153184",
"divisionId": "677793",
"hostname": "DC-C0FY5VD-L",
"agentName": "856win10agent",
"status": "Error",
"sensorName": "856win10agent",
"type": "Agent",
"agentLicense": "9E38430DB99D75B3",
"updatePreference": 1,
"updateAvailable": false
}
],
"totalCount": 14,
"totalPages": 2
}
Name | Req/Opt | Type | Description |
---|---|---|---|
accountId | required | string | Account ID. |
searchCriteriaList | optional | array |
Filter results by specified values. For definitions, see the Filter options for searchCriteriaList table below.Example: "searchCriteriaList":[{"key":"AGENT_STATUS","operation":"EQUALS","value":["Error"]}
|
divisionIds | required | array | Division IDs. |
startIndex | optional | integer |
Index of the first result. Default: 1
|
pageSize | optional | integer |
Number of records per page. Allowed values: 0 to 512 Default: 50
|
sorting | optional | object |
Sorting details. An object with key/value pairs that describe how to sort the results. Each key is the name of a field that you can use for sorting. Each value describes whether to sort in ascending ASC or descending DESC order.Allowed keys: AGENTNAME , AGENTSTATUS , HOSTNAME , AGENTYPE .Allowed values: DESC (descending: 9-0, Z-A), ASC (ascending: 0-9, A-Z).Examples: “sorting”: {“AGENTNAME”: “ASC”} Sorts results in ascending order by agent name. |
Name | Type | Description |
---|---|---|
error | object | Object with error details, if any. |
data | object | Object with response data. |
.. agentList | object | Object with details about the agents that meet the search criteria. |
.. agentId | integer | Agent ID. |
.. accountId | string | Account ID. |
.. divisionId | string | Division ID. |
.. hostname | string | Name of the host. |
.. agentName | string | Name of the agent. |
.. status | string |
Status of the agent. Possible values: Error , Configured , Not Configured , Suspended , Upgrading , Void .
|
.. sensorLicenseKey | string |
License key associated with the sensor. NOTE: Only returned if AGENTTYPE is selected as Agentless .
|
.. sensorName | string | Name of the sensor. |
.. type | string |
Type of the agent. Possible values: Agent , Agentless .
|
.. agentLicense | string | License of the agent. |
.. updatePreference | integer |
Agent upgrade preference.0 Automatic upgrade.1 Manual upgrade.Manually upgrade the agent from the CertCentral UI. |
.. updateAvailable | boolean |
Indicates whether a new agent upgrade is available. Possible values: false .
|
.. managementIp | string |
Management IP. For more information, see Sensor automation on F5 load balancer. NOTE: Only returned if AGENTTYPE is selected as Agentless .
|
totalCount | integer | Total number of agents based on the filter criteria. |
totalPages | integer | Total number of pages for the agents based on filter criteria. |
The array includes key, operation, and value.
Key | Operation | Value |
---|---|---|
AGENTTYPE
|
EQUALS
|
Agent , Agentless .
|
AGENTNAME
|
EQUALS
|
Name of the agent. |
AGENTSTATUS
|
EQUALS
|
Error , Configured , Not Configured , Suspended , Upgrading , Void .
|
LICENSEKEY
|
EQUALS
|
License key of the user. |
SENSOR
|
EQUALS
|
Name of the sensor. |