Product list

  6 minute read  

GET https://www.digicert.com/services/v2/product
Use this endpoint to list products available to your account.

Example requests and responses

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

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

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/product"

	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/product',
  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

{
  "products": [
    {
      "group_name": "code_signing_certificate",
      "name_id": "code_signing",
      "name": "Code Signing",
      "type": "code_signing_certificate",
      "allowed_container_ids": [
        123456
      ],
      "allowed_validity_years": [
        1,
        2,
        3
      ],
      "allowed_order_validity_years": [
        1,
        2,
        3
      ],
      "signature_hash_types": {
        "allowed_hash_types": [
          {
            "id": "sha256",
            "name": "SHA-256"
          }
        ],
        "default_hash_type_id": "sha256"
      },
      "csr_required": false
    },
    {
      "group_name": "code_signing_certificate",
      "name_id": "code_signing_ev",
      "name": "EV Code Signing",
      "type": "code_signing_certificate",
      "allowed_container_ids": [
        123456
      ],
      "allowed_validity_years": [
        1,
        2,
        3
      ],
      "allowed_order_validity_years": [
        1,
        2,
        3
      ],
      "signature_hash_types": {
        "allowed_hash_types": [
          {
            "id": "sha256",
            "name": "SHA-256"
          }
        ],
        "default_hash_type_id": "sha256"
      },
      "csr_required": false
    },
    {
      "group_name": "document_signing",
      "name_id": "document_signing_org_1",
      "name": "Document Signing - Organization (2000)",
      "type": "document_signing",
      "allowed_container_ids": [
        123456
      ],
      "allowed_validity_years": [
        1,
        2,
        3
      ],
      "allowed_order_validity_years": [
        1,
        2,
        3
      ],
      "signature_hash_types": {
        "allowed_hash_types": [
          {
            "id": "sha256",
            "name": "SHA-256"
          },
          {
            "id": "sha384",
            "name": "SHA-384"
          },
          {
            "id": "sha512",
            "name": "SHA-512"
          }
        ],
        "default_hash_type_id": "sha256"
      },
      "csr_required": false
    },
    {
      "group_name": "document_signing",
      "name_id": "document_signing_org_2",
      "name": "Document Signing - Organization (5000)",
      "type": "document_signing",
      "allowed_container_ids": [
        123456
      ],
      "allowed_validity_years": [
        1,
        2,
        3
      ],
      "allowed_order_validity_years": [
        1,
        2,
        3
      ],
      "signature_hash_types": {
        "allowed_hash_types": [
          {
            "id": "sha256",
            "name": "SHA-256"
          },
          {
            "id": "sha384",
            "name": "SHA-384"
          },
          {
            "id": "sha512",
            "name": "SHA-512"
          }
        ],
        "default_hash_type_id": "sha256"
      },
      "csr_required": false
    },
    {
      "group_name": "document_signing",
      "name_id": "document_signing_individual_1",
      "name": "Document Signing - Individual (500)",
      "type": "document_signing",
      "allowed_container_ids": [
        123456
      ],
      "allowed_validity_years": [
        1,
        2,
        3
      ],
      "allowed_order_validity_years": [
        1,
        2,
        3
      ],
      "signature_hash_types": {
        "allowed_hash_types": [
          {
            "id": "sha256",
            "name": "SHA-256"
          },
          {
            "id": "sha384",
            "name": "SHA-384"
          },
          {
            "id": "sha512",
            "name": "SHA-512"
          }
        ],
        "default_hash_type_id": "sha256"
      },
      "csr_required": false
    },
    {
      "group_name": "document_signing",
      "name_id": "document_signing_individual_2",
      "name": "Document Signing - Individual (2000)",
      "type": "document_signing",
      "allowed_container_ids": [
        123456
      ],
      "allowed_validity_years": [
        1,
        2,
        3
      ],
      "allowed_order_validity_years": [
        1,
        2,
        3
      ],
      "signature_hash_types": {
        "allowed_hash_types": [
          {
            "id": "sha256",
            "name": "SHA-256"
          },
          {
            "id": "sha384",
            "name": "SHA-384"
          },
          {
            "id": "sha512",
            "name": "SHA-512"
          }
        ],
        "default_hash_type_id": "sha256"
      },
      "csr_required": false
    },
    {
      "group_name": "ssl_certificate",
      "name_id": "ssl_basic",
      "name": "Basic OV",
      "type": "ssl_certificate",
      "allowed_container_ids": [
        123456
      ],
      "allowed_validity_years": [
        1
      ],
      "allowed_order_validity_years": [
        1,
        2,
        3
      ],
      "signature_hash_types": {
        "allowed_hash_types": [
          {
            "id": "sha256",
            "name": "SHA-256"
          },
          {
            "id": "sha384",
            "name": "SHA-384"
          },
          {
            "id": "sha512",
            "name": "SHA-512"
          }
        ],
        "default_hash_type_id": "sha256"
      },
      "csr_required": true
    },
    {
      "group_name": "ssl_certificate",
      "name_id": "ssl_ev_basic",
      "name": "Basic EV",
      "type": "ssl_certificate",
      "allowed_container_ids": [
        123456
      ],
      "allowed_validity_years": [
        1
      ],
      "allowed_order_validity_years": [
        1,
        2,
        3
      ],
      "signature_hash_types": {
        "allowed_hash_types": [
          {
            "id": "sha256",
            "name": "SHA-256"
          },
          {
            "id": "sha384",
            "name": "SHA-384"
          },
          {
            "id": "sha512",
            "name": "SHA-512"
          }
        ],
        "default_hash_type_id": "sha256"
      },
      "csr_required": true
    },
    {
      "group_name": "securesite_ssl_certificate",
      "name_id": "ssl_ev_securesite_flex",
      "name": "Secure Site EV",
      "type": "ssl_certificate",
      "allowed_container_ids": [
        123456
      ],
      "allowed_validity_years": [
        1
      ],
      "allowed_order_validity_years": [
        1,
        2,
        3
      ],
      "signature_hash_types": {
        "allowed_hash_types": [
          {
            "id": "sha256",
            "name": "SHA-256"
          },
          {
            "id": "sha384",
            "name": "SHA-384"
          },
          {
            "id": "sha512",
            "name": "SHA-512"
          }
        ],
        "default_hash_type_id": "sha256"
      },
      "csr_required": true
    },
    {
      "group_name": "securesite_ssl_certificate",
      "name_id": "ssl_ev_securesite_pro",
      "name": "Secure Site Pro EV SSL",
      "type": "ssl_certificate",
      "allowed_container_ids": [
        123456
      ],
      "allowed_validity_years": [
        1
      ],
      "allowed_order_validity_years": [
        1,
        2,
        3
      ],
      "signature_hash_types": {
        "allowed_hash_types": [
          {
            "id": "sha256",
            "name": "SHA-256"
          },
          {
            "id": "sha384",
            "name": "SHA-384"
          },
          {
            "id": "sha512",
            "name": "SHA-512"
          }
        ],
        "default_hash_type_id": "sha256"
      },
      "csr_required": true
    },
    {
      "group_name": "securesite_ssl_certificate",
      "name_id": "ssl_securesite_flex",
      "name": "Secure Site OV",
      "type": "ssl_certificate",
      "allowed_container_ids": [
        123456
      ],
      "allowed_validity_years": [
        1
      ],
      "allowed_order_validity_years": [
        1,
        2,
        3
      ],
      "signature_hash_types": {
        "allowed_hash_types": [
          {
            "id": "sha256",
            "name": "SHA-256"
          },
          {
            "id": "sha384",
            "name": "SHA-384"
          },
          {
            "id": "sha512",
            "name": "SHA-512"
          }
        ],
        "default_hash_type_id": "sha256"
      },
      "csr_required": true
    },
    {
      "group_name": "securesite_ssl_certificate",
      "name_id": "ssl_securesite_pro",
      "name": "Secure Site Pro SSL",
      "type": "ssl_certificate",
      "allowed_container_ids": [
        123456
      ],
      "allowed_validity_years": [
        1
      ],
      "allowed_order_validity_years": [
        1,
        2,
        3
      ],
      "signature_hash_types": {
        "allowed_hash_types": [
          {
            "id": "sha256",
            "name": "SHA-256"
          },
          {
            "id": "sha384",
            "name": "SHA-384"
          },
          {
            "id": "sha512",
            "name": "SHA-512"
          }
        ],
        "default_hash_type_id": "sha256"
      },
      "csr_required": true
    }
  ]
}

Response parameters

NameTypeDescription
productsarrayList of all available products.
.. group_namestringGroup to which the product belongs. See Glossary – Product identifiers.
.. name_idstringProduct identifier. See Glossary – Product identifiers.
.. namestringDisplay name of the product.
.. typestringProduct type. See Glossary – Product types.
.. allowed_container_idsarray of intsList of containers that can request the specified product.
.. allowed_validity_yearsarray of intsList of numbers. Each number is a certificate validity period (in years) the product supports.
.. allowed_order_validity_yearsarray of intsList of numbers. Each number is an order validity period (in years) the product supports.
Account administrators can limit the order validity periods that users with specific container and role assignments can request for each product. The Product list endpoint does not return details about these custom limits. For information about custom limits for products in your account, use the Product limits endpoint.
.. signature_hash_typesobjectContainer for signature hash info.
.. .. allowed_hash_typesarrayList of allowed hash types for the product.
.. .. .. idstringHash identifier. See Glossary – Hash types.
.. .. .. namestringHash name.
.. .. default_hash_type_idstringDefault hash type used for the product.
.. allowed_ca_certsarrayList of objects. Each object includes the name and ID for an issuing intermediate certificate authority (ICA) certificate that can be used with the product.
Note: We only return this parameter for public DV, OV, and EV products if:
In the Product list response, the list of allowed_ca_certs includes the name and ID for each ICA that may issue end-entity certificates for a given product. This list includes any ICAs disabled for the product at the container or user role level. To only see IDs for ICAs that users may select when ordering a product, see the list of allowed_intermediates in the Product limits](/certcentral-apis/services-api/containers/product-limits.html) response.
[Learn more about ICA certificate chain selection for public TLS certificates.
.. .. idstringID of the ICA certificate.
In certificate order requests, this ID is the value of the ca_cert_id request parameter.
.. .. namestringName of the ICA certificate.
.. csr_requiredboolSpecifies if a CSR is required when requesting the product type.