Reference · Tools

Venafi TLS Protect Cloud

Manage certificates and certificate requests via the Venafi TLS Protect Cloud API.

Action (binary) Utility v1 Binary data

The Venafi TLS Protect Cloud node manages certificates and certificate requests: creating and renewing requests, listing and deleting certificates, and downloading certificate or keystore files. A typical build is renewing a certificate before expiry and delivering the new keystore to where it is needed.

Node type
Action (binary)
Parameters
31
Outputs
Output, Error
Credentials
Venafi TLS Protect Cloud

Venafi TLS Protect Cloud

Manage and download TLS certificates via Venafi Cloud

Overview

The Venafi TLS Protect Cloud tool manages TLS/SSL certificates through Venafi’s cloud platform. Supports two resources: (1) Certificate — delete, download (PEM/DER certificate or JKS/PKCS12/PEM keystore with encrypted passphrases), get details, get many (with subject filter), and renew. (2) Certificate Request — create (with server-side CSR generation or user-provided CSR), get details, get many. Certificate download produces binary data (PEM files, DER files, or keystore archives). Uses API key authentication via the tppl-api-key header. Supports US and EU regions.

Category: Utility
Tool Name: venafi
Version: 1

Appearance: Icon: lucide-ShieldCheck | Color: #BE1E2D

Node Type

Action (Binary) — handles file/binary data operations

Input / Output

DirectionPort(s)
InputInput
OutputOutput, Error

Credentials

This tool requires Venafi TLS Protect Cloud credentials. See the Credentials Guide for setup instructions.

Resources

ResourceValue
Certificatecertificate
Certificate RequestcertificateRequest

Operations

OperationValueDescription
DeletedeleteDelete a certificate
DownloaddownloadDownload a certificate
GetgetRetrieve a certificate
Get ManygetManyRetrieve many certificates
RenewrenewRenew a certificate
CreatecreateCreate a new certificate request

delete, download and renew exist only on Certificate. Certificate Request offers create, get and getMany.

Parameters

Certificate: Download

ParameterTypeRequiredDefaultDescription
Certificate IDstringYesThe ID of the certificate to download. Supports expressions.
Download ItemoptionsNocertificateWhether to download the certificate itself or a keystore with the private key.
Options: certificate (the certificate file, PEM or DER), keystore (certificate plus private key)
Keystore TypeoptionsNoPEMThe format of the keystore to export. (shown when Download Item is keystore)
Options: JKS (Java KeyStore), PKCS12 (PKCS#12, .p12), PEM (PEM with private key)
Certificate LabelstringYesA label for the certificate within the keystore. (shown when Download Item is keystore)
Private Key PassphrasestringYesPassphrase to protect the private key. Will be encrypted before sending to the API. (shown when Download Item is keystore)
Keystore PassphrasestringYesPassphrase for the JKS keystore. Will be encrypted before sending to the API. (shown when Download Item is keystore and Keystore Type is JKS)
Binary PropertystringYesdataName of the binary property to write the downloaded certificate/keystore to. Names are case-sensitive — see the upstream node’s Binary Data panel for the exact names to use.
Options (options)collectionNo{}Download formatting options.
— Chain OrderoptionsNoROOT_FIRSTThe order of the certificate chain in the download.
Options: EE_FIRST (end-entity certificate first), EE_ONLY (end-entity certificate only), ROOT_FIRST (root certificate first)
— FormatoptionsNoPEMThe format of the downloaded certificate (applies to certificate download, not keystore).
Options: PEM, DER

Certificate: Get

ParameterTypeRequiredDefaultDescription
Certificate IDstringYesThe ID of the certificate. Supports expressions.

Certificate: Delete

ParameterTypeRequiredDefaultDescription
Certificate IDstringYesThe ID of the certificate. Supports expressions.

Certificate: Get Many

ParameterTypeRequiredDefaultDescription
Return AllbooleanNofalseWhether to return all results or only up to a given limit.
LimitnumberNo50Max number of results to return. (shown when Return All is false)
FilterscollectionNo{}Narrows the certificate list.
— SubjectstringNoFilter certificates by subject.

Certificate: Renew

ParameterTypeRequiredDefaultDescription
Application IDstringYesThe ID of the application. Find this in the Venafi Cloud console under Applications. Supports expressions.
Certificate Issuing Template IDstringYesThe ID of the certificate issuing template. Available under the application details in Venafi Cloud.
Existing Certificate IDstringYesThe ID of the existing certificate to renew. Supports expressions.
Certificate Signing RequeststringYesThe PEM-encoded PKCS#10 CSR for the renewal. Supports expressions.
Options (renewOptions)collectionNo{}Renewal options.
— Validity PeriodoptionsNoP1YHow long the renewed certificate should be valid.
Options: P1Y (1 year), P10D (10 days), PT12H (12 hours)

Certificate Request: Create

ParameterTypeRequiredDefaultDescription
Application IDstringYesThe ID of the application. Find this in the Venafi Cloud console under Applications. Supports expressions.
Certificate Issuing Template IDstringYesThe ID of the certificate issuing template. Available under the application details in Venafi Cloud.
Generate CSRbooleanNofalseWhether to have Venafi generate the CSR server-side. If false, you must provide a CSR.
Common NamestringYesThe Common Name (CN) for the certificate subject. Supports expressions. (shown when Generate CSR is true)
Additional FieldscollectionNo{}Subject and key details for the server-generated CSR. (shown when Generate CSR is true)
— Key TypeoptionsNoRSAThe encryption algorithm for the public key.
Options: EC (elliptic curve), RSA
— Key CurveoptionsNoED25519The elliptic curve to use (only relevant for EC key type).
Options: ED25519 (EdDSA), P256, P384, P521, UNKNOWN
— Key LengthnumberNo2048The number of bits for key generation (only relevant for RSA key type).
— OrganizationstringNoThe (O) organization name for the certificate subject.
— Organizational UnitsstringNoComma-separated list of (OU) organizational unit names.
— City / LocalitystringNoThe (L) city or locality for the certificate subject.
— StatestringNoThe (ST) state or province for the certificate subject.
— CountrystringNoThe (C) 2-letter country code for the certificate subject.
— DNS Subject Alt NamesstringNoComma-separated list of DNS Subject Alternative Names (SANs).
Certificate Signing RequeststringNoThe PEM-encoded PKCS#10 CSR. Required when Generate CSR is false. Supports expressions. (shown when Generate CSR is false)
Options (createOptions)collectionNo{}Issuance options.
— Validity PeriodstringNoP1YHow long the issued certificate should be valid. Use ISO 8601 duration format (e.g. P1Y for 1 year, P10D for 10 days, PT12H for 12 hours).

Certificate Request: Get

ParameterTypeRequiredDefaultDescription
Certificate Request IDstringYesThe ID of the certificate request. Supports expressions.

Certificate Request: Get Many

ParameterTypeRequiredDefaultDescription
Return AllbooleanNofalseWhether to return all results or only up to a given limit.
LimitnumberNo50Max number of results to return. (shown when Return All is false)

All Operations

ParameterTypeRequiredDefaultDescription
Max ConcurrencynumberNo10Maximum number of items to process concurrently.

Output Data

The Venafi record is merged onto the top level of the item JSON; anything already on the item passes through, and existing binary data is forwarded.

OperationOutput
Certificate downloadOne item carrying the file itself on the binary property you named, plus certificateId, downloadItem, fileName and fileSize on the JSON. The file name comes from Venafi’s content-disposition header, falling back to certificate.pem / certificate.der or keystore.jks / keystore.p12 / keystore.pem, and the MIME type is detected from that name and the bytes
Certificate getOne item carrying the certificate record
Certificate getManyFans out — one item per certificate
Certificate deleteOne item per deleted certificate record Venafi returns
Certificate renewOne item per certificate request Venafi created for the renewal
Certificate Request createOne item per certificate request Venafi created
Certificate Request getOne item carrying the certificate request record
Certificate Request getManyFans out — one item per certificate request

With Return All on, the node follows Venafi’s Next link until the list is exhausted.

Keystore downloads encrypt both passphrases before they leave the workflow: the node reads the certificate’s data-encryption key hash, fetches the matching public key from Venafi and seals each passphrase against it. A certificate without that key hash cannot be exported as a keystore and fails the item with an explicit message.

Usage Examples

  • Download a TLS certificate as PEM
  • Download a PKCS12 keystore for a certificate
  • Create a certificate request with server-generated CSR
  • Renew an expiring certificate
  • List all certificates with a specific subject

Example Configuration

Download a certificate as PEM, root first:

{
  "type": "venafi",
  "parameters": {
    "resource": "certificate",
    "operation": "download",
    "certificateId": "cert-123456",
    "downloadItem": "certificate",
    "binaryPropertyName": "data",
    "options": {
      "chainOrder": "ROOT_FIRST",
      "format": "PEM"
    }
  }
}

Download a PKCS12 keystore:

{
  "type": "venafi",
  "parameters": {
    "resource": "certificate",
    "operation": "download",
    "certificateId": "cert-123456",
    "downloadItem": "keystore",
    "keystoreType": "PKCS12",
    "certificateLabel": "My Certificate",
    "privateKeyPassphrase": "myPrivateKeyPass",
    "binaryPropertyName": "keystoreData"
  }
}

Download a JKS keystore — JKS also needs the keystore passphrase:

{
  "type": "venafi",
  "parameters": {
    "resource": "certificate",
    "operation": "download",
    "certificateId": "cert-123456",
    "downloadItem": "keystore",
    "keystoreType": "JKS",
    "certificateLabel": "My Certificate",
    "privateKeyPassphrase": "myPrivateKeyPass",
    "keystorePassphrase": "myKeystorePass",
    "binaryPropertyName": "keystoreData"
  }
}

Look up one certificate:

{
  "type": "venafi",
  "parameters": {
    "resource": "certificate",
    "operation": "get",
    "certificateId": "cert-123456"
  }
}

List certificates by subject — one output item per certificate:

{
  "type": "venafi",
  "parameters": {
    "resource": "certificate",
    "operation": "getMany",
    "returnAll": false,
    "limit": 50,
    "filters": {
      "subject": "CN=example.com"
    }
  }
}

Renew a certificate with a CSR from the item:

{
  "type": "venafi",
  "parameters": {
    "resource": "certificate",
    "operation": "renew",
    "applicationId": "app-123456",
    "certificateIssuingTemplateId": "template-789012",
    "existingCertificateId": "cert-123456",
    "certificateSigningRequest": "{{ $json.csr }}",
    "renewOptions": {
      "validityPeriod": "P1Y"
    }
  }
}

Request a new certificate and let Venafi generate the CSR:

{
  "type": "venafi",
  "parameters": {
    "resource": "certificateRequest",
    "operation": "create",
    "applicationId": "app-123456",
    "certificateIssuingTemplateId": "template-789012",
    "generateCsr": true,
    "commonName": "www.example.com",
    "additionalFields": {
      "keyType": "RSA",
      "keyLength": 2048,
      "organization": "Example Corp",
      "organizationalUnits": "IT Department",
      "locality": "San Francisco",
      "state": "California",
      "country": "US",
      "dnsNames": "www.example.com,example.com"
    },
    "createOptions": {
      "validityPeriod": "P1Y"
    }
  }
}

Request a new certificate with your own CSR:

{
  "type": "venafi",
  "parameters": {
    "resource": "certificateRequest",
    "operation": "create",
    "applicationId": "app-123456",
    "certificateIssuingTemplateId": "template-789012",
    "generateCsr": false,
    "certificateSigningRequest": "{{ $json.csr }}",
    "createOptions": {
      "validityPeriod": "P2Y"
    }
  }
}

Check on a request you submitted earlier:

{
  "type": "venafi",
  "parameters": {
    "resource": "certificateRequest",
    "operation": "get",
    "certificateRequestId": "{{ $json.id }}"
  }
}

Error Handling

ModeBehavior
stopHalts workflow on first error
continueSkips failed items, passes successful ones through
errorPortRoutes failed items to Error output port

Tips

Manage Venafi TLS Protect Cloud certificates: download certificate/keystore files, create/renew certificate requests, and list/delete certificates.

Common Patterns

Certificate request workflow — create the request with a server-generated CSR, poll the request with Certificate Request → Get until it is issued, then download the certificate.

Keystore export workflow — set Download Item to keystore, choose the Keystore Type your application needs, supply the passphrases, and write the result to a binary property that a following node (upload, write to file, email attachment) can pick up.

Frequently asked questions

What does a certificate request flow look like?

Create the request with a server-generated CSR, poll it with Certificate Request → Get until it is issued, then download the certificate.

How do I export a keystore?

Set Download Item to `keystore` and choose the format, which returns the keystore as binary rather than the bare certificate.

Why does the request need polling?

Issuance is not instantaneous — the request has to be processed before a certificate exists, so a workflow either polls or splits the request and collection into separate runs.

Which credential does it need?

A Venafi TLS Protect Cloud credential.

Build with the Venafi TLS Protect Cloud node

Drop it into a workflow, wire it to an agent, or call it on a schedule. You'll need Venafi TLS Protect Cloud credentials first.

Open BusyBot

Last updated . Spotted something wrong? Tell us.