Endpoint API

Use these API function to retrieve detailed endpoint information of the host.

List Endpoints

POST/certview/v1/getEndpointData

Input ParametersInput Parameters

Parameter

Mandatory/Optional

Data Type

Description

Authorization 

Mandatory

String

Authorization token to authenticate to the Qualys Cloud Platform.

Prepend token with "Bearer" and one space.

For example - Bearer authToken

ip 

Mandatory

String

Host IP for which the endpoint details are required.

port 

Optional

Integer

Used to filter the endpoint details based on port.

In Certview scan, we can scan multiple ports as certificates can be found on multiple ports. Define the port number to filter the endpoint data based on port.

fqdn 

Optional

String

Used to filter the endpoint details based on FQDN.

Note: For filtering based on fqdn, port is required parameter. Also, this field is required if the service or protocol parameter is specified.

service 

Optional

String

Used to filter the endpoint details based on service.

Note: For filtering based on fqdn, port is required parameter. Also, this field is required if the fqdn or protocol parameter is specified.

protocol 

Optional

String

Used to filter the endpoint details based on protocol.

Note: For filtering based on fqdn, port is required parameter. Also, this field is required if the service or protocol parameter is specified.

Sample with all Parameters DefinedSample with all Parameters Defined

API Request

curl -X POST 
"<qualys_base_url>/certview/v1/getEndpointData"
-H "Accept: application/json" 
-H "Content-Type: application/json"
-d "{ \"ip\": \"XX.XX.XX.XX\", \"port\": 443, \"fqdn\": \"\",
\"service\": \"tcp\"}" -H "Authorization: Bearer <JWT Token>"    

Response

[
  {
    "ipAddress": "XXX.XXX.XXX.XXX",
    "port": 443,
    "lastFound": 1600191908000,
    "service": "http",
    "grade": "A",
    "gradeTrustIgnored": "A",
    "hasWarnings": false,
    "isExceptional": false,
    "details": {
      "certChains": [
        {
          "certIds": [
            "61ffdf5ec74189b0f6f256fc42fe8xxxxxxc1862c0f4cb9ecxxxxxbf4b2e0499",
            "403e062a26530xxxxx85baf80a0d4ae422c848c9f78fad01fxxxxxb87fef1a",
            "7431e5f4c3c1ce46xxxxx0b61e05440883ba9a01ed00bxxxxx7806ed3b118cf"
          ],
          "trustPaths": [
            {
              "certIds": [
                "61ffdf5ec74189b0f6f256fcxxxxxx8bb04c1862c0f4cb9ec9d5f9bf4b2e0499",
                "403e062a2653xxxxxx285baf80a0d4ae422c848c9f78fad01fc9xxxxxx7fef1a",
                "7431e5f4c3c1ce4690774fxxxxxx5440883ba9a01ed00ba6xxxxxx6ed3b118cf"
              ],
              "trust": [
                {
                  "rootStore": "Mozilla",
                  "isTrusted": true
                }
              ]
            }
          ],
          "noSni": false
        }
      ],
      "protocols": [
        {
          "id": 771,
          "name": "TLS",
          "version": "1.2"
        }
      ],
      "suites": [
        {
          "protocol": 771,
          "list": [
            {
              "id": 103,
              "name": "DHE-RSA-AES128-SHA256",
              "cipherStrength": 128,
              "kxType": "DH"
            },
            {
              "id": 107,
              "name": "DHE-RSA-AES256-SHA256",
              "cipherStrength": 256,
              "kxType": "DH"
            },
            {
              "id": 158,
              "name": "DHE-RSA-AES128-GCM-SHA256",
              "cipherStrength": 128,
              "kxType": "DH"
            },
            {
              "id": 159,
              "name": "DHE-RSA-AES256-GCM-SHA384",
              "cipherStrength": 256,
              "kxType": "DH"
            },
            {
              "id": 49171,
              "name": "ECDHE-RSA-AES128-SHA",
              "cipherStrength": 128,
              "kxType": "ECDH"
            },
            {
              "id": 49172,
              "name": "ECDHE-RSA-AES256-SHA",
              "cipherStrength": 256,
              "kxType": "ECDH"
            },
            {
              "id": 49191,
              "name": "ECDHE-RSA-AES128-SHA256",
              "cipherStrength": 128,
              "kxType": "ECDH"
            },
            {
              "id": 49192,
              "name": "ECDHE-RSA-AES256-SHA384",
              "cipherStrength": 256,
              "kxType": "ECDH"
            },
            {
              "id": 49199,
              "name": "ECDHE-RSA-AES128-GCM-SHA256",
              "cipherStrength": 128,
              "kxType": "ECDH"
            },
            {
              "id": 49200,
              "name": "ECDHE-RSA-AES256-GCM-SHA384",
              "cipherStrength": 256,
              "kxType": "ECDH"
            }
          ]
        }
      ],
      "vulnBeast": false,
      "renegSupport": 2,
      "compressionMethods": 0,
      "supportsRc4": false,
      "rc4WithModern": false,
      "rc4Only": false,
      "forwardSecrecy": 4,
      "supportsAead": true,
      "protocolIntolerance": 48,
      "heartbleed": false,
      "heartbeat": false,
      "openSslCcs": 1,
      "openSSLLuckyMinus20": 1,
      "ticketbleed": 1,
      "bleichenbacher": 1,
      "poodle": false,
      "poodleTls": 1,
      "fallbackScsv": false,
      "freak": false,
      "hasSct": 1,
      "logjam": false,
      "drownVulnerable": false,
      "zombiePoodle": 1,
      "goldenDoodle": 1,
      "supportsCBC": true,
      "zeroLengthPaddingOracle": 1,
      "sleepingPoodle": 1
    }
  }
]

Note: For more information on End Point details fields, refer to Appendix B - Endpoint Details with Description