Server certificate status: Request

To retrieve the server certificate configuration status, send the following request:

GET https://<IA_IP_address>:<port_number>/config/v1/x509/server

Note
To use this request, your user account must have sudo access.

Required headers:

Cookie: px=<token> X-Username: <user> X-Role: <role>

Options

IA_IP_address—The IP address of the NDR appliance running the NDR API.
port_number—The port number of the NDR appliance running the NDR API.
token—This token authenticates the session. By default, the session times out after 24 hours.
user—The user ID.
role—The user's role.

Example

GET https://xxx.xxx.xxx.xxx:443/config/v1/x509/server

Required headers:

Cookie: px=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx > X-Username: wheel X-Role: wheel

Server certificate status: Response

HTTP/1.1 [Response Code] [Response Message]				
Date: [Date]				
Content-Type: [Content Type]
{
  "state": "state",
  "certificate": {
    "subject": "C=US, ST=Virginia, L=Reston, O=FireEye, OU=Enterprise Forensics, CN=localhost/emailAddress=support@fireeye.com"
    "validity": {
      "notBefore": "Jan 31 15:05:57 2019 GMT",
      "notAfter": "Jan 31 15:05:57 2020 GMT"
    }
  }
}

Response fields

Response code—A standard HTTP response code.
- 200—Request successful; the configuration was successful.
Response message—A standard HTTP response message.
- OK—Request successful; the configuration was successful.
Date—Standard HTML date format.
Content type—The response format.
state—The status of the server certificate configuration. Values can be: none, default, pending, or custom.
subject—The certificate subject.
notBefore—The earliest validity time of the certificate.
notAfter—The latest validity time of the certificate.

Example

HTTP/1.1 200 OK
Date: Thu, 03 Oct 2019 11:39:01 GMT
Content-Type: application/json; charset=utf-8
{
  "state": "none|default|pending|custom",
  "certificate": {
    "subject": "C=US, ST=Virginia, L=Reston, O=FireEye, OU=Enterprise Forensics, CN=localhost/emailAddress=support@fireeye.com"
    "validity": {
      "notBefore": "Jan 31 15:05:57 2019 GMT",
      "notAfter": "Jan 31 15:05:57 2020 GMT"
    }
  }
}

cURL code sample: Server certificate status

curl -k --cookie "px=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" 
-H "X-Username: wheel" -H "X-Role: wheel" 
https://xxx.xxx.xxx.xxx:443/config/v1/x509/server

This cURL sample includes the following options:

-k—This option explicitly allows cURL to perform insecure SSL connections and transfers, which allows you to test your SSL connection without installing a CA certificate.
--cookie "px=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"—This option specifies the authentication token for this session.
-H "X-Username: wheel"—User name.
-H "X-Role: wheel"—User role.
https://xxx.xxx.xxx.xxx:443/config/v1/x509/server—The certificate status request URL. Replace xxx.xxx.xxx.xxx with the IP address of your NDR appliance.

Results

This example retrieves the server certificate status.