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
- https://api.cloudflare.com/client/v4
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
zone_name |
String | Yes |
The hostname to check for a zone hold. May be a subdomain (e.g. |
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
- Add HTTP Task to your workflow definition.
- 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.
- Click Test request to test run your request to the API and see the API's response.