Spectrum
ModelsExpand Collapse
The anycast edge IP configuration for the hostname of this application.
The anycast edge IP configuration for the hostname of this application.
Union[int, str]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.
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.
SpectrumAnalytics
SpectrumAnalyticsAggregates
SpectrumAnalyticsAggregatesCurrents
Get current aggregated analytics
SpectrumAnalyticsEventsBytimes
Get analytics by time
ModelsExpand Collapse
class BytimeGetResponse: …
Number of seconds between current time and last processed event, i.e. how many seconds of data could be missing.
query: Query
Can be used to break down the data by given attributes. Options are:
Dimension
Name
Example
event
Connection Event
connect, progress, disconnect, originError, clientFiltered
appID
Application ID
40d67c87c6cd4b889a4fd57805225e85
coloName
Colo Name
SFO
ipVersion
IP version used by the client
4, 6.
Can be used to break down the data by given attributes. Options are:
| Dimension | Name | Example |
|---|---|---|
| event | Connection Event | connect, progress, disconnect, originError, clientFiltered |
| appID | Application ID | 40d67c87c6cd4b889a4fd57805225e85 |
| coloName | Colo Name | SFO |
| ipVersion | IP version used by the client | 4, 6. |
Used to filter rows by one or more dimensions. Filters can be combined using OR and AND boolean logic. AND takes precedence over OR in all the expressions. The OR operator is defined using a comma (,) or OR keyword surrounded by whitespace. The AND operator is defined using a semicolon (;) or AND keyword surrounded by whitespace. Note that the semicolon is a reserved character in URLs (rfc1738) and needs to be percent-encoded as %3B. Comparison options are:
| Operator | Name | URL Encoded |
|---|---|---|
| == | Equals | %3D%3D |
| != | Does not equals | !%3D |
| > | Greater Than | %3E |
| < | Less Than | %3C |
| >= | Greater than or equal to | %3E%3D |
| <= | Less than or equal to | %3C%3D |
metrics: Optional[List[Literal["count", "bytesIngress", "bytesEgress", 4 more]]]One or more metrics to compute. Options are:
Metric
Name
Example
Unit
count
Count of total events
1000
Count
bytesIngress
Sum of ingress bytes
1000
Sum
bytesEgress
Sum of egress bytes
1000
Sum
durationAvg
Average connection duration
1.0
Time in milliseconds
durationMedian
Median connection duration
1.0
Time in milliseconds
duration90th
90th percentile connection duration
1.0
Time in milliseconds
duration99th
99th percentile connection duration
1.0
Time in milliseconds.
One or more metrics to compute. Options are:
| Metric | Name | Example | Unit |
|---|---|---|---|
| count | Count of total events | 1000 | Count |
| bytesIngress | Sum of ingress bytes | 1000 | Sum |
| bytesEgress | Sum of egress bytes | 1000 | Sum |
| durationAvg | Average connection duration | 1.0 | Time in milliseconds |
| durationMedian | Median connection duration | 1.0 | Time in milliseconds |
| duration90th | 90th percentile connection duration | 1.0 | Time in milliseconds |
| duration99th | 99th percentile connection duration | 1.0 | Time in milliseconds. |
Start of time interval to query, defaults to until - 6 hours. Timestamp must be in RFC3339 format and uses UTC unless otherwise specified.
SpectrumAnalyticsEventsSummaries
Get analytics summary
ModelsExpand Collapse
class SummaryGetResponse: …
Number of seconds between current time and last processed event, i.e. how many seconds of data could be missing.
query: Query
Can be used to break down the data by given attributes. Options are:
Dimension
Name
Example
event
Connection Event
connect, progress, disconnect, originError, clientFiltered
appID
Application ID
40d67c87c6cd4b889a4fd57805225e85
coloName
Colo Name
SFO
ipVersion
IP version used by the client
4, 6.
Can be used to break down the data by given attributes. Options are:
| Dimension | Name | Example |
|---|---|---|
| event | Connection Event | connect, progress, disconnect, originError, clientFiltered |
| appID | Application ID | 40d67c87c6cd4b889a4fd57805225e85 |
| coloName | Colo Name | SFO |
| ipVersion | IP version used by the client | 4, 6. |
Used to filter rows by one or more dimensions. Filters can be combined using OR and AND boolean logic. AND takes precedence over OR in all the expressions. The OR operator is defined using a comma (,) or OR keyword surrounded by whitespace. The AND operator is defined using a semicolon (;) or AND keyword surrounded by whitespace. Note that the semicolon is a reserved character in URLs (rfc1738) and needs to be percent-encoded as %3B. Comparison options are:
| Operator | Name | URL Encoded |
|---|---|---|
| == | Equals | %3D%3D |
| != | Does not equals | !%3D |
| > | Greater Than | %3E |
| < | Less Than | %3C |
| >= | Greater than or equal to | %3E%3D |
| <= | Less than or equal to | %3C%3D |
metrics: Optional[List[Literal["count", "bytesIngress", "bytesEgress", 4 more]]]One or more metrics to compute. Options are:
Metric
Name
Example
Unit
count
Count of total events
1000
Count
bytesIngress
Sum of ingress bytes
1000
Sum
bytesEgress
Sum of egress bytes
1000
Sum
durationAvg
Average connection duration
1.0
Time in milliseconds
durationMedian
Median connection duration
1.0
Time in milliseconds
duration90th
90th percentile connection duration
1.0
Time in milliseconds
duration99th
99th percentile connection duration
1.0
Time in milliseconds.
One or more metrics to compute. Options are:
| Metric | Name | Example | Unit |
|---|---|---|---|
| count | Count of total events | 1000 | Count |
| bytesIngress | Sum of ingress bytes | 1000 | Sum |
| bytesEgress | Sum of egress bytes | 1000 | Sum |
| durationAvg | Average connection duration | 1.0 | Time in milliseconds |
| durationMedian | Median connection duration | 1.0 | Time in milliseconds |
| duration90th | 90th percentile connection duration | 1.0 | Time in milliseconds |
| duration99th | 99th percentile connection duration | 1.0 | Time in milliseconds. |
Start of time interval to query, defaults to until - 6 hours. Timestamp must be in RFC3339 format and uses UTC unless otherwise specified.
SpectrumApps
List Spectrum applications
Get Spectrum application configuration
Create Spectrum application using a name for the origin
Update Spectrum application configuration using a name for the origin
Delete Spectrum application
ModelsExpand Collapse
class SpectrumConfigAppConfig: …
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.
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.
Enables Argo Smart Routing for this application. Notes: Only available for TCP applications with traffic_type set to "direct".
Enables IP Access Rules for this application. Notes: Only available for TCP applications.
List of origin IP addresses. Array may contain multiple IP addresses for load balancing.
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.
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.
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.
class SpectrumConfigAppConfig: …
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.
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.
Enables Argo Smart Routing for this application. Notes: Only available for TCP applications with traffic_type set to "direct".
Enables IP Access Rules for this application. Notes: Only available for TCP applications.
List of origin IP addresses. Array may contain multiple IP addresses for load balancing.
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.
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.
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.
class SpectrumConfigAppConfig: …
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.
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.
Enables Argo Smart Routing for this application. Notes: Only available for TCP applications with traffic_type set to "direct".
Enables IP Access Rules for this application. Notes: Only available for TCP applications.
List of origin IP addresses. Array may contain multiple IP addresses for load balancing.
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.
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.
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.
class SpectrumConfigAppConfig: …
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.
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.
Enables Argo Smart Routing for this application. Notes: Only available for TCP applications with traffic_type set to "direct".
Enables IP Access Rules for this application. Notes: Only available for TCP applications.
List of origin IP addresses. Array may contain multiple IP addresses for load balancing.
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.
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.
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.