Use this endpoint to get a list of details about your automated IPs.
This endpoint returns information about:
curl --location --request POST 'https://caas.digicert.com/automationws/v1/automatedips/list' \
--header 'X-DC-DEVKEY: {{api_key}}' \
--header 'Content-Type: application/json' \
--data-raw '{
"accountId": 5153184,
"searchCriteriaList": [
{
"key": "AUTOMATION_STATUS",
"operation": "EQUALS",
"value": [
"SUCCESSFULLY_RENEWED"
]
},
{
"key": "AGENT_NAME",
"operation": "EQUALS",
"value": [
"10.100.192.228"
]
}
],
"divisionIds": [
677793
],
"pageSize": 50,
"startIndex": 1,
"sorting": {
"commonName": "DESC"
}
}'
{
"error": null,
"data": {
"automatedIps": [
{
"appInfo": {
"name": "A10",
"version": "2.7.2-P7-SP3",
},
"appPartition": "/shared",
"alias": "10.100.198.228_HTTPS_2012",
"automationId": 299171,
"automatedIp": "10.100.198.228",
"automatedPort": 2012,
"managementIp": "10.100.192.228",
"agentName": "10.100.192.228",
"automationStatus": "SUCCESSFULLY_RENEWED",
"certificateCn": "31Aug.cert-testing.com",
"certificateExpiresOn": 15995664E12,
"certificateId": "6f8f128f8cec54b3daff5b95888c4aa516598072",
"certificateSerialNumber": "045251e7ffd49ec34d48cd911165fe62",
"certProductType": "ssl_securesite_pro",
"agentId": 1985,
"certificateCa": "DigiCert",
"divisionId": 677793,
"newCertOrderId": 9013451,
"newCertCn": "31Aug.cert-testing.com",
"profileId": 726,
"profileName": "9thJuly",
"sensorName": "LatestSensorUpgrade3818",
"sensorLicenseKey": "9A553B6AD7812E96",
"actions": [
{
"actionType": "primary",
"action": [
"renew"
]
},
{
"actionType": "secondary",
"action": [
"replace"
]
}
]
}
],
"totalCount": 1,
"totalPages": 1
}
}
Name | Req/Opt | Type | Description |
---|---|---|---|
accountId | required | string | Account ID. |
searchCriteriaList | optional | array |
Filter results by specified values. Example: "searchCriteriaList":[{"key":"AUTOMATION_STATUS","operation":"EQUALS","value":["SUCCESSFULLY_RENEWED"]}
|
.. key | optional | string |
Field name (key) to search. Allowed values: PROFILE_TYPE , LB_DATA_PORT , AUTOMATION_STATUS , LB_DATA_IP , CA , AGENT_NAME .
|
.. operation | optional | string |
Filter operation. Allowed values: EQUALS .
|
.. value | optional | array | List of values to filter against. |
divisionIds | required | array | Division IDs. |
pageSize | optional | integer |
Number of records per page. Allowed values: 0 to 512 Default: 50
|
startIndex | optional | integer |
Index of the first result. Default: 1 .
|
sorting | optional | object |
Sorting details. An object with key/value pairs that describe how to sort the results. Each key is the name of a field that you can use for sorting. Each value describes whether to sort in ascending ASC or descending DESC order. Allowed keys: commonName , automatedIp , automatedPort , ca , agentName , automationAgentAppName , automationStatus .Allowed values: DESC (descending: 9-0, Z-A), ASC (ascending: 0-9, A-Z)Examples: “sorting”: {“commonName”: “DESC”} Sorts results in descending order by common name. “Sorting”: {commonName: “ASC”, “ca”: “DESC”} Sorts results in an ascending order by the common name first, then in a descending order by the certificate authority. |
filterSelected | optional | string | Name of the filter selected. |
Name | Type | Description |
---|---|---|
error | object | Object with error details. |
data | object | Object with response data. |
.. automatedIps | array | List of objects with details about the results. |
.. .. appInfo | object | Object with details about the application. |
.. .. .. name | string | Name of the application. |
.. .. .. version | string | Application version. |
.. appPartition | string | The partition to which the data IP belongs. |
.. .. automationId | integer | Automation ID. |
.. .. automatedIp | string | IP that is automated. |
.. .. automatedPort | integer | Port that is automated. |
.. .. managementIp | string |
Management IP. For more information, see Sensor automation on F5 load balancer. |
.. .. agentName | string | Name of the agent. |
.. .. automationStatus | string |
Status of the automation. Possible values: ACTION_REQUIRED , SUCCESFULLY_RENEWED , AUTO_RENEW_SCHEDULED , AUTOMATION_FAILED , AUTOMATION_SCHEDULED , CONFIGURED , INSTALL_VALIDATION_FAILED , INSTALL_FAILED , ERROR .
|
.. .. certificateCn | string | Common name of the certificate. |
.. .. certificateExpiresOn | integer |
Expiration date of the certificate. Format: epoch in milliseconds. Example: 1596781119
|
.. .. certificateId | string | ID of the CA certificate that signs the certificate. |
.. .. certificateSerialNumber | string | Serial number of the certificate. |
.. .. certProductType | string | Product ID for the certificate. |
.. .. agentId | integer | ID of the agent. |
.. .. certificateCa | string | CA that issued the certificate. |
.. .. divisionId | integer | Division ID. |
.. .. newCertOrderId | integer | Order ID of the new certificate. |
.. .. newCertCn | string | Common name of the new certificate. |
.. .. profileId | integer | Automation profile ID. |
.. .. profileName | string | Name of the profile. |
.. .. sensorName | string | Name of the sensor. |
.. .. sensorLicenseKey | string | License key associated with the sensor. |
.. .. actions | array | List of objects with action details. |
.. .. .. actionType | string |
Type of the action performed.0 -primary and 1 - secondary
|
.. .. .. action | array |
Action performed on the certificate. Possible values: renew , replace .
|
totalCount | integer | Total number of automated IPs. |
totalPages | integer | Total number of pages for the automated IPs. |
The array includes key, operation, and value.
Key | Operation | Value |
---|---|---|
COMMON_NAME
|
EQUALS
|
Common name. |
LB_DATA_IP
|
EQUALS
|
Data IP of the load balancer. |
LB_DATA_PORT
|
EQUALS
|
Data port of the load balancer. |
CA
|
EQUALS
|
Name of the CA. |
AGENT_NAME
|
EQUALS
|
Name of the agent. |
AUTOMATION_STATUS
|
EQUALS
|
ACTION_REQUIRED , AUTOMATION_FAILED , SUCCESSFULLY_RENEWED , AUTO_RENEW_SCHEDULED , CERT_PENDING_APPROVAL , CONFIGURED , CSR_GENERATION_FAILED , INSTALL_FAILED , NOT_SCANNED , POST_CSR_FAILED
|
LB_APP_NAME
|
EQUALS
|
Application name of the load balancer. |
LB_APP_VERSION
|
EQUALS
|
Application version of the load balancer. |