Skip to content
Hayonix

API reference · Schema

PodConnect

Present when reading one pod

  • portsarray of objectrequired

    How to reach each configured port

    Show 6 fields of ports
    • portintegerrequired

      Port number the container listens on

    • namestringrequired

      Its name

    • protocolstringrequired

      `http`: served at the port’s HTTPS URL (WebSocket included). `tcp`: raw TCP, reachable through SSH port forwarding.

      One ofhttptcp

    • visibilitystringrequired

      `public`: anyone with the URL. `private`: no URL; SSH port forwarding and the project network only.

      One ofpublicprivate

    • urlstring | nullrequired

      HTTPS URL (public HTTP ports)

    • forward_commandstring | nullrequired

      SSH local-forward command reaching the port from your machine (when SSH is on)

  • sshobject | nullrequired

    Null while SSH is off or the pod is not on a host

    Show 6 fields of ssh
    • userstringrequired

      User name to log in with (identifies the pod)

    • hoststringrequired

      SSH host name

    • portintegerrequired

      SSH TCP port

    • commandstringrequired

      Ready-to-run ssh command

    • known_hostsarray of stringrequired

      Lines for ~/.ssh/known_hosts pinning the host keys

    • sftp_commandstringrequired

      Ready-to-run sftp command

  • private_networkobjectrequired

    How other pods of the project reach this one

    Show 2 fields of private_network
    • hostnamestringrequired

      Name this pod answers to in the project’s private network

    • scopestringrequired

      Other pods of this project reach this one at `hostname` when they run on the same host (pods sharing a network volume always do). Pods of other projects cannot reach it.

      One ofsame_host

Example
{
  "ports": [
    {
      "port": 1,
      "name": "string",
      "protocol": "http",
      "visibility": "public",
      "url": "string",
      "forward_command": "string"
    }
  ],
  "ssh": {
    "user": "string",
    "host": "string",
    "port": 1,
    "command": "string",
    "known_hosts": [
      "string"
    ],
    "sftp_command": "string"
  },
  "private_network": {
    "hostname": "string",
    "scope": "same_host"
  }
}