---
title: "Update agent"
source_url: https://dev.digicert.com/certcentral-apis/automation-api/update-agent.html
api_method: POST
api_endpoint: "/automationws/v1/agent/update"
api_url: "https://caas.digicert.com/automationws/v1/agent/update"
---

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

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

## Example requests and responses

## cURL

```bash
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"
}'
```

## 200 OK

```json
{
    "error": null,
    "data": "Agent updated successfully"
}
```

## Request parameters

<table class="params-table">
<thead>
<tr>
<th>Name</th>
<th>Req/Opt</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>accountId</td>
<td>required</td>
<td>string</td>
<td>Account ID.</td>
</tr>
<tr>
<td>agentId</td>
<td>required</td>
<td>long</td>
<td>ID of the agent.</td>
</tr>
<tr>
<td>nickname</td>
<td>optional</td>
<td>string</td>
<td>Friendly name of the agent.</td>
</tr>
<tr>
<td>licenseKey</td>
<td>required</td>
<td>string</td>
<td>Agent license key.</td>
</tr>
<tr>
<td>divisionId</td>
<td>required</td>
<td>string</td>
<td>Division ID.</td>
</tr>
<tr>
<td>isSniConfigured</td>
<td>optional</td>
<td>boolean</td>
<td>Whether the Server Name Indication (SNI) is configured.<br>Default:
 false</td>
</tr>
<tr>
<td>automationMasterDtoList</td>
<td>optional</td>
<td>array</td>
<td>Array of objects with automation details for each IP/port.</td>
</tr>
<tr>
<td>.. id</td>
<td>optional</td>
<td>integer</td>
<td>Automation ID.</td>
</tr>
<tr>
<td>.. automatedIp</td>
<td>optional</td>
<td>string</td>
<td>IP to configure for automation.</td>
</tr>
<tr>
<td>.. automatedPort</td>
<td>optional</td>
<td>string</td>
<td>Port to configure for automation.</td>
</tr>
<tr>
<td>.. isRetry</td>
<td>optional</td>
<td>boolean</td>
<td>Whether to retry the automation if it fails. If true, retry is initiated.</td>
</tr>
<tr>
<td>.. acmeClientId</td>
<td>optional</td>
<td>integer</td>
<td>ID associated with an ACME client to configure for automation.</td>
</tr>
<tr>
<td>.. isIgnore</td>
<td>optional</td>
<td>boolean</td>
<td>Whether to ignore the port.<br>Default:
 false</td>
</tr>
<tr>
<td>sniDomains</td>
<td>optional</td>
<td>string</td>
<td>Server Name Indication (SNI) domains to enable. This can be a single domain or a comma-separated list of domains.</td>
</tr>
</tbody>
</table>

## Response parameters

<table class="params-table">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>error</td>
<td>object</td>
<td>Object with error details, if any.</td>
</tr>
<tr>
<td>data</td>
<td>object</td>
<td>Message with information about the request.</td>
</tr>
</tbody>
</table>