API Reference

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Cache

Purge Cached Content

client.Cache.Purge(ctx, params) (*CachePurgeResponse, error)

POST/zones/{zone_id}/purge_cache

Purge Cached Content by Environment

client.Cache.PurgeEnvironment(ctx, environmentID, params) (*CachePurgeEnvironmentResponse, error)

POST/zones/{zone_id}/environments/{environment_id}/purge_cache

CacheCache Reserve

Get Cache Reserve setting

client.Cache.CacheReserve.Get(ctx, query) (*CacheReserveGetResponse, error)

GET/zones/{zone_id}/cache/cache_reserve

Change Cache Reserve setting

client.Cache.CacheReserve.Edit(ctx, params) (*CacheReserveEditResponse, error)

PATCH/zones/{zone_id}/cache/cache_reserve

Get Cache Reserve Clear

client.Cache.CacheReserve.Status(ctx, query) (*CacheReserveStatusResponse, error)

GET/zones/{zone_id}/cache/cache_reserve_clear

Start Cache Reserve Clear

client.Cache.CacheReserve.Clear(ctx, params) (*CacheReserveClearResponse, error)

POST/zones/{zone_id}/cache/cache_reserve_clear

ModelsExpand Collapse

type CacheReserve string

The identifier of the caching setting.

type CacheReserveClear string

ID of the zone setting.

type State string

The current state of the Cache Reserve Clear operation.

One of the following:

const StateInProgress State = "In-progress"

const StateCompleted State = "Completed"

CacheSmart Tiered Cache

Get Smart Tiered Cache setting

client.Cache.SmartTieredCache.Get(ctx, query) (*SmartTieredCacheGetResponse, error)

GET/zones/{zone_id}/cache/tiered_cache_smart_topology_enable

Create Smart Tiered Cache setting

client.Cache.SmartTieredCache.New(ctx, params) (*SmartTieredCacheNewResponse, error)

POST/zones/{zone_id}/cache/tiered_cache_smart_topology_enable

Patch Smart Tiered Cache setting

client.Cache.SmartTieredCache.Edit(ctx, params) (*SmartTieredCacheEditResponse, error)

PATCH/zones/{zone_id}/cache/tiered_cache_smart_topology_enable

Delete Smart Tiered Cache setting

client.Cache.SmartTieredCache.Delete(ctx, body) (*SmartTieredCacheDeleteResponse, error)

DELETE/zones/{zone_id}/cache/tiered_cache_smart_topology_enable

CacheVariants

Get variants setting

client.Cache.Variants.Get(ctx, query) (*VariantGetResponse, error)

GET/zones/{zone_id}/cache/variants

Change variants setting

client.Cache.Variants.Edit(ctx, params) (*VariantEditResponse, error)

PATCH/zones/{zone_id}/cache/variants

Delete variants setting

client.Cache.Variants.Delete(ctx, body) (*VariantDeleteResponse, error)

DELETE/zones/{zone_id}/cache/variants

ModelsExpand Collapse

type CacheVariant struct{…}

Variant support enables caching variants of images with certain file extensions in addition to the original. This only applies when the origin server sends the ‘Vary: Accept’ response header. If the origin server sends ‘Vary: Accept’ but does not serve the variant requested, the response will not be cached. This will be indicated with BYPASS cache status in the response headers.

ID CacheVariantID

ID of the zone setting.

ModifiedOn TimeOptional

Last time this setting was modified.

formatdate-time

CacheRegional Tiered Cache

Get Regional Tiered Cache setting

client.Cache.RegionalTieredCache.Get(ctx, query) (*RegionalTieredCacheGetResponse, error)

GET/zones/{zone_id}/cache/regional_tiered_cache

Change Regional Tiered Cache setting

client.Cache.RegionalTieredCache.Edit(ctx, params) (*RegionalTieredCacheEditResponse, error)

PATCH/zones/{zone_id}/cache/regional_tiered_cache

ModelsExpand Collapse

type RegionalTieredCache string

The identifier of the caching setting.

CacheOrigin Cloud Regions

List origin cloud region mappings

client.Cache.OriginCloudRegions.List(ctx, params) (*V4PagePaginationArray[OriginCloudRegion], error)

GET/zones/{zone_id}/origin/cloud_regions

Get an origin cloud region mapping

client.Cache.OriginCloudRegions.Get(ctx, originIP, query) (*OriginCloudRegion, error)

GET/zones/{zone_id}/origin/cloud_regions/{origin_ip}

Create or replace an origin cloud region mapping

client.Cache.OriginCloudRegions.Update(ctx, originIP, params) (*OriginCloudRegion, error)

PUT/zones/{zone_id}/origin/cloud_regions/{origin_ip}

Delete an origin cloud region mapping

client.Cache.OriginCloudRegions.Delete(ctx, originIP, body) (*OriginCloudRegionDeleteResponse, error)

DELETE/zones/{zone_id}/origin/cloud_regions/{origin_ip}

Batch create or replace origin cloud region mappings

client.Cache.OriginCloudRegions.BulkUpdate(ctx, params) (*OriginCloudRegionBulkUpdateResponse, error)

PUT/zones/{zone_id}/origin/cloud_regions/batch

Batch delete origin cloud region mappings

client.Cache.OriginCloudRegions.BulkDelete(ctx, body) (*OriginCloudRegionBulkDeleteResponse, error)

DELETE/zones/{zone_id}/origin/cloud_regions/batch

List supported cloud vendors and regions

client.Cache.OriginCloudRegions.SupportedRegions(ctx, query) (*OriginCloudRegionSupportedRegionsResponse, error)

GET/zones/{zone_id}/origin/cloud_regions/supported_regions

ModelsExpand Collapse

type OriginCloudRegion struct{…}

A single origin IP-to-cloud-region mapping.

OriginIP string

The origin IP address (IPv4 or IPv6). Normalized to canonical form (RFC 5952 for IPv6).

Region string

Cloud vendor region identifier.

Vendor OriginCloudRegionVendor

Cloud vendor hosting the origin.

One of the following:

const OriginCloudRegionVendorAws OriginCloudRegionVendor = "aws"

const OriginCloudRegionVendorAzure OriginCloudRegionVendor = "azure"

const OriginCloudRegionVendorGcp OriginCloudRegionVendor = "gcp"

const OriginCloudRegionVendorOci OriginCloudRegionVendor = "oci"

ModifiedOn TimeOptional

Time this mapping was last modified.

formatdate-time