GET Certificates/Retrieve
Returns the available certificate data and optional private key information for an enrolled certificate. The requested certificate returns, with the appropriate mime-type and content‑disposition to allow HTTP clients to properly save the file.
This API method matches POST Certificates/Retrieve, except that all arguments are passed as part of the URL.
Requirements
- Permissions: The caller must have Read permission and Private Key Read permission to the Certificate object.
- Token scope: Certificate:Manage
Headers
-
Content type: Content-Type:application/json.
- Token: The bearer access token that you received. For example, Authorization:Bearer 4MyGeneratedBearerTknz==. For more information, see Passing a bearer token in your API calls.
Parameters
Name |
Description |
---|---|
CertificateDN |
The Trust Protection Platform Distinguished Name (DN) of the certificate. |
Format |
The certificate format for the return data. Specify one of the following case sensitive values and use the exact spacing:
|
FriendlyName |
(Optional) The label or alias to use for Base64, JKS, or PKCS #12 formats. Required for the JKS format. |
IncludeChain |
(Optional) When the Format is Base64, Base64, PKCS #7, PKCS #12, or JKS, you can include the parent or root chain in the return data.
|
IncludePrivateKey |
(Optional) When the Format is Base64 (PKCS #8), PKCS #12, or JKS, you can specify whether to return the private key:
|
KeystorePassword |
If the Format is JKS, you must set this value. Use the same requirements as required for Password. |
Password |
If the IncludePrivateKey value is true, this value must be set. Create a strong password by using a
|
RootFirstOrder (Optional) |
In the REST response, the order of the certificate chain of trust. Use when IncludeChain is true
|
WorkToDoTimeout |
(Optional) The maximum wait time for certificate retrieval. Overrides the Platforms tree setting for the Certificate API ToDo Timeout setting. The maximum number of seconds to wait for the ToDo operation to complete. The default is zero seconds with a maximum value of 120 seconds. For example:WorkToDoTimeout: 60. For more information, see Certificates API configuration. |
Returns
Name |
Description |
---|---|
HTTP 200 |
For valid requests, GET Certificates/Retrieve returns a HTTP 200 message and certificates based on the Format in the request. If the certificate is currently in enrollment, provisioning, or in error, the response contains only the current Status and processing Stage of the Certificate object. |
HTTP 202 |
When the certificate is not ready, this API call returns:
|
HTTP 400 |
For invalid requests, the method fails to return the certificate data and optional private key information. Certificates/Retrieve returns a HTTP 400 BadRequest and Error for missing parameters or one of the following errors:
|
Example: Get an existing certificate and list the Root certificate first
Request
GET https://tpp.venafi.example/vedsdk/Certificates/Retrieve? CertificateDN=\VED\Policy\retrieve-me.venafi.example& Format=Base64&IncludeChain=true&RootFirstOrder=true Authorization:Bearer 4MyGeneratedBearerTknz==
Response
HTTP/1.1 200 OK Content-Disposition: attachment; filename="retrieve-me.venafi.example.pem" Content-Length: 5966 Content-Type: application/x-pem-file -----BEGIN CERTIFICATE----- MIIE9aFFA8kgAwIBHgIHAKvN8x ... -----END CERTIFICATE-----subject=CN=Venafi Example Root CA, OU=Demonstration Purposes, O="Venafi, Inc.", L=Salt Lake City, S=Utah, C=US issuer=CN=Venafi Example Root CA, OU=Demonstration Purposes, O="Venafi, Inc.", L=Salt Lake City, S=Utah, C=US -----BEGIN CERTIFICATE----- MIIEmDCCA4CgAwIBAgIJALgpHD ... -----END CERTIFICATE----- subject=CN=Venafi Example Issuing CA, OU=Demonstration Services, O="Venafi, Inc.", L=Salt Lake City, S=Utah, C=US issuer=CN=Venafi Example Root CA, OU=Demonstration Purposes, O="Venafi, Inc.", L=Salt Lake City, S=Utah, C=US -----BEGIN CERTIFICATE----- MIIE4zCCA8ugAwIBAgIHAKvN7w ... -----END CERTIFICATE----- subject=CN=retrieve-me.venafi.example, OU=Quality Assurance, O="Venafi, Inc.", L=Salt Lake City, S=Utah, C=US issuer=CN=Venafi Example Issuing CA, OU=Demonstration Services, O="Venafi, Inc.", L=Salt Lake City, S=Utah, C=US -----BEGIN CERTIFICATE----- MIIE+zCCA+OgAwIBAgIKYX5M+QA ... -----END CERTIFICATE-----