Skip to main content

Get notification settings

GET https://www.digicert.com/services/v2/vulnerability-assessment/{{order_id}}/notification-settings

Use this endpoint to get the current setting for when you receive notification emails about vulnerability assessments for an order.

Replace {{order_id}} in the URL with the ID of the order. To get the ID values for orders in your account, use the List orders endpoint.

Example requests and responses

Example 1. cURL
curl -X GET \
https://www.digicert.com/services/v2/vulnerability-assessment/{{order_id}}/notification-settings \
-H 'Content-Type: application/json' \
-H 'X-DC-DEVKEY: {{api_key}}'

Example 2. Python
import requests

url = "https://www.digicert.com/services/v2/vulnerability-assessment/{{order_id}}/notification-settings"

payload = {}
headers = {
  'Content-Type': 'application/json',
  'X-DC-DEVKEY': '{{api_key}}'
}

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

print(response.text.encode('utf8'))

Example 3. Go
package main

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

func main() {

  url := "https://www.digicert.com/services/v2/vulnerability-assessment/{{order_id}}/notification-settings"
  method := "GET"

  client := &http.Client {
  }
  req, err := http.NewRequest(method, url, nil)

  if err != nil {
    fmt.Println(err)
  }
  req.Header.Add("Content-Type", "application/json")
  req.Header.Add("X-DC-DEVKEY", "{{api_key}}")

  res, err := client.Do(req)
  defer res.Body.Close()
  body, err := ioutil.ReadAll(res.Body)

  fmt.Println(string(body))
}

Example 4. NodeJS
var request = require('request');
var options = {
  'method': 'GET',
  'url': 'https://www.digicert.com/services/v2/vulnerability-assessment/{{order_id}}/notification-settings',
  'headers': {
    'Content-Type': 'application/json',
    'X-DC-DEVKEY': '{{api_key}}'
  }
};
request(options, function (error, response) { 
  if (error) throw new Error(error);
  console.log(response.body);
});

Response parameters

Name

Type

Description

setting

string

Current setting for when you receive notification emails.

Possible values:

  • disabled: Never receive email notifications.

  • always_notify: Receive notification emails after every completed scan.

  • notify_only_alerts: Only receive email notifications when a scan finds vulnerabilities.

In this section: