API Reference

Speed

Availabilities

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Get quota and availability

client.Speed.Availabilities.List(ctx, query) (*Availability, error)

GET/zones/{zone_id}/speed_api/availabilities

Retrieves quota for all plans, as well as the current zone quota.

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

query AvailabilityListParams

ZoneID param.Field[string]

Identifier.

maxLength32

ReturnsExpand Collapse

type Availability struct{…}

Quota AvailabilityQuotaoptional

Plan stringoptional

Cloudflare plan.

QuotasPerPlan AvailabilityQuotaQuotasPerPlanoptional

The number of tests available per plan.

Value AvailabilityQuotaQuotasPerPlanValueoptional

Counts per account plan.

Business int64optional

Enterprise int64optional

Free int64optional

Pro int64optional

RemainingSchedules float64optional

The number of remaining schedules available.

RemainingTests float64optional

The number of remaining tests available.

ScheduleQuotasPerPlan AvailabilityQuotaScheduleQuotasPerPlanoptional

The number of schedules available per plan.

Value AvailabilityQuotaScheduleQuotasPerPlanValueoptional

Counts per account plan.

Business int64optional

Enterprise int64optional

Free int64optional

Pro int64optional

Regions []LabeledRegionoptional

Label stringoptional

Value LabeledRegionValueoptional

A test region.

One of the following:

const LabeledRegionValueAsiaEast1 LabeledRegionValue = "asia-east1"

const LabeledRegionValueAsiaNortheast1 LabeledRegionValue = "asia-northeast1"

const LabeledRegionValueAsiaNortheast2 LabeledRegionValue = "asia-northeast2"

const LabeledRegionValueAsiaSouth1 LabeledRegionValue = "asia-south1"

const LabeledRegionValueAsiaSoutheast1 LabeledRegionValue = "asia-southeast1"

const LabeledRegionValueAustraliaSoutheast1 LabeledRegionValue = "australia-southeast1"

const LabeledRegionValueEuropeNorth1 LabeledRegionValue = "europe-north1"

const LabeledRegionValueEuropeSouthwest1 LabeledRegionValue = "europe-southwest1"

const LabeledRegionValueEuropeWest1 LabeledRegionValue = "europe-west1"

const LabeledRegionValueEuropeWest2 LabeledRegionValue = "europe-west2"

const LabeledRegionValueEuropeWest3 LabeledRegionValue = "europe-west3"

const LabeledRegionValueEuropeWest4 LabeledRegionValue = "europe-west4"

const LabeledRegionValueEuropeWest8 LabeledRegionValue = "europe-west8"

const LabeledRegionValueEuropeWest9 LabeledRegionValue = "europe-west9"

const LabeledRegionValueMeWest1 LabeledRegionValue = "me-west1"

const LabeledRegionValueSouthamericaEast1 LabeledRegionValue = "southamerica-east1"

const LabeledRegionValueUsCentral1 LabeledRegionValue = "us-central1"

const LabeledRegionValueUsEast1 LabeledRegionValue = "us-east1"

const LabeledRegionValueUsEast4 LabeledRegionValue = "us-east4"

const LabeledRegionValueUsSouth1 LabeledRegionValue = "us-south1"

const LabeledRegionValueUsWest1 LabeledRegionValue = "us-west1"

RegionsPerPlan AvailabilityRegionsPerPlanoptional

Available regions.

Business []LabeledRegionoptional

Label stringoptional

Value LabeledRegionValueoptional

A test region.

One of the following:

const LabeledRegionValueAsiaEast1 LabeledRegionValue = "asia-east1"

const LabeledRegionValueAsiaNortheast1 LabeledRegionValue = "asia-northeast1"

const LabeledRegionValueAsiaNortheast2 LabeledRegionValue = "asia-northeast2"

const LabeledRegionValueAsiaSouth1 LabeledRegionValue = "asia-south1"

const LabeledRegionValueAsiaSoutheast1 LabeledRegionValue = "asia-southeast1"

const LabeledRegionValueAustraliaSoutheast1 LabeledRegionValue = "australia-southeast1"

const LabeledRegionValueEuropeNorth1 LabeledRegionValue = "europe-north1"

const LabeledRegionValueEuropeSouthwest1 LabeledRegionValue = "europe-southwest1"

const LabeledRegionValueEuropeWest1 LabeledRegionValue = "europe-west1"

const LabeledRegionValueEuropeWest2 LabeledRegionValue = "europe-west2"

const LabeledRegionValueEuropeWest3 LabeledRegionValue = "europe-west3"

const LabeledRegionValueEuropeWest4 LabeledRegionValue = "europe-west4"

const LabeledRegionValueEuropeWest8 LabeledRegionValue = "europe-west8"

const LabeledRegionValueEuropeWest9 LabeledRegionValue = "europe-west9"

const LabeledRegionValueMeWest1 LabeledRegionValue = "me-west1"

const LabeledRegionValueSouthamericaEast1 LabeledRegionValue = "southamerica-east1"

const LabeledRegionValueUsCentral1 LabeledRegionValue = "us-central1"

const LabeledRegionValueUsEast1 LabeledRegionValue = "us-east1"

const LabeledRegionValueUsEast4 LabeledRegionValue = "us-east4"

const LabeledRegionValueUsSouth1 LabeledRegionValue = "us-south1"

const LabeledRegionValueUsWest1 LabeledRegionValue = "us-west1"

Enterprise []LabeledRegionoptional

Label stringoptional

Value LabeledRegionValueoptional

A test region.

One of the following:

const LabeledRegionValueAsiaEast1 LabeledRegionValue = "asia-east1"

const LabeledRegionValueAsiaNortheast1 LabeledRegionValue = "asia-northeast1"

const LabeledRegionValueAsiaNortheast2 LabeledRegionValue = "asia-northeast2"

const LabeledRegionValueAsiaSouth1 LabeledRegionValue = "asia-south1"

const LabeledRegionValueAsiaSoutheast1 LabeledRegionValue = "asia-southeast1"

const LabeledRegionValueAustraliaSoutheast1 LabeledRegionValue = "australia-southeast1"

const LabeledRegionValueEuropeNorth1 LabeledRegionValue = "europe-north1"

const LabeledRegionValueEuropeSouthwest1 LabeledRegionValue = "europe-southwest1"

const LabeledRegionValueEuropeWest1 LabeledRegionValue = "europe-west1"

const LabeledRegionValueEuropeWest2 LabeledRegionValue = "europe-west2"

const LabeledRegionValueEuropeWest3 LabeledRegionValue = "europe-west3"

const LabeledRegionValueEuropeWest4 LabeledRegionValue = "europe-west4"

const LabeledRegionValueEuropeWest8 LabeledRegionValue = "europe-west8"

const LabeledRegionValueEuropeWest9 LabeledRegionValue = "europe-west9"

const LabeledRegionValueMeWest1 LabeledRegionValue = "me-west1"

const LabeledRegionValueSouthamericaEast1 LabeledRegionValue = "southamerica-east1"

const LabeledRegionValueUsCentral1 LabeledRegionValue = "us-central1"

const LabeledRegionValueUsEast1 LabeledRegionValue = "us-east1"

const LabeledRegionValueUsEast4 LabeledRegionValue = "us-east4"

const LabeledRegionValueUsSouth1 LabeledRegionValue = "us-south1"

const LabeledRegionValueUsWest1 LabeledRegionValue = "us-west1"

Free []LabeledRegionoptional

Label stringoptional

Value LabeledRegionValueoptional

A test region.

One of the following:

const LabeledRegionValueAsiaEast1 LabeledRegionValue = "asia-east1"

const LabeledRegionValueAsiaNortheast1 LabeledRegionValue = "asia-northeast1"

const LabeledRegionValueAsiaNortheast2 LabeledRegionValue = "asia-northeast2"

const LabeledRegionValueAsiaSouth1 LabeledRegionValue = "asia-south1"

const LabeledRegionValueAsiaSoutheast1 LabeledRegionValue = "asia-southeast1"

const LabeledRegionValueAustraliaSoutheast1 LabeledRegionValue = "australia-southeast1"

const LabeledRegionValueEuropeNorth1 LabeledRegionValue = "europe-north1"

const LabeledRegionValueEuropeSouthwest1 LabeledRegionValue = "europe-southwest1"

const LabeledRegionValueEuropeWest1 LabeledRegionValue = "europe-west1"

const LabeledRegionValueEuropeWest2 LabeledRegionValue = "europe-west2"

const LabeledRegionValueEuropeWest3 LabeledRegionValue = "europe-west3"

const LabeledRegionValueEuropeWest4 LabeledRegionValue = "europe-west4"

const LabeledRegionValueEuropeWest8 LabeledRegionValue = "europe-west8"

const LabeledRegionValueEuropeWest9 LabeledRegionValue = "europe-west9"

const LabeledRegionValueMeWest1 LabeledRegionValue = "me-west1"

const LabeledRegionValueSouthamericaEast1 LabeledRegionValue = "southamerica-east1"

const LabeledRegionValueUsCentral1 LabeledRegionValue = "us-central1"

const LabeledRegionValueUsEast1 LabeledRegionValue = "us-east1"

const LabeledRegionValueUsEast4 LabeledRegionValue = "us-east4"

const LabeledRegionValueUsSouth1 LabeledRegionValue = "us-south1"

const LabeledRegionValueUsWest1 LabeledRegionValue = "us-west1"

Pro []LabeledRegionoptional

Label stringoptional

Value LabeledRegionValueoptional

A test region.

One of the following:

const LabeledRegionValueAsiaEast1 LabeledRegionValue = "asia-east1"

const LabeledRegionValueAsiaNortheast1 LabeledRegionValue = "asia-northeast1"

const LabeledRegionValueAsiaNortheast2 LabeledRegionValue = "asia-northeast2"

const LabeledRegionValueAsiaSouth1 LabeledRegionValue = "asia-south1"

const LabeledRegionValueAsiaSoutheast1 LabeledRegionValue = "asia-southeast1"

const LabeledRegionValueAustraliaSoutheast1 LabeledRegionValue = "australia-southeast1"

const LabeledRegionValueEuropeNorth1 LabeledRegionValue = "europe-north1"

const LabeledRegionValueEuropeSouthwest1 LabeledRegionValue = "europe-southwest1"

const LabeledRegionValueEuropeWest1 LabeledRegionValue = "europe-west1"

const LabeledRegionValueEuropeWest2 LabeledRegionValue = "europe-west2"

const LabeledRegionValueEuropeWest3 LabeledRegionValue = "europe-west3"

const LabeledRegionValueEuropeWest4 LabeledRegionValue = "europe-west4"

const LabeledRegionValueEuropeWest8 LabeledRegionValue = "europe-west8"

const LabeledRegionValueEuropeWest9 LabeledRegionValue = "europe-west9"

const LabeledRegionValueMeWest1 LabeledRegionValue = "me-west1"

const LabeledRegionValueSouthamericaEast1 LabeledRegionValue = "southamerica-east1"

const LabeledRegionValueUsCentral1 LabeledRegionValue = "us-central1"

const LabeledRegionValueUsEast1 LabeledRegionValue = "us-east1"

const LabeledRegionValueUsEast4 LabeledRegionValue = "us-east4"

const LabeledRegionValueUsSouth1 LabeledRegionValue = "us-south1"

const LabeledRegionValueUsWest1 LabeledRegionValue = "us-west1"

Get quota and availability

Go

HTTP

TypeScript

Python

Go

Terraform

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"),
  )
  availability, err := client.Speed.Availabilities.List(context.TODO(), speed.AvailabilityListParams{
    ZoneID: cloudflare.F("023e105f4ecef8ad9ca31a8372d0c353"),
  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", availability.Quota)
}

200 example

{
  "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": {
    "quota": {
      "plan": "free",
      "quotasPerPlan": {
        "value": {
          "business": 1,
          "enterprise": 1,
          "free": 1,
          "pro": 1
        }
      },
      "remainingSchedules": 1,
      "remainingTests": 30,
      "scheduleQuotasPerPlan": {
        "value": {
          "business": 1,
          "enterprise": 1,
          "free": 1,
          "pro": 1
        }
      }
    },
    "regions": [
      {
        "label": "Iowa, USA",
        "value": "us-central1"
      }
    ],
    "regionsPerPlan": {
      "business": [
        {
          "label": "Iowa, USA",
          "value": "us-central1"
        }
      ],
      "enterprise": [
        {
          "label": "Iowa, USA",
          "value": "us-central1"
        }
      ],
      "free": [
        {
          "label": "Iowa, USA",
          "value": "us-central1"
        }
      ],
      "pro": [
        {
          "label": "Iowa, USA",
          "value": "us-central1"
        }
      ]
    }
  }
}

Returns Examples

200 example

{
  "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": {
    "quota": {
      "plan": "free",
      "quotasPerPlan": {
        "value": {
          "business": 1,
          "enterprise": 1,
          "free": 1,
          "pro": 1
        }
      },
      "remainingSchedules": 1,
      "remainingTests": 30,
      "scheduleQuotasPerPlan": {
        "value": {
          "business": 1,
          "enterprise": 1,
          "free": 1,
          "pro": 1
        }
      }
    },
    "regions": [
      {
        "label": "Iowa, USA",
        "value": "us-central1"
      }
    ],
    "regionsPerPlan": {
      "business": [
        {
          "label": "Iowa, USA",
          "value": "us-central1"
        }
      ],
      "enterprise": [
        {
          "label": "Iowa, USA",
          "value": "us-central1"
        }
      ],
      "free": [
        {
          "label": "Iowa, USA",
          "value": "us-central1"
        }
      ],
      "pro": [
        {
          "label": "Iowa, USA",
          "value": "us-central1"
        }
      ]
    }
  }
}