Product info

5 minute read

GET https://www.digicert.com/services/v2/product/{{name_id}}

Use this endpoint to get information about a product.

CertCentral account administrators can customize some of the properties for each product at the container (or division) and user role level. For customizable properties, the Product info response returns the current product settings based on the user who submits the request and the container identified in the URL query. If there are no customized product settings for any container or user role in your account, the Product info response returns the same values for every user and container ID.

Note

To see the customized product settings for each container and user role in your account, use the Product limits endpoint.

Example requests and responses

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

import requests

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

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/{{name_id}}"

	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/{{name_id}}',
  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

{
  "group_name": "ssl_certificate",
  "name_id": "ssl_basic",
  "name": "Basic OV",
  "type": "ssl_certificate",
  "validation_type": "OV",
  "duplicates_allowed": true,
  "allowed_validity_years": [
    1
  ],
  "allowed_order_validity_years": [
    1,
    2,
    3
  ],
  "max_multi_year_order_validity_years": 3,
  "signature_hash_types": {
    "allowed_hash_types": [
      {
        "id": "sha256",
        "name": "SHA-256"
      },
      ...
    ],
    "default_hash_type_id": "sha256"
  },
  "additional_dns_names_allowed": true,
  "increased_compatibility_allowed": true,
  "custom_expiration_date_allowed": true,
  "custom_order_expiration_date_allowed": true,
  "csr_required": true,
  "allow_auto_renew": true,
  "allow_auto_reissue": true,
  "allowed_wildcards": true,
  "server_platforms": [
    {
      "id": 2,
      "name": "Apache",
      "install_url": "http://www.digicert.com/ssl-certificate-installation-apache.htm",
      "csr_url": "http://www.digicert.com/csr-creation-apache.htm",
      "best_format": "apache"
    },
    ...
  ],
  "license_agreement": "https://www.digicert.com/master-services-agreement"
}

URL query strings

Name	Req/Opt	Description
container_id	conditional	ID of a container (or division) in your account. Use this parameter to return product information for a specific container. Omit the `container_id` query string if:

Response parameters

Name	Type	Description
group_name	string	Group to which the product belongs. See Glossary – Product group names.
name_id	string	Product identifier. See Glossary – Product identifiers.
name	string	Display name of the product.
type	string	Product type. See Glossary – Product types.
validation_type	string	Validation type for the product. Not returned for all products. Possible values:
duplicates_allowed	boolean	Specifies if the product supports duplicates.
allowed_validity_years	array	List of numbers. Each number is a certificate validity period (in years) you can select when submitting a certificate order request for the product. The values in this list are based on the product settings for the user who submits the request and the container identified in the URL query. To see the full range of certificate validity periods each product supports, use the allowed_validity_years array in the Product list response.
allowed_order_validity_years	array	List of numbers. Each number is an order validity period (in years) you can select when submitting a certificate order request for the product. The values in this list are based on the product settings for the user who submits the request and the container identified in the URL query. To see the full range of order validity periods each product supports, use the allowed_order_validity_years array in the Product list response.
max_multi_year_order_validity_years	integer	Maximum number of years that can be requested on a Multi-year Plan for the product. Only returned for products that support Multi-year Plans.
signature_hash_types	object	Container for signature hash info.
.. allowed_hash_types	array	List of allowed hash types for the product.
.. .. id	string	Hash identifier. See Glossary – Hash types.
.. .. name	string	Hash name.
.. default_hash_type_id	string	Default hash type used for the product.
allowed_ca_certs	array	List of objects. Each object includes the name, ID, and certificate chain information for an issuing intermediate certificate authority (ICA) certificate you can select when ordering the product. Note: We only return this parameter for public DV, OV, and EV products if: CertCentral account administrators can customize the ICAs that users with different role and container assignments can select when placing an order for a given product. In the Product info response, the `allowed_ca_certs` array only returns information about the ICAs you are allowed to select. To get a list of all ICAs that may issue end-entity certificates for a given product, including ICAs that are disabled for certain containers or user roles in your account, see the `allowed_ca_certs` array in the Product list](/certcentral-apis/services-api/orders/order-client-certificate.html) response. [Learn more about ICA certificate chain selection for public TLS certificates
.. id	string	ID of the ICA certificate. In certificate order requests, this ID is the value of the ca_cert_id request parameter.
.. name	string	Name of the ICA certificate.
.. chain_info	string	Details about the ICA certificate chain.
default_intermediate	string	ID of the default issuing ICA for the product. Only returned for products that support ICA selection, and only if an administrator has customized a product setting for a division or user role in the account. Additionally, this parameter is only returned if ICA selection is enabled for the account. Learn more about ICA certificate chain selection for public TLS certificates.
additional_dns_names_allowed	boolean	Specifies if the product allows additional DNS names.
increased_compatibility_allowed	boolean	Specifies if the product allows for increased compatibility options. See DigiCert SSL Compatibility
custom_expiration_date_allowed	boolean	If `true`, you can use a custom expiration date to set the certificate validity period for this type of product. Otherwise, `false`.
custom_order_expiration_date_allowed	boolean	If `true`, you can use a custom expiration date to set the order validity period for this type of product. Otherwise, `false`.
csr_required	boolean	Specifies if a CSR is required when requesting the product type.
allow_auto_renew	boolean	If `true`, automatic certificate renewal requests (auto-renew) can be enabled for the product. Otherwise, `false`.
allow_auto_reissue	boolean	If `true`, automatic certificate reissue requests (auto-reissue) can be enabled for the product. Otherwise, `false`.
server_platforms	array	List of server platforms compatible with the product.
.. id	integer	Server platform ID. See Glossary – Server platforms.
.. name	string	Name of the server platform.
.. install_url	string	Installation instructions URL.
.. csr_url	string	CSR creation instructions URL.
.. best_format	string	Default certificate format returned for server platform. See Glossary – Certificate formats.
license_agreement	string	Very long string that contains the Certificate Services Agreement text.