Skip to main content

Get agent summary

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

Use this endpoint to get basic information about an automation agent.

Example requests and responses

Example 1. cURL
curl --location --request POST 'https://caas.digicert.com/automationws/v1/agent/basicdetails' \
--header 'X-DC-DEVKEY: {{api_key}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "licenseKey": "4C78FD86EA557866",
    "accountId": 5153184,
    "divisionId": 677793
}'

Request parameters

Name

Req/Opt

Type

Description

licenseKey

required

string

Agent license key.

accountId

required

string

Account ID.

divisionId

required

long

Division ID.

Response parameters

Name

Type

Description

error

object

Object with error details, if any.

data

object

Object with response data.

.. licenseKey

string

Agent license key.

.. agentName

string

Name of the agent.

.. updatePreference

integer

Agent upgrade preference.

  • 0: Automatic upgrade.

  • 1: Manual upgrade. Manually upgrade the agent from the CertCentral UI.

.. stateString

string

Current state of the agent.

Possible values: Error, Configured, Not Configured, Suspended, Upgrading, or Void

.. agentVersion

string

Agent version.

.. updateAvailable

boolean

Returns true, if an agent upgrade is available. Otherwise, returns false.

.. publishUpgradeOption

boolean

Returns true if updatePreference is 1 (manual upgrade) and there is a sensor upgrade available. Otherwise, returns false.

.. emailAddresses

string

Comma-separated list of email addresses for the contacts associated with the agent.

In this section: