List requests

4 minute read

GET https://www.digicert.com/services/v2/request

Use this endpoint to list all requests.

Note

Change the ACCEPT header to text/csv to return a CSV output of the results.

Example requests and responses

curl -X GET \
  https://www.digicert.com/services/v2/request \
  -H 'Content-Type: application/json' \
  -H 'X-DC-DEVKEY: {{api_key}}'

import requests

url = "https://www.digicert.com/services/v2/request"

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

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

print(response.text)

package main

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

func main() {

	url := "https://www.digicert.com/services/v2/request"

	req, _ := http.NewRequest("GET", url, nil)

	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: 'GET',
  url: 'https://www.digicert.com/services/v2/request',
  headers: 
   { 'Content-Type': 'application/json',
     'X-DC-DEVKEY': '{{api_key}}' } };

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

  console.log(body);
});

200 OK

{
  "requests": [
    {
      "id": 198,
      "date": "2018-10-16T20:05:28+00:00",
      "type": "new_request",
      "status": "pending",
      "requester": {
        "id": 14,
        "first_name": "John",
        "last_name": "Smith",
        "email": "john.smith@digicert.com"
      },
      "order": {
        "id": 12345678,
        "certificate": {
          "common_name": "example.com"
        },
        "organization": {
          "id": 112233,
          "name": "Epigyne Unwieldiness llc"
        },
        "container": {
          "id": 5,
          "name": "History Department"
        },
        "product": {
          "name_id": "ssl_plus",
          "name": "Standard SSL",
          "type": "ssl_certificate"
        }
      }
    },
    ...
  ],
  "page": {
    "total": 14,
    "limit": 0,
    "offset": 0
  }
}

Filters and URL query parameters

This endpoint supports filters, sorting, and pagination. For general information and examples of the syntax to use when applying filters and sorting results, see Services API - Filters, sorting, and pagination parameters.

Name	Req/Opt	Type	Description
filters[`{{property_name}}`]	optional	string	Filters results by the specified property. Replace `{{property_name}}` in your request with the property to use for filtering. This endpoint supports filtering by the following properties:
filters[search]	optional	string	Limits response to results where the value of the `order.certificate.common_name` property matches or contains a specific string of characters. To search for values that contain a specific string of characters, prefix the string with a URL encoded (percent-encoded) % character: `%25`. To search for values that are an exact match for a string of characters, omit the `%25` from the request. Examples:
sort	optional	string	Sorts results by the value of one or more properties. By default, sorts results in ascending alphabetical order (0-9, A-Z). To sort in descending alphabetical order (9-0, Z-A), prefix the property name with a minus (`-`). To sort by multiple properties, separate the name of each property with a comma. Sort hierarchy matches the order of properties in this list. This endpoint supports sorting by the following properties:
offset	optional	int	Index of the first result to include in the response. Default:0
limit	optional	int	Total number of results to include in the response. Max: 1000 (default)

Response parameters

Name	Type	Description
requests	array	List of requests.
.. id	int	Request ID.
.. date	string	Timestamp of when the request was submitted. Format: UTC timezone and ISO 8601 date
.. type	string	Request type. Possible values: new_request, revoke, duplicate, reissue, renew
.. status	string	Status of the request. Possible values: submitted, pending, approved, rejected
.. requester	object	Details about the user that submitted the request. See Structures – User details object.
.. order	object	Details about the order associated with the request.
.. .. id	int	Order ID.
.. .. certificate	object	Certificate details.
.. .. .. common_name	string	Name secured by the certificate.
.. .. organization	object	Details about the organization associated with the order.
.. .. .. id	int	Organization ID.
.. .. .. name	string	Legal name of the organization.
.. .. container	object	Details about the container associated with the order.
.. .. .. id	int	Container ID.
.. .. .. name	string	Name of the container.
.. .. product	object	Details about the ordered product.
.. .. .. name_id	string	Name ID of the product. See Glossary – Product identifiers.
.. .. .. name	string	Display name of the product. See Glossary – Product identifiers.
.. .. .. type	string	Product type. See Glossary – Product types.
page	object	Details about results. Modified using URL query strings.