Skip to main content

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.

Example requests and responses

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.