Skip to main content
PATCH
/
v2
/
deployments
/
{deployment_id}
Patch Deployment
curl --request PATCH \
  --url https://api.example.com/v2/deployments/{deployment_id} \
  --header 'Content-Type: application/json' \
  --data '
{
  "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": 123,
      "cpu_limit": 123,
      "memory_mb": 123,
      "memory_limit_mb": 123,
      "queue_min_scale": 123,
      "queue_max_scale": 123,
      "queue_cpu": 123,
      "queue_cpu_limit": 123,
      "queue_memory_mb": 123,
      "queue_memory_limit_mb": 123,
      "orchestrator_cpu": 123,
      "orchestrator_cpu_limit": 123,
      "orchestrator_memory_mb": 123,
      "orchestrator_memory_limit_mb": 123,
      "orchestrator_min_scale": 123,
      "orchestrator_max_scale": 123,
      "executor_cpu": 123,
      "executor_cpu_limit": 123,
      "executor_memory_mb": 123,
      "executor_memory_limit_mb": 123,
      "redis_memory_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>"
  },
  "secrets": [
    {
      "name": "<string>",
      "value": "<string>"
    }
  ]
}
'
{
  "name": "<string>",
  "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": 123,
      "cpu_limit": 123,
      "memory_mb": 123,
      "memory_limit_mb": 123,
      "queue_min_scale": 123,
      "queue_max_scale": 123,
      "queue_cpu": 123,
      "queue_cpu_limit": 123,
      "queue_memory_mb": 123,
      "queue_memory_limit_mb": 123,
      "orchestrator_cpu": 123,
      "orchestrator_cpu_limit": 123,
      "orchestrator_memory_mb": 123,
      "orchestrator_memory_limit_mb": 123,
      "orchestrator_min_scale": 123,
      "orchestrator_max_scale": 123,
      "executor_cpu": 123,
      "executor_cpu_limit": 123,
      "executor_memory_mb": 123,
      "executor_memory_limit_mb": 123,
      "redis_memory_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>",
    "repo_commit_sha": "<string>"
  },
  "secrets": [
    {
      "name": "<string>",
      "value": "<string>"
    }
  ],
  "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",
  "image_version": "<string>"
}

Path Parameters

​
deployment_id
string<uuid>
required

Body

application/json

Request body for patching a deployment.

Patching a deployment may trigger a new revision depending on the provided source configurations.

​
source_config
SourceConfigRequest · object

Fields for a deployment that are specific to the source, but do not require a new revision when modified or cannot be modified.

All fields are nullable, but are validated based on the source.

​
source_revision_config
SourceRevisionConfigRequest · object

Fields for a deployment that are specific to the source and require a new revision when modified.

All fields are nullable, but are validated based on the source.

​
secrets
Secret · object[] | null

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) or a Docker image (external_docker).

Deploying from GitHub is only available for Cloud SaaS deployments. Deploying from a Docker image is only available for self-hosted deployments. This cannot be changed once the deployment is created.

Available options:
github,
external_docker
​
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.

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

​
image_version
string | null

Image version of the deployment.