TLS subscriptions

The TLS subscriptions API allows you to programmatically generate and renew TLS certificates. Once a subscription is created for a given hostname or wildcard domain, DNS records are checked to ensure that the domain on the subscription is owned by the subscription creator. Provided DNS records are maintained, TLS certificates will automatically renew.

Data model

certificate_authorityStringThe entity that issues and certifies the TLS certificates for your subscription. Valid values are lets-encrypt or globalsign. The ability to select Globalsign as a certificate authority is part of a limited availability release.
created_atStringTime-stamp (GMT) when the subscription was created. Read Only.
stateStringThe current state of your subscription. The list of possible states are: pending, processing, issued, and renewing. Read Only.
relationships.tls_configuration.data.idStringThe unique identifier for the set of TLS configuration options that apply to the enabled domains on this subscription. Write-only on create.
updated_atStringTime-stamp (GMT) when the subscription was last updated. Read Only.

Endpoints

List TLS subscriptions

GET/tls/subscriptions

Get a TLS subscription

GET/tls/subscriptions/id

Create a TLS subscription

POST/tls/subscriptions

Delete a TLS subscription

DELETE/tls/subscriptions/id

User contributed notes

We welcome comments that add use cases, ideas, tips, and caveats. All comments will be moderated before publication. To post support questions, visit our support center and we'll find you the help you need.