GET /tls/subscriptions

List all TLS subscriptions.

Authorization: API token with at least TLS management permissions.

Servers

Request headers

Name Type Required Description
host String No

Query parameters

Name Type Required Description
filterstate String No

Limit the returned subscriptions by state. Valid values are pending, processing, issued, renewing, and failed. Accepts parameters: not (e.g., filter[state][not]=renewing).

include String No

Include related objects. Optional, comma-separated values. Permitted values: tls_authorizations, tls_authorizations.globalsign_email_challenge, and tls_authorizations.self_managed_http_challenge.

filtertls_domains.id String No

Limit the returned subscriptions to those that include the specific domain.

sort String No

The order in which to list the results by creation date.

filterhas_active_order String No

Limit the returned subscriptions to those that have currently active orders. Permitted values: true.

pagenumber String No

Current page.

pagesize String No

Number of records per page.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.