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

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

Use this endpoint to get details for an automation agent.

## Example requests and responses

## cURL

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

## 200 OK

```json
{
    "error": null,
    "data": {
        "agent": {
            "nickname": "SOW-F5-10.100.192.227_7",
            "hostname": "gp2lab-f5.sbolab.blu.digicert.com",
            "sensorLicenseKey": "C49946D00F476E18",
            "sensorName": "3820LatestsensorSOW",
            "sensorVersion": "3.8.20",
            "applicationType": "BIGIP 13.1.1",
            "managementIp": "10.100.192.227",
            "partitions": [
                "/Common",
                "/Zpartition",
                "/APartition",
                "/zpartition2",
                "/partition1"
            ],
            "activationDate": "1603121043109",
            "type": "Agentless",
            "status": "Configured",
            "isSniConfigured": false
        },
        "checkConfigStatus": {
            "status": "Succeeded",
            "lastUpdatedTime": 1604896564065
        },
        "errors": []
    }
}
```

## 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>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.<br>Note: Returns null if there are no errors.</td>
</tr>
<tr>
<td>data</td>
<td>object</td>
<td>Object with response data.</td>
</tr>
<tr>
<td>.. agent</td>
<td>object</td>
<td>Object container for agent details.</td>
</tr>
<tr>
<td>.. .. nickname</td>
<td>string</td>
<td>Friendly name  given to the agent.</td>
</tr>
<tr>
<td>.. .. hostname</td>
<td>string</td>
<td>Name of the host.</td>
</tr>
<tr>
<td>.. .. sensorLicenseKey</td>
<td>string</td>
<td>License key associated with the sensor.<br>Note:  Only returned if agent’s type is Agentless .</td>
</tr>
<tr>
<td>.. .. sensorName</td>
<td>string</td>
<td>Name of the sensor.</td>
</tr>
<tr>
<td>.. .. sensorVersion</td>
<td>string</td>
<td>Version of the sensor.</td>
</tr>
<tr>
<td>.. .. applicationType</td>
<td>string</td>
<td>Application name and version number.</td>
</tr>
<tr>
<td>.. .. managementIp</td>
<td>string</td>
<td>Management IP. For more information, see Sensor automation on F5 load balancer.<br>Note:  Only returned if agent’s type is Agentless.</td>
</tr>
<tr>
<td>.. .. partition</td>
<td>array</td>
<td>List of partitions available in the load balancer.</td>
</tr>
<tr>
<td>.. .. activationDate</td>
<td>string</td>
<td>Date when the agent was activated.<br>Format: epoch in milliseconds.</td>
</tr>
<tr>
<td>.. .. type</td>
<td>string</td>
<td>Agent type.<br>Possible values: Agent, Agentless.</td>
</tr>
<tr>
<td>.. .. status</td>
<td>boolean</td>
<td>Agent status.<br>Possible values:  Error, Configured, Not Configured, Suspended, Upgrading, Void.</td>
</tr>
<tr>
<td>.. .. isSniConfigured</td>
<td>boolean</td>
<td>Whether the Server Name Indication (SNI) is configured.<br>Default:
 false</td>
</tr>
<tr>
<td>.. checkConfigStatus</td>
<td>object</td>
<td>Object with details about the agent's most recent configuration check.</td>
</tr>
<tr>
<td>.. .. status</td>
<td>string</td>
<td>Status of the last check configuration request.<br>Possible values:  Succeeded, Failed, In progress.</td>
</tr>
<tr>
<td>.. .. lastUpdatedTime</td>
<td>long</td>
<td>Timestamp for when the configuration was last updated.<br>Format:  epoch in milliseconds.</td>
</tr>
<tr>
<td>.. errors</td>
<td>array</td>
<td>List of objects with information about any errors that occurred while fetching the agent details.</td>
</tr>
<tr>
<td>.. .. errorCode</td>
<td>string</td>
<td>Error code.</td>
</tr>
<tr>
<td>.. .. errorMessage</td>
<td>string</td>
<td>Error message.</td>
</tr>
</tbody>
</table>