tunnel_ingressRule

Public hostname

APIs.ioEngineeringPlatform

Properties

Name Type Description
hostname string Public hostname for this service.
originRequest object
path string Requests with this path route to this public hostname.
service string 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]
View JSON Schema on GitHub

JSON Schema

apis-io-engineering-platform-tunnel-ingressrule-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/tunnel_ingressRule",
  "title": "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'.\n",
      "example": "https://localhost:8001",
      "type": "string"
    }
  },
  "required": [
    "hostname",
    "service"
  ],
  "type": "object"
}