Skip to main content
PATCH
/
v2
/
deployments
/
{deployment_id}
/
deployment-tier
Patch Deployment Tier
curl --request PATCH \
  --url https://api.example.com/v2/deployments/{deployment_id}/deployment-tier \
  --header 'Content-Type: application/json' \
  --data '{}'
import requests

url = "https://api.example.com/v2/deployments/{deployment_id}/deployment-tier"

payload = {}
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({})
};

fetch('https://api.example.com/v2/deployments/{deployment_id}/deployment-tier', 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/deployments/{deployment_id}/deployment-tier",
  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([
    
  ]),
  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/deployments/{deployment_id}/deployment-tier"

	payload := strings.NewReader("{}")

	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/deployments/{deployment_id}/deployment-tier")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/v2/deployments/{deployment_id}/deployment-tier")

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 = "{}"

response = http.request(request)
puts response.read_body
{
  "name": "<string>",
  "source_config": {
    "integration_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "repo_url": "<string>",
    "build_on_push": true,
    "custom_url": "<string>",
    "resource_spec": {
      "min_scale": 123,
      "max_scale": 123,
      "cpu": 0.1,
      "cpu_limit": 0.2,
      "memory_mb": 123,
      "memory_limit_mb": 123,
      "queue_min_scale": 123,
      "queue_max_scale": 123,
      "queue_cpu": 0.1,
      "queue_cpu_limit": 0.2,
      "queue_memory_mb": 123,
      "queue_memory_limit_mb": 123,
      "redis_cpu": 0.1,
      "redis_cpu_limit": 0.2,
      "redis_memory_mb": 123,
      "redis_memory_limit_mb": 123,
      "core_cpu": 1.1,
      "core_cpu_limit": 1.1,
      "core_memory_mb": 123,
      "core_memory_limit_mb": 123,
      "labels": {},
      "annotations": {},
      "service_account_name": "<string>",
      "image_pull_secrets": [
        {
          "name": "<string>"
        }
      ],
      "volumes": [
        {
          "name": "<string>",
          "configMap": {},
          "secret": {},
          "emptyDir": {},
          "persistentVolumeClaim": {},
          "nfs": {},
          "projected": {},
          "downwardAPI": {},
          "csi": {}
        }
      ],
      "volume_mounts": [
        {
          "name": "<string>",
          "mountPath": "<string>",
          "subPath": "<string>",
          "mountPropagation": "<string>",
          "readOnly": true,
          "subPathExpr": "<string>"
        }
      ],
      "init_containers": [
        {
          "name": "<string>",
          "image": "<string>",
          "imagePullPolicy": "<string>",
          "command": [
            "<string>"
          ],
          "args": [
            "<string>"
          ],
          "workingDir": "<string>",
          "env": [
            {
              "name": "<string>",
              "value": "<string>",
              "valueFrom": {}
            }
          ],
          "envFrom": [
            {}
          ],
          "resources": {
            "limits": {},
            "requests": {}
          },
          "volumeMounts": [
            {
              "name": "<string>",
              "mountPath": "<string>",
              "subPath": "<string>",
              "mountPropagation": "<string>",
              "readOnly": true,
              "subPathExpr": "<string>"
            }
          ],
          "securityContext": {},
          "restartPolicy": "<string>"
        }
      ],
      "sidecars": [
        {
          "name": "<string>",
          "image": "<string>",
          "imagePullPolicy": "<string>",
          "command": [
            "<string>"
          ],
          "args": [
            "<string>"
          ],
          "workingDir": "<string>",
          "env": [
            {
              "name": "<string>",
              "value": "<string>",
              "valueFrom": {}
            }
          ],
          "envFrom": [
            {}
          ],
          "resources": {
            "limits": {},
            "requests": {}
          },
          "volumeMounts": [
            {
              "name": "<string>",
              "mountPath": "<string>",
              "subPath": "<string>",
              "mountPropagation": "<string>",
              "readOnly": true,
              "subPathExpr": "<string>"
            }
          ],
          "securityContext": {},
          "restartPolicy": "<string>"
        }
      ],
      "db_cpu": 123,
      "db_cpu_limit": 123,
      "db_memory_mb": 123,
      "db_memory_limit_mb": 123,
      "db_storage_gi": 123,
      "db_max_connections": 123
    },
    "listener_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "listener_config": {
      "k8s_namespace": "<string>"
    },
    "install_command": "<string>",
    "build_command": "<string>"
  },
  "source_revision_config": {
    "repo_ref": "<string>",
    "langgraph_config_path": "<string>",
    "image_uri": "<string>",
    "source_tarball_path": "<string>",
    "repo_commit_sha": "<string>"
  },
  "secrets": [
    {
      "name": "<string>",
      "value": "<string>"
    }
  ],
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "tenant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "latest_revision_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "active_revision_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "secret_references": [
    {
      "name": "<string>",
      "secret_name": "<string>",
      "secret_key": "<string>"
    }
  ],
  "image_version": "<string>",
  "is_managed_deep_agent": false
}
{
  "detail": "Error description."
}
{
  "detail": "Deployment ID {deployment_id} not found."
}
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Path Parameters

​
deployment_id
string<uuid>
required

Body

application/json

Request body for updating a deployment's fixed resource tier.

​
deployment_tier
enum<string>
required

Fixed resource tier to apply to the deployment. Serverless deployments support SERVERLESS_S, SERVERLESS_M, and SERVERLESS_L; dedicated deployments support DEDICATED_S, DEDICATED_M, and DEDICATED_L.

Available options:
SERVERLESS_S,
SERVERLESS_M,
SERVERLESS_L,
DEDICATED_S,
DEDICATED_M,
DEDICATED_L

Response

Successful Response

Deployment resource.

​
name
string
required

Name of the deployment.

A LangSmith tracing project with the same name will also automatically be created. This cannot be changed once the deployment is created.

​
source
enum<string>
required

Deploy from a GitHub repository (github), an external Docker image (external_docker), a CLI-pushed image (internal_docker), uploaded source (internal_source), or a prebuilt LangChain template (internal_template).

Deploying from GitHub, internal Docker, internal source, or a template is only available for Cloud SaaS deployments. Deploying from an external Docker image is only available for self-hosted deployments. This cannot be changed once the deployment is created.

Available options:
github,
external_docker,
internal_docker,
internal_source,
internal_template
​
source_config
SourceConfig · object
required

Source configuration.

​
source_revision_config
SourceRevisionConfig · object
required

Source revision configuration.

For a Deployment resource, the field values refer to the latest revision of the Deployment. For a Revision resource, the field values refer to the Revision itself.

​
secrets
Secret · object[]
required
​
id
string<uuid>
required

The ID of the deployment.

This is a read-only field.

​
tenant_id
string<uuid>
required

The ID of the tenant that owns the deployment.

This is a read-only field.

​
created_at
string<date-time>
required

The creation time of the deployment.

This is a read-only field.

​
updated_at
string<date-time>
required

The last update time of the deployment.

This is a read-only field.

​
status
enum<string>
required

The status of the deployment.

This is a read-only field.

Available options:
AWAITING_DATABASE,
READY,
UNUSED,
AWAITING_DELETE,
UNKNOWN
​
latest_revision_id
string<uuid> | null
required

The ID of the latest revision of the deployment.

This is a read-only field.

​
active_revision_id
string<uuid> | null
required

The ID of the current (actively deployed) revision of the deployment.

This is a read-only field.

​
secret_references
SecretReference · object[] | null

List of Kubernetes Secret references.

Only applicable for external_docker source.

​
image_version
string | null

Image version of the deployment.

​
is_managed_deep_agent
boolean
default:false

Whether this deployment is a Managed Deep Agent deployment.

This is a read-only field.

​
deployment_tier
enum<string> | null

The selected fixed resource tier for this deployment. Existing deployments without an explicit selection return the default tier for their deployment type.

Available options:
SERVERLESS_S,
SERVERLESS_M,
SERVERLESS_L,
DEDICATED_S,
DEDICATED_M,
DEDICATED_L