schedule

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

Overview

Name	schedule
Type	Resource
Id	cloudflare.speed.schedule

Fields

The following fields are returned by SELECT queries:

get

Page test schedule.

Name	Datatype	Description
frequency	string	The frequency of the test. (DAILY, WEEKLY) (example: DAILY)
region	string	A test region. (asia-east1, asia-northeast1, asia-northeast2, asia-south1, asia-southeast1, australia-southeast1, europe-north1, europe-southwest1, europe-west1, europe-west2, europe-west3, europe-west4, europe-west8, europe-west9, me-west1, southamerica-east1, us-central1, us-east1, us-east4, us-south1, us-west1) (example: us-central1)
url	string	A URL. (example: example.com)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	zone_id, url	region	Retrieves the test schedule for a page in a specific region.
create	insert	zone_id, url	region, frequency	Creates a scheduled test for a page.
delete	delete	zone_id, url	region	Deletes a scheduled test for a page.

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
url	string
zone_id	string	The Cloudflare zone ID.
frequency	string	The frequency of the scheduled test. Defaults to WEEKLY for free plans, DAILY for paid plans.
region	string

SELECT examples

get

Retrieves the test schedule for a page in a specific region.

SELECT
frequency,
region,
url
FROM cloudflare.speed.schedule
WHERE zone_id = '{{ zone_id }}' -- required
AND url = '{{ url }}' -- required
AND region = '{{ region }}'
;

INSERT examples

create

Creates a scheduled test for a page.

INSERT INTO cloudflare.speed.schedule (
zone_id,
url,
region,
frequency
)
SELECT 
'{{ zone_id }}',
'{{ url }}',
'{{ region }}',
'{{ frequency }}'
RETURNING
errors,
messages,
result,
success
;

Manifest

# Description fields are for documentation purposes
- name: schedule
props:
  - name: zone_id
    value: "{{ zone_id }}"
    description: Required parameter for the schedule resource.
  - name: url
    value: "{{ url }}"
    description: Required parameter for the schedule resource.
  - name: region
    value: "{{ region }}"
  - name: frequency
    value: "{{ frequency }}"
    description: The frequency of the scheduled test. Defaults to WEEKLY for free plans, DAILY for paid plans.
    description: The frequency of the scheduled test. Defaults to WEEKLY for free plans, DAILY for paid plans.

DELETE examples

delete

Deletes a scheduled test for a page.

DELETE FROM cloudflare.speed.schedule
WHERE zone_id = '{{ zone_id }}' --required
AND url = '{{ url }}' --required
AND region = '{{ region }}'
;