Skip to content
Cloudflare API
Start here
API Reference
Spectrum
Apps

Get Spectrum application configuration

spectrum.apps.get(strapp_id, AppGetParams**kwargs) -> AppGetResponse
GET/zones/{zone_id}/spectrum/apps/{app_id}

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

Security
API Token

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

Example:Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY
API Email + API Key

The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.

Example:X-Auth-Email: user@example.com

The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.

Example:X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194
Accepted Permissions (at least one required)
Zone Settings WriteZone Settings Read
ParametersExpand Collapse
zone_id: str

Zone identifier.

maxLength32
app_id: str

App identifier.

maxLength32
ReturnsExpand 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.

name: Optional[str]

The name of the DNS record associated with the application.

formathostname
type: Optional[Literal["CNAME", "ADDRESS"]]

The type of DNS record associated with the application.

One of the following:
"CNAME"
"ADDRESS"
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.

One of the following:
class Dynamic: …
connectivity: Optional[Literal["all", "ipv4", "ipv6"]]

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

One of the following:
"all"
"ipv4"
"ipv6"
type: Optional[Literal["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.

class Static: …
ips: Optional[List[str]]

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

type: Optional[Literal["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.

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.

name: Optional[str]

The name of the DNS record associated with the origin.

formathostname
ttl: Optional[int]

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

minimum600
type: Optional[Literal["", "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:
""
"A"
"AAAA"
"SRV"
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
One of the following:
int
str
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.

name: Optional[str]

The name of the DNS record associated with the application.

formathostname
type: Optional[Literal["CNAME", "ADDRESS"]]

The type of DNS record associated with the application.

One of the following:
"CNAME"
"ADDRESS"
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.

Get Spectrum application configuration

import os
from cloudflare import Cloudflare

client = Cloudflare(
    api_token=os.environ.get("CLOUDFLARE_API_TOKEN"),  # This is the default and can be omitted
)
app = client.spectrum.apps.get(
    app_id="023e105f4ecef8ad9ca31a8372d0c353",
    zone_id="023e105f4ecef8ad9ca31a8372d0c353",
)
print(app)
{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "success": true,
  "result": {
    "id": "023e105f4ecef8ad9ca31a8372d0c353",
    "created_on": "2014-01-01T05:20:00.12345Z",
    "dns": {
      "name": "ssh.example.com",
      "type": "CNAME"
    },
    "modified_on": "2014-01-01T05:20:00.12345Z",
    "protocol": "tcp/22",
    "traffic_type": "direct",
    "argo_smart_routing": true,
    "edge_ips": {
      "connectivity": "all",
      "type": "dynamic"
    },
    "ip_firewall": false,
    "origin_direct": [
      "tcp://127.0.0.1:8080"
    ],
    "origin_dns": {
      "name": "origin.example.com",
      "ttl": 600,
      "type": ""
    },
    "origin_port": 22,
    "proxy_protocol": "off",
    "tls": "off"
  }
}
Returns Examples
{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "success": true,
  "result": {
    "id": "023e105f4ecef8ad9ca31a8372d0c353",
    "created_on": "2014-01-01T05:20:00.12345Z",
    "dns": {
      "name": "ssh.example.com",
      "type": "CNAME"
    },
    "modified_on": "2014-01-01T05:20:00.12345Z",
    "protocol": "tcp/22",
    "traffic_type": "direct",
    "argo_smart_routing": true,
    "edge_ips": {
      "connectivity": "all",
      "type": "dynamic"
    },
    "ip_firewall": false,
    "origin_direct": [
      "tcp://127.0.0.1:8080"
    ],
    "origin_dns": {
      "name": "origin.example.com",
      "ttl": 600,
      "type": ""
    },
    "origin_port": 22,
    "proxy_protocol": "off",
    "tls": "off"
  }
}