Patch Deployment Resource Tiers

curl --request PATCH \
  --url https://api.example.com/v2/deployments/{deployment_id}/resource-tiers \
  --header 'Content-Type: application/json' \
  --data '{}'

import requests

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

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}/resource-tiers', 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}/resource-tiers",
  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}/resource-tiers"

	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))

}

require 'uri'
require 'net/http'

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

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

{
  "source": "github",
  "source_config": {
    "integration_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "repo_url": "<string>",
    "deployment_type": "dev_free",
    "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,
      "cpu_target_percent": 50,
      "cpu_scaling_enabled": true,
      "cpu_limit_enabled": true,
      "autoscaling_behavior": {
        "scale_up": {
          "stabilization_window_seconds": 1800,
          "select_policy": "Max",
          "policies": [
            {
              "type": "Pods",
              "value": 500,
              "period_seconds": 900
            }
          ]
        },
        "scale_down": {
          "stabilization_window_seconds": 1800,
          "select_policy": "Max",
          "policies": [
            {
              "type": "Pods",
              "value": 500,
              "period_seconds": 900
            }
          ]
        }
      },
      "queue_cpu_target_percent": 50,
      "queue_cpu_scaling_enabled": true,
      "queue_cpu_limit_enabled": true,
      "queue_autoscaling_behavior": {
        "scale_up": {
          "stabilization_window_seconds": 1800,
          "select_policy": "Max",
          "policies": [
            {
              "type": "Pods",
              "value": 500,
              "period_seconds": 900
            }
          ]
        },
        "scale_down": {
          "stabilization_window_seconds": 1800,
          "select_policy": "Max",
          "policies": [
            {
              "type": "Pods",
              "value": 500,
              "period_seconds": 900
            }
          ]
        }
      }
    },
    "listener_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "listener_config": {
      "k8s_namespace": "<string>"
    },
    "install_command": "<string>",
    "build_command": "<string>",
    "repo_branch": "<string>"
  },
  "source_revision_config": {
    "repo_ref": "<string>",
    "langgraph_config_path": "<string>",
    "image_uri": "<string>",
    "source_tarball_path": "<string>",
    "repo_commit_sha": "<string>",
    "repo_commit_title": "<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",
  "status": "AWAITING_DATABASE",
  "latest_revision_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "active_revision_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "agent": {
    "agent_id": "<string>",
    "environment": "local"
  },
  "secret_references": [
    {
      "name": "<string>",
      "secret_name": "<string>",
      "secret_key": "<string>"
    }
  ],
  "extra_manifests": [
    {}
  ],
  "shareable": false,
  "route_through_gateway": false,
  "extra_manifests_configured": false,
  "extra_manifests_name_prefix": "<string>",
  "tracer_session_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "url": "<string>",
  "is_preview": false,
  "image_version": "<string>",
  "display_name": "<string>",
  "is_managed_deep_agent": false,
  "deployment_tier": "SERVERLESS_S",
  "compute_tier": "SERVERLESS_S",
  "database_tier": "SERVERLESS_S"
}

{
  "detail": "Error description."
}

{
  "detail": "Deployment ID {deployment_id} not found."
}

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

PATCH

deployments

{deployment_id}

resource-tiers

Patch Deployment Resource Tiers

curl --request PATCH \
  --url https://api.example.com/v2/deployments/{deployment_id}/resource-tiers \
  --header 'Content-Type: application/json' \
  --data '{}'

import requests

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

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}/resource-tiers', 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}/resource-tiers",
  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}/resource-tiers"

	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))

}

require 'uri'
require 'net/http'

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

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

{
  "source": "github",
  "source_config": {
    "integration_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "repo_url": "<string>",
    "deployment_type": "dev_free",
    "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,
      "cpu_target_percent": 50,
      "cpu_scaling_enabled": true,
      "cpu_limit_enabled": true,
      "autoscaling_behavior": {
        "scale_up": {
          "stabilization_window_seconds": 1800,
          "select_policy": "Max",
          "policies": [
            {
              "type": "Pods",
              "value": 500,
              "period_seconds": 900
            }
          ]
        },
        "scale_down": {
          "stabilization_window_seconds": 1800,
          "select_policy": "Max",
          "policies": [
            {
              "type": "Pods",
              "value": 500,
              "period_seconds": 900
            }
          ]
        }
      },
      "queue_cpu_target_percent": 50,
      "queue_cpu_scaling_enabled": true,
      "queue_cpu_limit_enabled": true,
      "queue_autoscaling_behavior": {
        "scale_up": {
          "stabilization_window_seconds": 1800,
          "select_policy": "Max",
          "policies": [
            {
              "type": "Pods",
              "value": 500,
              "period_seconds": 900
            }
          ]
        },
        "scale_down": {
          "stabilization_window_seconds": 1800,
          "select_policy": "Max",
          "policies": [
            {
              "type": "Pods",
              "value": 500,
              "period_seconds": 900
            }
          ]
        }
      }
    },
    "listener_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "listener_config": {
      "k8s_namespace": "<string>"
    },
    "install_command": "<string>",
    "build_command": "<string>",
    "repo_branch": "<string>"
  },
  "source_revision_config": {
    "repo_ref": "<string>",
    "langgraph_config_path": "<string>",
    "image_uri": "<string>",
    "source_tarball_path": "<string>",
    "repo_commit_sha": "<string>",
    "repo_commit_title": "<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",
  "status": "AWAITING_DATABASE",
  "latest_revision_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "active_revision_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "agent": {
    "agent_id": "<string>",
    "environment": "local"
  },
  "secret_references": [
    {
      "name": "<string>",
      "secret_name": "<string>",
      "secret_key": "<string>"
    }
  ],
  "extra_manifests": [
    {}
  ],
  "shareable": false,
  "route_through_gateway": false,
  "extra_manifests_configured": false,
  "extra_manifests_name_prefix": "<string>",
  "tracer_session_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "url": "<string>",
  "is_preview": false,
  "image_version": "<string>",
  "display_name": "<string>",
  "is_managed_deep_agent": false,
  "deployment_tier": "SERVERLESS_S",
  "compute_tier": "SERVERLESS_S",
  "database_tier": "SERVERLESS_S"
}

{
  "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 scaling configuration.

compute_tier

enum<string> | null

Fixed resource tier to apply to the deployment's compute. Serverless deployments support SERVERLESS_S, SERVERLESS_M, and SERVERLESS_L; dedicated deployments support DEDICATED_S, DEDICATED_M, and DEDICATED_L. Leave null to keep the current compute tier.

Available options:

SERVERLESS_S,

SERVERLESS_M,

SERVERLESS_L,

DEDICATED_S,

DEDICATED_M,

DEDICATED_L

database_tier

enum<string> | null

Fixed resource tier to apply to the deployment's database. Only supported for dedicated deployments (DEDICATED_S, DEDICATED_M, DEDICATED_L). Leave null to keep the current database tier.

Available options:

SERVERLESS_S,

SERVERLESS_M,

SERVERLESS_L,

DEDICATED_S,

DEDICATED_M,

DEDICATED_L

Response

Successful Response

Deployment resource.

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.

Show child attributes

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.

Show child attributes

secrets

Secret · object[]

required

Show child attributes

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,

AWAITING_FINAL_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.

name

string | null

Deployment name. Required when agent is omitted; retained as the agent identity in the production environment when agent associations are enabled. Omit when supplying agent to generate a deployment name.

Minimum string length: 1

agent

DeploymentAgent · object | null

Agent and environment to deploy. Both fields are required when supplied.

Show child attributes

secret_references

SecretReference · object[] | null

List of Kubernetes Secret references.

Only applicable for external_docker source.

Show child attributes

extra_manifests

Extra Manifests · object[]

Extra Kubernetes objects stored for this deployment, in the format accepted by extra_manifests on create and PATCH. An empty list means no objects are stored.

Returned only by the get deployment endpoint, to user callers with permission to update the deployment, when extra manifests are enabled on this self-hosted installation and the deployment is not on a remote listener. Omitted otherwise.

shareable

boolean

default:false

Whether the deployment can be shared with LangSmith users outside the organization.

route_through_gateway

boolean

default:false

Route OpenAI and Anthropic model calls through the LangSmith LLM gateway.

extra_manifests_configured

boolean

default:false

Whether extra Kubernetes manifests are stored for this deployment.

This is a read-only field.

extra_manifests_name_prefix

string | null

Required metadata.name prefix for extra manifests, or null when extra manifests are unavailable for this deployment.

This is a read-only field.

tracer_session_id

string<uuid> | null

The ID of the LangSmith tracing project the deployment writes runs to.

This is a read-only field.

url

string | null

The deployment's serving URL, once provisioned.

This is a read-only field.

is_preview

boolean

default:false

Whether this is a preview-build deployment. Full preview metadata (parent deployment, PR, lifecycle) is available from the preview-builds details endpoint.

This is a read-only field.

image_version

string | null

Image version of the deployment.

display_name

string | null

Human-readable display name for 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. When compute and database tiers differ, this reflects the compute tier. Null when compute has a custom size.

Available options:

SERVERLESS_S,

SERVERLESS_M,

SERVERLESS_L,

DEDICATED_S,

DEDICATED_M,

DEDICATED_L

compute_tier

The selected fixed resource tier for this deployment's compute. Deployments without an explicit selection return the default tier for their deployment type. LEGACY_CUSTOM means the compute has a custom size that matches no tier.

Available options:

SERVERLESS_S,

SERVERLESS_M,

SERVERLESS_L,

DEDICATED_S,

DEDICATED_M,

DEDICATED_L

database_tier

The selected fixed resource tier for this deployment's database. Deployments without an explicit selection return the default tier for their deployment type. LEGACY_CUSTOM means the database has a custom size that matches no tier.

Available options:

SERVERLESS_S,

SERVERLESS_M,

SERVERLESS_L,

DEDICATED_S,

DEDICATED_M,

DEDICATED_L

Deployment components

Develop & test

Frameworks and platforms

Reference

Patch Deployment Resource Tiers

Path Parameters

Body

Response