routes

Creates, updates, deletes, gets or lists a routes resource.

Overview

Name	routes
Type	Resource
Id	cloudflare.workers.routes

Fields

The following fields are returned by SELECT queries:

get

Get Route response.

Name	Datatype	Description
id	string	Identifier. (example: 023e105f4ecef8ad9ca31a8372d0c353)
pattern	string	Pattern to match incoming requests against. Learn more. (example: example.com/*)
script	string	Name of the script to run if the route matches. (example: my-workers-script)

list

List Routes response.

Name	Datatype	Description
id	string	Identifier. (example: 023e105f4ecef8ad9ca31a8372d0c353)
pattern	string	Pattern to match incoming requests against. Learn more. (example: example.com/*)
script	string	Name of the script to run if the route matches. (example: my-workers-script)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	route_id, zone_id		Returns information about a route, including URL pattern and Worker.
list	select	zone_id		Returns routes for a zone.
create	insert	zone_id, pattern		Creates a route that maps a URL pattern to a Worker.
update	replace	route_id, zone_id, pattern		Updates the URL pattern or Worker associated with a route.
delete	delete	route_id, zone_id		Deletes a route.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
route_id	string
zone_id	string	The Cloudflare zone ID.

SELECT examples

get

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

SELECT
id,
pattern,
script
FROM cloudflare.workers.routes
WHERE route_id = '{{ route_id }}' -- required
AND zone_id = '{{ zone_id }}' -- required
;

list

Returns routes for a zone.

SELECT
id,
pattern,
script
FROM cloudflare.workers.routes
WHERE zone_id = '{{ zone_id }}' -- required
;

INSERT examples

create

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

INSERT INTO cloudflare.workers.routes (
pattern,
script,
zone_id
)
SELECT 
'{{ pattern }}' /* required */,
'{{ script }}',
'{{ zone_id }}'
RETURNING
errors,
messages,
result,
success
;

Manifest

# Description fields are for documentation purposes
- name: routes
props:
  - name: zone_id
    value: "{{ zone_id }}"
    description: Required parameter for the routes resource.
  - name: pattern
    value: "{{ pattern }}"
    description: |
      Pattern to match incoming requests against. [Learn more](https://developers.cloudflare.com/workers/configuration/routing/routes/#matching-behavior).
  - name: script
    value: "{{ script }}"
    description: |
      Name of the script to run if the route matches.

REPLACE examples

update

Updates the URL pattern or Worker associated with a route.

REPLACE cloudflare.workers.routes
SET 
pattern = '{{ pattern }}',
script = '{{ script }}'
WHERE 
route_id = '{{ route_id }}' --required
AND zone_id = '{{ zone_id }}' --required
AND pattern = '{{ pattern }}' --required
RETURNING
errors,
messages,
result,
success;

DELETE examples

delete

Deletes a route.

DELETE FROM cloudflare.workers.routes
WHERE route_id = '{{ route_id }}' --required
AND zone_id = '{{ zone_id }}' --required
;