2021-10-11 17:04:49 -03:00
|
|
|
---
|
|
|
|
name: CF_WORKER_ROUTE
|
|
|
|
parameters:
|
|
|
|
- pattern
|
|
|
|
- script
|
2023-01-12 16:59:42 -05:00
|
|
|
parameter_types:
|
|
|
|
pattern: string
|
|
|
|
script: string
|
2022-10-28 17:27:06 +02:00
|
|
|
provider: CLOUDFLAREAPI
|
2021-10-11 17:04:49 -03:00
|
|
|
---
|
|
|
|
|
2022-02-17 18:22:31 +01:00
|
|
|
`CF_WORKER_ROUTE` uses the [Cloudflare Workers](https://developers.cloudflare.com/workers/)
|
2021-10-11 17:04:49 -03:00
|
|
|
API to manage [worker routes](https://developers.cloudflare.com/workers/platform/routes)
|
|
|
|
for a given domain.
|
|
|
|
|
2022-02-17 18:22:31 +01:00
|
|
|
If _any_ `CF_WORKER_ROUTE` function is used then `dnscontrol` will manage _all_
|
2021-10-11 17:04:49 -03:00
|
|
|
Worker Routes for the domain. To be clear: this means it will delete existing routes that
|
|
|
|
were created outside of DNSControl.
|
|
|
|
|
2023-01-20 13:56:20 +01:00
|
|
|
{% hint style="warning" %}
|
|
|
|
**WARNING**: This interface is not extensively tested. Take precautions such as making
|
2021-10-11 17:04:49 -03:00
|
|
|
backups and manually verifying `dnscontrol preview` output before running
|
|
|
|
`dnscontrol push`.
|
2023-01-20 13:56:20 +01:00
|
|
|
{% endhint %}
|
2021-10-11 17:04:49 -03:00
|
|
|
|
|
|
|
This example assigns the patterns `api.foo.com/*` and `foo.com/api/*` to a `my-worker` script:
|
|
|
|
|
2023-01-20 13:56:20 +01:00
|
|
|
```javascript
|
2021-10-11 17:04:49 -03:00
|
|
|
D("foo.com", .... ,
|
|
|
|
CF_WORKER_ROUTE("api.foo.com/*", "my-worker"),
|
|
|
|
CF_WORKER_ROUTE("foo.com/api/*", "my-worker"),
|
|
|
|
);
|
2022-02-17 18:22:31 +01:00
|
|
|
```
|