Retrieve API key

2 minute read

GET https://www.digicert.com/partner-subscription/api/v1/api-key//{{apiKeyId}}

Use this endpoint to retrieve the details of a specific API key using its unique ID.

Parent accounts can retrieve their own API keys and API keys that belong to their subaccounts. Subaccounts can retrieve only their own API keys. If the API key belongs to an unrelated account, the endpoint returns 403 Forbidden error message.

Example requests and responses

curl -X GET \
  https://www.digicert.com/partner-subscription/api/v1/api-key/12345 \
  -H 'X-PARTNER-APIKEY: {{partner_api_key}}'

import requests

url = "https://www.digicert.com/partner-subscription/api/v1/api-key/12345"

headers = {
    'X-PARTNER-APIKEY': "{{partner_api_key}}"
    }

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/partner-subscription/api/v1/api-key/12345"

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

	req.Header.Add("X-PARTNER-APIKEY", "{{partner_api_key}}")

	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/partner-subscription/api/v1/api-key/12345',
  headers: {
    'X-PARTNER-APIKEY': '{{partner_api_key}}'
  }
};

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

  console.log(body);
});

200 OK

{
  "id": 12345,
  "name": "Production API Key",
  "account_id": 67890,
  "status": "active",
  "created_at": "2025-01-15T10:30:00Z",
  "last_used_date": "2025-01-28T14:22:00Z",
  "api_key_last4": "xyz9"
}

URL path and query parameters

Name	Req/Opt	Type	Description
apiKeyId	required	integer	The unique identifier of the API key.

Request parameters

This endpoint does not use request body parameters.

Response parameters

Name	Type	Description
id	integer	Unique identifier of the API key.
name	string	Descriptive name of the API key.
account_id	integer	Identifier of the account that owns the API key.
status	string	Operational status of the API key. Allowed values: `active`, `inactive`
created_at	string	API key creation date in ISO 8601 format.
last_used_date	string	Date and time the API key was last used.
api_key_last4	string	Last four characters of the API key.