tunnel_config

The tunnel configuration and ingress rules.

APIs.ioEngineeringPlatform

Properties

Name Type Description
ingress array List of public hostname definitions. At least one ingress rule needs to be defined for the tunnel.
originRequest object
warp-routing object Enable private network access from WARP users to private network routes. This is enabled if the tunnel has an assigned route.
View JSON Schema on GitHub

JSON Schema

apis-io-engineering-platform-tunnel-config-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/tunnel_config",
  "title": "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"
}