Support API Key Authentication

Update Template

put/templates/{id}

Path parameters

idstring uuid required

Request body

namestring

descriptionstring nullable

docker_imagestring required

docker_image_digeststring

docker_image_tagstring nullable

volumesstring[]

environmentobject

entrypointstring

internal_portsinteger[]

is_privateboolean

readmestring nullable

startup_commandsstring

container_start_immediatelyboolean

health_check_commandstring nullable

one_time_templateboolean

is_temporaryboolean

docker_image_sizeinteger nullable

supports_dockerboolean

supports_volume_encryptionboolean

Example request

{
  "category": "UBUNTU",
  "container_start_immediately": false,
  "description": "Ubuntu Template",
  "docker_image": "ubuntu",
  "docker_image_digest": "sha256:e5a6aeef391a8a9bdaee3de6b28f393837c479d8217324a2340b64e45a81e0ef",
  "docker_image_tag": "20.04",
  "entrypoint": "",
  "environment": {
    "test_env": "44"
  },
  "internal_ports": [
    22,
    8002
  ],
  "is_private": true,
  "name": "Ubuntu",
  "readme": "# Ubuntu Template",
  "startup_commands": "bash -c 'apt update;apt install -y wget;DEBIAN_FRONTEND=noninteractive apt-get install openssh-server -y;mkdir -p /root/.ssh;cd $_;chmod 700 /root/.ssh;echo USER_PUBLIC_KEY > /root/.ssh/authorized_keys;chmod 700 /root/.ssh/authorized_keys;service ssh start; touch /root/container_ready; sleep infinity'",
  "volumes": [
    "/workspace"
  ]
}

Response

Successful Response

idstring uuid

created_atstring date-time

updated_atstring date-time nullable

namestring required

descriptionstring nullable

docker_imagestring required

docker_image_tagstring required

docker_image_digeststring nullable required

docker_image_sizeinteger nullable required

validator_onlyboolean nullable

volumesstring[] nullable required

environmentobject nullable required

entrypointstring nullable

internal_portsinteger[] nullable required

user_idstring uuid nullable

is_privateboolean nullable

readmestring nullable required

startup_commandsstring nullable

statusstring nullable

is_temporaryboolean nullable

is_created_from_official_templateboolean nullable

docker_credential_idstring uuid nullable

one_time_templateboolean nullable

container_start_immediatelyboolean nullable

verify_ssh_connectionboolean nullable

health_check_commandstring nullable

verification_logsstring nullable

download_countinteger nullable