GET /zones/{zone_id}/hold/{zone_name}

Retrieve whether a given hostname is subject to a zone hold, and metadata about the hold. This endpoint checks whether the given hostname (or any of its ancestor domains) is blocked by an active zone hold. If a hold with include_subdomains is active on an ancestor domain, that hold is returned. This endpoint is used internally by SSL/COMS to check hold status during zone activation.

Servers

Path parameters

Name Type Required Description
zone_name String Yes

The hostname to check for a zone hold. May be a subdomain (e.g. subdomain.example.com) or an apex domain (e.g. example.com). The service checks the hostname and its ancestor domains for active holds with include_subdomains enabled.

zone_id String Yes

Zone identifier. Consumed by the API gateway for routing; the backend handler does not use this value directly.

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.