Skip to main content

Update agent

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

Use this endpoint to update agent details for an automation agent.

Example requests and responses

Request parameters

Name

Req/Opt

Type

Description

accountId

required

string

Account ID.

agentId

required

long

ID of the agent.

nickname

optional

string

Friendly name of the agent.

licenseKey

required

string

Agent license key.

divisionId

required

string

Division ID.

isSniConfigured

optional

boolean

Whether the Server Name Indication (SNI) is configured.

Default: false

automationMasterDtoList

optional

array

Array of objects with automation details for each IP/port.

.. id

optional

integer

Automation ID.

.. automatedIp

optional

string

IP to configure for automation.

.. automatedPort

optional

string

Port to configure for automation.

.. isRetry

optional

boolean

Whether to retry the automation if it fails. If true, retry is initiated.

.. acmeClientId

optional

integer

ID associated with an ACME client to configure for automation.

.. isIgnore

optional

boolean

Whether to ignore the port.

Default: false

sniDomains

optional

string

Server Name Indication (SNI) domains to enable. This can be a single domain or a comma-separated list of domains.

Response parameters

Name

Type

Description

error

object

Object with error details, if any.

data

object

Message with information about the request.