Skip to main content

Get agent list

POST https://caas.digicert.com/automationws/v1/agent/list

Use this endpoint to get a list of automation agents.

Example requests and responses

Request parameters

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.

Response parameters

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.

Filter options for searchCriteriaList

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.