PATCH /tls/subscriptions/{tls_subscription_id}

Change the TLS domains or common name associated with this subscription, update the TLS configuration for this set of domains, or retry a subscription with state failed by setting the state to retry.

Authorization: API token with at least TLS management permissions.

Servers

Path parameters

Name Type Required Description
tls_subscription_id String Yes

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

host String No

Query parameters

Name Type Required Description
force String No

A flag that allows you to edit and delete a subscription with active domains. Valid to use on PATCH and DELETE actions. As a warning, removing an active domain from a subscription or forcing the deletion of a subscription may result in breaking TLS termination to that domain.

Request body fields

Name Type Required Description
data Object No
data.attributes Object No
data.attributes.state String No
data.type String No
data.relationships Object No
data.relationships.tls_domains Object No
data.relationships.tls_domains.data[] Array No
data.relationships.tls_domains.data[].id String No
data.relationships.tls_domains.data[].type String No
data.relationships.tls_configuration Object No
data.relationships.tls_configuration.data Object No
data.relationships.tls_configuration.data.id String No
data.relationships.tls_configuration.data.type String No
data.relationships.common_name Object No
data.relationships.common_name.data Object No
data.relationships.common_name.data.id String No
data.relationships.common_name.data.type String No

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.