Skip to content
Cloudflare API
Start here
API Reference
Spectrum

Apps

List Spectrum applications
spectrum.apps.list(AppListParams**kwargs) -> SyncV4PagePaginationArray[AppListResponse]
GET/zones/{zone_id}/spectrum/apps
Get Spectrum application configuration
spectrum.apps.get(strapp_id, AppGetParams**kwargs) -> AppGetResponse
GET/zones/{zone_id}/spectrum/apps/{app_id}
Create Spectrum application using a name for the origin
spectrum.apps.create(AppCreateParams**kwargs) -> AppCreateResponse
POST/zones/{zone_id}/spectrum/apps
Update Spectrum application configuration using a name for the origin
spectrum.apps.update(strapp_id, AppUpdateParams**kwargs) -> AppUpdateResponse
PUT/zones/{zone_id}/spectrum/apps/{app_id}
Delete Spectrum application
spectrum.apps.delete(strapp_id, AppDeleteParams**kwargs) -> AppDeleteResponse
DELETE/zones/{zone_id}/spectrum/apps/{app_id}
ModelsExpand Collapse
One of the following:
class SpectrumConfigAppConfig: …
id: str

App identifier.

maxLength32
created_on: datetime

When the Application was created.

formatdate-time
dns: DNS

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

modified_on: datetime

When the Application was last modified.

formatdate-time
protocol: str

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: Literal["direct", "http", "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[bool]

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[bool]

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

origin_direct: Optional[List[str]]

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

origin_dns: Optional[OriginDNS]

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[Literal["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"
"v1"
"v2"
"simple"
tls: Optional[Literal["off", "flexible", "full", "strict"]]

The type of TLS termination associated with the application.

One of the following:
"off"
"flexible"
"full"
"strict"
class SpectrumConfigPaygoAppConfig: …
id: str

App identifier.

maxLength32
created_on: datetime

When the Application was created.

formatdate-time
dns: DNS

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

modified_on: datetime

When the Application was last modified.

formatdate-time
protocol: str

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[List[str]]

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

One of the following:
class SpectrumConfigAppConfig: …
id: str

App identifier.

maxLength32
created_on: datetime

When the Application was created.

formatdate-time
dns: DNS

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

modified_on: datetime

When the Application was last modified.

formatdate-time
protocol: str

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: Literal["direct", "http", "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[bool]

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[bool]

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

origin_direct: Optional[List[str]]

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

origin_dns: Optional[OriginDNS]

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[Literal["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"
"v1"
"v2"
"simple"
tls: Optional[Literal["off", "flexible", "full", "strict"]]

The type of TLS termination associated with the application.

One of the following:
"off"
"flexible"
"full"
"strict"
class SpectrumConfigPaygoAppConfig: …
id: str

App identifier.

maxLength32
created_on: datetime

When the Application was created.

formatdate-time
dns: DNS

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

modified_on: datetime

When the Application was last modified.

formatdate-time
protocol: str

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[List[str]]

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

One of the following:
class SpectrumConfigAppConfig: …
id: str

App identifier.

maxLength32
created_on: datetime

When the Application was created.

formatdate-time
dns: DNS

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

modified_on: datetime

When the Application was last modified.

formatdate-time
protocol: str

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: Literal["direct", "http", "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[bool]

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[bool]

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

origin_direct: Optional[List[str]]

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

origin_dns: Optional[OriginDNS]

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[Literal["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"
"v1"
"v2"
"simple"
tls: Optional[Literal["off", "flexible", "full", "strict"]]

The type of TLS termination associated with the application.

One of the following:
"off"
"flexible"
"full"
"strict"
class SpectrumConfigPaygoAppConfig: …
id: str

App identifier.

maxLength32
created_on: datetime

When the Application was created.

formatdate-time
dns: DNS

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

modified_on: datetime

When the Application was last modified.

formatdate-time
protocol: str

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[List[str]]

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

One of the following:
class SpectrumConfigAppConfig: …
id: str

App identifier.

maxLength32
created_on: datetime

When the Application was created.

formatdate-time
dns: DNS

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

modified_on: datetime

When the Application was last modified.

formatdate-time
protocol: str

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: Literal["direct", "http", "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[bool]

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[bool]

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

origin_direct: Optional[List[str]]

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

origin_dns: Optional[OriginDNS]

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[Literal["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"
"v1"
"v2"
"simple"
tls: Optional[Literal["off", "flexible", "full", "strict"]]

The type of TLS termination associated with the application.

One of the following:
"off"
"flexible"
"full"
"strict"
class SpectrumConfigPaygoAppConfig: …
id: str

App identifier.

maxLength32
created_on: datetime

When the Application was created.

formatdate-time
dns: DNS

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

modified_on: datetime

When the Application was last modified.

formatdate-time
protocol: str

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[List[str]]

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

class AppDeleteResponse: …
id: str

Identifier.

maxLength32