Skip to content
Cloudflare API
Start here
API Reference

Spectrum

ModelsExpand Collapse
type DNS struct{…}

The name and type of DNS record for the Spectrum application.

Name stringoptional

The name of the DNS record associated with the application.

formathostname
Type DNSTypeoptional

The type of DNS record associated with the application.

One of the following:
const DNSTypeCNAME DNSType = "CNAME"
const DNSTypeAddress DNSType = "ADDRESS"
type EdgeIPs interface{…}

The anycast edge IP configuration for the hostname of this application.

One of the following:
type EdgeIPsDynamic struct{…}
Connectivity EdgeIPsDynamicConnectivityoptional

The IP versions supported for inbound connections on Spectrum anycast IPs.

One of the following:
const EdgeIPsDynamicConnectivityAll EdgeIPsDynamicConnectivity = "all"
const EdgeIPsDynamicConnectivityIPV4 EdgeIPsDynamicConnectivity = "ipv4"
const EdgeIPsDynamicConnectivityIPV6 EdgeIPsDynamicConnectivity = "ipv6"
Type EdgeIPsDynamicTypeoptional

The type of edge IP configuration specified. Dynamically allocated edge IPs use Spectrum anycast IPs in accordance with the connectivity you specify. Only valid with CNAME DNS names.

type EdgeIPsStatic struct{…}
IPs []stringoptional

The array of customer owned IPs we broadcast via anycast for this hostname and application.

Type EdgeIPsStaticTypeoptional

The type of edge IP configuration specified. Statically allocated edge IPs use customer IPs in accordance with the ips array you specify. Only valid with ADDRESS DNS names.

type OriginDNS struct{…}

The name and type of DNS record for the Spectrum application.

Name stringoptional

The name of the DNS record associated with the origin.

formathostname
TTL int64optional

The TTL of our resolution of your DNS record in seconds.

minimum600
Type OriginDNSTypeoptional

The type of DNS record associated with the origin. "" is used to specify a combination of A/AAAA records.

One of the following:
const OriginDNSTypeEmpty OriginDNSType = ""
const OriginDNSTypeA OriginDNSType = "A"
const OriginDNSTypeAAAA OriginDNSType = "AAAA"
const OriginDNSTypeSRV OriginDNSType = "SRV"
type OriginPortUnion interface{…}

The destination port at the origin. Only specified in conjunction with origin_dns. May use an integer to specify a single origin port, for example 1000, or a string to specify a range of origin ports, for example "1000-2000". Notes: If specifying a port range, the number of ports in the range must match the number of ports specified in the "protocol" field.

One of the following:
UnionInt
UnionString

SpectrumAnalytics

SpectrumAnalyticsAggregates

SpectrumAnalyticsAggregatesCurrents

Get current aggregated analytics
client.Spectrum.Analytics.Aggregates.Currents.Get(ctx, params) (*[]AnalyticsAggregateCurrentGetResponse, error)
GET/zones/{zone_id}/spectrum/analytics/aggregate/current

SpectrumAnalyticsEvents

ModelsExpand Collapse
type Dimension string
One of the following:
const DimensionEvent Dimension = "event"
const DimensionAppID Dimension = "appID"
const DimensionColoName Dimension = "coloName"
const DimensionIPVersion Dimension = "ipVersion"

SpectrumAnalyticsEventsBytimes

Get analytics by time
client.Spectrum.Analytics.Events.Bytimes.Get(ctx, params) (*AnalyticsEventBytimeGetResponse, error)
GET/zones/{zone_id}/spectrum/analytics/events/bytime

SpectrumAnalyticsEventsSummaries

Get analytics summary
client.Spectrum.Analytics.Events.Summaries.Get(ctx, params) (*AnalyticsEventSummaryGetResponse, error)
GET/zones/{zone_id}/spectrum/analytics/events/summary

SpectrumApps

List Spectrum applications
client.Spectrum.Apps.List(ctx, params) (*V4PagePaginationArray[AppListResponse], error)
GET/zones/{zone_id}/spectrum/apps
Get Spectrum application configuration
client.Spectrum.Apps.Get(ctx, appID, query) (*AppGetResponse, error)
GET/zones/{zone_id}/spectrum/apps/{app_id}
Create Spectrum application using a name for the origin
client.Spectrum.Apps.New(ctx, params) (*AppNewResponse, error)
POST/zones/{zone_id}/spectrum/apps
Update Spectrum application configuration using a name for the origin
client.Spectrum.Apps.Update(ctx, appID, params) (*AppUpdateResponse, error)
PUT/zones/{zone_id}/spectrum/apps/{app_id}
Delete Spectrum application
client.Spectrum.Apps.Delete(ctx, appID, body) (*AppDeleteResponse, error)
DELETE/zones/{zone_id}/spectrum/apps/{app_id}