# Routes

## List Routes

`client.Workers.Routes.List(ctx, query) (*SinglePage[RouteListResponse], error)`

**get** `/zones/{zone_id}/workers/routes`

Returns routes for a zone.

### Parameters

- `query RouteListParams`

  - `ZoneID param.Field[string]`

    Identifier.

### Returns

- `type RouteListResponse struct{…}`

  - `ID string`

    Identifier.

  - `Pattern string`

    Pattern to match incoming requests against. [Learn more](https://developers.cloudflare.com/workers/configuration/routing/routes/#matching-behavior).

  - `Script string`

    Name of the script to run if the route matches.

### Example

```go
package main

import (
  "context"
  "fmt"

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

func main() {
  client := cloudflare.NewClient(
    option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"),
  )
  page, err := client.Workers.Routes.List(context.TODO(), workers.RouteListParams{
    ZoneID: cloudflare.F("023e105f4ecef8ad9ca31a8372d0c353"),
  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", page)
}
```

#### 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": [
    {
      "id": "023e105f4ecef8ad9ca31a8372d0c353",
      "pattern": "example.com/*",
      "script": "my-workers-script"
    }
  ],
  "success": true
}
```

## Get Route

`client.Workers.Routes.Get(ctx, routeID, query) (*RouteGetResponse, error)`

**get** `/zones/{zone_id}/workers/routes/{route_id}`

Returns information about a route, including URL pattern and Worker.

### Parameters

- `routeID string`

  Identifier.

- `query RouteGetParams`

  - `ZoneID param.Field[string]`

    Identifier.

### Returns

- `type RouteGetResponse struct{…}`

  - `ID string`

    Identifier.

  - `Pattern string`

    Pattern to match incoming requests against. [Learn more](https://developers.cloudflare.com/workers/configuration/routing/routes/#matching-behavior).

  - `Script string`

    Name of the script to run if the route matches.

### Example

```go
package main

import (
  "context"
  "fmt"

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

func main() {
  client := cloudflare.NewClient(
    option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"),
  )
  route, err := client.Workers.Routes.Get(
    context.TODO(),
    "023e105f4ecef8ad9ca31a8372d0c353",
    workers.RouteGetParams{
      ZoneID: cloudflare.F("023e105f4ecef8ad9ca31a8372d0c353"),
    },
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", route.ID)
}
```

#### 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": {
    "id": "023e105f4ecef8ad9ca31a8372d0c353",
    "pattern": "example.com/*",
    "script": "my-workers-script"
  },
  "success": true
}
```

## Create Route

`client.Workers.Routes.New(ctx, params) (*RouteNewResponse, error)`

**post** `/zones/{zone_id}/workers/routes`

Creates a route that maps a URL pattern to a Worker.

### Parameters

- `params RouteNewParams`

  - `ZoneID param.Field[string]`

    Path param: Identifier.

  - `Pattern param.Field[string]`

    Body param: Pattern to match incoming requests against. [Learn more](https://developers.cloudflare.com/workers/configuration/routing/routes/#matching-behavior).

  - `Script param.Field[string]`

    Body param: Name of the script to run if the route matches.

### Returns

- `type RouteNewResponse struct{…}`

  - `ID string`

    Identifier.

  - `Pattern string`

    Pattern to match incoming requests against. [Learn more](https://developers.cloudflare.com/workers/configuration/routing/routes/#matching-behavior).

  - `Script string`

    Name of the script to run if the route matches.

### Example

```go
package main

import (
  "context"
  "fmt"

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

func main() {
  client := cloudflare.NewClient(
    option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"),
  )
  route, err := client.Workers.Routes.New(context.TODO(), workers.RouteNewParams{
    ZoneID: cloudflare.F("023e105f4ecef8ad9ca31a8372d0c353"),
    Pattern: cloudflare.F("example.com/*"),
  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", route.ID)
}
```

#### 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": {
    "id": "023e105f4ecef8ad9ca31a8372d0c353",
    "pattern": "example.com/*",
    "script": "my-workers-script"
  },
  "success": true
}
```

## Update Route

`client.Workers.Routes.Update(ctx, routeID, params) (*RouteUpdateResponse, error)`

**put** `/zones/{zone_id}/workers/routes/{route_id}`

Updates the URL pattern or Worker associated with a route.

### Parameters

- `routeID string`

  Identifier.

- `params RouteUpdateParams`

  - `ZoneID param.Field[string]`

    Path param: Identifier.

  - `Pattern param.Field[string]`

    Body param: Pattern to match incoming requests against. [Learn more](https://developers.cloudflare.com/workers/configuration/routing/routes/#matching-behavior).

  - `Script param.Field[string]`

    Body param: Name of the script to run if the route matches.

### Returns

- `type RouteUpdateResponse struct{…}`

  - `ID string`

    Identifier.

  - `Pattern string`

    Pattern to match incoming requests against. [Learn more](https://developers.cloudflare.com/workers/configuration/routing/routes/#matching-behavior).

  - `Script string`

    Name of the script to run if the route matches.

### Example

```go
package main

import (
  "context"
  "fmt"

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

func main() {
  client := cloudflare.NewClient(
    option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"),
  )
  route, err := client.Workers.Routes.Update(
    context.TODO(),
    "023e105f4ecef8ad9ca31a8372d0c353",
    workers.RouteUpdateParams{
      ZoneID: cloudflare.F("023e105f4ecef8ad9ca31a8372d0c353"),
      Pattern: cloudflare.F("example.com/*"),
    },
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", route.ID)
}
```

#### 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": {
    "id": "023e105f4ecef8ad9ca31a8372d0c353",
    "pattern": "example.com/*",
    "script": "my-workers-script"
  },
  "success": true
}
```

## Delete Route

`client.Workers.Routes.Delete(ctx, routeID, body) (*RouteDeleteResponse, error)`

**delete** `/zones/{zone_id}/workers/routes/{route_id}`

Deletes a route.

### Parameters

- `routeID string`

  Identifier.

- `body RouteDeleteParams`

  - `ZoneID param.Field[string]`

    Identifier.

### Returns

- `type RouteDeleteResponse struct{…}`

  - `ID string`

    Identifier.

### Example

```go
package main

import (
  "context"
  "fmt"

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

func main() {
  client := cloudflare.NewClient(
    option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"),
  )
  route, err := client.Workers.Routes.Delete(
    context.TODO(),
    "023e105f4ecef8ad9ca31a8372d0c353",
    workers.RouteDeleteParams{
      ZoneID: cloudflare.F("023e105f4ecef8ad9ca31a8372d0c353"),
    },
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", route.ID)
}
```

#### 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": {
    "id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "success": true
}
```