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}
Retrieves the test schedule for a page in a specific region.
Security
API Token
The preferred authorization scheme for interacting with the Cloudflare API. Create a token.
Example:
API Email + API Key
The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.
Example:
The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.
Example:
Accepted Permissions (at least one required)
Get a page test schedule
import Cloudflare from 'cloudflare';
const client = new Cloudflare({
apiToken: process.env['CLOUDFLARE_API_TOKEN'], // This is the default and can be omitted
});
const schedule = await client.speed.schedule.get('example.com', {
zone_id: '023e105f4ecef8ad9ca31a8372d0c353',
});
console.log(schedule.frequency);{
"errors": [
{
"code": 1000,
"message": "message",
"documentation_url": "documentation_url",
"source": {
"pointer": "pointer"
}
}
],
"messages": [
{
"code": 1000,
"message": "message",
"documentation_url": "documentation_url",
"source": {
"pointer": "pointer"
}
}
],
"success": true,
"result": {
"frequency": "DAILY",
"region": "us-central1",
"url": "example.com"
}
}Returns Examples
{
"errors": [
{
"code": 1000,
"message": "message",
"documentation_url": "documentation_url",
"source": {
"pointer": "pointer"
}
}
],
"messages": [
{
"code": 1000,
"message": "message",
"documentation_url": "documentation_url",
"source": {
"pointer": "pointer"
}
}
],
"success": true,
"result": {
"frequency": "DAILY",
"region": "us-central1",
"url": "example.com"
}
}