Skip to content
Hayonix

API reference · Schema

PodPort

  • portintegerrequired

    Port number the container listens on

    1–65535

  • protocolstring

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

    One ofhttptcp

    default "http"

  • visibilitystring

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

    One ofpublicprivate

    default "public"

  • namestring

    Its name

    pattern ^[a-z][a-z0-9-]{0,30}$

Example
{
  "port": 8888,
  "protocol": "http",
  "visibility": "public",
  "name": "string"
}