Get Certificates

List certificates for a zone.

GET/organizations/{organizationId}/zones/{zoneId}/certificates

Use it in a workflow

Add a step and choose the Salesforce Commerce Cloud connector.
Pick the Get Certificates action (under Zones (Data API)).
Fill in the fields below, then reference the result from later steps as {{getCertificates.response.data}}.

Request

Path parameters

zoneIdstringrequired

organizationIdstringrequired

An identifier for the organization the request is being made by

Query parameters

limitinteger (int32)

Maximum records to retrieve per request, not to exceed 50. Defaults to 25.

Default 25

offsetinteger (int32)

Used to retrieve the results based on a particular resource offset.

Default 0

Response

Returns 200 with an object. Read it in later steps with {{getCertificates.response.data.<field>}}.

dataarray<object>

certificateIdstringrequired

Id generated by CDN provider for the certificate.

hostsarray<string>

List of hosts the certificate applies to.

expiresOnstring (date-time)

Date of expiration for the certificate.

uploadedOnstring (date-time)

Date the certificate was uploaded.

issuerstring

The certificate authority that issued the certificate.

signaturestring

The type of hash used for the certificate.

statusstringrequired

Current status of the certificate.

One ofACTIVEEXPIREDDELETEDPENDINGINITIALIZINGPENDING_VALIDATIONPENDING_ISSUANCEPENDING_DEPLOYMENTPENDING_DELETIONVALIDATION_TIMED_OUTDEPLOYMENT_TIMED_OUTDELETION_TIMED_OUTINITIALIZING_TIMED_OUTPENDING_EXPIRATIONISSUANCE_TIMED_OUT

minTlsVersionstring

Minimum TLS Version only allows HTTPS connections from visitors that support the selected TLS protocol version or newer.

certificateTypestringrequired

Indicates certificate is custom cert uploaded by customer or automatic renewal certificate by eCDN.

One ofcustomautomaticcustom_legacy

certificateAuthoritystring

Indicates certificate issuer for automatic renewal certificate by eCDN.

One ofgooglelets_encryptdigicert

certificateValidationstring

Indicates certificate validation type for automatic renewal certificate by eCDN.

One ofhttptxt

certificateVerificationTXTNamestring

eCDN automatic renewal certificate verification txt name.

certificateVerificationTXTValuestring

eCDN automatic renewal certificate verification txt value.

certificateVerificationStatusstring

Current status of certificate verification.

One ofACTIVEEXPIREDPENDINGINITIALIZINGPENDING_VALIDATIONPENDING_ISSUANCEPENDING_DEPLOYMENT

wildcardHostnameboolean

Set to true for a wildcard custom hostname.

wildcardCertificateVerificationTXTNamestring

eCDN automatic renewal certificate verification txt name.

wildcardCertificateVerificationTXTValuestring

eCDN automatic renewal certificate verification txt value.

wildcardCertificateVerificationStatusstring

Current status of certificate verification.

One ofACTIVEEXPIREDPENDINGINITIALIZINGPENDING_VALIDATIONPENDING_ISSUANCEPENDING_DEPLOYMENT

customHostnameVerificationTXTNamestring

Custom Hostname verification txt name.

customHostnameVerificationTXTValuestring

Custom Hostname verification txt value.

customHostnameIdstring

Custom hostname associated with the zone

customHostnamestring

Custom hostname associated with the zone

customHostnameStatusstring

Current status of custom hostname validation.

One ofACTIVEEXPIREDDELETEDPENDINGINITIALIZINGPENDING_VALIDATIONPENDING_ISSUANCEPENDING_DEPLOYMENTPENDING_DELETIONMOVED

dcvDelegationRecordsarray<object>2 fields

eCDN automatic renewal certificate DCV delegation records

json

{
  "data": [
    {
      "certificateId": "f90712123fb02287348dd34c0a282bb9",
      "hosts": [
        "example.com",
        "www.example.com"
      ],
      "expiresOn": "2025-12-31T23:59:59Z",
      "uploadedOn": "2024-01-01T00:00:00Z",
      "issuer": "Let's Encrypt Authority X3",
      "signature": "SHA256",
      "status": "ACTIVE",
      "minTlsVersion": "1.2",
      "certificateType": "custom",
      "certificateAuthority": "lets_encrypt",
      "certificateValidation": "http",
      "certificateVerificationTXTName": "_acme-challenge.example.com",
      "certificateVerificationTXTValue": "abc123def456ghi789",
      "certificateVerificationStatus": "ACTIVE",
      "wildcardHostname": false,
      "wildcardCertificateVerificationTXTName": "_acme-challenge.wildcard.example.com",
      "wildcardCertificateVerificationTXTValue": "wildcard_abc123def456",
      "wildcardCertificateVerificationStatus": "ACTIVE",
      "customHostnameVerificationTXTName": "_acme-challenge.custom.example.com",
      "customHostnameVerificationTXTValue": "custom_abc123def456",
      "customHostnameId": "f90712123fb02287348dd34c0a282bb9",
      "customHostname": "custom.example.com",
      "customHostnameStatus": "ACTIVE",
      "dcvDelegationRecords": []
    }
  ]
}

Need more? See the Salesforce Commerce Cloud guide for connection setup and behaviour shared by every action.

Was this page helpful?