Update Certificate

PATCH/organizations/{organizationId}/zones/{zoneId}/certificates/{certificateId}

Use it in a workflow

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

Request

Path parameters

certificateIdstringrequired

zoneIdstringrequired

organizationIdstringrequired

An identifier for the organization the request is being made by

Request body

Enter the body as JSON in the step's Body field.

hostnamestringrequired

Hostname that certificate needs to be applied to.

bundleMethodstring

Bundle method of the custom certificate chain for verification.

certificateTypestring

Indicates certificate is custom or automatic certificate renewal by eCDN. Optional field, if nothing specified the default value is custom. Valid values are custom or automatic.

certificatestring

Public key of the custom certificate. Required if the certificateType value is custom.

privateKeystring

Private key associated with the custom certificate. Required if the `certificateType` value is custom.

certificateAuthoritystring

Certificate authority only for automatic certificate renewal by eCDN. Required if the `certificateType` value is automatic. Valid values are `google` or `lets_encrypt`.

certificateValidationstring

Certificate validation type is optional only for `certificateType` automatic, default value is `http`. Valid values are `http` or `txt`.

wildcardHostnameboolean

Set to true for a wildcard custom hostname.

json

{
  "hostname": "example.com",
  "bundleMethod": "ubiquitous",
  "certificateType": "custom",
  "certificate": "-----BEGIN CERTIFICATE-----\nMIIDtTCCAp2gAwIBAgIJAMHAwfXZ5PWMA0GCSqGSIb3DQEBCwUAMEUxCzAJBgNV\nBAYTAkFVMRMwEQYDVQQIEwpTb21lLVN0YXRlMSEwHwYDVQQKExhJbnRlcm5ldCBX\naWRnaXRzIFB0eSBMdGQwHhcNMTYwODI0MTY0MzAxWhcNMTYxMTIyMTY0MzAxWjBF\nMQswCQYDVQQGEwJBVTETMBEGA1UECBMKU29tZS1TdGF0ZTEhMB8GA1UEChMYSW50\nZXJuZXQgV2lkZ2l0cyBQdHkgTHRkMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIB\nCgKCAQEAwQHoetcl9+5ikGzV6cMzWtWPJHqXT3wpbEkRU9Yz7lgvddmGdtcGbg/1\nCGZu0jJGkMoppoUo4c3dts3iwqRYmBikUP77wwY2QGmDZw2FvkJCJlKnabIRuGvB\nKwzESIXgKk2016aTP6/dAjEHyo6SeoK8lkIySUvK0fyOVlsiEsCmOpidtnKX/a+5\n0GjB79CJH4ER2lLVZnhePFR/zUOyPxZQQ4naHf7yu/b5jhO0f8fwt+pyFxIXjbEI\ndZliWRkRMtzrHOJIhrmJ2A1J7iOrirbbwillwjjNVUWPf3IJ3M12S9pEewooaeO2\nizNTERcG9HzAacbVRn2Y2SWIyT/18QIDAQABo4GnMIGkMB0GA1UdDgQWBBT/LbE4\n9rWf288N6sJA5BRb6FJIGDB1BgNVHSMEbjBsgBT/LbE49rWf288N6sJA5BRb6FJI\nGKFJpEcwRTELMAkGA1UEBhMCQVUxEzARBgNVBAgTClNvbWUtU3RhdGUxITAfBgNV\nBAoTGEludGVybmV0IFdpZGdpdHMgUHR5IEx0ZIIJAMHAwfXZ5/PWMAwGA1UdEwQF\nMAMBAf8wDQYJKoZIhvcNAQELBQADggEBAHHFwl0tH0quUYZYO0dZYt4R7SJ0pCm2\n2satiyzHl4OnXcHDpekAo7/a09c6Lz6AU83cKy/+x3/djYHXWba7HpEu0dR3ugQP\nMlr4zrhd9xKZ0KZKiYmtJH+ak4OM4L3FbT0owUZPyjLSlhMtJVcoRp5CJsjAMBUG\nSvD8RX+T01wzox/Qb+lnnNnOlaWpqu8eoOenybxKp1a9ULzIVvN/LAcc+14vioFq\n2swRWtmocBAs8QR9n4uvbpiYvS8eYueDCWMM4fvFfBhaDZ3N9IbtySh3SpFdQDhw\nYbjM2rxXiyLGxB4Bol7QTv4zHif7Zt89FReT/NBy4rzaskDJY5L6xmY=\n-----END CERTIFICATE-----",
  "privateKey": "-----BEGIN RSA PRIVATE KEY-----\nMIIEowIBAAKCAQEAwQHoetcl9+5ikGzV6cMzWtWPJHqXT3wpbEkRU9Yz7lgvddmG\ndtcGbg/1CGZu0jJGkMoppoUo4c3dts3iwqRYmBikUP77wwY2QGmDZw2FvkJCJlKn\nabIRuGvBKwzESIXgKk2016aTP6/dAjEHyo6SeoK8lkIySUvK0fyOVlsiEsCmOpid\ntnKX/a+50GjB79CJH4ER2lLVZnhePFR/zUOyPxZQQ4naHf7yu/b5jhO0f8fwt+py\nFxIXjbEIdZliWRkRMtzrHOJIhrmJ2A1J7iOrirbbwillwjjNVUWPf3IJ3M12S9pE\newooaeO2izNTERcG9HzAacbVRn2Y2SWIyT/18QIDAQABAoIBACbhTYXBZYKmYPCb\nHBR1IBlCQA2nLGf0qRuJNJZg5iEzXows/6tc8YymZkQE7nolapWsQ+upk2y5Xdp/\naxiuprIs9JzkYK8Ox0r+dlwCG1kSW+UAbX0bQ/qUqlsTvU6muVuMP8vZYHxJ3wmb\n+ufRBKztPTQ/rYWaYQcgC0RWI20HTFBMxlTAyNxYNWzX7RKFkGVVyB9RsAtmcc8g\n+j4OdosbfNoJPS0HeIfNpAznDfHKdxDk2Yc1tV6RHBrC1ynyLE9+TaflIAdo2MVv\nKLMLq51GqYKtgJFIlBRPQqKoyXdz3fGvXrTkf/WY9QNq0J1Vk5ERePZ54mN8iZB7\n9lwy/AkCgYEA6FXzosxswaJ2wQLeoYc7ceaweX/SwTvxHgXzRyJIIT0eJWgx13Wo\n/WA3Iziimsjf6qE+SI/8laxPp2A86VMaIt3Z3mJN/CqSVGw8LK2AQst+OwdPyDMu\niacE8lj/IFGC8mwNUAb9CzGU3JpU4PxxGFjS/eMtGeRXCWkK4NE+G08CgYEA1Kp9\nN2JrVlqUz+gAX+LPmE9OEMAS9WQSQsfCHGogIFDGGcNf7+uwBM7GAaSJIP01zcoe\nVAgWdzXCv3FLhsaZoJ6RyLOLay5phbu1iaTr4UNYm5WtYTzMzqh8l1+MFFDl9xDB\nvULuCIIrglM5MeS/qnSg1uMoH2oVPj9TVst/ir8CgYEAxrI7Ws9Zc4Bt70N1As+U\nlySjaEVZCMkqvHJ6TCuVZFfQoE0r0whdLdRLU2PsLFP+q7qaeZQqgBaNSKeVcDYR\n9B+nY/jOmQoPewPVsp/vQTCnE/R81spu0mp0YI6cIheT1Z9zAy322svcc43JaWB7\nmEbeqyLOP4Z4qSOcmghZBSECgYACvR9Xs0DGn+wCsW4vze/2ei77MD4OQvepPIFX\ndFZtlBy5ADcgE9z0cuVB6CiL8DbdK5kwY9pGNr8HUCI03iHkW6Zs+0L0YmihfEVe\nPG19PSzK9CaDdhD9KFZSbLyVFmWfxOt50H7YRTTiPMgjyFpfi5j2q348yVT0tEQS\nfhRqaQKBgAcWPokmJ7EbYQGeMbS7HC8eWO/RyamlnSffdCdSc7ue3zdVJxpAkQ8W\nqu80pEIF6raIQfAf8MXiiZ7auFOSnHQTXUbhCpvDLKi0Mwq3G8Pl07l+2s6dQG6T\nlv6XTQaMyf6n1yjzL+fzDrH3qXMxHMO/b13EePXpDMpY7HQpoLDi\n-----END RSA PRIVATE KEY-----",
  "certificateAuthority": "lets_encrypt",
  "certificateValidation": "http",
  "wildcardHostname": false
}

Response

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

dataobject

The certificate information

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?