Use this endpoint to update agent details for an automation agent.
curl --location --request POST 'https://caas.digicert.com/automationws/v1/agent/update' \
--header 'X-DC-DEVKEY: {{api_key}}' \
--header 'Content-Type: application/json' \
--data-raw '{
"accountId": 5153184,
"agentId": 2059,
"nickname": "SOW-WinAgent",
"licenseKey": "C719FB5C5FD6A4BE",
"divisionId": "677793",
"isSniConfigured": true,
"automationMasterDtoList": [
{
"id": 325253,
"automatedIp": "10.100.192.83",
"automatedPort": "1900",
"isRetry": false,
"acmeClientId": 111,
"isIgnore": false
}
],
"sniDomains": "www.digicert.com"
}'
{
"error": null,
"data": "Agent updated successfully"
}
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. |
Name | Type | Description |
---|---|---|
error | object | Object with error details, if any. |
data | object | Message with information about the request. |