Get a page test schedule

client.Speed.Schedule.Get(ctx, url, params) (*Schedule, error)

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:Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY

API Email + API Key

The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.

Example:X-Auth-Email: user@example.com

The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.

Example:X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194

Accepted Permissions (at least one required)

Zone Settings WriteZone Settings Read

ParametersExpand Collapse

url string

A URL.

params ScheduleGetParams

ZoneID param.Field[string]

Path param: Identifier.

maxLength32

Region param.Field[ScheduleGetParamsRegion]optional

Query param: A test region.

const ScheduleGetParamsRegionAsiaEast1 ScheduleGetParamsRegion = "asia-east1"

const ScheduleGetParamsRegionAsiaNortheast1 ScheduleGetParamsRegion = "asia-northeast1"

const ScheduleGetParamsRegionAsiaNortheast2 ScheduleGetParamsRegion = "asia-northeast2"

const ScheduleGetParamsRegionAsiaSouth1 ScheduleGetParamsRegion = "asia-south1"

const ScheduleGetParamsRegionAsiaSoutheast1 ScheduleGetParamsRegion = "asia-southeast1"

const ScheduleGetParamsRegionAustraliaSoutheast1 ScheduleGetParamsRegion = "australia-southeast1"

const ScheduleGetParamsRegionEuropeNorth1 ScheduleGetParamsRegion = "europe-north1"

const ScheduleGetParamsRegionEuropeSouthwest1 ScheduleGetParamsRegion = "europe-southwest1"

const ScheduleGetParamsRegionEuropeWest1 ScheduleGetParamsRegion = "europe-west1"

const ScheduleGetParamsRegionEuropeWest2 ScheduleGetParamsRegion = "europe-west2"

const ScheduleGetParamsRegionEuropeWest3 ScheduleGetParamsRegion = "europe-west3"

const ScheduleGetParamsRegionEuropeWest4 ScheduleGetParamsRegion = "europe-west4"

const ScheduleGetParamsRegionEuropeWest8 ScheduleGetParamsRegion = "europe-west8"

const ScheduleGetParamsRegionEuropeWest9 ScheduleGetParamsRegion = "europe-west9"

const ScheduleGetParamsRegionMeWest1 ScheduleGetParamsRegion = "me-west1"

const ScheduleGetParamsRegionSouthamericaEast1 ScheduleGetParamsRegion = "southamerica-east1"

const ScheduleGetParamsRegionUsCentral1 ScheduleGetParamsRegion = "us-central1"

const ScheduleGetParamsRegionUsEast1 ScheduleGetParamsRegion = "us-east1"

const ScheduleGetParamsRegionUsEast4 ScheduleGetParamsRegion = "us-east4"

const ScheduleGetParamsRegionUsSouth1 ScheduleGetParamsRegion = "us-south1"

const ScheduleGetParamsRegionUsWest1 ScheduleGetParamsRegion = "us-west1"

ReturnsExpand Collapse

type Schedule struct{…}

The test schedule.

Frequency ScheduleFrequencyoptional

The frequency of the test.

One of the following:

const ScheduleFrequencyDaily ScheduleFrequency = "DAILY"

const ScheduleFrequencyWeekly ScheduleFrequency = "WEEKLY"

Region ScheduleRegionoptional

A test region.

One of the following:

const ScheduleRegionAsiaEast1 ScheduleRegion = "asia-east1"

const ScheduleRegionAsiaNortheast1 ScheduleRegion = "asia-northeast1"

const ScheduleRegionAsiaNortheast2 ScheduleRegion = "asia-northeast2"

const ScheduleRegionAsiaSouth1 ScheduleRegion = "asia-south1"

const ScheduleRegionAsiaSoutheast1 ScheduleRegion = "asia-southeast1"

const ScheduleRegionAustraliaSoutheast1 ScheduleRegion = "australia-southeast1"

const ScheduleRegionEuropeNorth1 ScheduleRegion = "europe-north1"

const ScheduleRegionEuropeSouthwest1 ScheduleRegion = "europe-southwest1"

const ScheduleRegionEuropeWest1 ScheduleRegion = "europe-west1"

const ScheduleRegionEuropeWest2 ScheduleRegion = "europe-west2"

const ScheduleRegionEuropeWest3 ScheduleRegion = "europe-west3"

const ScheduleRegionEuropeWest4 ScheduleRegion = "europe-west4"

const ScheduleRegionEuropeWest8 ScheduleRegion = "europe-west8"

const ScheduleRegionEuropeWest9 ScheduleRegion = "europe-west9"

const ScheduleRegionMeWest1 ScheduleRegion = "me-west1"

const ScheduleRegionSouthamericaEast1 ScheduleRegion = "southamerica-east1"

const ScheduleRegionUsCentral1 ScheduleRegion = "us-central1"

const ScheduleRegionUsEast1 ScheduleRegion = "us-east1"

const ScheduleRegionUsEast4 ScheduleRegion = "us-east4"

const ScheduleRegionUsSouth1 ScheduleRegion = "us-south1"

const ScheduleRegionUsWest1 ScheduleRegion = "us-west1"

URL stringoptional

A URL.

Get a page test schedule

package main

import (
  "context"
  "fmt"

  "github.com/cloudflare/cloudflare-go"
  "github.com/cloudflare/cloudflare-go/option"
  "github.com/cloudflare/cloudflare-go/speed"
)

func main() {
  client := cloudflare.NewClient(
    option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"),
  )
  schedule, err := client.Speed.Schedule.Get(
    context.TODO(),
    "example.com",
    speed.ScheduleGetParams{
      ZoneID: cloudflare.F("023e105f4ecef8ad9ca31a8372d0c353"),
    },
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", 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"
  }
}