Skip to main content

List certificate filter values

POST https://daas.digicert.com/apicontroller/v1/certificate/filter

Get all known values for certificate attributes found through CertCentral Discovery scans. For example, get all common names found through Discovery scans or get the certificate statuses currently applicable in your environment.

Known values allow you to populate valid information for end users to choose, instead of users needing to know exact or valid values beforehand.

Example requests and responses

Example 1. cURL
curl -X POST \
  https://daas.digicert.com/apicontroller/v1/certificate/filter \
  -H 'Content-Type: application/json' \
  -H 'X-DC-DEVKEY: {{api_key}}' \
  -d '{
    "searchCriteriaList": [
        {
            "key":"cn",
            "operation": "STARTS_WITH",
            "value": [
                "www","digi"
            ]
        }
     ],
    "accountId": "126993",
    "divisionIds": [],
    "startIndex": 1,
    "pageSize": 50,
    "filterSelected": "cn",
    "sortedColumnId": "cn",
    "sortOrder": "ASC"
}'

Example 2. Python
import requests

url = "https://daas.digicert.com/apicontroller/v1/certificate/filter"

payload = "{\n    \"searchCriteriaList\": [\n        {\n            \"key\": \"cn\",\n            \"operation\": \"STARTS_WITH\",\n            \"value\": [\n                \"www\",\"digi\"\n            ]\n        }\n    ],\n    \"accountId\": \"126993\",\n    \"divisionIds\": [],\n    \"startIndex\": 1,\n    \"pageSize\": 50,\n    \"filterSelected\": \"cn\",\n    \"sortedColumnId\": \"cn\",\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)

Example 3. Go
package main

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

func main() {

	url := "https://daas.digicert.com/apicontroller/v1/certificate/filter"

	payload := strings.NewReader("{\n    \"searchCriteriaList\": [\n        {\n            \"key\": \"cn\",\n            \"operation\": \"STARTS_WITH\",\n            \"value\": [\n                \"www\",\"digi\"\n            ]\n        }\n    ],\n    \"accountId\": \"126993\",\n    \"divisionIds\": [],\n    \"startIndex\": 1,\n    \"pageSize\": 50,\n    \"filterSelected\": \"cn\",\n    \"sortedColumnId\": \"cn\",\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))

}

Example 4. NodeJS
var request = require("request");

var options = { method: 'POST',
  url: 'https://daas.digicert.com/apicontroller/v1/certificate/filter',
  headers: 
   { 'Content-Type': 'application/json',
     'X-DC-DEVKEY': '{{api_key}}' },
  body: 
   { searchCriteriaList: 
      [ { key: 'cn', operation: 'STARTS_WITH', value: [ 'www','digi' ] } ],
     accountId: '126993',
     divisionIds: [],
     startIndex: 1,
     pageSize: 50,
     filterSelected: 'cn',
     sortedColumnId: 'cn',
     sortOrder: 'ASC' },
  json: true };

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

  console.log(body);
});

Request parameters

Name

Req/Opt

Type

Description

searchCriteriaList

optional

array

Filter results by specified values.

.. key

optional

string

Filter parameter.

Allowed values: cn, org, status, serialNum, securityRating, ca

.. operation

optional

string

Filter operation.

Allowed value: STARTS_WITH

.. value

optional

array

Filter values.

accountId

required

string

Account ID.

divisionIds

optional

array

Division IDs.

startIndex

optional

int

Start at the specified index.

Default: 1

pageSize

optional

int

Number of records per page.

Default: 50,

Max: 100

filterSelected

required

string

Data type you want to retrieve.

Allowed values: cn, org, status, serialNumber, securityRating, ca

sortOrder

optional

string

Sort direction.

Allowed values: ASC (ascending: 0-9, A-Z), DESC (descending: 9-0, Z-A)

Default: ASC

Response parameters

Name

Type

Description

data

object

Container.

.. filterName

string

Specified filter ID.

.. displayName

string

Friendly filter name.

.. values

array

Matching results.

In this section: