Skip to main content

List custom fields

GET https://www.digicert.com/services/v2/account/metadata

Use this endpoint to list metadata for custom order fields in your account.

Example requests and responses

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

Example 2. Python
import requests

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

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

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

print(response.text)

Example 3. Go
package main

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

func main() {

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

	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))

}

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

var options = { method: 'GET',
  url: 'https://www.digicert.com/services/v2/account/metadata',
  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);
});

Response parameters

Name

Type

Description

metadata

array

List of returned custom order field objects. Only returned for accounts with custom order fields. If there are no custom order fields, the call returns an empty JSON object.

.. id

int

Custom order field ID.

.. label

string

Name of the custom order field. When you use the CertCenral console to request a certificate, this name appears above the custom field on the certificate order form.

.. is_required

bool

Specifies if the field is required.

.. is_active

bool

Specifies if the field appears on the order form.

.. data_type

string

Input type for the customer order field. If missing, this indicates an input type of anything.See Glossary – Custom order field input types

.. show_in_receipt

bool

If true, DigiCert displays the custom field on order receipts. Otherwise, false (default).

In this section: