Cloudflare API | Speed › Availabilities › Get Quota And Availability

API Reference

Account & User Management

Resource Sharing

AI

Certificate Management

Certificate Authorities

Client Certificates

Custom Certificates

Custom Hostnames

Keyless Certificates

MTLS Certificates

Origin CA Certificates

Origin Post Quantum Encryption

Origin TLS Client Auth

Cloudflare One

DNS

Account Custom Nameservers

Domain/Zone Management

IP Addresses

Media

Networking

Magic Network Monitoring

Network Interconnects

Observability

Security Center

Radar

Routing & Performance

Get quota and availability

Rules

Cloud Connector

Managed Transforms

URL Normalization

Security

Content Scanning

Leaked Credential Checks

Storage & Databases

Threat Intelligence

Brand Protection

Workers & Pages

Browser Rendering

Durable Objects

Workers For Platforms

Shared

Speed

speed

Domain types

LabeledRegion = { label, value }

A test region with a label.

LighthouseReport = { cls, deviceType, error, 9 more... }

The Lighthouse report.

Trend = { cls, fcp, lcp, 5 more... }

Availabilities

speed.availabilities

Methods

Get Quota And Availability -> Envelope<

>

get/zones/{zone_id}/speed_api/availabilities

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

Security

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 Write Zone Settings Read

Parameters

zone_id: string

(maxLength: 32)

Identifier

Response fields

errors: Array<

>

messages: Array<

>

success: boolean

Whether the API call was successful.

result:

Optional

Request example

curl https://api.cloudflare.com/client/v4/zones/$ZONE_ID/speed_api/availabilities \
    -H "X-Auth-Email: $CLOUDFLARE_EMAIL" \
    -H "X-Auth-Key: $CLOUDFLARE_API_KEY"

200Example

{
  "errors": [
    {
      "code": 1000,
      "message": "message"
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message"
    }
  ],
  "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": "asia-east1"
      }
    ],
    "regionsPerPlan": {
      "business": [
        {
          "label": "Iowa, USA",
          "value": "asia-east1"
        }
      ],
      "enterprise": [
        {
          "label": "Iowa, USA",
          "value": "asia-east1"
        }
      ],
      "free": [
        {
          "label": "Iowa, USA",
          "value": "asia-east1"
        }
      ],
      "pro": [
        {
          "label": "Iowa, USA",
          "value": "asia-east1"
        }
      ]
    }
  }
}

Domain types

Availability = { quota, regions, regionsPerPlan }

Pages

speed.pages

Methods

List Tested Webpages -> SinglePage<{ region, scheduleFrequency, tests, 1 more... }>

get/zones/{zone_id}/speed_api/pages

Lists all webpages which have been tested.

List Core Web Vital Metrics Trend -> Envelope<

>

get/zones/{zone_id}/speed_api/pages/{url}/trend

Lists the core web vital metrics trend over time for a specific page.

Tests

speed.pages.tests

Methods

Start Page Test -> Envelope<

>

post/zones/{zone_id}/speed_api/pages/{url}/tests

Starts a test for a specific webpage, in a specific region.

Delete All Page Tests -> Envelope<{ count }>

delete/zones/{zone_id}/speed_api/pages/{url}/tests

Deletes all tests for a specific webpage from a specific region. Deleted tests are still counted as part of the quota.

Get A Page Test Result -> Envelope<

>

get/zones/{zone_id}/speed_api/pages/{url}/tests/{test_id}

Retrieves the result of a specific test.

List Page Test History -> V4PagePaginationArray<

>

get/zones/{zone_id}/speed_api/pages/{url}/tests

Test history (list of tests) for a specific webpage.

Domain types

Test = { id, date, desktopReport, 4 more... }

Schedule

speed.schedule

Methods

Create Scheduled Page Test -> Envelope<{ schedule, test }>

post/zones/{zone_id}/speed_api/schedule/{url}

Creates a scheduled test for a page.

Delete Scheduled Page Test -> Envelope<{ count }>

delete/zones/{zone_id}/speed_api/schedule/{url}

Deletes a scheduled test for a page.

Get A Page Test Schedule -> Envelope<

>

get/zones/{zone_id}/speed_api/schedule/{url}

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

Domain types

Schedule = { frequency, region, url }

The test schedule.