Update a SandboxTemplate

curl --request PATCH \
  --url https://api.example.com/v2/sandboxes/templates/{name} \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>"
}
'

import requests

url = "https://api.example.com/v2/sandboxes/templates/{name}"

payload = { "name": "<string>" }
headers = {"Content-Type": "application/json"}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({name: '<string>'})
};

fetch('https://api.example.com/v2/sandboxes/templates/{name}', 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.example.com/v2/sandboxes/templates/{name}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$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.example.com/v2/sandboxes/templates/{name}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\"\n}")

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

	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.example.com/v2/sandboxes/templates/{name}")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/v2/sandboxes/templates/{name}")

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

request = Net::HTTP::Patch.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\"\n}"

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

{
  "name": "<string>",
  "image": "<string>",
  "resources": {
    "cpu": "500m",
    "memory": "256Mi",
    "storage": "1Gi"
  },
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "volume_mounts": [
    {
      "volume_name": "<string>",
      "mount_path": "/data"
    }
  ],
  "proxy_config": {
    "rules": [
      {
        "name": "openai-api",
        "match_hosts": [
          "api.openai.com"
        ],
        "inject_headers": {
          "Authorization": "Bearer ${OPENAI_API_KEY}"
        },
        "match_paths": [
          "/v1/*"
        ],
        "enabled": true
      }
    ],
    "no_proxy": [
      "<string>"
    ]
  },
  "created_at": "<string>",
  "updated_at": "<string>"
}

{
  "detail": {
    "error": "NotFound",
    "message": "Resource not found."
  }
}

{
  "detail": {
    "error": "Conflict",
    "message": "Template 'new-name' already exists"
  }
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

PATCH

sandboxes

templates

{name}

Update a SandboxTemplate

curl --request PATCH \
  --url https://api.example.com/v2/sandboxes/templates/{name} \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>"
}
'

import requests

url = "https://api.example.com/v2/sandboxes/templates/{name}"

payload = { "name": "<string>" }
headers = {"Content-Type": "application/json"}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({name: '<string>'})
};

fetch('https://api.example.com/v2/sandboxes/templates/{name}', 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.example.com/v2/sandboxes/templates/{name}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$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.example.com/v2/sandboxes/templates/{name}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\"\n}")

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

	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.example.com/v2/sandboxes/templates/{name}")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/v2/sandboxes/templates/{name}")

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

request = Net::HTTP::Patch.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\"\n}"

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

{
  "name": "<string>",
  "image": "<string>",
  "resources": {
    "cpu": "500m",
    "memory": "256Mi",
    "storage": "1Gi"
  },
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "volume_mounts": [
    {
      "volume_name": "<string>",
      "mount_path": "/data"
    }
  ],
  "proxy_config": {
    "rules": [
      {
        "name": "openai-api",
        "match_hosts": [
          "api.openai.com"
        ],
        "inject_headers": {
          "Authorization": "Bearer ${OPENAI_API_KEY}"
        },
        "match_paths": [
          "/v1/*"
        ],
        "enabled": true
      }
    ],
    "no_proxy": [
      "<string>"
    ]
  },
  "created_at": "<string>",
  "updated_at": "<string>"
}

{
  "detail": {
    "error": "NotFound",
    "message": "Resource not found."
  }
}

{
  "detail": {
    "error": "Conflict",
    "message": "Template 'new-name' already exists"
  }
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Path Parameters

name

string

required

Template name

Body

application/json

Request model for updating a SandboxTemplate.

Currently only the display name can be updated.

name

string | null

New display name for the template (max 63 chars, DNS-1035 format). Must be unique within the organization.

Response

Successful Response

Response model for a SandboxTemplate.

name

string

required

image

string

required

resources

ResourceSpec · object

required

Resource specification for a sandbox.

ResourceSpec
Resources

Show child attributes

string<uuid> | null

Unique template identifier

volume_mounts

VolumeMountSpec · object

Specification for mounting a volume in a sandbox template.

VolumeMountSpec · object[]
Volume Mounts · object[]

Show child attributes

proxy_config

ProxyConfig · object

Proxy configuration for a sandbox template.

When proxy_config is set, a smithbox-proxy sidecar will be deployed alongside the sandbox container to intercept HTTPS traffic and inject headers based on the configured rules.

ProxyConfig
Proxy Config

Show child attributes

created_at

string | null

updated_at

string | null

LangSmith Deployment

Releases

Update a SandboxTemplate

Path Parameters

Body

Response