Skip to main content

Get agent advanced settings

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

Use this endpoint to get advanced settings details for an automation agent, such as the agent's communication interval (also known as the heartbeat interval) and the debug log level settings.

Example requests and responses

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

Request parameters

Name

Req/Opt

Type

Description

licenseKey

required

string

License key associated with the agent.

divisionId

required

long

Division ID.

accountId

required

string

Account ID.

Response parameters

Name

Type

Description

error

object

Object with error details, if any.

Note: Returns null if there are no errors.

data

object

Object with response data.

.. heartbeatInterval

integer

Agent heartbeat interval (in seconds).

.. programLogs

object

Object with details about the debug log level settings.

.. .. startNow

boolean

If true, the system received a request to immediately change the log level from "error" to "debug".

.. .. startAt

integer

Time when the system is scheduled to automatically enable the debug log level.

Format: epoch in milliseconds.

Example: 1596781119000

.. .. manually

boolean

If true, a user must manually disable the debug log level.

.. .. stopOn

integer

Time when the system is scheduled to automatically disable the debug log level.

Format: epoch in milliseconds.

Example: 1596781119000

.. .. timezone

string

Time zone for the agent to start the debug log.

Format: GMT+ your timezone offset

Example: -8#pacifictime

.. .. stopTimezone

string

Time zone for the agent to stop the debug log.

Format: GMT+ your timezone offset

Example: -8#pacifictime

In this section: