Skip to content
Start here

Apps

List Spectrum applications
GET/zones/{zone_id}/spectrum/apps
Get Spectrum application configuration
GET/zones/{zone_id}/spectrum/apps/{app_id}
Delete Spectrum application
DELETE/zones/{zone_id}/spectrum/apps/{app_id}
ModelsExpand Collapse
AppListResponse = object { id, created_on, dns, 11 more } or object { id, created_on, dns, 3 more }
One of the following:
SpectrumConfigAppConfig = object { id, created_on, dns, 11 more }
id: string

App identifier.

maxLength32
created_on: string

When the Application was created.

formatdate-time
dns: DNS { name, type }

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

modified_on: string

When the Application was last modified.

formatdate-time
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".

traffic_type: "direct" or "http" or "https"

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.

One of the following:
"direct"
"http"
"https"
argo_smart_routing: optional boolean

Enables Argo Smart Routing for this application. Notes: Only available for TCP applications with traffic_type set to "direct".

edge_ips: optional EdgeIPs

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

ip_firewall: optional boolean

Enables IP Access Rules for this application. Notes: Only available for TCP applications.

origin_direct: optional array of string

List of origin IP addresses. Array may contain multiple IP addresses for load balancing.

origin_dns: optional OriginDNS { name, ttl, type }

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

origin_port: optional 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
proxy_protocol: optional "off" or "v1" or "v2" or "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"
"v1"
"v2"
"simple"
tls: optional "off" or "flexible" or "full" or "strict"

The type of TLS termination associated with the application.

One of the following:
"off"
"flexible"
"full"
"strict"
SpectrumConfigPaygoAppConfig = object { id, created_on, dns, 3 more }
id: string

App identifier.

maxLength32
created_on: string

When the Application was created.

formatdate-time
dns: DNS { name, type }

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

modified_on: string

When the Application was last modified.

formatdate-time
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".

origin_direct: optional array of string

List of origin IP addresses. Array may contain multiple IP addresses for load balancing.

AppGetResponse = object { id, created_on, dns, 11 more } or object { id, created_on, dns, 3 more }
One of the following:
SpectrumConfigAppConfig = object { id, created_on, dns, 11 more }
id: string

App identifier.

maxLength32
created_on: string

When the Application was created.

formatdate-time
dns: DNS { name, type }

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

modified_on: string

When the Application was last modified.

formatdate-time
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".

traffic_type: "direct" or "http" or "https"

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.

One of the following:
"direct"
"http"
"https"
argo_smart_routing: optional boolean

Enables Argo Smart Routing for this application. Notes: Only available for TCP applications with traffic_type set to "direct".

edge_ips: optional EdgeIPs

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

ip_firewall: optional boolean

Enables IP Access Rules for this application. Notes: Only available for TCP applications.

origin_direct: optional array of string

List of origin IP addresses. Array may contain multiple IP addresses for load balancing.

origin_dns: optional OriginDNS { name, ttl, type }

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

origin_port: optional 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
proxy_protocol: optional "off" or "v1" or "v2" or "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"
"v1"
"v2"
"simple"
tls: optional "off" or "flexible" or "full" or "strict"

The type of TLS termination associated with the application.

One of the following:
"off"
"flexible"
"full"
"strict"
SpectrumConfigPaygoAppConfig = object { id, created_on, dns, 3 more }
id: string

App identifier.

maxLength32
created_on: string

When the Application was created.

formatdate-time
dns: DNS { name, type }

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

modified_on: string

When the Application was last modified.

formatdate-time
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".

origin_direct: optional array of string

List of origin IP addresses. Array may contain multiple IP addresses for load balancing.

AppCreateResponse = object { id, created_on, dns, 11 more } or object { id, created_on, dns, 3 more }
One of the following:
SpectrumConfigAppConfig = object { id, created_on, dns, 11 more }
id: string

App identifier.

maxLength32
created_on: string

When the Application was created.

formatdate-time
dns: DNS { name, type }

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

modified_on: string

When the Application was last modified.

formatdate-time
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".

traffic_type: "direct" or "http" or "https"

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.

One of the following:
"direct"
"http"
"https"
argo_smart_routing: optional boolean

Enables Argo Smart Routing for this application. Notes: Only available for TCP applications with traffic_type set to "direct".

edge_ips: optional EdgeIPs

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

ip_firewall: optional boolean

Enables IP Access Rules for this application. Notes: Only available for TCP applications.

origin_direct: optional array of string

List of origin IP addresses. Array may contain multiple IP addresses for load balancing.

origin_dns: optional OriginDNS { name, ttl, type }

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

origin_port: optional 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
proxy_protocol: optional "off" or "v1" or "v2" or "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"
"v1"
"v2"
"simple"
tls: optional "off" or "flexible" or "full" or "strict"

The type of TLS termination associated with the application.

One of the following:
"off"
"flexible"
"full"
"strict"
SpectrumConfigPaygoAppConfig = object { id, created_on, dns, 3 more }
id: string

App identifier.

maxLength32
created_on: string

When the Application was created.

formatdate-time
dns: DNS { name, type }

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

modified_on: string

When the Application was last modified.

formatdate-time
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".

origin_direct: optional array of string

List of origin IP addresses. Array may contain multiple IP addresses for load balancing.

AppUpdateResponse = object { id, created_on, dns, 11 more } or object { id, created_on, dns, 3 more }
One of the following:
SpectrumConfigAppConfig = object { id, created_on, dns, 11 more }
id: string

App identifier.

maxLength32
created_on: string

When the Application was created.

formatdate-time
dns: DNS { name, type }

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

modified_on: string

When the Application was last modified.

formatdate-time
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".

traffic_type: "direct" or "http" or "https"

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.

One of the following:
"direct"
"http"
"https"
argo_smart_routing: optional boolean

Enables Argo Smart Routing for this application. Notes: Only available for TCP applications with traffic_type set to "direct".

edge_ips: optional EdgeIPs

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

ip_firewall: optional boolean

Enables IP Access Rules for this application. Notes: Only available for TCP applications.

origin_direct: optional array of string

List of origin IP addresses. Array may contain multiple IP addresses for load balancing.

origin_dns: optional OriginDNS { name, ttl, type }

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

origin_port: optional 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
proxy_protocol: optional "off" or "v1" or "v2" or "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"
"v1"
"v2"
"simple"
tls: optional "off" or "flexible" or "full" or "strict"

The type of TLS termination associated with the application.

One of the following:
"off"
"flexible"
"full"
"strict"
SpectrumConfigPaygoAppConfig = object { id, created_on, dns, 3 more }
id: string

App identifier.

maxLength32
created_on: string

When the Application was created.

formatdate-time
dns: DNS { name, type }

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

modified_on: string

When the Application was last modified.

formatdate-time
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".

origin_direct: optional array of string

List of origin IP addresses. Array may contain multiple IP addresses for load balancing.

AppDeleteResponse = object { id }
id: string

Identifier.

maxLength32