Spectrum

spectrum

Domain types

DNS = { name, type }

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

EdgeIPs = { connectivity, type } | { ips, type }

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

OriginDNS = { name, ttl, type }

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

OriginPort = number | string

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.

Spectrum

Analytics

spectrum.analytics

spectrum.analytics.aggregates

spectrum.analytics.aggregates.currents

Methods

Get Current Aggregated Analytics -> Envelope<Array<{ appID, bytesEgress, bytesIngress, 2 more... }>>
get/zones/{zone_id}/spectrum/analytics/aggregate/current

Retrieves analytics aggregated from the last minute of usage on Spectrum applications underneath a given zone.

spectrum.analytics.events

Domain types

Dimension = "event" | "appID" | "coloName" | 1 more...

spectrum.analytics.events.bytimes

Methods

Get Analytics By Time -> Envelope<{ data, data_lag, max, 5 more... }>
get/zones/{zone_id}/spectrum/analytics/events/bytime

Retrieves a list of aggregate metrics grouped by time interval.

spectrum.analytics.events.summaries

Methods

Get Analytics Summary -> Envelope<{ data, data_lag, max, 5 more... }>
get/zones/{zone_id}/spectrum/analytics/events/summary

Retrieves a list of summarised aggregate metrics over a given time period.

spectrum.apps

Methods

Create Spectrum Application Using A Name For The Origin -> Envelope<{ id, created_on, dns, 11 more... } | { id, created_on, dns, 3 more... }>
post/zones/{zone_id}/spectrum/apps

Creates a new Spectrum application from a configuration using a name for the origin.

Delete Spectrum Application -> Envelope<{ id }>
delete/zones/{zone_id}/spectrum/apps/{app_id}

Deletes a previously existing application.

Get Spectrum Application Configuration -> Envelope<{ id, created_on, dns, 11 more... } | { id, created_on, dns, 3 more... }>
get/zones/{zone_id}/spectrum/apps/{app_id}

Gets the application configuration of a specific application inside a zone.

List Spectrum Applications -> V4PagePaginationArray<Array<{ id, created_on, dns, 11 more... }> | Array<{ id, created_on, dns, 3 more... }>>
get/zones/{zone_id}/spectrum/apps

Retrieves a list of currently existing Spectrum applications inside a zone.

Security

The preferred authorization scheme for interacting with the Cloudflare API. Create a token.

Example: Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY

Accepted Permissions (at least one required)

Zone Settings Write Zone Settings Read

Parameters
zone_id: string
(maxLength: 32)

Identifier

direction:
Optional

Sets the direction by which results are ordered.

"asc"
"desc"
order:
Optional

Application field by which results are ordered.

"protocol"
"app_id"
"created_on"
"modified_on"
"dns"
page: number
Optional
(minimum: 1)

Page number of paginated results. This parameter is required in order to use other pagination parameters. If included in the query, result_info will be present in the response.

per_page: number
Optional
(maximum: 100, minimum: 1)

Sets the maximum number of results per page.

Response fields
errors: Array<>
messages: Array<>
success: true

Whether the API call was successful

result: Array<{ id, created_on, dns, 11 more... }> | Array<{ id, created_on, dns, 3 more... }>
Optional
result_info: { count, page, per_page, 1 more... }
Optional
Request example
200Example
Update Spectrum Application Configuration Using A Name For The Origin -> Envelope<{ id, created_on, dns, 11 more... } | { id, created_on, dns, 3 more... }>
put/zones/{zone_id}/spectrum/apps/{app_id}

Updates a previously existing application's configuration that uses a name for the origin.