Skip to main content

Get key info

GET https://www.digicert.com/services/v2/key/{{key_id}}

Use this endpoint to get details about an API key.

Notice

The API key itself will not be returned.

Example requests and responses

Response parameters

Name

Type

Description

id

int

Key ID.

user

object

Details about the user linked to the key.

.. id

int

User ID.

.. first_name

string

First name of user.

.. last_name

string

Last name of user.

status

string

Key status.

Possible values: active, revoked

create_date

string

Key creation timestamp.

Format: UTC timezone and ISO 8601 date

last_used_date

string

Timestamp of the last time the key was used.

Format: UTC timezone and ISO 8601 date

name

string

Name of the key.

is_legacy

bool

Legacy status of the key.

restricted_to_role_id

int

Access role ID that limits API key permissions to a defined set of actions. See Glossary – API key roles.

acme_directory_url

string

Obfuscated ACME directory URL. Only returned for ACME keys.

product_name_id

string

Name ID of the product ordered via ACME. Only returned for ACME keys. See Glossary – Product identifiers.

product_name

string

Friendly name of the product ordered via ACME. Only returned for ACME keys. See Glossary – Product identifiers.

organization_id

string

Organization name associated with certificate orders via ACME. Only returned for ACME keys.

organizatin_name

string

Organization name associated with certificate orders via ACME. Only returned for ACME keys.

validity_days

string

Number of days the certificate will be valid. Only returned for ACME keys.

validity_years

string

Number of years the certificate will be valid. Only returned for ACME keys.