Edit Template

curl --request POST \
  --url https://api.novita.ai/gpu-instance/openapi/v1/template/update \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: <content-type>' \
  --data '
{
  "template": {
    "Id": "<string>",
    "name": "<string>",
    "readme": "<string>",
    "type": "<string>",
    "channel": "<string>",
    "image": "<string>",
    "imageAuth": "<string>",
    "startCommand": "<string>",
    "entrypoint": "<string>",
    "rootfsSize": 123,
    "ports": [
      {
        "type": "<string>",
        "ports": [
          123
        ]
      }
    ],
    "envs": [
      {
        "key": "<string>",
        "value": "<string>"
      }
    ],
    "minCudaVersion": "<string>"
  }
}
'

import requests

url = "https://api.novita.ai/gpu-instance/openapi/v1/template/update"

payload = { "template": {
        "Id": "<string>",
        "name": "<string>",
        "readme": "<string>",
        "type": "<string>",
        "channel": "<string>",
        "image": "<string>",
        "imageAuth": "<string>",
        "startCommand": "<string>",
        "entrypoint": "<string>",
        "rootfsSize": 123,
        "ports": [
            {
                "type": "<string>",
                "ports": [123]
            }
        ],
        "envs": [
            {
                "key": "<string>",
                "value": "<string>"
            }
        ],
        "minCudaVersion": "<string>"
    } }
headers = {
    "Content-Type": "<content-type>",
    "Authorization": "<authorization>"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': '<content-type>', Authorization: '<authorization>'},
  body: JSON.stringify({
    template: {
      Id: '<string>',
      name: '<string>',
      readme: '<string>',
      type: '<string>',
      channel: '<string>',
      image: '<string>',
      imageAuth: '<string>',
      startCommand: '<string>',
      entrypoint: '<string>',
      rootfsSize: 123,
      ports: [{type: '<string>', ports: [123]}],
      envs: [{key: '<string>', value: '<string>'}],
      minCudaVersion: '<string>'
    }
  })
};

fetch('https://api.novita.ai/gpu-instance/openapi/v1/template/update', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.novita.ai/gpu-instance/openapi/v1/template/update",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'template' => [
        'Id' => '<string>',
        'name' => '<string>',
        'readme' => '<string>',
        'type' => '<string>',
        'channel' => '<string>',
        'image' => '<string>',
        'imageAuth' => '<string>',
        'startCommand' => '<string>',
        'entrypoint' => '<string>',
        'rootfsSize' => 123,
        'ports' => [
                [
                                'type' => '<string>',
                                'ports' => [
                                                                123
                                ]
                ]
        ],
        'envs' => [
                [
                                'key' => '<string>',
                                'value' => '<string>'
                ]
        ],
        'minCudaVersion' => '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <authorization>",
    "Content-Type: <content-type>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.novita.ai/gpu-instance/openapi/v1/template/update"

	payload := strings.NewReader("{\n  \"template\": {\n    \"Id\": \"<string>\",\n    \"name\": \"<string>\",\n    \"readme\": \"<string>\",\n    \"type\": \"<string>\",\n    \"channel\": \"<string>\",\n    \"image\": \"<string>\",\n    \"imageAuth\": \"<string>\",\n    \"startCommand\": \"<string>\",\n    \"entrypoint\": \"<string>\",\n    \"rootfsSize\": 123,\n    \"ports\": [\n      {\n        \"type\": \"<string>\",\n        \"ports\": [\n          123\n        ]\n      }\n    ],\n    \"envs\": [\n      {\n        \"key\": \"<string>\",\n        \"value\": \"<string>\"\n      }\n    ],\n    \"minCudaVersion\": \"<string>\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "<content-type>")
	req.Header.Add("Authorization", "<authorization>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.novita.ai/gpu-instance/openapi/v1/template/update")
  .header("Content-Type", "<content-type>")
  .header("Authorization", "<authorization>")
  .body("{\n  \"template\": {\n    \"Id\": \"<string>\",\n    \"name\": \"<string>\",\n    \"readme\": \"<string>\",\n    \"type\": \"<string>\",\n    \"channel\": \"<string>\",\n    \"image\": \"<string>\",\n    \"imageAuth\": \"<string>\",\n    \"startCommand\": \"<string>\",\n    \"entrypoint\": \"<string>\",\n    \"rootfsSize\": 123,\n    \"ports\": [\n      {\n        \"type\": \"<string>\",\n        \"ports\": [\n          123\n        ]\n      }\n    ],\n    \"envs\": [\n      {\n        \"key\": \"<string>\",\n        \"value\": \"<string>\"\n      }\n    ],\n    \"minCudaVersion\": \"<string>\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.novita.ai/gpu-instance/openapi/v1/template/update")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = '<content-type>'
request["Authorization"] = '<authorization>'
request.body = "{\n  \"template\": {\n    \"Id\": \"<string>\",\n    \"name\": \"<string>\",\n    \"readme\": \"<string>\",\n    \"type\": \"<string>\",\n    \"channel\": \"<string>\",\n    \"image\": \"<string>\",\n    \"imageAuth\": \"<string>\",\n    \"startCommand\": \"<string>\",\n    \"entrypoint\": \"<string>\",\n    \"rootfsSize\": 123,\n    \"ports\": [\n      {\n        \"type\": \"<string>\",\n        \"ports\": [\n          123\n        ]\n      }\n    ],\n    \"envs\": [\n      {\n        \"key\": \"<string>\",\n        \"value\": \"<string>\"\n      }\n    ],\n    \"minCudaVersion\": \"<string>\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "templateId": "<string>"
}

POST

gpu-instance

openapi

template

update

Edit Template

curl --request POST \
  --url https://api.novita.ai/gpu-instance/openapi/v1/template/update \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: <content-type>' \
  --data '
{
  "template": {
    "Id": "<string>",
    "name": "<string>",
    "readme": "<string>",
    "type": "<string>",
    "channel": "<string>",
    "image": "<string>",
    "imageAuth": "<string>",
    "startCommand": "<string>",
    "entrypoint": "<string>",
    "rootfsSize": 123,
    "ports": [
      {
        "type": "<string>",
        "ports": [
          123
        ]
      }
    ],
    "envs": [
      {
        "key": "<string>",
        "value": "<string>"
      }
    ],
    "minCudaVersion": "<string>"
  }
}
'

import requests

url = "https://api.novita.ai/gpu-instance/openapi/v1/template/update"

payload = { "template": {
        "Id": "<string>",
        "name": "<string>",
        "readme": "<string>",
        "type": "<string>",
        "channel": "<string>",
        "image": "<string>",
        "imageAuth": "<string>",
        "startCommand": "<string>",
        "entrypoint": "<string>",
        "rootfsSize": 123,
        "ports": [
            {
                "type": "<string>",
                "ports": [123]
            }
        ],
        "envs": [
            {
                "key": "<string>",
                "value": "<string>"
            }
        ],
        "minCudaVersion": "<string>"
    } }
headers = {
    "Content-Type": "<content-type>",
    "Authorization": "<authorization>"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': '<content-type>', Authorization: '<authorization>'},
  body: JSON.stringify({
    template: {
      Id: '<string>',
      name: '<string>',
      readme: '<string>',
      type: '<string>',
      channel: '<string>',
      image: '<string>',
      imageAuth: '<string>',
      startCommand: '<string>',
      entrypoint: '<string>',
      rootfsSize: 123,
      ports: [{type: '<string>', ports: [123]}],
      envs: [{key: '<string>', value: '<string>'}],
      minCudaVersion: '<string>'
    }
  })
};

fetch('https://api.novita.ai/gpu-instance/openapi/v1/template/update', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.novita.ai/gpu-instance/openapi/v1/template/update",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'template' => [
        'Id' => '<string>',
        'name' => '<string>',
        'readme' => '<string>',
        'type' => '<string>',
        'channel' => '<string>',
        'image' => '<string>',
        'imageAuth' => '<string>',
        'startCommand' => '<string>',
        'entrypoint' => '<string>',
        'rootfsSize' => 123,
        'ports' => [
                [
                                'type' => '<string>',
                                'ports' => [
                                                                123
                                ]
                ]
        ],
        'envs' => [
                [
                                'key' => '<string>',
                                'value' => '<string>'
                ]
        ],
        'minCudaVersion' => '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <authorization>",
    "Content-Type: <content-type>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.novita.ai/gpu-instance/openapi/v1/template/update"

	payload := strings.NewReader("{\n  \"template\": {\n    \"Id\": \"<string>\",\n    \"name\": \"<string>\",\n    \"readme\": \"<string>\",\n    \"type\": \"<string>\",\n    \"channel\": \"<string>\",\n    \"image\": \"<string>\",\n    \"imageAuth\": \"<string>\",\n    \"startCommand\": \"<string>\",\n    \"entrypoint\": \"<string>\",\n    \"rootfsSize\": 123,\n    \"ports\": [\n      {\n        \"type\": \"<string>\",\n        \"ports\": [\n          123\n        ]\n      }\n    ],\n    \"envs\": [\n      {\n        \"key\": \"<string>\",\n        \"value\": \"<string>\"\n      }\n    ],\n    \"minCudaVersion\": \"<string>\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "<content-type>")
	req.Header.Add("Authorization", "<authorization>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.novita.ai/gpu-instance/openapi/v1/template/update")
  .header("Content-Type", "<content-type>")
  .header("Authorization", "<authorization>")
  .body("{\n  \"template\": {\n    \"Id\": \"<string>\",\n    \"name\": \"<string>\",\n    \"readme\": \"<string>\",\n    \"type\": \"<string>\",\n    \"channel\": \"<string>\",\n    \"image\": \"<string>\",\n    \"imageAuth\": \"<string>\",\n    \"startCommand\": \"<string>\",\n    \"entrypoint\": \"<string>\",\n    \"rootfsSize\": 123,\n    \"ports\": [\n      {\n        \"type\": \"<string>\",\n        \"ports\": [\n          123\n        ]\n      }\n    ],\n    \"envs\": [\n      {\n        \"key\": \"<string>\",\n        \"value\": \"<string>\"\n      }\n    ],\n    \"minCudaVersion\": \"<string>\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.novita.ai/gpu-instance/openapi/v1/template/update")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = '<content-type>'
request["Authorization"] = '<authorization>'
request.body = "{\n  \"template\": {\n    \"Id\": \"<string>\",\n    \"name\": \"<string>\",\n    \"readme\": \"<string>\",\n    \"type\": \"<string>\",\n    \"channel\": \"<string>\",\n    \"image\": \"<string>\",\n    \"imageAuth\": \"<string>\",\n    \"startCommand\": \"<string>\",\n    \"entrypoint\": \"<string>\",\n    \"rootfsSize\": 123,\n    \"ports\": [\n      {\n        \"type\": \"<string>\",\n        \"ports\": [\n          123\n        ]\n      }\n    ],\n    \"envs\": [\n      {\n        \"key\": \"<string>\",\n        \"value\": \"<string>\"\n      }\n    ],\n    \"minCudaVersion\": \"<string>\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "templateId": "<string>"
}

Request Headers

string

required

Enum: application/json

string

required

Bearer authentication format, for example: Bearer {{API Key}}.

Request Body

object

required

Template settings.

Hide properties

string

required

Template ID.

string

required

Template name. String, length limit: 1-255 characters.

string

Template README content (in Markdown format). String, length limit: 0-102400 characters.

string

required

Template type.
Enum: instance

string

required

Template channel.
Enum: private

string

required

Docker image address for instance startup. String, length limit: 1-500 characters.

string

Image repository authentication ID for private images. String, length limit: 0-255 characters.

string

Startup command for the instance. String, length limit: 0-2047 characters.

string

Instance startup entrypoint. This setting will override the Docker image’s ENTRYPOINT. String, length limit: 0-2047 characters.

integer

required

Root filesystem storage (GB). Integer, value must be greater than 0.

object[]

Exposed port settings.

Hide properties

string

required

Exposed port types.
Enum: http, tcp

integer[]

required

Exposed ports (maximum of 10). Supported port range: 1-65535, except for 2222, 2223, 2224 which are reserved for internal use.

object[]

Environment variables injected into the instance. Up to 100 environment variable pairs can be created.

Hide properties

string

Environment variable key. String, length limit: 0-511 characters.

string

Environment variable value. String, length limit: 0-4095 characters.

string

Minimum supported CUDA version. String, length limit: 0-255 characters. Format example: 11.8, 12.4.

Response

string

ID of the updated template.

Example

Request

curl --request POST \
  --url 'https://api.novita.ai/gpu-instance/openapi/v1/template/update' \
  --header 'Authorization: Bearer {{API Key}}' \
  --header 'Content-Type: application/json' \
  --data '{
    "template": {
      "Id": "1",
      "name": "test",
      "readme": "readme",
      "type": "instance",
      "channel": "private",
      "readme": "test create template",
      "image": "nginx",
      "imageAuth": "",
      "startCommand": "echo test",
      "entrypoint": "",
      "rootfsSize": 60,
      "ports": [
        {
          "type": "http",
          "ports": [80, 443]
        },
        {
          "type": "tcp",
          "ports": [90, 95]
        }
      ],
      "envs": [
        {
          "key": "test1",
          "value": "template1"
        },
        {
          "key": "test2",
          "value": "test2"
        }
      ],
      "minCudaVersion": "11.8"
    }
  }'

Response

{
  "templateId": "1"
}

Last modified on June 10, 2026

⌘I

Overview

Basic

Quota

Team Budget

API Key Model Access

API Key Network Access

Model APIs

GPUs

Edit Template

Request Headers

Request Body

Response

Example

​Request Headers

​Request Body

​Response

​Example

Request Headers

Request Body

Response

Example