Get sandbox template

curl --request GET \
  --url https://api.coreweave.com/v1/sandboxTemplates/{sandboxTemplateId} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.coreweave.com/v1/sandboxTemplates/{sandboxTemplateId}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.coreweave.com/v1/sandboxTemplates/{sandboxTemplateId}', 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.coreweave.com/v1/sandboxTemplates/{sandboxTemplateId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.coreweave.com/v1/sandboxTemplates/{sandboxTemplateId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.coreweave.com/v1/sandboxTemplates/{sandboxTemplateId}")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "displayName": "<string>",
  "sandboxTemplateId": "<string>",
  "spec": {
    "containers": [
      {
        "name": "<string>",
        "image": "<string>",
        "command": "<string>",
        "args": [
          "<string>"
        ],
        "environmentVariables": {},
        "resources": {
          "cpu": "<string>",
          "memory": "<string>",
          "gpu": {
            "count": "<string>",
            "type": "<string>",
            "memoryGb": "<string>"
          }
        },
        "files": [
          {
            "path": "<string>",
            "content": "<string>"
          }
        ],
        "volumeMounts": [
          {
            "volume": "<string>",
            "mountPath": "<string>",
            "readOnly": true,
            "subPath": "<string>"
          }
        ],
        "secretStores": [
          {
            "storeName": "<string>",
            "secrets": [
              {
                "path": "<string>",
                "envVar": "<string>",
                "field": "<string>"
              }
            ]
          }
        ],
        "workingDir": "<string>",
        "resourceRequirements": {
          "requests": {
            "cpu": "<string>",
            "memory": "<string>",
            "gpu": {
              "count": "<string>",
              "type": "<string>",
              "memoryGb": "<string>"
            }
          },
          "limits": {
            "cpu": "<string>",
            "memory": "<string>",
            "gpu": {
              "count": "<string>",
              "type": "<string>",
              "memoryGb": "<string>"
            }
          }
        },
        "securityContext": {
          "runAsUser": 123,
          "runAsGroup": 123,
          "privileged": true,
          "allowPrivilegeEscalation": true,
          "readOnlyRootFilesystem": true,
          "capabilitiesAdd": [
            "<string>"
          ],
          "capabilitiesDrop": [
            "<string>"
          ],
          "seccompProfile": "<string>"
        },
        "imagePullCredentials": {
          "registry": "<string>",
          "credentials": {
            "storeName": "<string>",
            "path": "<string>",
            "field": "<string>"
          }
        },
        "primary": true,
        "startupProbe": {
          "exec": [
            "<string>"
          ],
          "periodSeconds": 123,
          "timeoutSeconds": 123,
          "failureThreshold": 123,
          "initialDelaySeconds": 123
        }
      }
    ],
    "volumes": [
      {
        "name": "<string>",
        "scratch": {
          "size": "<string>",
          "medium": "STORAGE_MEDIUM_UNSPECIFIED",
          "restoreFromSnapshotId": "<string>"
        },
        "volumeId": "<string>"
      }
    ],
    "services": [
      {
        "port": 123,
        "name": "<string>",
        "protocol": "SERVICE_PROTOCOL_UNSPECIFIED",
        "visibility": "VISIBILITY_UNSPECIFIED",
        "endpoint": {
          "kind": "ENDPOINT_KIND_UNSPECIFIED",
          "auth": "ENDPOINT_AUTH_UNSPECIFIED",
          "requestTimeoutSeconds": 123
        }
      }
    ],
    "maxLifetimeSeconds": 123,
    "networkIds": [
      "<string>"
    ],
    "objectStorageAccess": {
      "buckets": [
        "<string>"
      ],
      "permission": "OBJECT_STORAGE_PERMISSION_UNSPECIFIED",
      "objectPrefix": "<string>"
    },
    "tags": [
      "<string>"
    ],
    "runnerIds": [
      "<string>"
    ],
    "network": {
      "ingress": [
        {
          "cidr": {
            "cidr": "<string>",
            "except": [
              "<string>"
            ]
          },
          "tenant": "TENANT_SCOPE_UNSPECIFIED",
          "any": true,
          "ports": [
            {
              "port": 123,
              "protocol": "<string>",
              "endPort": 123
            }
          ]
        }
      ],
      "egress": [
        {
          "cidr": {
            "cidr": "<string>",
            "except": [
              "<string>"
            ]
          },
          "httpsHostname": "<string>",
          "tenant": "TENANT_SCOPE_UNSPECIFIED",
          "any": true,
          "selector": {
            "podLabels": {},
            "namespaceLabels": {}
          },
          "ports": [
            {
              "port": 123,
              "protocol": "<string>",
              "endPort": 123
            }
          ],
          "httpsHostnameExcept": [
            "<string>"
          ]
        }
      ],
      "denyEgress": true,
      "denyIngress": true,
      "dnsEgress": "DNS_EGRESS_MODE_UNSPECIFIED"
    },
    "annotations": {},
    "instanceType": "<string>",
    "mode": "SANDBOX_MODE_UNSPECIFIED",
    "runtimeClass": "<string>",
    "networkConfigId": "<string>",
    "runtimeClassSelection": "RUNTIME_CLASS_UNSPECIFIED"
  },
  "revision": "<string>",
  "createTime": "2023-11-07T05:31:56Z",
  "updateTime": "2023-11-07T05:31:56Z",
  "deleteTime": "2023-11-07T05:31:56Z",
  "createUserId": "<string>",
  "deleted": true,
  "attachments": {},
  "requiresCks": true
}

{
  "code": 123,
  "message": "<string>",
  "details": [
    {
      "@type": "<string>"
    }
  ]
}

GET

sandboxTemplates

{sandboxTemplateId}

Get sandbox template

curl --request GET \
  --url https://api.coreweave.com/v1/sandboxTemplates/{sandboxTemplateId} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.coreweave.com/v1/sandboxTemplates/{sandboxTemplateId}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.coreweave.com/v1/sandboxTemplates/{sandboxTemplateId}', 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.coreweave.com/v1/sandboxTemplates/{sandboxTemplateId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.coreweave.com/v1/sandboxTemplates/{sandboxTemplateId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.coreweave.com/v1/sandboxTemplates/{sandboxTemplateId}")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "displayName": "<string>",
  "sandboxTemplateId": "<string>",
  "spec": {
    "containers": [
      {
        "name": "<string>",
        "image": "<string>",
        "command": "<string>",
        "args": [
          "<string>"
        ],
        "environmentVariables": {},
        "resources": {
          "cpu": "<string>",
          "memory": "<string>",
          "gpu": {
            "count": "<string>",
            "type": "<string>",
            "memoryGb": "<string>"
          }
        },
        "files": [
          {
            "path": "<string>",
            "content": "<string>"
          }
        ],
        "volumeMounts": [
          {
            "volume": "<string>",
            "mountPath": "<string>",
            "readOnly": true,
            "subPath": "<string>"
          }
        ],
        "secretStores": [
          {
            "storeName": "<string>",
            "secrets": [
              {
                "path": "<string>",
                "envVar": "<string>",
                "field": "<string>"
              }
            ]
          }
        ],
        "workingDir": "<string>",
        "resourceRequirements": {
          "requests": {
            "cpu": "<string>",
            "memory": "<string>",
            "gpu": {
              "count": "<string>",
              "type": "<string>",
              "memoryGb": "<string>"
            }
          },
          "limits": {
            "cpu": "<string>",
            "memory": "<string>",
            "gpu": {
              "count": "<string>",
              "type": "<string>",
              "memoryGb": "<string>"
            }
          }
        },
        "securityContext": {
          "runAsUser": 123,
          "runAsGroup": 123,
          "privileged": true,
          "allowPrivilegeEscalation": true,
          "readOnlyRootFilesystem": true,
          "capabilitiesAdd": [
            "<string>"
          ],
          "capabilitiesDrop": [
            "<string>"
          ],
          "seccompProfile": "<string>"
        },
        "imagePullCredentials": {
          "registry": "<string>",
          "credentials": {
            "storeName": "<string>",
            "path": "<string>",
            "field": "<string>"
          }
        },
        "primary": true,
        "startupProbe": {
          "exec": [
            "<string>"
          ],
          "periodSeconds": 123,
          "timeoutSeconds": 123,
          "failureThreshold": 123,
          "initialDelaySeconds": 123
        }
      }
    ],
    "volumes": [
      {
        "name": "<string>",
        "scratch": {
          "size": "<string>",
          "medium": "STORAGE_MEDIUM_UNSPECIFIED",
          "restoreFromSnapshotId": "<string>"
        },
        "volumeId": "<string>"
      }
    ],
    "services": [
      {
        "port": 123,
        "name": "<string>",
        "protocol": "SERVICE_PROTOCOL_UNSPECIFIED",
        "visibility": "VISIBILITY_UNSPECIFIED",
        "endpoint": {
          "kind": "ENDPOINT_KIND_UNSPECIFIED",
          "auth": "ENDPOINT_AUTH_UNSPECIFIED",
          "requestTimeoutSeconds": 123
        }
      }
    ],
    "maxLifetimeSeconds": 123,
    "networkIds": [
      "<string>"
    ],
    "objectStorageAccess": {
      "buckets": [
        "<string>"
      ],
      "permission": "OBJECT_STORAGE_PERMISSION_UNSPECIFIED",
      "objectPrefix": "<string>"
    },
    "tags": [
      "<string>"
    ],
    "runnerIds": [
      "<string>"
    ],
    "network": {
      "ingress": [
        {
          "cidr": {
            "cidr": "<string>",
            "except": [
              "<string>"
            ]
          },
          "tenant": "TENANT_SCOPE_UNSPECIFIED",
          "any": true,
          "ports": [
            {
              "port": 123,
              "protocol": "<string>",
              "endPort": 123
            }
          ]
        }
      ],
      "egress": [
        {
          "cidr": {
            "cidr": "<string>",
            "except": [
              "<string>"
            ]
          },
          "httpsHostname": "<string>",
          "tenant": "TENANT_SCOPE_UNSPECIFIED",
          "any": true,
          "selector": {
            "podLabels": {},
            "namespaceLabels": {}
          },
          "ports": [
            {
              "port": 123,
              "protocol": "<string>",
              "endPort": 123
            }
          ],
          "httpsHostnameExcept": [
            "<string>"
          ]
        }
      ],
      "denyEgress": true,
      "denyIngress": true,
      "dnsEgress": "DNS_EGRESS_MODE_UNSPECIFIED"
    },
    "annotations": {},
    "instanceType": "<string>",
    "mode": "SANDBOX_MODE_UNSPECIFIED",
    "runtimeClass": "<string>",
    "networkConfigId": "<string>",
    "runtimeClassSelection": "RUNTIME_CLASS_UNSPECIFIED"
  },
  "revision": "<string>",
  "createTime": "2023-11-07T05:31:56Z",
  "updateTime": "2023-11-07T05:31:56Z",
  "deleteTime": "2023-11-07T05:31:56Z",
  "createUserId": "<string>",
  "deleted": true,
  "attachments": {},
  "requiresCks": true
}

{
  "code": 123,
  "message": "<string>",
  "details": [
    {
      "@type": "<string>"
    }
  ]
}

Authorizations

Authorization

string

header

default:Bearer {API_ACCESS_TOKEN}

required

CoreWeave API access token sent as a bearer token.

Path Parameters

sandboxTemplateId

string

required

UUID or org-unique display_name. Resolution: if the string parses as a UUID, look up by id only (including soft-deleted when show_deleted); a soft-deleted id does not fall through to display_name. Otherwise look up by display_name among rows visible under show_deleted (active-only when false). Name lookup is best-effort for discovery; Create selects by UUID.

Query Parameters

showDeleted

boolean

When true, allow returning a soft-deleted template. Requires sandbox_admin.

Response

SandboxTemplate is an organization-scoped partial workload template. PartialSandboxSpec / PartialContainer are defined in sandbox.proto.

displayName

string

required

Human-readable name, unique among active (non-deleted) templates in the tenant organization. Trimmed; 1–128 Unicode characters; must not be empty. Prefer names that are not UUID-shaped so they do not collide with id-first Get resolution.

sandboxTemplateId

string

read-only

Server-assigned unique identifier.

spec

object

Partial workload specification. May omit fields that CreateSandboxFromTemplate supplies via overrides (for example containers). Must not carry policy selectors. Server-enforced size ceiling: 1 MiB.

Show child attributes

revision

string

read-only

Monotonic revision; incremented on each successful update. CreateSandboxFromTemplate records the selected revision on the sandbox as source_template_revision.

createTime

string<date-time>

read-only

updateTime

string<date-time>

read-only

deleteTime

string<date-time>

read-only

Set when soft-deleted; unset for active templates.

createUserId

string

read-only

User id of the creator.

deleted

boolean

read-only

True when delete_time is set. Convenience for admin filtering.

attachments

object

Optional admin runtime attachments applied when creating a sandbox from this template. Same opaque fragment shape as Policy.base (for example, a PodSpec fragment on a Kubernetes runner). Writable by sandbox_admin only. When set, CreateSandboxFromTemplate requires SANDBOX_MODE_CKS (serverless is rejected; unset mode is treated as CKS). Not part of SandboxSpec; CreateSandbox and create overrides cannot supply or change them.

requiresCks

boolean

read-only

True when attachments are set. Indicates CreateSandboxFromTemplate for this template requires CKS placement.

Sandboxes

Use sandboxes

Manage sandboxes

Reference

Get sandbox template

Authorizations

Path Parameters

Query Parameters

Response