# Holds

## Get Zone Hold

`zones.holds.get(HoldGetParams**kwargs)  -> ZoneHold`

**get** `/zones/{zone_id}/hold`

Retrieve whether the zone is subject to a zone hold, and metadata about the hold.

### Parameters

- `zone_id: str`

  Identifier.

### Returns

- `class ZoneHold: …`

  - `hold: Optional[bool]`

  - `hold_after: Optional[str]`

  - `include_subdomains: Optional[str]`

### Example

```python
import os
from cloudflare import Cloudflare

client = Cloudflare(
    api_token=os.environ.get("CLOUDFLARE_API_TOKEN"),  # This is the default and can be omitted
)
zone_hold = client.zones.holds.get(
    zone_id="023e105f4ecef8ad9ca31a8372d0c353",
)
print(zone_hold.hold)
```

#### Response

```json
{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "result": {
    "hold": true,
    "hold_after": "2023-01-31T15:56:36+00:00",
    "include_subdomains": "include_subdomains"
  },
  "success": true
}
```

## Create Zone Hold

`zones.holds.create(HoldCreateParams**kwargs)  -> ZoneHold`

**post** `/zones/{zone_id}/hold`

Enforce a zone hold on the zone, blocking the creation and activation of zones with this zone's hostname.

### Parameters

- `zone_id: str`

  Identifier.

- `include_subdomains: Optional[bool]`

  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.

### Returns

- `class ZoneHold: …`

  - `hold: Optional[bool]`

  - `hold_after: Optional[str]`

  - `include_subdomains: Optional[str]`

### Example

```python
import os
from cloudflare import Cloudflare

client = Cloudflare(
    api_token=os.environ.get("CLOUDFLARE_API_TOKEN"),  # This is the default and can be omitted
)
zone_hold = client.zones.holds.create(
    zone_id="023e105f4ecef8ad9ca31a8372d0c353",
)
print(zone_hold.hold)
```

#### Response

```json
{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "result": {
    "hold": true,
    "hold_after": "2023-01-31T15:56:36+00:00",
    "include_subdomains": "include_subdomains"
  },
  "success": true
}
```

## Update Zone Hold

`zones.holds.edit(HoldEditParams**kwargs)  -> ZoneHold`

**patch** `/zones/{zone_id}/hold`

Update the `hold_after` and/or `include_subdomains` values on an existing zone hold.
The hold is enabled if the `hold_after` date-time value is in the past.

### Parameters

- `zone_id: str`

  Identifier.

- `hold_after: Optional[str]`

  If `hold_after` is provided and future-dated, the hold will be temporarily disabled,
  then automatically re-enabled by the system at the time specified
  in this RFC3339-formatted timestamp. A past-dated `hold_after` value will have
  no effect on an existing, enabled hold. Providing an empty string will set its value
  to the current time.

- `include_subdomains: Optional[bool]`

  If `true`, 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.

### Returns

- `class ZoneHold: …`

  - `hold: Optional[bool]`

  - `hold_after: Optional[str]`

  - `include_subdomains: Optional[str]`

### Example

```python
import os
from cloudflare import Cloudflare

client = Cloudflare(
    api_token=os.environ.get("CLOUDFLARE_API_TOKEN"),  # This is the default and can be omitted
)
zone_hold = client.zones.holds.edit(
    zone_id="023e105f4ecef8ad9ca31a8372d0c353",
)
print(zone_hold.hold)
```

#### Response

```json
{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "result": {
    "hold": true,
    "hold_after": "2023-01-31T15:56:36+00:00",
    "include_subdomains": "include_subdomains"
  },
  "success": true
}
```

## Remove Zone Hold

`zones.holds.delete(HoldDeleteParams**kwargs)  -> ZoneHold`

**delete** `/zones/{zone_id}/hold`

Stop enforcement of a zone hold on the zone, permanently or temporarily, allowing the
creation and activation of zones with this zone's hostname.

### Parameters

- `zone_id: str`

  Identifier.

- `hold_after: Optional[str]`

  If `hold_after` is 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.

### Returns

- `class ZoneHold: …`

  - `hold: Optional[bool]`

  - `hold_after: Optional[str]`

  - `include_subdomains: Optional[str]`

### Example

```python
import os
from cloudflare import Cloudflare

client = Cloudflare(
    api_token=os.environ.get("CLOUDFLARE_API_TOKEN"),  # This is the default and can be omitted
)
zone_hold = client.zones.holds.delete(
    zone_id="023e105f4ecef8ad9ca31a8372d0c353",
)
print(zone_hold.hold)
```

#### Response

```json
{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "result": {
    "hold": true,
    "hold_after": "2023-01-31T15:56:36+00:00",
    "include_subdomains": "include_subdomains"
  },
  "success": true
}
```

## Domain Types

### Zone Hold

- `class ZoneHold: …`

  - `hold: Optional[bool]`

  - `hold_after: Optional[str]`

  - `include_subdomains: Optional[str]`