Skip to main content

Update agent advanced settings

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

Use this endpoint to update the communication interval (also known as the heartbeat interval) and debug log level settings for an automation agent.

Example requests and responses

Example 1. cURL
curl --location --request POST 'https://caas.digicert.com/automationws/v1/agent/updateadvancesettings' \
--header 'X-DC-DEVKEY: {{api_key}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "accountId": 5153184,
    "divisionId": 677793,
    "licenseKey": "3D8B9DE411965F6F",
    "advancedSettings": {
        "heartbeatInterval": 30,
        "programLogs": {
            "startNow": false,
            "manually": false,
            "timezone": "5:30#chennai",
            "stopTimezone": "5:30#chennai",
            "startAt": 1605805200000,
            "stopOn": 1605828600000
        }
    }
}'

Request parameters

Name

Req/Opt

Type

Description

accountId

required

string

Account ID.

divisionId

required

string

Division ID.

licenseKey

required

string

License key associated with the agent.

advancedSettings

required

object

Object with key/value pairs for each setting to update.

.. heartbeatInterval

required

integer

Agent heartbeat interval (in seconds).

.. programLogs

optional

object

Object for configuring the debug log level for the agent's program logs.

By default, the program logs for an agent only include error messages. To get more information in the logs, you can use the programLogs object to manually change the log level from "error" to "debug". Alternatively, you can set specific times when the system should start and stop writing debug level messages to the program logs.

.. .. startNow

optional

boolean

Use true to immediately change the log level from "error" to "debug".

.. .. manually

optional

boolean

Use true to require a user to manually disable the debug log level.

.. .. timezone

optional

string

Time zone for the agent to start the debug log.

Format: GMT + your timezone offset.

Example: -8#pacifictime

.. .. stopTimezone

optional

string

Time zone for the agent to stop the debug log.

Format: GMT + your timezone offset.

Example: -8#pacifictime

.. .. startAt

optional

long

Schedules the system to automatically enable the debug log level at a at a specific time.

Format: epoch in milliseconds.

Example: 1596781119000

.. .. stopOn

optional

long

Schedules the system to automatically disable the debug log level at a specific time.

Format: epoch in milliseconds.

Example: 1598299200000

Response parameters

Name

Type

Description

error

object

Object with error details, if any.

Note: Returns null if there are no errors.

data

object

Message with additional information about the request.

In this section: