List endpoints

POST https://daas.digicert.com/apicontroller/v1/reports/viewIpPort
Get a total count and list of all endpoint servers that have certificates found through CertCentral Discovery scans. Optionally filter results by server or scan attributes.

Example requests and responses

curl -X POST \
  https://daas.digicert.com/apicontroller/v1/reports/viewIpPort \
  -H 'Content-Type: application/json' \
  -H 'X-DC-DEVKEY: {{api_key}}' \
  -d '{
    "searchCriteriaList": [
        {
            "key":"serialNumber",
            "operation": "EQUALS",
            "value": [
                "0eb6eab418c873d8f3c031dcdddf18b0"
            ]
        },
        {
            "key":"ip",
            "operation": "EQUALS",
            "value": [
                "www.itc.com","www.digicert.com","www.cert.com","wmart.com","ph.com"
            ]
        },
        {
            "key":"port",
            "operation": "EQUALS",
            "value": [
                3389,636,443,80,389,8443
            ]
        },
        {
            "key":"scanName",
            "operation": "EQUALS",
            "value": [
                "ScanWithAllVul","GtScdlV612Aug19"
            ]
        },
        {
            "key":"serverSecurity",
            "operation": "EQUALS",
            "value": [
                "NO_VULNERABILITY_FOUND"
            ]
        },
        {
            "key":"isCertPresent",
            "operation": "EQUALS",
            "value": [
                true
            ]
        },
        {
            "key":"cn",
            "operation": "EQUALS",
            "value": [
                "www.origin.digicert.com"
            ]
        }
    ],
    "accountId": "126993",
    "divisionIds": [],
    "startIndex": 1,
    "pageSize": 50,
    "sortedColumnId": null,
    "sortOrder": "ASC"
}'
import requests

url = "https://daas.digicert.com/apicontroller/v1/reports/viewIpPort"

payload = "{\n    \"searchCriteriaList\": [\n        {\n            \"key\": \"serialNumber\",\n            \"operation\": \"EQUALS\",\n            \"value\": [\n                \"0eb6eab418c873d8f3c031dcdddf18b0\"\n            ]\n        },\n        {\n            \"key\": \"ip\",\n            \"operation\": \"EQUALS\",\n            \"value\": [\n                \"www.itc.com\",\"www.digicert.com\",\"www.cert.com\",\"wmart.com\",\"ph.com\"\n            ]\n        },\n        {\n            \"key\": \"port\",\n            \"operation\": \"EQUALS\",\n            \"value\": [\n                \"3389\",\"636\",\"443\",\"80\",\"389\",\"8443\"\n            ]\n        },\n        {\n            \"key\": \"scanName\",\n            \"operation\": \"EQUALS\",\n            \"value\": [\n                \"ScanWithAllVul\",\"GtScdlV612Aug19\"\n            ]\n        },\n        {\n            \"key\": \"serverSecurity\",\n            \"operation\": \"EQUALS\",\n            \"value\": [\n                \"NO_VULNERABILITY_FOUND\"\n            ]\n        },\n        {\n            \"key\": \"isCertPresent\",\n            \"operation\": \"EQUALS\",\n            \"value\": [\n                \"true\"\n            ]\n        },\n        {\n            \"key\": \"cn\",\n            \"operation\": \"EQUALS\",\n            \"value\": [\n                \"www.origin.digicert.com\"\n            ]\n        }\n    ],\n    \"accountId\": \"126993\",\n    \"divisionIds\": [],\n    \"startIndex\": 1,\n    \"pageSize\": 50,\n    \"sortedColumnId\": null,\n    \"sortOrder\": \"ASC\"\n}"
headers = {
    'X-DC-DEVKEY': "{{api_key}}",
    'Content-Type': "application/json",
    }

response = requests.request("POST", url, data=payload, headers=headers)

print(response.text)
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://daas.digicert.com/apicontroller/v1/reports/viewIpPort"

	payload := strings.NewReader("{\n    \"searchCriteriaList\": [\n        {\n            \"key\": \"serialNumber\",\n            \"operation\": \"EQUALS\",\n            \"value\": [\n                \"0eb6eab418c873d8f3c031dcdddf18b0\"\n            ]\n        },\n        {\n            \"key\": \"ip\",\n            \"operation\": \"EQUALS\",\n            \"value\": [\n                \"www.itc.com\",\"www.digicert.com\",\"www.cert.com\",\"wmart.com\",\"ph.com\"\n            ]\n        },\n        {\n            \"key\": \"port\",\n            \"operation\": \"EQUALS\",\n            \"value\": [\n                \"3389\",\"636\",\"443\",\"80\",\"389\",\"8443\"\n            ]\n        },\n        {\n            \"key\": \"scanName\",\n            \"operation\": \"EQUALS\",\n            \"value\": [\n                \"ScanWithAllVul\",\"GtScdlV612Aug19\"\n            ]\n        },\n        {\n            \"key\": \"serverSecurity\",\n            \"operation\": \"EQUALS\",\n            \"value\": [\n                \"NO_VULNERABILITY_FOUND\"\n            ]\n        },\n        {\n            \"key\": \"isCertPresent\",\n            \"operation\": \"EQUALS\",\n            \"value\": [\n                \"true\"\n            ]\n        },\n        {\n            \"key\": \"cn\",\n            \"operation\": \"EQUALS\",\n            \"value\": [\n                \"www.origin.digicert.com\"\n            ]\n        }\n    ],\n    \"accountId\": \"126993\",\n    \"divisionIds\": [],\n    \"startIndex\": 1,\n    \"pageSize\": 50,\n    \"sortedColumnId\": null,\n    \"sortOrder\": \"ASC\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-DC-DEVKEY", "{{api_key}}")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
var request = require("request");

var options = { method: 'POST',
  url: 'https://daas.digicert.com/apicontroller/v1/reports/viewIpPort',
  headers: 
   { 'Content-Type': 'application/json',
     'X-DC-DEVKEY': '{{api_key}}' },
  body: 
   { searchCriteriaList: 
      [ { key: 'serialNumber', operation: 'EQUALS', value: [ '0eb6eab418c873d8f3c031dcdddf18b0' ] },
        { key: 'ip', operation: 'EQUALS', value: [ 'www.itc.com','www.digicert.com','www.cert.com','wmart.com','ph.com' ] },
        { key: 'port', operation: 'EQUALS', value: [ '3389','636','443','80','389','8443' ] },
        { key: 'scanName', operation: 'EQUALS', value: [ 'ScanWithAllVul','GtScdlV612Aug19' ] },
        { key: 'serverSecurity', operation: 'EQUALS', value: [ 'NO_VULNERABILITY_FOUND' ] },
        { key: 'isCertPresent', operation: 'EQUALS', value: [ 'true' ] },
        { key: 'cn', operation: 'EQUALS', value: [ 'www.origin.digicert.com' ] } ],
     accountId: '126993',
     divisionIds: [],
     startIndex: 1,
     pageSize: 50,
     sortedColumnId: null,
     sortOrder: 'ASC' },
  json: true };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

200 OK

{
    "data": {
        "totalCount": 728,
        "currentCount": 50,
        "onlineIPPortDetailsDTOList": [
            {
                "commonName": "www.digicert.com",
                "port": 443,
                "ipAddress": "digicert.com",
                "portStatus": null,
                "isCertPresent": true,
                "serverSecurityRating": "Not secure",
                "service": "https",
                "devicetype": "Unavailable",
                "serverName": "Unavailable",
                "serverVersion": "Unavailable",
                "scanId": null,
                "scanName": "Ray test scan",
                "domainName": "digicert.com",
                "firstDiscoveredDate": 1563917837971,
                "certificateId": "041340bf2a9fb794d30fda13395b314ae67df53d",
                "os": "",
                "osVersion": null,
                "vulnerabilityName": "POODLE (TLS)",
                "serverId": 1634548,
                "san": "www.digicert.com,ak-dfw01-www.digicert.com,ak-dal01-www.digicert.com,www.dig-cert.com,digicert.com",
                "org": "DigiCert, Inc.",
                "certExpiryDate": 1581162880000,
                "certStatus": "VALID",
                "certRating": "Very secure",
                "ca": "DigiCert",
                "serialNumber": "3abd311ca0530854676aab23"
            },
            {
                "commonName": "*.stackexchange.com",
                "port": 443,
                "ipAddress": "stackoverflow.com",
                "portStatus": null,
                "isCertPresent": true,
                "serverSecurityRating": "Secure",
                "service": "https",
                "devicetype": "",
                "serverName": "Unavailable",
                "serverVersion": "Unavailable",
                "scanId": null,
                "scanName": "Morpheus",
                "domainName": "stackoverflow.com",
                "firstDiscoveredDate": 1561409075964,
                "certificateId": "390a4684b989444a6d286705acd429415a9c433d",
                "os": "",
                "osVersion": null,
                "vulnerabilityName": "",
                "serverId": 1407732,
                "san": "*.askubuntu.com,*.blogoverflow.com,*.mathoverflow.net,*.meta.stackexchange.com,*.meta.stackoverflow.com,*.serverfault.com,*.sstatic.net,*.stackexchange.com,*.stackoverflow.com,*.stackoverflow.email,*.superuser.com,askubuntu.com,blogoverflow.com,mathoverflow.net,openid.stackauth.com,serverfault.com,sstatic.net,stackapps.com,stackauth.com,stackexchange.com,stackoverflow.blog,stackoverflow.com,stackoverflow.email,stacksnippets.net,superuser.com",
                "org": "",
                "certExpiryDate": 1566927383000,
                "certStatus": "EXPIRED",
                "certRating": "Secure",
                "ca": "Let's Encrypt",
                "serialNumber": "039980940a562af6fb09e8a984d2a14c6ec9"
            }
        ]
    }
}

Request parameters

NameReq/OptTypeDescription
searchCriteriaListoptionalarrayGet records for specified criteria.
.. keyoptionalstringSearch parameter.
Allowed values: serialNumber, ip, port, scanName, serverSecurity, isCertPresent, cn
.. operationoptionalstringSearch operation.
Allowed value: EQUALS
.. valueoptionalarraySearch values.
accountIdrequiredstringAccount ID.
divisionIdsoptionalarrayDivision IDs.
startIndexoptionalintegerStart at the specified index.
Default: 1
pageSizeoptionalintegerNumber of records per page.
Default: 50,
Max: 100
sortedColumnIdoptionalstringSort results by specified parameter.
Allowed values: serialNumber, ip, port, scanName, serverSecurity, isCertPresent, cn
Default: isCertPresent
sortOrderoptionalstringSort direction.
Allowed values: DESC (descending: 9-0, Z-A), ASC (ascending: 0-9, A-Z)
Default: DESC

Response parameters

NameTypeDescription
dataobjectContainer.
.. totalCountintegerTotal number of records that match search criteria.
.. currentCountintegerNumber of records on current page.
.. onlineIPPortDetailsDTOListarrayContainer for endpoint details.
.. .. commonNamestringCommon name of certificate found on the endpoint.
.. .. portstringPort that the certificate was found on.
.. .. ipAddressstringIP address of the endpoint.
.. .. portStatusstringAvailability or connection status of the endpoint.
.. .. isCertPresentboolWhether or not certificate is installed at the endpoint.
.. .. serverSecurityRatingstringServer security rating, based on the endpoint’s communication and security settings.
.. .. servicestringCommunication protocol, such as https.
.. .. deviceTypestringGeneral hardware type, if available.
.. .. serverNamestringServer software, if available.
.. .. serverVersionstringServer version, if available.
.. .. scanIdstringUnique ID for the CertCentral Discovery scan that scanned and retrieved details for the endpoint.
.. .. scanNamestringFriendly name the admin gave to the CertCentral Discovery scan.
.. .. domainNamestringRoot domain of the endpoint.
.. .. firstDiscoveredDateintegerDate endpoint was first found by CertCentral Discovery scan.
**Format:**epoch in millisecond.
Epoch corresponds to 0 hours, 0 minutes, and 0 seconds (00:00:00) Coordinated Universal Time (UTC) on a specific date, which varies from system to system.
Example: 1855828800000
.. .. certificateIdstringUnique DigiCert-generated ID for the certificate found on the endpoint. Use for API requests that require it.
.. .. osstringOperating system.
.. .. osVersionstringOperating system version, if available.
.. .. vulnerabilityNamestringVulnerabilities found based on known endpoint details.
.. .. serverIdstringServer ID that uniquely identifies the record.
.. .. sanstringSubject alternative names on the certificate found on the endpoint.
.. .. orgstringOrganization name on the certificate found on the endpoint.
.. .. certExpiryDateintegerExpiration date of the certificate found on the endpoint.
**Format:**epoch in millisecond.
Epoch corresponds to 0 hours, 0 minutes, and 0 seconds (00:00:00) Coordinated Universal Time (UTC) on a specific date, which varies from system to system.
Example: 1855828800000
.. .. certStatusstringStatus of the certificate found on the endpoint.
.. .. certRatingstringCertificate security rating, based on industry standards and the certificate’s settings.
.. .. castringCertificate Authority that issued the certificate.
.. .. serialNumberstringSerial number assigned to the certificate on issuance.