# Holds

## Get Zone Hold

`client.Zones.Holds.Get(ctx, query) (*ZoneHold, error)`

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

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

### Parameters

- `query HoldGetParams`

  - `ZoneID param.Field[string]`

    Identifier.

### Returns

- `type ZoneHold struct{…}`

  - `Hold bool`

  - `HoldAfter string`

  - `IncludeSubdomains string`

### Example

```go
package main

import (
  "context"
  "fmt"

  "github.com/cloudflare/cloudflare-go"
  "github.com/cloudflare/cloudflare-go/option"
  "github.com/cloudflare/cloudflare-go/zones"
)

func main() {
  client := cloudflare.NewClient(
    option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"),
  )
  zoneHold, err := client.Zones.Holds.Get(context.TODO(), zones.HoldGetParams{
    ZoneID: cloudflare.F("023e105f4ecef8ad9ca31a8372d0c353"),
  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", zoneHold.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

`client.Zones.Holds.New(ctx, params) (*ZoneHold, error)`

**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

- `params HoldNewParams`

  - `ZoneID param.Field[string]`

    Path param: Identifier.

  - `IncludeSubdomains param.Field[bool]`

    Query param: 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

- `type ZoneHold struct{…}`

  - `Hold bool`

  - `HoldAfter string`

  - `IncludeSubdomains string`

### Example

```go
package main

import (
  "context"
  "fmt"

  "github.com/cloudflare/cloudflare-go"
  "github.com/cloudflare/cloudflare-go/option"
  "github.com/cloudflare/cloudflare-go/zones"
)

func main() {
  client := cloudflare.NewClient(
    option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"),
  )
  zoneHold, err := client.Zones.Holds.New(context.TODO(), zones.HoldNewParams{
    ZoneID: cloudflare.F("023e105f4ecef8ad9ca31a8372d0c353"),
  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", zoneHold.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

`client.Zones.Holds.Edit(ctx, params) (*ZoneHold, error)`

**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

- `params HoldEditParams`

  - `ZoneID param.Field[string]`

    Path param: Identifier.

  - `HoldAfter param.Field[string]`

    Body param: 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.

  - `IncludeSubdomains param.Field[bool]`

    Body param: 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

- `type ZoneHold struct{…}`

  - `Hold bool`

  - `HoldAfter string`

  - `IncludeSubdomains string`

### Example

```go
package main

import (
  "context"
  "fmt"

  "github.com/cloudflare/cloudflare-go"
  "github.com/cloudflare/cloudflare-go/option"
  "github.com/cloudflare/cloudflare-go/zones"
)

func main() {
  client := cloudflare.NewClient(
    option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"),
  )
  zoneHold, err := client.Zones.Holds.Edit(context.TODO(), zones.HoldEditParams{
    ZoneID: cloudflare.F("023e105f4ecef8ad9ca31a8372d0c353"),
  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", zoneHold.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

`client.Zones.Holds.Delete(ctx, params) (*ZoneHold, error)`

**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

- `params HoldDeleteParams`

  - `ZoneID param.Field[string]`

    Path param: Identifier.

  - `HoldAfter param.Field[string]`

    Query param: 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

- `type ZoneHold struct{…}`

  - `Hold bool`

  - `HoldAfter string`

  - `IncludeSubdomains string`

### Example

```go
package main

import (
  "context"
  "fmt"

  "github.com/cloudflare/cloudflare-go"
  "github.com/cloudflare/cloudflare-go/option"
  "github.com/cloudflare/cloudflare-go/zones"
)

func main() {
  client := cloudflare.NewClient(
    option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"),
  )
  zoneHold, err := client.Zones.Holds.Delete(context.TODO(), zones.HoldDeleteParams{
    ZoneID: cloudflare.F("023e105f4ecef8ad9ca31a8372d0c353"),
  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", zoneHold.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

- `type ZoneHold struct{…}`

  - `Hold bool`

  - `HoldAfter string`

  - `IncludeSubdomains string`