APIs.io Engineering Platform Cloudflare Tunnel Configuration API

openapi: 3.2.0
info:
  description: 'To get started using Cloudflare''s products and services via the API, refer to [how to interact with Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), which covers using tools like [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) and the [official SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) to maintain your Cloudflare resources.


    Using the Cloudflare API requires authentication so that Cloudflare knows who is making requests and what permissions you have. Create an API token to grant access to the API to perform actions.


    To create an API token, from the Cloudflare dashboard, go to My Profile > API Tokens and select Create Token. For more information on how to create and troubleshoot API tokens, refer to

    our [API fundamentals](https://developers.cloudflare.com/fundamentals/api/).


    Totally new to Cloudflare? [Start here](https://developers.cloudflare.com/fundamentals/get-started/).'
  license:
    name: BSD-3-Clause
    url: https://opensource.org/licenses/BSD-3-Clause
  title: APIs.io Engineering Platform Cloudflare Cloudflare Tunnel Configuration API
  version: 4.0.0
tags:
- name: Cloudflare Tunnel Configuration
paths:
  /accounts/{account_id}/cfd_tunnel/{tunnel_id}/configurations:
    get:
      description: Gets the configuration for a remotely-managed tunnel
      operationId: cloudflare-tunnel-configuration-get-configuration
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/tunnel_identifier'
      - in: path
        name: tunnel_id
        required: true
        schema:
          $ref: '#/components/schemas/tunnel_tunnel_id'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tunnel_api-response-common-failure'
          description: Get configuration response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tunnel_configuration_response'
          description: Get configuration response
      security:
      - api_email: []
        api_key: []
      - api_token: []
      - user_service_key: []
      summary: APIs.io Engineering Platform Get configuration
      tags:
      - Cloudflare Tunnel Configuration
    put:
      description: Adds or updates the configuration for a remotely-managed tunnel.
      operationId: cloudflare-tunnel-configuration-put-configuration
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/tunnel_identifier'
      - in: path
        name: tunnel_id
        required: true
        schema:
          $ref: '#/components/schemas/tunnel_tunnel_id'
      requestBody:
        content:
          application/json:
            schema:
              properties:
                config:
                  $ref: '#/components/schemas/tunnel_config'
              type: object
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tunnel_api-response-common-failure'
          description: Put configuration response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tunnel_configuration_response'
          description: Put configuration response
      security:
      - api_email: []
        api_key: []
      - api_token: []
      - user_service_key: []
      summary: APIs.io Engineering Platform Put configuration
      tags:
      - Cloudflare Tunnel Configuration
components:
  schemas:
    tunnel_messages:
      example: []
      items:
        properties:
          code:
            minimum: 1000
            type: integer
          message:
            type: string
        required:
        - code
        - message
        type: object
        uniqueItems: true
      type: array
    tunnel_schemas-api-response-common:
      properties:
        errors:
          $ref: '#/components/schemas/tunnel_messages'
        messages:
          $ref: '#/components/schemas/tunnel_messages'
        success:
          description: Whether the API call was successful
          enum:
          - true
          example: true
          type: boolean
      required:
      - success
      - errors
      - messages
      type: object
    tunnel_ingressRule:
      description: Public hostname
      properties:
        hostname:
          description: Public hostname for this service.
          example: tunnel.example.com
          type: string
        originRequest:
          $ref: '#/components/schemas/tunnel_originRequest'
        path:
          default: ''
          description: Requests with this path route to this public hostname.
          example: subpath
          type: string
        service:
          description: 'Protocol and address of destination server. Supported protocols: http://, https://, unix://, tcp://, ssh://, rdp://, unix+tls://, smb://. Alternatively can return a HTTP status code http_status:[code] e.g. ''http_status:404''.

            '
          example: https://localhost:8001
          type: string
      required:
      - hostname
      - service
      type: object
    tunnel_schemas-api-response-single:
      allOf:
      - $ref: '#/components/schemas/tunnel_schemas-api-response-common'
      type: object
    tunnel_schemas-config_version:
      description: The version of the Tunnel Configuration.
      type: integer
    tunnel_api-response-common-failure:
      properties:
        errors:
          allOf:
          - $ref: '#/components/schemas/tunnel_messages'
          example:
          - code: 7003
            message: No route for the URI
          minLength: 1
        messages:
          allOf:
          - $ref: '#/components/schemas/tunnel_messages'
          example: []
        result:
          enum:
          - null
          type:
          - object
          - 'null'
        success:
          description: Whether the API call was successful
          enum:
          - false
          example: false
          type: boolean
      required:
      - success
      - errors
      - messages
      - result
      type: object
    tunnel_tunnel_id:
      description: UUID of the tunnel.
      example: f70ff985-a4ef-4643-bbbc-4a0ed4fc8415
      format: uuid
      maxLength: 36
      readOnly: true
      type: string
    tunnel_originRequest:
      description: Configuration parameters for the public hostname specific connection settings between cloudflared and origin server.
      properties:
        access:
          description: For all L7 requests to this hostname, cloudflared will validate each request's Cf-Access-Jwt-Assertion request header.
          properties:
            audTag:
              description: Access applications that are allowed to reach this hostname for this Tunnel. Audience tags can be identified in the dashboard or via the List Access policies API.
              items:
                type: string
              type: array
            required:
              default: false
              description: Deny traffic that has not fulfilled Access authorization.
              type: boolean
            teamName:
              default: Your Zero Trust organization name.
              type: string
          required:
          - audTag
          - teamName
          type: object
        caPool:
          default: ''
          description: Path to the certificate authority (CA) for the certificate of your origin. This option should be used only if your certificate is not signed by Cloudflare.
          type: string
        connectTimeout:
          default: 10
          description: Timeout for establishing a new TCP connection to your origin server. This excludes the time taken to establish TLS, which is controlled by tlsTimeout.
          type: integer
        disableChunkedEncoding:
          description: Disables chunked transfer encoding. Useful if you are running a WSGI server.
          type: boolean
        http2Origin:
          description: Attempt to connect to origin using HTTP2. Origin must be configured as https.
          type: boolean
        httpHostHeader:
          description: Sets the HTTP Host header on requests sent to the local service.
          type: string
        keepAliveConnections:
          default: 100
          description: Maximum number of idle keepalive connections between Tunnel and your origin. This does not restrict the total number of concurrent connections.
          type: integer
        keepAliveTimeout:
          default: 90
          description: Timeout after which an idle keepalive connection can be discarded.
          type: integer
        noHappyEyeballs:
          default: false
          description: Disable the “happy eyeballs” algorithm for IPv4/IPv6 fallback if your local network has misconfigured one of the protocols.
          type: boolean
        noTLSVerify:
          default: false
          description: Disables TLS verification of the certificate presented by your origin. Will allow any certificate from the origin to be accepted.
          type: boolean
        originServerName:
          default: ''
          description: Hostname that cloudflared should expect from your origin server certificate.
          type: string
        proxyType:
          default: ''
          description: 'cloudflared starts a proxy server to translate HTTP traffic into TCP when proxying, for example, SSH or RDP. This configures what type of proxy will be started. Valid options are: "" for the regular proxy and "socks" for a SOCKS5 proxy.

            '
          type: string
        tcpKeepAlive:
          default: 30
          description: The timeout after which a TCP keepalive packet is sent on a connection between Tunnel and the origin server.
          type: integer
        tlsTimeout:
          default: 10
          description: Timeout for completing a TLS handshake to your origin server, if you have chosen to connect Tunnel to an HTTPS server.
          type: integer
      type: object
    tunnel_configuration_response:
      allOf:
      - $ref: '#/components/schemas/tunnel_schemas-api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/tunnel_configuration'
    tunnel_config:
      description: The tunnel configuration and ingress rules.
      properties:
        ingress:
          description: List of public hostname definitions. At least one ingress rule needs to be defined for the tunnel.
          items:
            $ref: '#/components/schemas/tunnel_ingressRule'
          minItems: 1
          type: array
        originRequest:
          $ref: '#/components/schemas/tunnel_originRequest'
        warp-routing:
          description: Enable private network access from WARP users to private network routes. This is enabled if the tunnel has an assigned route.
          properties:
            enabled:
              default: false
              type: boolean
          readOnly: true
          type: object
      type: object
    tunnel_identifier:
      description: Identifier
      example: 023e105f4ecef8ad9ca31a8372d0c353
      maxLength: 32
      type: string
    tunnel_timestamp:
      example: '2014-01-01T05:20:00.12345Z'
      format: date-time
      type: string
    tunnel_configuration:
      description: Cloudflare Tunnel configuration
      properties:
        account_id:
          $ref: '#/components/schemas/tunnel_identifier'
        config:
          $ref: '#/components/schemas/tunnel_config'
        created_at:
          $ref: '#/components/schemas/tunnel_timestamp'
        source:
          $ref: '#/components/schemas/tunnel_schemas-config_src'
        tunnel_id:
          $ref: '#/components/schemas/tunnel_tunnel_id'
        version:
          $ref: '#/components/schemas/tunnel_schemas-config_version'
      type: object
    tunnel_schemas-config_src:
      default: local
      description: 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 tunnel's configuration on the Zero Trust dashboard.
      enum:
      - local
      - cloudflare
      example: cloudflare
      type: string
  securitySchemes:
    api_email:
      in: header
      name: X-Auth-Email
      type: apiKey
    api_key:
      in: header
      name: X-Auth-Key
      type: apiKey
    api_token:
      scheme: bearer
      type: http
    user_service_key:
      in: header
      name: X-Auth-User-Service-Key
      type: apiKey