--- title: Get Spectrum application configuration --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/typescript) [Spectrum](https://developers.cloudflare.com/api/typescript/resources/spectrum) [Apps](https://developers.cloudflare.com/api/typescript/resources/spectrum/subresources/apps) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Get Spectrum application configuration client.spectrum.apps.get(stringappID, AppGetParams {zone\_id } params, RequestOptionsoptions?): [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 Write``Zone Settings Read` ##### ParametersExpand Collapse appID: string App identifier. maxLength32 [Link to this property](<#(resource)%20spectrum.apps%20%3E%20(method)%20get%20%3E%20(params)%20default%20%3E%20(param)%20app_id%20%3E%20(schema)>)
params: AppGetParams {zone\_id } zone\_id: string Zone identifier. maxLength32 Link to this property
[Link to this property](<#(resource)%20spectrum.apps%20%3E%20(method)%20get%20%3E%20(params)%20default>) ##### ReturnsExpand Collapse
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 } 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. 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 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. 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 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. 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
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 One of the following: number Link to this property string Link to this property
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 } 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. 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 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 origin\_direct?: Array<string> List of origin IP addresses. Array may contain multiple IP addresses for load balancing. Link to this property
Link to this property
[Link to this property](<#(resource)%20spectrum.apps%20%3E%20(model)%20app_get_response%20%3E%20(schema)>) ### Get Spectrum application configuration TypeScript HTTPTypeScriptPythonGoTerraform ``` import Cloudflare from 'cloudflare'; const client = new Cloudflare({ apiToken: process.env['CLOUDFLARE_API_TOKEN'], // This is the default and can be omitted }); const app = await client.spectrum.apps.get('023e105f4ecef8ad9ca31a8372d0c353', { zone_id: '023e105f4ecef8ad9ca31a8372d0c353', }); console.log(app); ``` 200 example ``` { "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, "origin_worker_id": "277b7815c871434b960b60729659000a", "proxy_protocol": "off", "tls": "off", "virtual_network_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e" } } ``` ##### Returns Examples 200 example ``` { "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, "origin_worker_id": "277b7815c871434b960b60729659000a", "proxy_protocol": "off", "tls": "off", "virtual_network_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e" } } ```