Zones
Holds
Holds endpoint reference.
Get
Retrieve whether the zone is subject to a zone hold, and metadata about the hold.
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
zoneId | string | Yes | Zone Identifier. |
php
$response = $client->zones()->holds()->get('ZONE_ID');
Create
Enforce a zone hold on the zone, blocking the creation and activation of zones with this zone's hostname.
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
zoneId | string | Yes | Zone Identifier. | |
includeSubdomains | bool | No | true | If provided, the zone hold will extend to block any subdomain of the given zone, as well as SSL4SaaS Custom Hostnames. For example, a zone hold on a zone with the hostname 'example.com' and include_subdomains=true will block 'example.com', 'staging.example.com', 'api.staging.example.com', etc. |
php
$response = $client->zones()->holds()->create('ZONE_ID', true);
Delete
Stop enforcement of a zone hold on the zone, permanently or temporarily, allowing the creation and activation of zones with this zone's hostname.
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
zoneId | string | Yes | Zone Identifier. | |
holdAfter | string|null | No | If provided, the hold will be temporarily disabled, then automatically re-enabled by the system at the time specified in this RFC3339-formatted timestamp. Otherwise, the hold will be disabled indefinitely. |
php
$response = $client->zones()->holds()->delete('ZONE_ID', 'HOLD_AFTER');