ote-godaddy.com – certificates

Tools (27)

Extracted live via the executor SDK.

• v1.certificateActionRetrieve

  This method is used to retrieve all stateful actions relating to a certificate lifecycle.

• v1.certificateAlternateEmailAddress

  This method adds an alternate email address to a certificate order and re-sends all existing request emails to that address.

• v1.certificateCallbackDelete

  Unregister the callback for a particular certificate.

• v1.certificateCallbackGet

  This method is used to retrieve the registered callback url for a certificate.

• v1.certificateCallbackReplace

  This method is used to register/replace url for callbacks for stateful actions relating to a certificate lifecycle. The callback url is a Webhook style pattern and will receive POST http requests with json body defined in the CertificateAction model definition for each certificate action. Only one callback URL is allowed to be registered for each certificateId, so it will replace a previous registration.

• v1.certificateCancel

  Use the cancel call to cancel a pending certificate order.

• v1.certificateCreate

  Creating a certificate order can be a long running asynchronous operation in the PKI workflow. The PKI API supports 2 options for getting the completion stateful actions for this asynchronous operations: 1) by polling operations -- see /v1/certificates/{certificateId}/actions 2) via WebHook style callback -- see '/v1/certificates/{certificateId}/callback'.

• v1.certificateDownload

  Download certificate

• v1.certificateDownloadEntitlement

  Download certificate by entitlement

• v1.certificateEmailHistory

  This method can be used to retrieve all emails sent for a certificate.

• v1.certificateGet

  Once the certificate order has been created, this method can be used to check the status of the certificate. This method can also be used to retrieve details of the certificate.

• v1.certificateGetEntitlement

  Once the certificate order has been created, this method can be used to check the status of the certificate. This method can also be used to retrieve details of the certificates associated to an entitlement.

• v1.certificateReissue

  Rekeying is the process by which the private and public key is changed for a certificate. It is a simplified reissue,where only the CSR is changed. Reissuing is the process by which domain names are added or removed from a certificate.Once a request is validated and approved, the certificate will be reissued with the new common name and sans specified. Unlimited reissues are available during the lifetime of the certificate.New names added to a certificate that do not share the base domain of the common name may take additional time to validate. If this API call is made before a previous pending reissue has been validated and issued, the previous reissue request is automatically rejected and replaced with the current request.

• v1.certificateRenew

  Renewal is the process by which the validity of a certificate is extended. Renewal is only available 60 days prior to expiration of the previous certificate and 30 days after the expiration of the previous certificate. The renewal supports modifying a set of the original certificate order information. Once a request is validated and approved, the certificate will be issued with extended validity. Since subject alternative names can be removed during a renewal, we require that you provide the subject alternative names you expect in the renewed certificate. New names added to a certificate that do not share the base domain of the common name may take additional time to validate.

• v1.certificateResendEmail

  This method can be used to resend emails by providing the certificate id and the email id

• v1.certificateResendEmailAddress

  This method can be used to resend emails by providing the certificate id, the email id, and the recipient email address

• v1.certificateRevoke

  Use revoke call to revoke an active certificate, if the certificate has not been issued a 404 response will be returned.

• v1.certificateSitesealGet

  This method is used to obtain the site seal information for an issued certificate. A site seal is a graphic that the certificate purchaser can embed on their web site to show their visitors information about their SSL certificate. If a web site visitor clicks on the site seal image, a pop-up page is displayed that contains detailed information about the SSL certificate. The site seal token is used to link the site seal graphic image to the appropriate certificate details pop-up page display when a user clicks on the site seal. The site seal images are expected to be static images and hosted on the reseller's website, to minimize delays for customer page load times.

• v1.certificateValidate

  Validate a pending order for certificate

• v1.certificateVerifydomaincontrol

  Domain control is a means for verifying the domain included in the certificate order. This resource is useful for resellers that control the domains for their customers, and can expedite the verification process. See https://www.godaddy.com/help/verifying-your-domain-ownership-for-ssl-certificate-requests-html-or-dns-7452

• v2.getAcmeExternalAccountBinding

  Use this endpoint to retrieve a key identifier and Hash-based Message Authentication Code (HMAC) key for Automated Certificate Management Environment (ACME) External Account Binding (EAB). These credentials can be used with an ACME client that supports EAB (ex. CertBot) to automate the issuance request and deployment of DV SSL certificates

• v2.getCertificateDetailByCertIdentifier

  Once the certificate order has been created, this method can be used to check the status of the certificate. This method can also be used to retrieve details of the certificate.

  • shopperId is not the same as customerId. shopperId is a number of max length 10 digits (ex: 1234567890) whereas customerId is a UUIDv4 (ex: 295e3bc3-b3b9-4d95-aae5-ede41a994d13)

• v2.getCustomerCertificatesByCustomerId

  This method can be used to retrieve a list of certificates for a specified customer.

  • shopperId is not the same as customerId. shopperId is a number of max length 10 digits (ex: 1234567890) whereas customerId is a UUIDv4 (ex: 295e3bc3-b3b9-4d95-aae5-ede41a994d13)

• v2.getDomainDetailsByDomain

  Retrieve detailed information for supplied domain, including domain verification details and Certificate Authority Authorization (CAA) verification details.

  • shopperId is not the same as customerId. shopperId is a number of max length 10 digits (ex: 1234567890) whereas customerId is a UUIDv4 (ex: 295e3bc3-b3b9-4d95-aae5-ede41a994d13)

• v2.getDomainInformationByCertificateId

  This method can be used to retrieve the domain verification status for a certificate request.

  • shopperId is not the same as customerId. shopperId is a number of max length 10 digits (ex: 1234567890) whereas customerId is a UUIDv4 (ex: 295e3bc3-b3b9-4d95-aae5-ede41a994d13)

  "

• openapi.previewSpec

  Preview an OpenAPI document before adding it as a source

• openapi.addSource

  Add an OpenAPI source and register its operations as tools