List Deployments

List all deployments.

GET /v2/deployments

List Deployments

cURL

curl --request GET \
  --url https://api.example.com/v2/deployments

200

{
  "resources": [
    {
      "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": 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",
      "latest_revision_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "active_revision_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "image_version": "<string>"
    }
  ],
  "offset": 123
}

Query Parameters

limit · integer · default: 20

Maximum number of resources to return.

Required range: 1 <= x <= 100

offset · integer · default: 0

Pagination offset. Pass this value to subsequent requests to fetch the next page of resources.

Required range: x >= 0

name_contains · string | null

Name of the deployment to filter by.

status · string | null

status of the deployment to filter by.

remote_reconciled · boolean | null

Flag to filter by remote reconciled deployments.

tag_value_ids · string | null

Comma separated list of tag value IDs of the deployment to filter by.

image_version · string | null

Image version to filter by.

deployment_type · enum<string> | null

Deployment type to filter by.

Available options: dev_free, dev, prod

deployment_ids · string | null

Comma separated list of deployment IDs to filter by.

Response

200

application/json

Successful Response

resources · Deployment · object[] · required

Show child attributes

offset · integer · required

Pagination offset. Pass this value to subsequent requests to fetch the next page.