Create Spectrum application using a name for the origin

Creates a new Spectrum application from a configuration using a name for the origin.

Request

Path Params

zone

string

required

Body Params application/json

argo_smart_routing

boolean

optional

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

Default:

false

Example:

true

dns

object (dns)

required

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

name

string <hostname>

optional

The name of the DNS record associated with the application.

Example:

ssh.example.com

type

enum<string>

optional

The type of DNS record associated with the application.

Allowed values:

CNAMEADDRESS

Example:

CNAME

edge_ips

optional

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

One of

object

Default:

{"connectivity":"all","type":"dynamic"}

connectivity

enum<string>

optional

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

Allowed values:

allipv4ipv6

Example:

all

type

enum<string>

optional

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.

Allowed value:

dynamic

Example:

dynamic

ip_firewall

boolean

optional

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

Example:

true

origin_dns

object (origin_dns)

required

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

name

string <hostname>

optional

The name of the DNS record associated with the origin.

Example:

origin.example.com

ttl

integer

optional

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

>= 600

type

enum<string>

optional

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

Allowed values:

AAAAASRV

Example:

origin_port

required

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.

Any of

integer

allOf {2}

>= 1<= 65535

Example:

protocol

string

required

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

Example:

tcp/22

proxy_protocol

enum<string>

optional

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.

Allowed values:

offv1v2simple

Default:

off

Example:

off

tls

enum<string>

optional

The type of TLS termination associated with the application.

Allowed values:

offflexiblefullstrict

Example:

full

traffic_type

enum<string>

optional

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.

Allowed values:

directhttphttps

Default:

direct

Example:

direct

Example

{
    "argo_smart_routing": true,
    "dns": {
        "name": "ssh.example.com",
        "type": "CNAME"
    },
    "edge_ips": {
        "connectivity": "all",
        "type": "dynamic"
    },
    "ip_firewall": true,
    "origin_dns": {
        "name": "origin.example.com",
        "ttl": 600,
        "type": ""
    },
    "origin_port": 22,
    "protocol": "tcp/22",
    "proxy_protocol": "off",
    "tls": "full",
    "traffic_type": "direct"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Create Spectrum application using a name for the origin response

application/json

Body

allOf {2}

optional

object (api-response-single)

optional

errors

array [object {2}]

messages

required

Example:

[]

messages

array [object {2}]

messages

required

Example:

[]

result

required

success

enum<boolean>

required

Whether the API call was successful

Allowed value:

true

Example:

true

object

optional

result

object

optional

Example

{
    "errors": [],
    "messages": [],
    "result": {
        "argo_smart_routing": true,
        "created_on": "2014-01-02T02:20:00Z",
        "dns": {
            "name": "ssh.example.com",
            "type": "CNAME"
        },
        "edge_ips": {
            "connectivity": "all",
            "type": "dynamic"
        },
        "id": "ea95132c15732412d22c1476fa83f27a",
        "ip_firewall": true,
        "modified_on": "2014-01-02T02:20:00Z",
        "origin_dns": {
            "name": "origin.example.com",
            "ttl": 600,
            "type": ""
        },
        "origin_port": 22,
        "protocol": "tcp/22",
        "proxy_protocol": "off",
        "tls": "full",
        "traffic_type": "direct"
    },
    "success": true
}

🟢200Create Spectrum application using a name for the origin response failure