sniCertificate

Provision or update a site's TLS certificate

Changed on

Provisions or updates a TLS certificate for the site.

Creating a certificate (site has no certificate):

  • Omit certificate params to initiate Let's Encrypt provisioning
  • Provide certificate, key, and ca_certificates to upload a custom certificate

Updating a certificate (site already has a certificate):

  • REQUIRES certificate, key, and ca_certificates to replace with a new custom certificate
  • Use POST /api/v1/sites/{site_id}/ssl/renew to renew an existing Let's Encrypt certificate
post/sites/{site_id}/ssl

Request

  • Base URL
    https://api.netlify.com/api/v1
  • URL
    https://api.netlify.com/api/v1/sites/{site_id}/ssl
  • Auth
    OAuth 2
    Implicit: https://app.netlify.com/authorize

Path parameters

site_idstring required

Query parameters

certificatestring

PEM-encoded certificate. Required when updating an existing certificate.

keystring

PEM-encoded private key. Required when updating an existing certificate.

ca_certificatesstring

PEM-encoded CA certificate chain. Required when updating an existing certificate.

Response

OK

statestring
domainsstring[]
created_atstring dateTime
updated_atstring dateTime
expires_atstring dateTime

Changes