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

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

Use this endpoint to get basic information about an automation agent.

## Example requests and responses

## cURL

```bash
curl --location --request POST 'https://caas.digicert.com/automationws/v1/agent/basicdetails' \
--header 'X-DC-DEVKEY: {{api_key}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "licenseKey": "4C78FD86EA557866",
    "accountId": 5153184,
    "divisionId": 677793
}'
```

## 200 OK

```json
{
    "error": null,
    "data": {
        "licenseKey": "4C78FD86EA557866",
        "agentName": "upgrade109-10110",
        "updatePreference": 0,
        "stateString": "Error",
        "agentVersion": "1.0.11",
        "updateAvailable": false,
        "publishUpgradeOption": false,
        "emailAddresses": "cc.admin@cert-testing.com"
    }
}
```

## 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>licenseKey</td>
<td>required</td>
<td>string</td>
<td>Agent license key.</td>
</tr>
<tr>
<td>accountId</td>
<td>required</td>
<td>string</td>
<td>Account ID.</td>
</tr>
<tr>
<td>divisionId</td>
<td>required</td>
<td>long</td>
<td>Division ID.</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>Object with response data.</td>
</tr>
<tr>
<td>.. licenseKey</td>
<td>string</td>
<td>Agent license key.</td>
</tr>
<tr>
<td>.. agentName</td>
<td>string</td>
<td>Name of the agent.</td>
</tr>
<tr>
<td>.. updatePreference</td>
<td>integer</td>
<td>Agent upgrade preference.<br><ul><li>0: Automatic upgrade.</li><li>1: Manual upgrade. Manually upgrade the agent from the CertCentral UI.</li></ul></td>
</tr>
<tr>
<td>.. stateString</td>
<td>string</td>
<td>Current state of the agent.<br>Possible values: Error, Configured, Not Configured, Suspended, Upgrading, or Void</td>
</tr>
<tr>
<td>.. agentVersion</td>
<td>string</td>
<td>Agent version.</td>
</tr>
<tr>
<td>.. updateAvailable</td>
<td>boolean</td>
<td>Returns <code>true</code>, if an agent upgrade is available. Otherwise, returns <code>false</code>.</td>
</tr>
<tr>
<td>.. publishUpgradeOption</td>
<td>boolean</td>
<td>Returns <code>true</code> if <code>updatePreference</code> is <code>1</code> (manual upgrade) and there is a sensor upgrade available. Otherwise, returns <code>false</code>.</td>
</tr>
<tr>
<td>.. emailAddresses</td>
<td>string</td>
<td>Comma-separated list of email addresses for the contacts associated with the agent.</td>
</tr>
</tbody>
</table>