> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.runtype.com/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.runtype.com/_mcp/server. # Replace a managed sandbox deployment spec PUT https://api.runtype.com/v1/sandbox-deployments/{id} Content-Type: application/json Requires If-Match against the control-plane resource version. An identical normalized spec returns 200 and writes no new revision; a changed spec returns 202 with a new desired revision. Reference: https://docs.runtype.com/api-reference/runtype-api/sandbox-deployments/replace-a-managed-sandbox-deployment-spec ## Authentication - `Authorization` header (bearer token, required) — API key or Clerk session token ## Servers - `https://api.runtype.com` (Production, default) - `https://api.runtype-staging.com` (Staging) ## Request ### Path parameters - `id` (string, required) ### Headers - `idempotency-key` (string, optional) — Replays the stored response for the same authored body for seven days. Reusing a key with a different body returns 409. - `if-match` (string, optional) — Required for a fresh update: the expected resourceVersion. Missing or stale values return 412. Optional only for a matching Idempotency-Key replay, which returns its stored response before checking this precondition. ### Body (application/json) This endpoint expects a Sandbox Deployments_replaceAManagedSandboxDeploymentSpec_Request. - `Sandbox Deployments_replaceAManagedSandboxDeploymentSpec_Request` ## Response ### 200 No change: the normalized desired spec already matches - `deployment` (V1SandboxDeploymentsIdPutResponsesContentApplicationJsonSchemaDeployment, required) - `operationId` (string, required, nullable) ### 202 New desired revision accepted - `deployment` (V1SandboxDeploymentsIdPutResponsesContentApplicationJsonSchemaDeployment, required) - `operationId` (string, required, nullable) ## Errors ### 400 Bad Request Error Validation error - `error` (string, required) - `details` (list of ErrorDetailsItems, optional) ### 401 Unauthorized Error Unauthorized - `error` (string, required) - `details` (list of ErrorDetailsItems, optional) ### 402 Payment Required Error Blocked by the organization managed deployment spend budget or credits - `error` (string, required) - `details` (list of ErrorDetailsItems, optional) ### 403 Forbidden Error Insufficient permissions - `error` (string, required) - `details` (list of ErrorDetailsItems, optional) ### 404 Not Found Error Not found - `error` (string, required) - `details` (list of ErrorDetailsItems, optional) ### 409 Conflict Error Conflict - `error` (string, required) - `details` (list of ErrorDetailsItems, optional) ### 412 Precondition Failed Error Resource version precondition failed - `error` (string, required) - `details` (list of ErrorDetailsItems, optional) ### 422 Unprocessable Entity Error Blocked by credential, source, or profile admission - `error` (string, required) - `details` (list of ErrorDetailsItems, optional) ### 429 Too Many Requests Error Organization quota exhausted - `error` (string, required) - `details` (list of ErrorDetailsItems, optional) ### 500 Internal Server Error Internal server error - `error` (string, required) - `details` (list of ErrorDetailsItems, optional) ## Types ### SandboxDeploymentsReplaceAManagedSandboxDeploymentSpecRequest0 - `spec` (V1SandboxDeploymentsIdPutRequestBodyContentApplicationJsonSchemaOneOf0Spec, required) - `displayName` (string, optional) ### SandboxDeploymentsReplaceAManagedSandboxDeploymentSpecRequest1 - `config` (V1SandboxDeploymentsIdPutRequestBodyContentApplicationJsonSchemaOneOf1Config, required) - `displayName` (string, optional) ### V1SandboxDeploymentsIdPutResponsesContentApplicationJsonSchemaDeployment - `activeOperationId` (string, required, nullable) - `activeProviderInstanceId` (string, required, nullable) - `counters` (V1SandboxDeploymentsIdPutResponsesContentApplicationJsonSchemaDeploymentCounters, required) - `createdAt` (string, required) - `createdByUserId` (string, required, nullable) - `deploymentId` (string, required) - `desiredState` (enum, required) - Allowed values: `active`, `suspended`, `destroyed`, `expired` - `displayName` (string, required, nullable) - `effectivePolicy` (V1SandboxDeploymentsIdPutResponsesContentApplicationJsonSchemaDeploymentEffectivePolicy, required) - `environment` (enum, required) - Allowed values: `development`, `staging`, `production` - `expiresAt` (string, required, nullable) - `ingressEnabled` (boolean, required) - `organizationId` (string, required) - `profile` (V1SandboxDeploymentsIdPutResponsesContentApplicationJsonSchemaDeploymentProfile, required) - `retentionAnchorAt` (string, required) - `specHash` (string, required) - `status` (enum, required) - Allowed values: `provisioning`, `running`, `sleeping`, `suspended`, `degraded`, `failed`, `blocked`, `destroying`, `destroyed`, `expired` - `statusReason` (string, required, nullable) - `updatedAt` (string, required) - `url` (string, required, nullable) ### ErrorDetailsItems - `message` (string, required) - `code` (string, optional) — Stable Runtype validation code (e.g. MISSING_REQUIRED_FIELD, INVALID_ENUM). - `path` (string, optional) — Dotted JSON path to the offending field. - `suggestion` (string, optional) — Actionable hint (allowed values, accepted range, …). ### V1SandboxDeploymentsIdPutRequestBodyContentApplicationJsonSchemaOneOf0Spec - `availability` (enum, required) - Allowed values: `on-demand`, `warm` - `capabilities` (list of enum, required) - Allowed values: `inspect-without-start`, `network-policy`, `private-ingress`, `process-adoption`, `rebuild`, `terminate:process-tree`, `terminate:sandbox-destroy`, `terminate:sandbox-stop`, `wake` - `credentialAuthority` (V1SandboxDeploymentsIdPutRequestBodyContentApplicationJsonSchemaOneOf0SpecCredentialAuthority, required) - `health` (V1SandboxDeploymentsIdPutRequestBodyContentApplicationJsonSchemaOneOf0SpecHealth, required) - `ingress` (V1SandboxDeploymentsIdPutRequestBodyContentApplicationJsonSchemaOneOf0SpecIngress, required) - `language` (enum, required) - Allowed values: `javascript`, `typescript`, `python` - `networkPolicyRef` (string, required) - `port` (integer, required) - `profile` (V1SandboxDeploymentsIdPutRequestBodyContentApplicationJsonSchemaOneOf0SpecProfile, required) - `restartPolicy` (enum, required) - Allowed values: `never`, `process`, `replace-sandbox` - `retention` (enum, required) - Allowed values: `10m`, `1h`, `24h`, `unlimited` - `runtimeProfile` (V1SandboxDeploymentsIdPutRequestBodyContentApplicationJsonSchemaOneOf0SpecRuntimeProfile, required) - `sleepPolicy` (V1SandboxDeploymentsIdPutRequestBodyContentApplicationJsonSchemaOneOf0SpecSleepPolicy, required) - `source` (V1SandboxDeploymentsIdPutRequestBodyContentApplicationJsonSchemaOneOf0SpecSource, required) - `startCommand` (string, required) - `networkAccess` (V1SandboxDeploymentsIdPutRequestBodyContentApplicationJsonSchemaOneOf0SpecNetworkAccess, optional) - `secretBindings` (map from string to string, optional, default: {}) ### V1SandboxDeploymentsIdPutRequestBodyContentApplicationJsonSchemaOneOf1Config - `credentialAuthority` (V1SandboxDeploymentsIdPutRequestBodyContentApplicationJsonSchemaOneOf1ConfigCredentialAuthority, required) - `language` (enum, required) - Allowed values: `javascript`, `typescript`, `python` - `port` (integer, required) - `retention` (enum, required) - Allowed values: `10m`, `1h`, `24h`, `unlimited` - `runtimeProfileId` (string, required) - `sourceAssetId` (string, required) - `startCommand` (string, required) - `health` (V1SandboxDeploymentsIdPutRequestBodyContentApplicationJsonSchemaOneOf1ConfigHealth, optional) - `ingress` (V1SandboxDeploymentsIdPutRequestBodyContentApplicationJsonSchemaOneOf1ConfigIngress, optional) - `networkAccess` (V1SandboxDeploymentsIdPutRequestBodyContentApplicationJsonSchemaOneOf1ConfigNetworkAccess, optional) - `restartPolicy` (enum, optional) - Allowed values: `never`, `replace-sandbox` - `secretBindings` (map from string to string, optional) - `sleepPolicy` (V1SandboxDeploymentsIdPutRequestBodyContentApplicationJsonSchemaOneOf1ConfigSleepPolicy, optional) ### V1SandboxDeploymentsIdPutResponsesContentApplicationJsonSchemaDeploymentCounters - `desiredRevision` (integer, required) - `observedRevision` (integer, required, nullable) - `providerGeneration` (integer, required) - `resourceVersion` (integer, required) - `runtimeEpoch` (integer, required) ### V1SandboxDeploymentsIdPutResponsesContentApplicationJsonSchemaDeploymentEffectivePolicy - `access` (enum, required) - Allowed values: `bearer`, `public` - `availability` (enum, required) - Allowed values: `on-demand`, `warm` - `restartPolicy` (enum, required) - Allowed values: `never`, `process`, `replace-sandbox` - `retention` (enum, required) - Allowed values: `10m`, `1h`, `24h`, `unlimited` - `sleepPolicy` (V1SandboxDeploymentsIdPutResponsesContentApplicationJsonSchemaDeploymentEffectivePolicySleepPolicy, required) - `networkAccess` (V1SandboxDeploymentsIdPutResponsesContentApplicationJsonSchemaDeploymentEffectivePolicyNetworkAccess, optional) ### V1SandboxDeploymentsIdPutResponsesContentApplicationJsonSchemaDeploymentProfile - `accountTier` (string, required) - `environment` (enum, required) - Allowed values: `development`, `staging`, `production` - `profileId` (string, required) - `providerId` (string, required) - `runtimeClass` (string, required) - `sdkVersion` (string, required) ### V1SandboxDeploymentsIdPutRequestBodyContentApplicationJsonSchemaOneOf0SpecCredentialAuthority ### V1SandboxDeploymentsIdPutRequestBodyContentApplicationJsonSchemaOneOf0SpecHealth ### V1SandboxDeploymentsIdPutRequestBodyContentApplicationJsonSchemaOneOf0SpecIngress - `access` (enum, required) - Allowed values: `bearer`, `public` - `allowedOrigins` (list of string, optional, default: []) ### V1SandboxDeploymentsIdPutRequestBodyContentApplicationJsonSchemaOneOf0SpecProfile - `accountTier` (string, required) - `environment` (enum, required) - Allowed values: `development`, `staging`, `production` - `profileId` (string, required) - `providerId` (string, required) - `runtimeClass` (string, required) - `sdkVersion` (string, required) ### V1SandboxDeploymentsIdPutRequestBodyContentApplicationJsonSchemaOneOf0SpecRuntimeProfile - `runtimeProfileDigest` (string, required) - `runtimeProfileId` (string, required) ### V1SandboxDeploymentsIdPutRequestBodyContentApplicationJsonSchemaOneOf0SpecSleepPolicy ### V1SandboxDeploymentsIdPutRequestBodyContentApplicationJsonSchemaOneOf0SpecSource - `sourceAssetId` (string, required) - `sourceHash` (string, required) ### V1SandboxDeploymentsIdPutRequestBodyContentApplicationJsonSchemaOneOf0SpecNetworkAccess ### V1SandboxDeploymentsIdPutRequestBodyContentApplicationJsonSchemaOneOf1ConfigCredentialAuthority ### V1SandboxDeploymentsIdPutRequestBodyContentApplicationJsonSchemaOneOf1ConfigHealth ### V1SandboxDeploymentsIdPutRequestBodyContentApplicationJsonSchemaOneOf1ConfigIngress - `access` (enum, required) - Allowed values: `bearer`, `public` - `allowedOrigins` (list of string, optional) ### V1SandboxDeploymentsIdPutRequestBodyContentApplicationJsonSchemaOneOf1ConfigNetworkAccess ### V1SandboxDeploymentsIdPutRequestBodyContentApplicationJsonSchemaOneOf1ConfigSleepPolicy ### V1SandboxDeploymentsIdPutResponsesContentApplicationJsonSchemaDeploymentEffectivePolicySleepPolicy ### V1SandboxDeploymentsIdPutResponsesContentApplicationJsonSchemaDeploymentEffectivePolicyNetworkAccess ### V1SandboxDeploymentsIdPutRequestBodyContentApplicationJsonSchemaOneOf0SpecCredentialAuthority0 - `connectionId` (string, required) - `kind` (enum, required) - Allowed values: `organization-connection` ### V1SandboxDeploymentsIdPutRequestBodyContentApplicationJsonSchemaOneOf0SpecCredentialAuthority1 - `kind` (enum, required) - Allowed values: `platform-managed` - `providerPolicyId` (string, required) ### V1SandboxDeploymentsIdPutRequestBodyContentApplicationJsonSchemaOneOf0SpecHealth0 - `kind` (enum, required) - Allowed values: `tcp` ### V1SandboxDeploymentsIdPutRequestBodyContentApplicationJsonSchemaOneOf0SpecHealth1 - `expectedStatus` (integer, required) - `kind` (enum, required) - Allowed values: `http` - `path` (string, required) ### V1SandboxDeploymentsIdPutRequestBodyContentApplicationJsonSchemaOneOf0SpecSleepPolicy0 - `mode` (enum, required) - Allowed values: `never` ### V1SandboxDeploymentsIdPutRequestBodyContentApplicationJsonSchemaOneOf0SpecSleepPolicy1 - `after` (enum, required) - Allowed values: `5m`, `15m`, `30m`, `1h` - `mode` (enum, required) - Allowed values: `idle` ### V1SandboxDeploymentsIdPutRequestBodyContentApplicationJsonSchemaOneOf0SpecNetworkAccess1 - `allow` (list of string, optional) - `profile` (enum, optional) - Allowed values: `none`, `essentials`, `open` ### V1SandboxDeploymentsIdPutRequestBodyContentApplicationJsonSchemaOneOf1ConfigCredentialAuthority0 - `connectionId` (string, required) - `kind` (enum, required) - Allowed values: `organization-connection` ### V1SandboxDeploymentsIdPutRequestBodyContentApplicationJsonSchemaOneOf1ConfigCredentialAuthority1 - `kind` (enum, required) - Allowed values: `platform-managed` - `providerPolicyId` (string, required) ### V1SandboxDeploymentsIdPutRequestBodyContentApplicationJsonSchemaOneOf1ConfigHealth0 - `kind` (enum, required) - Allowed values: `tcp` ### V1SandboxDeploymentsIdPutRequestBodyContentApplicationJsonSchemaOneOf1ConfigHealth1 - `expectedStatus` (integer, required) - `kind` (enum, required) - Allowed values: `http` - `path` (string, required) ### V1SandboxDeploymentsIdPutRequestBodyContentApplicationJsonSchemaOneOf1ConfigNetworkAccess1 - `allow` (list of string, required) - `profile` (enum, required) - Allowed values: `none`, `essentials` ### V1SandboxDeploymentsIdPutRequestBodyContentApplicationJsonSchemaOneOf1ConfigSleepPolicy0 - `mode` (enum, required) - Allowed values: `never` ### V1SandboxDeploymentsIdPutRequestBodyContentApplicationJsonSchemaOneOf1ConfigSleepPolicy1 - `after` (enum, required) - Allowed values: `5m`, `15m`, `30m`, `1h` - `mode` (enum, required) - Allowed values: `idle` ### V1SandboxDeploymentsIdPutResponsesContentApplicationJsonSchemaDeploymentEffectivePolicySleepPolicy0 - `mode` (enum, required) - Allowed values: `never` ### V1SandboxDeploymentsIdPutResponsesContentApplicationJsonSchemaDeploymentEffectivePolicySleepPolicy1 - `after` (enum, required) - Allowed values: `5m`, `15m`, `30m`, `1h` - `mode` (enum, required) - Allowed values: `idle` ### V1SandboxDeploymentsIdPutResponsesContentApplicationJsonSchemaDeploymentEffectivePolicyNetworkAccess1 - `allow` (list of string, optional) - `profile` (enum, optional) - Allowed values: `none`, `essentials`, `open` ## Examples ### Example 1 **Request** ```json { "spec": { "availability": "on-demand", "capabilities": [ "inspect-without-start" ], "credentialAuthority": { "connectionId": "string", "kind": "organization-connection" }, "health": { "kind": "tcp" }, "ingress": { "access": "bearer" }, "language": "javascript", "networkPolicyRef": "string", "port": 1, "profile": { "accountTier": "string", "environment": "development", "profileId": "string", "providerId": "string", "runtimeClass": "string", "sdkVersion": "string" }, "restartPolicy": "never", "retention": "10m", "runtimeProfile": { "runtimeProfileDigest": "string", "runtimeProfileId": "string" }, "sleepPolicy": { "mode": "never" }, "source": { "sourceAssetId": "string", "sourceHash": "string" }, "startCommand": "string" } } ``` **Response** ```json { "deployment": { "activeOperationId": "string", "activeProviderInstanceId": "string", "counters": { "desiredRevision": 1, "observedRevision": 1, "providerGeneration": 1, "resourceVersion": 1, "runtimeEpoch": 1 }, "createdAt": "string", "createdByUserId": "string", "deploymentId": "string", "desiredState": "active", "displayName": "string", "effectivePolicy": { "access": "bearer", "availability": "on-demand", "restartPolicy": "never", "retention": "10m", "sleepPolicy": { "mode": "never" }, "networkAccess": "none" }, "environment": "development", "expiresAt": "string", "ingressEnabled": true, "organizationId": "string", "profile": { "accountTier": "string", "environment": "development", "profileId": "string", "providerId": "string", "runtimeClass": "string", "sdkVersion": "string" }, "retentionAnchorAt": "string", "specHash": "string", "status": "provisioning", "statusReason": "string", "updatedAt": "string", "url": "string" }, "operationId": "string" } ``` **SDK Code** ```python import requests url = "https://api.runtype.com/v1/sandbox-deployments/id" payload = { "spec": { "availability": "on-demand", "capabilities": ["inspect-without-start"], "credentialAuthority": { "connectionId": "string", "kind": "organization-connection" }, "health": { "kind": "tcp" }, "ingress": { "access": "bearer" }, "language": "javascript", "networkPolicyRef": "string", "port": 1, "profile": { "accountTier": "string", "environment": "development", "profileId": "string", "providerId": "string", "runtimeClass": "string", "sdkVersion": "string" }, "restartPolicy": "never", "retention": "10m", "runtimeProfile": { "runtimeProfileDigest": "string", "runtimeProfileId": "string" }, "sleepPolicy": { "mode": "never" }, "source": { "sourceAssetId": "string", "sourceHash": "string" }, "startCommand": "string" } } headers = { "Authorization": "Bearer ", "Content-Type": "application/json" } response = requests.put(url, json=payload, headers=headers) print(response.json()) ``` ```javascript const url = 'https://api.runtype.com/v1/sandbox-deployments/id'; const options = { method: 'PUT', headers: {Authorization: 'Bearer ', 'Content-Type': 'application/json'}, body: '{"spec":{"availability":"on-demand","capabilities":["inspect-without-start"],"credentialAuthority":{"connectionId":"string","kind":"organization-connection"},"health":{"kind":"tcp"},"ingress":{"access":"bearer"},"language":"javascript","networkPolicyRef":"string","port":1,"profile":{"accountTier":"string","environment":"development","profileId":"string","providerId":"string","runtimeClass":"string","sdkVersion":"string"},"restartPolicy":"never","retention":"10m","runtimeProfile":{"runtimeProfileDigest":"string","runtimeProfileId":"string"},"sleepPolicy":{"mode":"never"},"source":{"sourceAssetId":"string","sourceHash":"string"},"startCommand":"string"}}' }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "https://api.runtype.com/v1/sandbox-deployments/id" payload := strings.NewReader("{\n \"spec\": {\n \"availability\": \"on-demand\",\n \"capabilities\": [\n \"inspect-without-start\"\n ],\n \"credentialAuthority\": {\n \"connectionId\": \"string\",\n \"kind\": \"organization-connection\"\n },\n \"health\": {\n \"kind\": \"tcp\"\n },\n \"ingress\": {\n \"access\": \"bearer\"\n },\n \"language\": \"javascript\",\n \"networkPolicyRef\": \"string\",\n \"port\": 1,\n \"profile\": {\n \"accountTier\": \"string\",\n \"environment\": \"development\",\n \"profileId\": \"string\",\n \"providerId\": \"string\",\n \"runtimeClass\": \"string\",\n \"sdkVersion\": \"string\"\n },\n \"restartPolicy\": \"never\",\n \"retention\": \"10m\",\n \"runtimeProfile\": {\n \"runtimeProfileDigest\": \"string\",\n \"runtimeProfileId\": \"string\"\n },\n \"sleepPolicy\": {\n \"mode\": \"never\"\n },\n \"source\": {\n \"sourceAssetId\": \"string\",\n \"sourceHash\": \"string\"\n },\n \"startCommand\": \"string\"\n }\n}") req, _ := http.NewRequest("PUT", url, payload) req.Header.Add("Authorization", "Bearer ") req.Header.Add("Content-Type", "application/json") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://api.runtype.com/v1/sandbox-deployments/id") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Put.new(url) request["Authorization"] = 'Bearer ' request["Content-Type"] = 'application/json' request.body = "{\n \"spec\": {\n \"availability\": \"on-demand\",\n \"capabilities\": [\n \"inspect-without-start\"\n ],\n \"credentialAuthority\": {\n \"connectionId\": \"string\",\n \"kind\": \"organization-connection\"\n },\n \"health\": {\n \"kind\": \"tcp\"\n },\n \"ingress\": {\n \"access\": \"bearer\"\n },\n \"language\": \"javascript\",\n \"networkPolicyRef\": \"string\",\n \"port\": 1,\n \"profile\": {\n \"accountTier\": \"string\",\n \"environment\": \"development\",\n \"profileId\": \"string\",\n \"providerId\": \"string\",\n \"runtimeClass\": \"string\",\n \"sdkVersion\": \"string\"\n },\n \"restartPolicy\": \"never\",\n \"retention\": \"10m\",\n \"runtimeProfile\": {\n \"runtimeProfileDigest\": \"string\",\n \"runtimeProfileId\": \"string\"\n },\n \"sleepPolicy\": {\n \"mode\": \"never\"\n },\n \"source\": {\n \"sourceAssetId\": \"string\",\n \"sourceHash\": \"string\"\n },\n \"startCommand\": \"string\"\n }\n}" response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.put("https://api.runtype.com/v1/sandbox-deployments/id") .header("Authorization", "Bearer ") .header("Content-Type", "application/json") .body("{\n \"spec\": {\n \"availability\": \"on-demand\",\n \"capabilities\": [\n \"inspect-without-start\"\n ],\n \"credentialAuthority\": {\n \"connectionId\": \"string\",\n \"kind\": \"organization-connection\"\n },\n \"health\": {\n \"kind\": \"tcp\"\n },\n \"ingress\": {\n \"access\": \"bearer\"\n },\n \"language\": \"javascript\",\n \"networkPolicyRef\": \"string\",\n \"port\": 1,\n \"profile\": {\n \"accountTier\": \"string\",\n \"environment\": \"development\",\n \"profileId\": \"string\",\n \"providerId\": \"string\",\n \"runtimeClass\": \"string\",\n \"sdkVersion\": \"string\"\n },\n \"restartPolicy\": \"never\",\n \"retention\": \"10m\",\n \"runtimeProfile\": {\n \"runtimeProfileDigest\": \"string\",\n \"runtimeProfileId\": \"string\"\n },\n \"sleepPolicy\": {\n \"mode\": \"never\"\n },\n \"source\": {\n \"sourceAssetId\": \"string\",\n \"sourceHash\": \"string\"\n },\n \"startCommand\": \"string\"\n }\n}") .asString(); ``` ```php request('PUT', 'https://api.runtype.com/v1/sandbox-deployments/id', [ 'body' => '{ "spec": { "availability": "on-demand", "capabilities": [ "inspect-without-start" ], "credentialAuthority": { "connectionId": "string", "kind": "organization-connection" }, "health": { "kind": "tcp" }, "ingress": { "access": "bearer" }, "language": "javascript", "networkPolicyRef": "string", "port": 1, "profile": { "accountTier": "string", "environment": "development", "profileId": "string", "providerId": "string", "runtimeClass": "string", "sdkVersion": "string" }, "restartPolicy": "never", "retention": "10m", "runtimeProfile": { "runtimeProfileDigest": "string", "runtimeProfileId": "string" }, "sleepPolicy": { "mode": "never" }, "source": { "sourceAssetId": "string", "sourceHash": "string" }, "startCommand": "string" } }', 'headers' => [ 'Authorization' => 'Bearer ', 'Content-Type' => 'application/json', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://api.runtype.com/v1/sandbox-deployments/id"); var request = new RestRequest(Method.PUT); request.AddHeader("Authorization", "Bearer "); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{\n \"spec\": {\n \"availability\": \"on-demand\",\n \"capabilities\": [\n \"inspect-without-start\"\n ],\n \"credentialAuthority\": {\n \"connectionId\": \"string\",\n \"kind\": \"organization-connection\"\n },\n \"health\": {\n \"kind\": \"tcp\"\n },\n \"ingress\": {\n \"access\": \"bearer\"\n },\n \"language\": \"javascript\",\n \"networkPolicyRef\": \"string\",\n \"port\": 1,\n \"profile\": {\n \"accountTier\": \"string\",\n \"environment\": \"development\",\n \"profileId\": \"string\",\n \"providerId\": \"string\",\n \"runtimeClass\": \"string\",\n \"sdkVersion\": \"string\"\n },\n \"restartPolicy\": \"never\",\n \"retention\": \"10m\",\n \"runtimeProfile\": {\n \"runtimeProfileDigest\": \"string\",\n \"runtimeProfileId\": \"string\"\n },\n \"sleepPolicy\": {\n \"mode\": \"never\"\n },\n \"source\": {\n \"sourceAssetId\": \"string\",\n \"sourceHash\": \"string\"\n },\n \"startCommand\": \"string\"\n }\n}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = [ "Authorization": "Bearer ", "Content-Type": "application/json" ] let parameters = ["spec": [ "availability": "on-demand", "capabilities": ["inspect-without-start"], "credentialAuthority": [ "connectionId": "string", "kind": "organization-connection" ], "health": ["kind": "tcp"], "ingress": ["access": "bearer"], "language": "javascript", "networkPolicyRef": "string", "port": 1, "profile": [ "accountTier": "string", "environment": "development", "profileId": "string", "providerId": "string", "runtimeClass": "string", "sdkVersion": "string" ], "restartPolicy": "never", "retention": "10m", "runtimeProfile": [ "runtimeProfileDigest": "string", "runtimeProfileId": "string" ], "sleepPolicy": ["mode": "never"], "source": [ "sourceAssetId": "string", "sourceHash": "string" ], "startCommand": "string" ]] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://api.runtype.com/v1/sandbox-deployments/id")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "PUT" request.allHTTPHeaderFields = headers request.httpBody = postData as Data let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ``` ### Example 2 **Request** ```json { "spec": { "availability": "on-demand", "capabilities": [ "inspect-without-start" ], "credentialAuthority": { "connectionId": "string", "kind": "organization-connection" }, "health": { "kind": "tcp" }, "ingress": { "access": "bearer" }, "language": "javascript", "networkPolicyRef": "string", "port": 1, "profile": { "accountTier": "string", "environment": "development", "profileId": "string", "providerId": "string", "runtimeClass": "string", "sdkVersion": "string" }, "restartPolicy": "never", "retention": "10m", "runtimeProfile": { "runtimeProfileDigest": "string", "runtimeProfileId": "string" }, "sleepPolicy": { "mode": "never" }, "source": { "sourceAssetId": "string", "sourceHash": "string" }, "startCommand": "string" } } ``` **Response** ```json { "deployment": { "activeOperationId": "string", "activeProviderInstanceId": "string", "counters": { "desiredRevision": 1, "observedRevision": 1, "providerGeneration": 1, "resourceVersion": 1, "runtimeEpoch": 1 }, "createdAt": "string", "createdByUserId": "string", "deploymentId": "string", "desiredState": "active", "displayName": "string", "effectivePolicy": { "access": "bearer", "availability": "on-demand", "restartPolicy": "never", "retention": "10m", "sleepPolicy": { "mode": "never" }, "networkAccess": "none" }, "environment": "development", "expiresAt": "string", "ingressEnabled": true, "organizationId": "string", "profile": { "accountTier": "string", "environment": "development", "profileId": "string", "providerId": "string", "runtimeClass": "string", "sdkVersion": "string" }, "retentionAnchorAt": "string", "specHash": "string", "status": "provisioning", "statusReason": "string", "updatedAt": "string", "url": "string" }, "operationId": "string" } ``` **SDK Code** ```python import requests url = "https://api.runtype.com/v1/sandbox-deployments/id" payload = { "spec": { "availability": "on-demand", "capabilities": ["inspect-without-start"], "credentialAuthority": { "connectionId": "string", "kind": "organization-connection" }, "health": { "kind": "tcp" }, "ingress": { "access": "bearer" }, "language": "javascript", "networkPolicyRef": "string", "port": 1, "profile": { "accountTier": "string", "environment": "development", "profileId": "string", "providerId": "string", "runtimeClass": "string", "sdkVersion": "string" }, "restartPolicy": "never", "retention": "10m", "runtimeProfile": { "runtimeProfileDigest": "string", "runtimeProfileId": "string" }, "sleepPolicy": { "mode": "never" }, "source": { "sourceAssetId": "string", "sourceHash": "string" }, "startCommand": "string" } } headers = { "Authorization": "Bearer ", "Content-Type": "application/json" } response = requests.put(url, json=payload, headers=headers) print(response.json()) ``` ```javascript const url = 'https://api.runtype.com/v1/sandbox-deployments/id'; const options = { method: 'PUT', headers: {Authorization: 'Bearer ', 'Content-Type': 'application/json'}, body: '{"spec":{"availability":"on-demand","capabilities":["inspect-without-start"],"credentialAuthority":{"connectionId":"string","kind":"organization-connection"},"health":{"kind":"tcp"},"ingress":{"access":"bearer"},"language":"javascript","networkPolicyRef":"string","port":1,"profile":{"accountTier":"string","environment":"development","profileId":"string","providerId":"string","runtimeClass":"string","sdkVersion":"string"},"restartPolicy":"never","retention":"10m","runtimeProfile":{"runtimeProfileDigest":"string","runtimeProfileId":"string"},"sleepPolicy":{"mode":"never"},"source":{"sourceAssetId":"string","sourceHash":"string"},"startCommand":"string"}}' }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "https://api.runtype.com/v1/sandbox-deployments/id" payload := strings.NewReader("{\n \"spec\": {\n \"availability\": \"on-demand\",\n \"capabilities\": [\n \"inspect-without-start\"\n ],\n \"credentialAuthority\": {\n \"connectionId\": \"string\",\n \"kind\": \"organization-connection\"\n },\n \"health\": {\n \"kind\": \"tcp\"\n },\n \"ingress\": {\n \"access\": \"bearer\"\n },\n \"language\": \"javascript\",\n \"networkPolicyRef\": \"string\",\n \"port\": 1,\n \"profile\": {\n \"accountTier\": \"string\",\n \"environment\": \"development\",\n \"profileId\": \"string\",\n \"providerId\": \"string\",\n \"runtimeClass\": \"string\",\n \"sdkVersion\": \"string\"\n },\n \"restartPolicy\": \"never\",\n \"retention\": \"10m\",\n \"runtimeProfile\": {\n \"runtimeProfileDigest\": \"string\",\n \"runtimeProfileId\": \"string\"\n },\n \"sleepPolicy\": {\n \"mode\": \"never\"\n },\n \"source\": {\n \"sourceAssetId\": \"string\",\n \"sourceHash\": \"string\"\n },\n \"startCommand\": \"string\"\n }\n}") req, _ := http.NewRequest("PUT", url, payload) req.Header.Add("Authorization", "Bearer ") req.Header.Add("Content-Type", "application/json") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://api.runtype.com/v1/sandbox-deployments/id") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Put.new(url) request["Authorization"] = 'Bearer ' request["Content-Type"] = 'application/json' request.body = "{\n \"spec\": {\n \"availability\": \"on-demand\",\n \"capabilities\": [\n \"inspect-without-start\"\n ],\n \"credentialAuthority\": {\n \"connectionId\": \"string\",\n \"kind\": \"organization-connection\"\n },\n \"health\": {\n \"kind\": \"tcp\"\n },\n \"ingress\": {\n \"access\": \"bearer\"\n },\n \"language\": \"javascript\",\n \"networkPolicyRef\": \"string\",\n \"port\": 1,\n \"profile\": {\n \"accountTier\": \"string\",\n \"environment\": \"development\",\n \"profileId\": \"string\",\n \"providerId\": \"string\",\n \"runtimeClass\": \"string\",\n \"sdkVersion\": \"string\"\n },\n \"restartPolicy\": \"never\",\n \"retention\": \"10m\",\n \"runtimeProfile\": {\n \"runtimeProfileDigest\": \"string\",\n \"runtimeProfileId\": \"string\"\n },\n \"sleepPolicy\": {\n \"mode\": \"never\"\n },\n \"source\": {\n \"sourceAssetId\": \"string\",\n \"sourceHash\": \"string\"\n },\n \"startCommand\": \"string\"\n }\n}" response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.put("https://api.runtype.com/v1/sandbox-deployments/id") .header("Authorization", "Bearer ") .header("Content-Type", "application/json") .body("{\n \"spec\": {\n \"availability\": \"on-demand\",\n \"capabilities\": [\n \"inspect-without-start\"\n ],\n \"credentialAuthority\": {\n \"connectionId\": \"string\",\n \"kind\": \"organization-connection\"\n },\n \"health\": {\n \"kind\": \"tcp\"\n },\n \"ingress\": {\n \"access\": \"bearer\"\n },\n \"language\": \"javascript\",\n \"networkPolicyRef\": \"string\",\n \"port\": 1,\n \"profile\": {\n \"accountTier\": \"string\",\n \"environment\": \"development\",\n \"profileId\": \"string\",\n \"providerId\": \"string\",\n \"runtimeClass\": \"string\",\n \"sdkVersion\": \"string\"\n },\n \"restartPolicy\": \"never\",\n \"retention\": \"10m\",\n \"runtimeProfile\": {\n \"runtimeProfileDigest\": \"string\",\n \"runtimeProfileId\": \"string\"\n },\n \"sleepPolicy\": {\n \"mode\": \"never\"\n },\n \"source\": {\n \"sourceAssetId\": \"string\",\n \"sourceHash\": \"string\"\n },\n \"startCommand\": \"string\"\n }\n}") .asString(); ``` ```php request('PUT', 'https://api.runtype.com/v1/sandbox-deployments/id', [ 'body' => '{ "spec": { "availability": "on-demand", "capabilities": [ "inspect-without-start" ], "credentialAuthority": { "connectionId": "string", "kind": "organization-connection" }, "health": { "kind": "tcp" }, "ingress": { "access": "bearer" }, "language": "javascript", "networkPolicyRef": "string", "port": 1, "profile": { "accountTier": "string", "environment": "development", "profileId": "string", "providerId": "string", "runtimeClass": "string", "sdkVersion": "string" }, "restartPolicy": "never", "retention": "10m", "runtimeProfile": { "runtimeProfileDigest": "string", "runtimeProfileId": "string" }, "sleepPolicy": { "mode": "never" }, "source": { "sourceAssetId": "string", "sourceHash": "string" }, "startCommand": "string" } }', 'headers' => [ 'Authorization' => 'Bearer ', 'Content-Type' => 'application/json', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://api.runtype.com/v1/sandbox-deployments/id"); var request = new RestRequest(Method.PUT); request.AddHeader("Authorization", "Bearer "); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{\n \"spec\": {\n \"availability\": \"on-demand\",\n \"capabilities\": [\n \"inspect-without-start\"\n ],\n \"credentialAuthority\": {\n \"connectionId\": \"string\",\n \"kind\": \"organization-connection\"\n },\n \"health\": {\n \"kind\": \"tcp\"\n },\n \"ingress\": {\n \"access\": \"bearer\"\n },\n \"language\": \"javascript\",\n \"networkPolicyRef\": \"string\",\n \"port\": 1,\n \"profile\": {\n \"accountTier\": \"string\",\n \"environment\": \"development\",\n \"profileId\": \"string\",\n \"providerId\": \"string\",\n \"runtimeClass\": \"string\",\n \"sdkVersion\": \"string\"\n },\n \"restartPolicy\": \"never\",\n \"retention\": \"10m\",\n \"runtimeProfile\": {\n \"runtimeProfileDigest\": \"string\",\n \"runtimeProfileId\": \"string\"\n },\n \"sleepPolicy\": {\n \"mode\": \"never\"\n },\n \"source\": {\n \"sourceAssetId\": \"string\",\n \"sourceHash\": \"string\"\n },\n \"startCommand\": \"string\"\n }\n}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = [ "Authorization": "Bearer ", "Content-Type": "application/json" ] let parameters = ["spec": [ "availability": "on-demand", "capabilities": ["inspect-without-start"], "credentialAuthority": [ "connectionId": "string", "kind": "organization-connection" ], "health": ["kind": "tcp"], "ingress": ["access": "bearer"], "language": "javascript", "networkPolicyRef": "string", "port": 1, "profile": [ "accountTier": "string", "environment": "development", "profileId": "string", "providerId": "string", "runtimeClass": "string", "sdkVersion": "string" ], "restartPolicy": "never", "retention": "10m", "runtimeProfile": [ "runtimeProfileDigest": "string", "runtimeProfileId": "string" ], "sleepPolicy": ["mode": "never"], "source": [ "sourceAssetId": "string", "sourceHash": "string" ], "startCommand": "string" ]] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://api.runtype.com/v1/sandbox-deployments/id")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "PUT" request.allHTTPHeaderFields = headers request.httpBody = postData as Data let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```