--- title: Spectrum --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/typescript) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Spectrum ##### ModelsExpand Collapse

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

name?: string The name of the DNS record associated with the application. formathostname Link to this property

type?: "CNAME"| "ADDRESS" The type of DNS record associated with the application.

One of the following: "CNAME" Link to this property "ADDRESS" Link to this property

Link to this property

[Link to this property](<#(resource)%20spectrum%20%3E%20(model)%20dns%20%3E%20(schema)>)

EdgeIPs = Dynamic {connectivity, type } | Static {ips, type } The anycast edge IP configuration for the hostname of this application.

One of the following:

Dynamic {connectivity, type }

connectivity?: "all"| "ipv4"| "ipv6" The IP versions supported for inbound connections on Spectrum anycast IPs.

One of the following: "all" Link to this property "ipv4" Link to this property "ipv6" Link to this property

Link to this property type?: "dynamic" 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. Link to this property

Link to this property

Static {ips, type }

ips?: Array<string> The array of customer owned IPs we broadcast via anycast for this hostname and application. Link to this property type?: "static" 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. Link to this property

Link to this property

[Link to this property](<#(resource)%20spectrum%20%3E%20(model)%20edge_ips%20%3E%20(schema)>)

OriginDNS {name, ttl, type } The name and type of DNS record for the Spectrum application.

name?: string The name of the DNS record associated with the origin. formathostname Link to this property ttl?: number The TTL of our resolution of your DNS record in seconds. minimum600 Link to this property

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

One of the following: "" Link to this property "A" Link to this property "AAAA" Link to this property "SRV" Link to this property

Link to this property

[Link to this property](<#(resource)%20spectrum%20%3E%20(model)%20origin_dns%20%3E%20(schema)>)

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.

One of the following: number Link to this property string Link to this property

[Link to this property](<#(resource)%20spectrum%20%3E%20(model)%20origin_port%20%3E%20(schema)>) #### SpectrumAnalytics #### SpectrumAnalyticsAggregates #### SpectrumAnalyticsAggregatesCurrents ##### [Get current aggregated analytics](https://developers.cloudflare.com/api/typescript/resources/spectrum/subresources/analytics/subresources/aggregates/subresources/currents/methods/get) client.spectrum.analytics.aggregates.currents.get(CurrentGetParams {zone\_id, appID, colo\_name } params, RequestOptionsoptions?): [CurrentGetResponse]() {appID, bytesEgress, bytesIngress, 2 more } GET/zones/{zone\_id}/spectrum/analytics/aggregate/current ##### ModelsExpand Collapse

CurrentGetResponse = Array<CurrentGetResponseItem>

appID: string Application identifier. maxLength32 Link to this property bytesEgress: number Number of bytes sent. Link to this property bytesIngress: number Number of bytes received. Link to this property connections: number Number of connections. Link to this property durationAvg: number Average duration of connections. Link to this property

[Link to this property](<#(resource)%20spectrum.analytics.aggregates.currents%20%3E%20(model)%20current_get_response%20%3E%20(schema)>) #### SpectrumAnalyticsEvents ##### ModelsExpand Collapse

Dimension = "event"| "appID"| "coloName"| "ipVersion"

One of the following: "event" Link to this property "appID" Link to this property "coloName" Link to this property "ipVersion" Link to this property

[Link to this property](<#(resource)%20spectrum.analytics.events%20%3E%20(model)%20dimension%20%3E%20(schema)>) #### SpectrumAnalyticsEventsBytimes ##### [Get analytics by time](https://developers.cloudflare.com/api/typescript/resources/spectrum/subresources/analytics/subresources/events/subresources/bytimes/methods/get) client.spectrum.analytics.events.bytimes.get(BytimeGetParams {zone\_id, time\_delta, dimensions, 5 more } params, RequestOptionsoptions?): [BytimeGetResponse]() {data, data\_lag, max, 5 more } GET/zones/{zone\_id}/spectrum/analytics/events/bytime ##### ModelsExpand Collapse

BytimeGetResponse {data, data\_lag, max, 5 more }

data: Array<Data> List of columns returned by the analytics query.

dimensions?: Array<string> Link to this property

metrics?: Array<number>| Array<Array<number>>

One of the following: Array<number> Link to this property Array<Array<number>> Link to this property

Link to this property

Link to this property data\_lag: number Number of seconds between current time and last processed event, i.e. how many seconds of data could be missing. minimum0 Link to this property max: Record<string, number> Maximum result for each selected metrics across all data. Link to this property min: Record<string, number> Minimum result for each selected metrics across all data. Link to this property

query: Query {dimensions, filters, limit, 4 more }

dimensions?: Array<Dimension> Can be used to break down the data by given attributes. Options are: | Dimension | Name | Example | | --- | --- | --- | | event | Connection Event | connect, progress, disconnect, originError, clientFiltered | | appID | Application ID | 40d67c87c6cd4b889a4fd57805225e85 | | coloName | Colo Name | SFO | | ipVersion | IP version used by the client | 4, 6. |

One of the following: "event" Link to this property "appID" Link to this property "coloName" Link to this property "ipVersion" Link to this property

Link to this property filters?: string Used to filter rows by one or more dimensions. Filters can be combined using OR and AND boolean logic. AND takes precedence over OR in all the expressions. The OR operator is defined using a comma (,) or OR keyword surrounded by whitespace. The AND operator is defined using a semicolon (;) or AND keyword surrounded by whitespace. Note that the semicolon is a reserved character in URLs (rfc1738) and needs to be percent-encoded as %3B. Comparison options are: | Operator | Name | URL Encoded | | --- | --- | --- | | == | Equals | %3D%3D | | != | Does not equals | !%3D | | > | Greater Than | %3E | | < | Less Than | %3C | | >= | Greater than or equal to | %3E%3D | | <= | Less than or equal to | %3C%3D | Use the above to construct filters. Link to this property limit?: number Limit number of returned metrics. Link to this property

metrics?: Array<"count"| "bytesIngress"| "bytesEgress"| 4 more> One or more metrics to compute. Options are: | Metric | Name | Example | Unit | | --- | --- | --- | --- | | count | Count of total events | 1000 | Count | | bytesIngress | Sum of ingress bytes | 1000 | Sum | | bytesEgress | Sum of egress bytes | 1000 | Sum | | durationAvg | Average connection duration | 1.0 | Time in milliseconds | | durationMedian | Median connection duration | 1.0 | Time in milliseconds | | duration90th | 90th percentile connection duration | 1.0 | Time in milliseconds | | duration99th | 99th percentile connection duration | 1.0 | Time in milliseconds. |

One of the following: "count" Link to this property "bytesIngress" Link to this property "bytesEgress" Link to this property "durationAvg" Link to this property "durationMedian" Link to this property "duration90th" Link to this property "duration99th" Link to this property

Link to this property since?: string Start of time interval to query, defaults to until - 6 hours. Timestamp must be in RFC3339 format and uses UTC unless otherwise specified. formatdate-time Link to this property sort?: Array<string> The sort order for the result set; sort fields must be included in metrics or dimensions. Link to this property until?: string End of time interval to query, defaults to current time. Timestamp must be in RFC3339 format and uses UTC unless otherwise specified. formatdate-time Link to this property

Link to this property rows: number Total number of rows in the result. minimum0 Link to this property totals: Record<string, number> Total result for each selected metrics across all data. Link to this property time\_intervals?: Array<Array<string>> List of time interval buckets: \[start, end]. Link to this property

[Link to this property](<#(resource)%20spectrum.analytics.events.bytimes%20%3E%20(model)%20bytime_get_response%20%3E%20(schema)>) #### SpectrumAnalyticsEventsSummaries ##### [Get analytics summary](https://developers.cloudflare.com/api/typescript/resources/spectrum/subresources/analytics/subresources/events/subresources/summaries/methods/get) client.spectrum.analytics.events.summaries.get(SummaryGetParams {zone\_id, dimensions, filters, 4 more } params, RequestOptionsoptions?): [SummaryGetResponse]() {data, data\_lag, max, 5 more } GET/zones/{zone\_id}/spectrum/analytics/events/summary ##### ModelsExpand Collapse

SummaryGetResponse {data, data\_lag, max, 5 more }

data: Array<Data> List of columns returned by the analytics query.

dimensions?: Array<string> Link to this property

metrics?: Array<number>| Array<Array<number>>

One of the following: Array<number> Link to this property Array<Array<number>> Link to this property

Link to this property

query: Query {dimensions, filters, limit, 4 more }

One of the following: "event" Link to this property "appID" Link to this property "coloName" Link to this property "ipVersion" Link to this property

[Link to this property](<#(resource)%20spectrum.analytics.events.summaries%20%3E%20(model)%20summary_get_response%20%3E%20(schema)>) #### SpectrumApps ##### [List Spectrum applications](https://developers.cloudflare.com/api/typescript/resources/spectrum/subresources/apps/methods/list) client.spectrum.apps.list(AppListParams {zone\_id, direction, order, 2 more } params, RequestOptionsoptions?): V4PagePaginationArray< [AppListResponse]()> GET/zones/{zone\_id}/spectrum/apps ##### [Get Spectrum application configuration](https://developers.cloudflare.com/api/typescript/resources/spectrum/subresources/apps/methods/get) client.spectrum.apps.get(stringappID, AppGetParams {zone\_id } params, RequestOptionsoptions?): [AppGetResponse]() GET/zones/{zone\_id}/spectrum/apps/{app\_id} ##### [Create Spectrum application using a name for the origin](https://developers.cloudflare.com/api/typescript/resources/spectrum/subresources/apps/methods/create) client.spectrum.apps.create(AppCreateParamsparams, RequestOptionsoptions?): [AppCreateResponse]() POST/zones/{zone\_id}/spectrum/apps ##### [Update Spectrum application configuration using a name for the origin](https://developers.cloudflare.com/api/typescript/resources/spectrum/subresources/apps/methods/update) client.spectrum.apps.update(stringappID, AppUpdateParamsparams, RequestOptionsoptions?): [AppUpdateResponse]() PUT/zones/{zone\_id}/spectrum/apps/{app\_id} ##### [Delete Spectrum application](https://developers.cloudflare.com/api/typescript/resources/spectrum/subresources/apps/methods/delete) client.spectrum.apps.delete(stringappID, AppDeleteParams {zone\_id } params, RequestOptionsoptions?): [AppDeleteResponse]() {id } | null DELETE/zones/{zone\_id}/spectrum/apps/{app\_id} ##### ModelsExpand Collapse

AppListResponse = SpectrumConfigAppConfig {id, created\_on, dns, 13 more } | SpectrumConfigPaygoAppConfig {id, created\_on, dns, 3 more }

One of the following:

SpectrumConfigAppConfig {id, created\_on, dns, 13 more }

id: string App identifier. maxLength32 Link to this property created\_on: string When the Application was created. formatdate-time Link to this property dns: DNS {name, type } The name and type of DNS record for the Spectrum application. Link to this property modified\_on: string When the Application was last modified. formatdate-time Link to this property protocol: string The port configuration at Cloudflare’s edge. May specify a single port, for example "tcp/1000", or a range of ports, for example "tcp/1000-2000". Link to this property

traffic\_type: "direct"| "http"| "https"| "worker" Determines how data travels from the edge to your origin. When set to “direct”, Spectrum will send traffic directly to your origin, and the application’s type is derived from the protocol. When set to “http” or “https”, Spectrum will apply Cloudflare’s HTTP/HTTPS features as it sends traffic to your origin, and the application type matches this property exactly. When set to “worker”, traffic is sent to the Worker specified by origin_worker_id.

One of the following: "direct" Link to this property "http" Link to this property "https" Link to this property "worker" Link to this property

Link to this property argo\_smart\_routing?: boolean Enables Argo Smart Routing for this application. Notes: Only available for TCP or UDP applications with traffic\_type set to “direct”. Link to this property edge\_ips?: EdgeIPs The anycast edge IP configuration for the hostname of this application. Link to this property ip\_firewall?: boolean Enables IP Access Rules for this application. Notes: Only available for TCP applications. Link to this property origin\_direct?: Array<string> List of origin IP addresses. Array may contain multiple IP addresses for load balancing. Link to this property origin\_dns?: OriginDNS {name, ttl, type } The name and type of DNS record for the Spectrum application. Link to this property origin\_port?: OriginPort 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. maximum65535 minimum1 Link to this property origin\_worker\_id?: string Optional Worker script tag (worker ID) to use as the application’s origin. Only supported for TCP applications with traffic\_type “worker”; mutually exclusive with origin\_direct, origin\_dns, origin\_port, proxy\_protocol, and argo\_smart\_routing. tls may only be “off” or “flexible”. Link to this property

proxy\_protocol?: "off"| "v1"| "v2"| "simple" Enables Proxy Protocol to the origin. Refer to Enable Proxy protocol for implementation details on PROXY Protocol V1, PROXY Protocol V2, and Simple Proxy Protocol.

One of the following: "off" Link to this property "v1" Link to this property "v2" Link to this property "simple" Link to this property

Link to this property

tls?: "off"| "flexible"| "full"| "strict" The type of TLS termination associated with the application.

One of the following: "off" Link to this property "flexible" Link to this property "full" Link to this property "strict" Link to this property

Link to this property virtual\_network\_id?: string Optional UUID of a virtual network for routing origin traffic through tunnel virtual networks. formatuuid Link to this property

Link to this property

SpectrumConfigPaygoAppConfig {id, created\_on, dns, 3 more }

Link to this property

[Link to this property](<#(resource)%20spectrum.apps%20%3E%20(model)%20app_list_response%20%3E%20(schema)>)

AppGetResponse = SpectrumConfigAppConfig {id, created\_on, dns, 13 more } | SpectrumConfigPaygoAppConfig {id, created\_on, dns, 3 more }

One of the following:

SpectrumConfigAppConfig {id, created\_on, dns, 13 more }

One of the following: "direct" Link to this property "http" Link to this property "https" Link to this property "worker" Link to this property

One of the following: "off" Link to this property "v1" Link to this property "v2" Link to this property "simple" Link to this property

Link to this property

tls?: "off"| "flexible"| "full"| "strict" The type of TLS termination associated with the application.

One of the following: "off" Link to this property "flexible" Link to this property "full" Link to this property "strict" Link to this property

Link to this property virtual\_network\_id?: string Optional UUID of a virtual network for routing origin traffic through tunnel virtual networks. formatuuid Link to this property

Link to this property

SpectrumConfigPaygoAppConfig {id, created\_on, dns, 3 more }

Link to this property

[Link to this property](<#(resource)%20spectrum.apps%20%3E%20(model)%20app_get_response%20%3E%20(schema)>)

AppCreateResponse = SpectrumConfigAppConfig {id, created\_on, dns, 13 more } | SpectrumConfigPaygoAppConfig {id, created\_on, dns, 3 more }

One of the following:

SpectrumConfigAppConfig {id, created\_on, dns, 13 more }

One of the following: "direct" Link to this property "http" Link to this property "https" Link to this property "worker" Link to this property

One of the following: "off" Link to this property "v1" Link to this property "v2" Link to this property "simple" Link to this property

Link to this property

tls?: "off"| "flexible"| "full"| "strict" The type of TLS termination associated with the application.

One of the following: "off" Link to this property "flexible" Link to this property "full" Link to this property "strict" Link to this property

Link to this property virtual\_network\_id?: string Optional UUID of a virtual network for routing origin traffic through tunnel virtual networks. formatuuid Link to this property

Link to this property

SpectrumConfigPaygoAppConfig {id, created\_on, dns, 3 more }

Link to this property

[Link to this property](<#(resource)%20spectrum.apps%20%3E%20(model)%20app_create_response%20%3E%20(schema)>)

AppUpdateResponse = SpectrumConfigAppConfig {id, created\_on, dns, 13 more } | SpectrumConfigPaygoAppConfig {id, created\_on, dns, 3 more }

One of the following:

SpectrumConfigAppConfig {id, created\_on, dns, 13 more }

One of the following: "direct" Link to this property "http" Link to this property "https" Link to this property "worker" Link to this property

One of the following: "off" Link to this property "v1" Link to this property "v2" Link to this property "simple" Link to this property

Link to this property

tls?: "off"| "flexible"| "full"| "strict" The type of TLS termination associated with the application.

One of the following: "off" Link to this property "flexible" Link to this property "full" Link to this property "strict" Link to this property

Link to this property virtual\_network\_id?: string Optional UUID of a virtual network for routing origin traffic through tunnel virtual networks. formatuuid Link to this property

Link to this property

SpectrumConfigPaygoAppConfig {id, created\_on, dns, 3 more }

Link to this property

[Link to this property](<#(resource)%20spectrum.apps%20%3E%20(model)%20app_update_response%20%3E%20(schema)>)

AppDeleteResponse {id }

id: string Identifier. maxLength32 Link to this property

[Link to this property](<#(resource)%20spectrum.apps%20%3E%20(model)%20app_delete_response%20%3E%20(schema)>) #### SpectrumProtocols ##### [List Spectrum application protocols](https://developers.cloudflare.com/api/typescript/resources/spectrum/subresources/protocols/methods/list) client.spectrum.protocols.list(ProtocolListParams {zone\_id } params, RequestOptionsoptions?): SinglePage< [ProtocolListResponse]() {description, name, ports, transport } > GET/zones/{zone\_id}/spectrum/protocols ##### ModelsExpand Collapse

ProtocolListResponse {description, name, ports, transport }

description: string The full name of the application protocol. Link to this property name: string The short name of the application protocol. Link to this property ports: Array<number> The available listening ports for the given protocol. Link to this property transport: string The transport layer protocol used by the application protocol Link to this property

[Link to this property](<#(resource)%20spectrum.protocols%20%3E%20(model)%20protocol_list_response%20%3E%20(schema)>)