Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

APIs.io Engineering Platform Cloudflare Tunnel Configuration API

The Cloudflare Tunnel Configuration API from APIs.io Engineering Platform — 1 operation(s) for cloudflare tunnel configuration.

This API exposes 2 operations across 1 path, and defines 14 schemas. It is described by OpenAPI 3.0.0, at version 2015-07-09.

Requests are made against 4 base URLs: http://apigateway.{region}.amazonaws.com, https://apigateway.{region}.amazonaws.com, http://apigateway.{region}.amazonaws.com.cn, https://apigateway.{region}.amazonaws.com.cn.

2 operations 1 paths 14 schemas 1 GET1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
2015-07-09
Base URL
https://{bucketname}.s3.amazonaws.com
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

APIs.io Engineering Platform Cloudflare Tunnel Configuration API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (hmac). By default, every request must be authenticated.

  • hmac — Amazon Signature authorization v4

Paths & Operations 2

Across 1 path, the API surfaces 2 operations — 1 GET, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Cloudflare Tunnel Configuration 2
GET
/accounts/{account_id}/cfd_tunnel/{tunnel_id}/configurations
APIs.io Engineering Platform Get configuration
cloudflare-tunnel-configuration-get-configuration 2 params → 4XX200
PUT
/accounts/{account_id}/cfd_tunnel/{tunnel_id}/configurations
APIs.io Engineering Platform Put configuration
cloudflare-tunnel-configuration-put-configuration 2 params body → 4XX200

Schemas 14

The contract defines 14 schemas that model the data the API accepts and returns. The most detailed are tunnel_originRequest (14 properties), tunnel_configuration (6 properties), tunnel_ingressRule (4 properties), tunnel_api-response-common-failure (4 properties). Each schema is shown below with its type and property counts.

tunnel_api-response-common-failure
object
4 properties 4 required
tunnel_configuration_response
tunnel_originRequest
object
Configuration parameters for the public hostname specific connection settings between cloudflared and origin server.
14 properties
tunnel_schemas-api-response-common
object
3 properties 3 required
tunnel_tunnel_id
string
UUID of the tunnel.
tunnel_messages
array
tunnel_schemas-config_src
string
Indicates if this is a locally or remotely configured tunnel. If local, manage the tunnel using a YAML file on the origin machine. If cloudflare, manage the tu…
tunnel_identifier
string
Identifier
tunnel_schemas-api-response-single
object
tunnel_timestamp
string
tunnel_ingressRule
object
Public hostname
4 properties 2 required
tunnel_schemas-config_version
integer
The version of the Tunnel Configuration.
tunnel_config
object
The tunnel configuration and ingress rules.
3 properties
tunnel_configuration
object
Cloudflare Tunnel configuration
6 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

engineering-platform-cloudflare-tunnel-configuration-api-openapi.yml Raw ↑