🚀 Share how you're building agents for a chance to win LangChain swag!
{
"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,
"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>"
}Get Deployment
Get a deployment by ID.
{
"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,
"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
Response
Successful Response
Deployment resource.
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.
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.
github, external_docker Source configuration.
Show child attributes
Show child attributes
The ID of the integration used for the deployment.
Retrieve this value from the GET /v1/integrations/github/install endpoint. This cannot be changed (PATCH) once the deployment is created. Only applicable for github source.
The URL of the git repository used for the deployment.
This cannot be changed (PATCH) once the deployment is created. Only applicable for github source.
The type of deployment to create.
See Deployment Types for more details. This cannot be changed (PATCH) once the deployment is created. Only applicable for github source.
dev_free, dev, prod Whether to build a new revision for the deployment on push to the source_revision_config.repo_ref (e.g. git branch).
Cannot be enabled when source_revision_config.repo_ref specifies a tag (starts with refs/tags/). Tags are immutable and cannot trigger automatic builds on push.
Only applicable for github source.
The custom URL of the deployment.
This field can only be set for external_docker source deployments. However, it will be set automatically for github source deployments (read only).
Resource specification for the deployment.
When updating a deployment (PATCH), setting this field to a non-null value will trigger creation of a new revision and overwrite the existing resource_spec for the deployment. Only applicable for external_docker source.
Show child attributes
Show child attributes
The minimum scale (number of replicas) of the deployment.
The maximum scale (number of replicas) of the deployment.
CPU request of a single replica of the deployment. If cpu_limit is not set, limit defaults to 2x this value.
CPU limit of a single replica of the deployment. If not set, defaults to 2x cpu.
Memory request (MB) of a single replica of the deployment. If memory_limit_mb is not set, limit defaults to 2x this value.
Memory limit (MB) of a single replica of the deployment. If not set, defaults to 2x memory_mb.
The minimum scale (number of replicas) of the queue deployment. If not provided, defaults to the same value as min_scale.
The maximum scale (number of replicas) of the queue deployment. If not provided, defaults to the same value as max_scale.
CPU request of a single replica of the queue deployment. If not provided, defaults to the same value as cpu. If queue_cpu_limit is not set, limit defaults to 2x this value.
CPU limit of a single replica of the queue deployment. If not set, defaults to 2x queue_cpu.
Memory request (MB) of a single replica of the queue deployment. If not provided, defaults to the same value as memory_mb. If queue_memory_limit_mb is not set, limit defaults to 2x this value.
Memory limit (MB) of a single replica of the queue deployment. If not set, defaults to 2x queue_memory_mb.
do not use
do not use
do not use
do not use
do not use
do not use
Memory (MB) of the Redis deployment.
The name of the service account to use for the deployment.
This must already exist in the Kubernetes namespace where the deployment will be deployed to.
List of references to secrets in the same namespace to use for pulling container images. Each entry is a LocalObjectReference to a Secret of type kubernetes.io/dockerconfigjson.
Show child attributes
Show child attributes
Name of the referent (e.g., name of a Secret for imagePullSecrets).
List of volumes that can be mounted by containers belonging to the pod. Reference the kubernetes documentation for more details on how to configure volumes.
Show child attributes
Show child attributes
Volume's name. Must be a DNS_LABEL and unique within the pod.
ConfigMap represents a configMap that should populate this volume.
Secret represents a secret that should populate this volume.
EmptyDir represents a temporary directory that shares a pod's lifetime.
PersistentVolumeClaim represents a reference to a PersistentVolumeClaim.
NFS represents an NFS mount on the host that shares a pod's lifetime.
Projected represents a volume that projects several volume sources into the same directory.
DownwardAPI represents downward API about the pod that should populate this volume.
CSI represents a volume that should be handled by an external CSI driver.
Pod volumes to mount into the container's filesystem. Reference the kubernetes documentation for more details on how to configure volume mounts.
Show child attributes
Show child attributes
This must match the Name of a Volume.
Path within the container at which the volume should be mounted.
Path within the volume from which the container's volume should be mounted.
Determines how mounts are propagated from the host to container and the other way around.
Mounted read-only if true, read-write otherwise.
Expanded path within the volume from which the container's volume should be mounted.
List of initialization containers belonging to the pod. Init containers are set as initContainers in the pod spec and run to completion before the main application container starts.
Show child attributes
Show child attributes
Name of the container. Must be a DNS_LABEL.
Container image name.
Image pull policy. One of Always, Never, IfNotPresent.
Entrypoint array. Not executed within a shell.
Arguments to the entrypoint.
Container's working directory.
List of environment variables to set in the container.
Show child attributes
Show child attributes
Name of the environment variable. Must be a C_IDENTIFIER.
Variable value. Defaults to empty string.
Source for the environment variable's value. Cannot be used if value is not empty.
List of sources to populate environment variables in the container.
Compute resource requirements.
Show child attributes
Show child attributes
Pod volumes to mount into the container's filesystem.
Show child attributes
Show child attributes
This must match the Name of a Volume.
Path within the container at which the volume should be mounted.
Path within the volume from which the container's volume should be mounted.
Determines how mounts are propagated from the host to container and the other way around.
Mounted read-only if true, read-write otherwise.
Expanded path within the volume from which the container's volume should be mounted.
Security options the pod should run with.
RestartPolicy for the container (for sidecar containers). One of Always, OnFailure.
List of sidecar containers that run alongside the main application container. These will be added to the pod spec as additional containers.
Show child attributes
Show child attributes
Name of the container. Must be a DNS_LABEL.
Container image name.
Image pull policy. One of Always, Never, IfNotPresent.
Entrypoint array. Not executed within a shell.
Arguments to the entrypoint.
Container's working directory.
List of environment variables to set in the container.
Show child attributes
Show child attributes
Name of the environment variable. Must be a C_IDENTIFIER.
Variable value. Defaults to empty string.
Source for the environment variable's value. Cannot be used if value is not empty.
List of sources to populate environment variables in the container.
Compute resource requirements.
Show child attributes
Show child attributes
Pod volumes to mount into the container's filesystem.
Show child attributes
Show child attributes
This must match the Name of a Volume.
Path within the container at which the volume should be mounted.
Path within the volume from which the container's volume should be mounted.
Determines how mounts are propagated from the host to container and the other way around.
Mounted read-only if true, read-write otherwise.
Expanded path within the volume from which the container's volume should be mounted.
Security options the pod should run with.
RestartPolicy for the container (for sidecar containers). One of Always, OnFailure.
CPU request of the Postgres database deployment. If db_cpu_limit is not set, limit defaults to 2x this value.
CPU limit of the Postgres database deployment. If not set, defaults to 2x db_cpu.
Memory request (MB) of the Postgres database deployment. If db_memory_limit_mb is not set, limit defaults to 2x this value.
Memory limit (MB) of the Postgres database deployment. If not set, defaults to 2x db_memory_mb.
Storage (GiB) of the Postgres database deployment.
Maximum number of connections allowed to the Postgres database.
The ID of the listener used for the deployment.
Retrieve this value from the GET /v2/listeners endpoint. This cannot be changed (PATCH) once the deployment is created. Only applicable for external_docker source.
Listener configuration for the deployment.
All fields are nullable, but are validated based on compute_type of the listener ID. Only applicable for external_docker source.
Show child attributes
Show child attributes
Kubernetes namespace where the deployment will be deployed to.
This cannot be changed (PATCH) once the deployment is created. Only applicable for deployments of listeners with k8s compute type.
The custom install command to run for your deployment. This only applies to JS deployments. This command will be run from the root of your repository - NOT where your langgraph.json file lives (unless these are the same place). If not provided, we will autodetect the command based on the presence of yarn/npm/etc. files.
The custom build command to run for your deployment. This only applies to JS deployments. This command will be run from where your langgraph.json file lives. This is helpful for using shared workspaces in your deployments, without having to provide a postinstall command or something similar in your package.json.
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
Show child attributes
The git ref of the repository used for the deployment.
Supports:
- Branches: Specify just the branch name (e.g., main, develop)
- Tags: Specify the full ref path (e.g., refs/tags/v1.0.0)
When using a tag, source_config.build_on_push must be set to false since tags are immutable.
When updating a deployment (PATCH), setting this field to a non-null value will trigger creation of a new revision. Only applicable for github source.
The path to the LangGraph configuration file (langgraph.json) used for the deployment.
When updating a deployment (PATCH), setting this field to a non-null value will trigger creation of a new revision. Only applicable for github source.
The URI of the Docker image used for the deployment.
When updating a deployment (PATCH), setting this field to a non-null value will trigger creation of a new revision. Only applicable for external_docker source.
The commit SHA of the git repository used for the deployment.
This is a read-only field. Only applicable for github source.
The ID of the deployment.
This is a read-only field.
The creation time of the deployment.
This is a read-only field.
The last update time of the deployment.
This is a read-only field.
The status of the deployment.
This is a read-only field.
AWAITING_DATABASE, READY, UNUSED, AWAITING_DELETE, UNKNOWN The ID of the latest revision of the deployment.
This is a read-only field.
The ID of the current (actively deployed) revision of the deployment.
This is a read-only field.
Image version of the deployment.
Was this page helpful?