GoDoxy

List routes

GET
/route/list

List routes

Query Parameters

provider?string

Provider

Response Body

application/json

application/json

curl -X GET "https://example.com/route/list"
[
  {
    "access_log": {
      "fields": {
        "cookies": {
          "config": {
            "property1": "keep",
            "property2": "keep"
          },
          "default": "keep"
        },
        "headers": {
          "config": {
            "property1": "keep",
            "property2": "keep"
          },
          "default": "keep"
        },
        "query": {
          "config": {
            "property1": "keep",
            "property2": "keep"
          },
          "default": "keep"
        }
      },
      "filters": {
        "cidr": {
          "negative": true,
          "values": [
            {
              "ip": [
                0
              ],
              "mask": [
                0
              ]
            }
          ]
        },
        "headers": {
          "negative": true,
          "values": [
            {
              "key": "string",
              "value": "string"
            }
          ]
        },
        "host": {
          "negative": true,
          "values": [
            "string"
          ]
        },
        "method": {
          "negative": true,
          "values": [
            "string"
          ]
        },
        "status_codes": {
          "negative": true,
          "values": [
            {
              "end": 0,
              "start": 0
            }
          ]
        }
      },
      "format": "common",
      "path": "string",
      "retention": {
        "days": 0,
        "keep_size": 0,
        "last": 0
      },
      "rotate_interval": 0,
      "stdout": true
    },
    "agent": "string",
    "alias": "string",
    "bind": "string",
    "container": {
      "agent": {
        "addr": "string",
        "name": "string",
        "runtime": "docker",
        "supports_tcp_stream": true,
        "supports_udp_stream": true,
        "version": "string"
      },
      "aliases": [
        "string"
      ],
      "container_id": "string",
      "container_name": "string",
      "docker_cfg": {
        "tls": {
          "ca_file": "string",
          "cert_file": "string",
          "key_file": "string"
        },
        "url": "string"
      },
      "errors": "string",
      "idlewatcher_config": {
        "depends_on": [
          "string"
        ],
        "docker": {
          "container_id": "string",
          "container_name": "string",
          "docker_cfg": {
            "tls": {
              "ca_file": "string",
              "cert_file": "string",
              "key_file": "string"
            },
            "url": "string"
          }
        },
        "idle_timeout": -9223372036854776000,
        "no_loading_page": true,
        "proxmox": {
          "node": "string",
          "vmid": 0
        },
        "start_endpoint": "string",
        "stop_method": "pause",
        "stop_signal": "string",
        "stop_timeout": -9223372036854776000,
        "wake_timeout": -9223372036854776000
      },
      "image": {
        "author": "string",
        "name": "string",
        "sha256": "string",
        "tag": "string",
        "version": "string"
      },
      "is_excluded": true,
      "is_explicit": true,
      "is_host_network_mode": true,
      "labels": {
        "property1": "string",
        "property2": "string"
      },
      "mounts": {
        "property1": "string",
        "property2": "string"
      },
      "network": "string",
      "private_hostname": "string",
      "private_ports": {
        "property1": {
          "IP": "string",
          "PrivatePort": 0,
          "PublicPort": 0,
          "Type": "string"
        },
        "property2": {
          "IP": "string",
          "PrivatePort": 0,
          "PublicPort": 0,
          "Type": "string"
        }
      },
      "public_hostname": "string",
      "public_ports": {
        "property1": {
          "IP": "string",
          "PrivatePort": 0,
          "PublicPort": 0,
          "Type": "string"
        },
        "property2": {
          "IP": "string",
          "PrivatePort": 0,
          "PublicPort": 0,
          "Type": "string"
        }
      },
      "running": true,
      "state": "created"
    },
    "disable_compression": true,
    "excluded": true,
    "excluded_reason": "string",
    "health": {
      "config": {
        "disable": true,
        "interval": 0,
        "path": "string",
        "retries": 0,
        "timeout": 0,
        "use_get": true
      },
      "detail": "string",
      "extra": {
        "config": {
          "link": "string",
          "mode": "",
          "options": {
            "property1": null,
            "property2": null
          },
          "sticky": true,
          "sticky_max_age": -9223372036854776000,
          "weight": 0
        },
        "pool": {
          "property1": null,
          "property2": null
        }
      },
      "lastSeen": 0,
      "latency": 0,
      "name": "string",
      "started": 0,
      "status": "unknown",
      "uptime": 0,
      "url": "string"
    },
    "healthcheck": {
      "disable": true,
      "interval": 0,
      "path": "string",
      "retries": 0,
      "timeout": 0,
      "use_get": true
    },
    "homepage": {
      "category": "string",
      "description": "string",
      "favorite": true,
      "icon": "string",
      "name": "string",
      "show": true,
      "url": "string",
      "widget_config": {
        "config": null,
        "provider": "string"
      }
    },
    "host": "string",
    "idlewatcher": {
      "depends_on": [
        "string"
      ],
      "docker": {
        "container_id": "string",
        "container_name": "string",
        "docker_cfg": {
          "tls": {
            "ca_file": "string",
            "cert_file": "string",
            "key_file": "string"
          },
          "url": "string"
        }
      },
      "idle_timeout": -9223372036854776000,
      "no_loading_page": true,
      "proxmox": {
        "node": "string",
        "vmid": 0
      },
      "start_endpoint": "string",
      "stop_method": "pause",
      "stop_signal": "string",
      "stop_timeout": -9223372036854776000,
      "wake_timeout": -9223372036854776000
    },
    "inbound_mtls_profile": "string",
    "index": "string",
    "load_balance": {
      "link": "string",
      "mode": "",
      "options": {
        "property1": null,
        "property2": null
      },
      "sticky": true,
      "sticky_max_age": -9223372036854776000,
      "weight": 0
    },
    "lurl": "string",
    "max_conns_per_host": 0,
    "middlewares": {
      "property1": {
        "property1": null,
        "property2": null
      },
      "property2": {
        "property1": null,
        "property2": null
      }
    },
    "no_tls_verify": true,
    "port": {
      "listening": 0,
      "proxy": 0
    },
    "provider": "string",
    "proxmox": {
      "files": [
        "string"
      ],
      "node": "string",
      "services": [
        "string"
      ],
      "vmid": 0,
      "vmname": "string"
    },
    "purl": "string",
    "relay_proxy_protocol_header": true,
    "response_header_timeout": 0,
    "root": "string",
    "rule_file": "string",
    "rules": [
      {
        "do": "string",
        "name": "string",
        "on": "string"
      }
    ],
    "scheme": "http",
    "spa": true,
    "ssl_certificate": "string",
    "ssl_certificate_key": "string",
    "ssl_protocols": [
      "string"
    ],
    "ssl_server_name": "string",
    "ssl_trusted_certificate": "string",
    "tls_termination": true
  }
]