Skip to content
Cloudflare API
Start here
API Reference
Speed

Schedule

Get a page test schedule
client.speed.schedule.get(stringurl, ScheduleGetParams { zone_id, region } params, RequestOptionsoptions?): Schedule { frequency, region, url }
GET/zones/{zone_id}/speed_api/schedule/{url}
Create scheduled page test
client.speed.schedule.create(stringurl, ScheduleCreateParams { zone_id, frequency, region } params, RequestOptionsoptions?): ScheduleCreateResponse { schedule, test }
POST/zones/{zone_id}/speed_api/schedule/{url}
Delete scheduled page test
client.speed.schedule.delete(stringurl, ScheduleDeleteParams { zone_id, region } params, RequestOptionsoptions?): ScheduleDeleteResponse { count }
DELETE/zones/{zone_id}/speed_api/schedule/{url}
ModelsExpand Collapse
Schedule { frequency, region, url }

The test schedule.

frequency?: "DAILY" | "WEEKLY"

The frequency of the test.

One of the following:
"DAILY"
"WEEKLY"
region?: "asia-east1" | "asia-northeast1" | "asia-northeast2" | 18 more

A test region.

One of the following:
"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"
url?: string

A URL.

ScheduleCreateResponse { schedule, test }
schedule?: Schedule { frequency, region, url }

The test schedule.

test?: Test { id, date, desktopReport, 4 more }
ScheduleDeleteResponse { count }
count?: number

Number of items affected.