Skip to content
Hayonix

API reference · Schema

TemplateDefaultsPatch

Only the fields sent change; the others keep their stored values. Send an empty list to clear one ("secret_env": []).

  • commandarray of string

    Replaces the image’s entrypoint when non-empty

    up to 64 items

  • argsarray of string

    Replaces the image’s default arguments when non-empty

    up to 256 items

  • envarray of object

    Values may contain {{random_token}}, replaced with a fresh random token for each pod

    up to 128 items

    Show 2 fields of env
    • namestringrequired

      Its name

      pattern ^[A-Za-z_][A-Za-z0-9_]{0,127}$

    • valuestringrequired

      Value of the variable (up to 32,768 characters)

      up to 32768 characters

  • secret_envarray of object

    Private templates only; dropped from public ones

    up to 128 items

    Show 2 fields of secret_env
    • namestringrequired

      Its name

      pattern ^[A-Za-z_][A-Za-z0-9_]{0,127}$

    • secret_idstringrequired

      ID of the secret

      ID with prefix sec_

  • portsarray of object

    Container ports each pod exposes

    up to 16 items

    Show 4 fields of ports
    • 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}$

  • container_disk_gbinteger

    Writable container disk in GB for each pod

    5–500

  • volumeobject | null

    Pod volume created with each pod (null: none)

    Show 2 fields of volume
    • size_gbintegerrequired

      Size in GB

      1–2000

    • mount_pathstringrequired

      Absolute path the volume is mounted at inside the container

      2–256 characters

  • sshboolean

    Allow SSH (and SFTP, port forwarding) with the project’s SSH keys

  • categorystring

    Grouping shown in the catalog: `base`, `notebook`, `ml` or `other`

    One ofbasenotebookmlother

Example
{
  "command": [
    "string"
  ],
  "args": [
    "string"
  ],
  "env": [
    {
      "name": "string",
      "value": "string"
    }
  ],
  "secret_env": [
    {
      "name": "string",
      "secret_id": "sec_01jc5zq4m8k3v6x9t2w7r0b1e4"
    }
  ],
  "ports": [
    {
      "port": 1,
      "protocol": "http",
      "visibility": "public",
      "name": "string"
    }
  ],
  "container_disk_gb": 5,
  "volume": {
    "size_gb": 1,
    "mount_path": "string"
  },
  "ssh": true,
  "category": "base"
}