Get agent IP/port details

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

Use this endpoint to get IP address and port details for an automation agent.

bash
curl --location --request POST 'https://caas.digicert.com/automationws/v1/agent/agentIPPortDetails' \
--header 'X-DC-DEVKEY: {{api_key}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "accountId": 5153184,
    "agentId": 2060,
    "divisionId":  "677793"
}'
200 OK
{
    "error": null,
    "data": [
        {
            "id": 325327,
            "agentId": 2060,
            "automatedIp": "10.100.196.83",
            "automatedPort": 135,
            "automationStatus": "NOT_CONFIGURED"
        },
        {
            "id": 325377,
            "agentId": 2060,
            "automatedIp": "10.100.192.83",
            "automatedPort": 7070,
            "automationStatus": "CONFIGURED",
            "acmeClientId": 113,
            "acmeClientName": "IIS",
            "acmeClientVersion": "10.0"
        },
        {
            "id": 325342,
            "agentId": 2060,
            "automatedIp": "10.100.196.83",
            "automatedPort": 49665,
            "automationStatus": "NOT_CONFIGURED"
        },
        {
            "id": 325344,
            "agentId": 2060,
            "automatedIp": "10.100.192.83",
            "automatedPort": 49666,
            "automationStatus": "NOT_CONFIGURED"
        },
        {
            "id": 325357,
            "agentId": 2060,
            "automatedIp": "10.100.196.83",
            "automatedPort": 49675,
            "automationStatus": "NOT_CONFIGURED"
        }
    ]
}

Request parameters

Name Req/Opt Type Description
accountId required string Account ID.
agentId required long ID of the agent.
divisionId required string Division ID.

Response parameters

Name Type Description
error object Object with error details, if any.
Note: Returns null if there are no errors.
data array List of objects with response data.
.. id integer Automation ID.
.. agentId required ID of the agent.
.. automatedIp optional The automated IP address.
.. automatedPort string The automated port.
.. automationStatus string Status of automation configuration.
Possible values: CONFIGURED, NOT_CONFIGURED.
.. acmeClientId integer ID associated with an ACME client configured for automation.
Note: Only returns when automationStatus is CONFIGURED.
.. acmeClientName string Name of the ACME client.
NOTE: Only returns when automationStatus is CONFIGURED.
.. acmeClientVersion string Version of the ACME client.
NOTE: Only returns when automationStatus is CONFIGURED.