Skip to content
Hayonix

API reference · Schema

UpdateTemplateRequest

  • namestring

    Its name

    1–100 characters

  • descriptionstring | null

    Free-text description

    up to 1000 characters

  • imagestring

    Container image reference

    1–512 characters

  • visibilitystring

    `private`: every project of your organization can use it. `public`: every organization can; secret references and the registry credential are dropped.

    One ofprivatepublic

  • requires_gpuboolean

    Pods from it need a GPU SKU (default false)

  • readmestring | null

    Usage notes shown with the template (Markdown)

    up to 20000 characters

  • registry_credential_idstring | null

    ID of the registry credential

    ID with prefix rcr_

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

    Show 9 fields of defaults
    • 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
{
  "description": "Updated description"
}

Used by