Retrieve Certificate
venafi_tpp.retrieve_certificate
ActionBusiness appsconnection required
Calls the Venafi TLS Protect Datacenter API with the connection's credentials.
Download an issued certificate, optionally with its chain and key.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- Custom
- Providers
- Venafi TLS Protect Datacenter
- Secret shape
- {"username": "…", "password": "…"} or {"access_token": "…"}
- Config it needs
- base_url, client_id, scope
- Resolved by
- config.connection_id, else node.connection_id
Configuration
8 fields, 1 required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.
| Field | Type | Required | Default | Constraints | Example |
|---|---|---|---|---|---|
certificate_dn Distinguished Name of the certificate object in the Trust Protection Platform tree. | string | Yes | — | — | \VED\Policy\Certificates\www.acme.com |
format The encoding to download the certificate in. | string | No | Base64 | one of "Base64", "Base64 (PKCS #8)", "DER", "JKS", "PKCS #7", "PKCS #12" | — |
include_chain Include the issuing and root certificates alongside the leaf. | boolean | No | false | — | — |
include_private_key Also return the private key, encrypted with the password below. | boolean | No | false | — | — |
password Password Venafi encrypts the private key with: at least 12 characters drawn from three or more character types. | string | Conditional | — | only with include_private_key; credential material | credential |
friendly_name Label to store the certificate under, which JKS and PKCS #12 keystores need. | string | No | — | — | www.acme.com |
root_first_order Order the returned chain root first instead of end entity first. | boolean | No | false | — | — |
work_to_do_timeout Seconds to wait for the certificate authority before answering. Left at 0 the platform queues the work and answers straight away. | number | No | 0 | 0–120 | — |
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"certificate_dn": "\\VED\\Policy\\Certificates\\www.acme.com",
"format": "Base64",
"friendly_name": "www.acme.com",
"include_chain": false,
"include_private_key": false,
"root_first_order": false,
"work_to_do_timeout": 0
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
CertificateData The certificate, base64 encoded in the chosen format. | string | — |
Filename The filename Venafi suggests for that data. | string | — |
Format The format the data is in, with its MIME type. | string | — |
{
"CertificateData": "",
"Filename": "",
"Format": ""
}Notes
- The private key is left out unless 'include_private_key' is on, and a password is then required — Venafi refuses to hand a key over in the clear.
Related Venafi TLS Protect Datacenter nodes
See Retrieve Certificate run in a workflow.
In a technical demo we add the Venafi TLS Protect Datacenter connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.