Sign in

v1

latestOpenAPI 3.1.02026-07-226168131.5 KB
Deployments (v2)

Patch Deployment

Patch a deployment by ID.

patch/v2/deployments/{deployment_id}

Path parameters

deployment_idstring uuid required

Request body

display_namestring nullable

Human-readable display name for the deployment. Updating this does not create a new revision.

revision_source'github' | 'internal_docker' | 'internal_source' nullable

Override the source for this revision. If omitted, falls back to deployment's default source.

deployment_tier'SERVERLESS_S' | 'SERVERLESS_M' | 'SERVERLESS_L' | 'DEDICATED_S' | 'DEDICATED_M' | 'DEDICATED_L'

Example request

{
  "source_config": {
    "resource_spec": {
      "cpu": 0.1,
      "cpu_limit": 0.2,
      "queue_cpu": 0.1,
      "queue_cpu_limit": 0.2,
      "redis_cpu": 0.1,
      "redis_cpu_limit": 0.2
    }
  }
}

Response

Successful Response

namestring required

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

source'github' | 'external_docker' | 'internal_docker' | 'internal_source' | 'internal_template' 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).<br><br>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.

idstring uuid required

The ID of the deployment.<br><br>This is a read-only field.

tenant_idstring uuid required

The ID of the tenant that owns the deployment.<br><br>This is a read-only field.

created_atstring date-time required

The creation time of the deployment.<br><br>This is a read-only field.

updated_atstring date-time required

The last update time of the deployment.<br><br>This is a read-only field.

status'AWAITING_DATABASE' | 'READY' | 'UNUSED' | 'AWAITING_DELETE' | 'UNKNOWN' required

The status of the deployment.<br><br>This is a read-only field.

latest_revision_idstring uuid nullable required

The ID of the latest revision of the deployment.<br><br>This is a read-only field.

active_revision_idstring uuid nullable required

The ID of the current (actively deployed) revision of the deployment.<br><br>This is a read-only field.

image_versionstring nullable

Image version of the deployment.

display_namestring nullable

Human-readable display name for the deployment.

is_managed_deep_agentboolean

Whether this deployment is a Managed Deep Agent deployment.<br><br>This is a read-only field.

deployment_tier'SERVERLESS_S' | 'SERVERLESS_M' | 'SERVERLESS_L' | 'DEDICATED_S' | 'DEDICATED_M' | 'DEDICATED_L'
compute_tier'SERVERLESS_S' | 'SERVERLESS_M' | 'SERVERLESS_L' | 'DEDICATED_S' | 'DEDICATED_M' | 'DEDICATED_L'
database_tier'SERVERLESS_S' | 'SERVERLESS_M' | 'SERVERLESS_L' | 'DEDICATED_S' | 'DEDICATED_M' | 'DEDICATED_L'

Example response

{
  "source_config": {
    "resource_spec": {
      "cpu": 0.1,
      "cpu_limit": 0.2,
      "queue_cpu": 0.1,
      "queue_cpu_limit": 0.2,
      "redis_cpu": 0.1,
      "redis_cpu_limit": 0.2
    }
  }
}