Skip to main content
GET
/
api
/
svc
/
v1
/
apps
List Applications
curl --request GET \
  --url https://{controlPlaneURL}/api/svc/v1/apps \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "<string>",
      "fqn": "<string>",
      "name": "<string>",
      "type": "async-service",
      "createdBySubject": {
        "subjectId": "<string>",
        "subjectType": "user",
        "subjectSlug": "<string>",
        "subjectDisplayName": "<string>"
      },
      "tenantName": "<string>",
      "metadata": {
        "paused": true
      },
      "lifecycleStage": "active",
      "workspaceId": "<string>",
      "lastVersion": 123,
      "activeVersion": 123,
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "recommendations": [
        {
          "id": "<string>",
          "clusterId": "<string>",
          "applicationId": "<string>",
          "deploymentId": "<string>",
          "applicationVersion": 123,
          "recommendationData": {},
          "recommendationType": "<string>",
          "appliedDeploymentId": "<string>",
          "expiryTimestamp": "2023-11-07T05:31:56Z",
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z"
        }
      ],
      "alerts": [
        {
          "id": "<string>",
          "name": "<string>",
          "timestamps": [
            "2023-11-07T05:31:56Z"
          ],
          "startTime": "2023-11-07T05:31:56Z",
          "resolvedTime": "2023-11-07T05:31:56Z",
          "applicationId": "<string>",
          "clusterId": "<string>",
          "tenantName": "<string>",
          "fingerprint": "<string>",
          "updatedAt": "<string>",
          "createdAt": "<string>",
          "applicationDebugInfoId": "<string>"
        }
      ],
      "alertsSummary": {},
      "applicationDebugInfos": [
        {
          "id": "<string>",
          "applicationId": "<string>",
          "application": {},
          "debugInfo": {},
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z"
        }
      ],
      "potentialProblems": [
        {
          "name": "<string>",
          "description": "<string>"
        }
      ],
      "autopilot": {},
      "workspaceFqn": "<string>",
      "createdBy": "<string>",
      "deployment": {
        "id": "<string>",
        "version": 123,
        "fqn": "<string>",
        "applicationId": "<string>",
        "manifest": {
          "name": "<string>",
          "image": {
            "type": "build",
            "docker_registry": "<string>",
            "build_source": {
              "type": "<any>",
              "remote_uri": "<any>"
            },
            "build_spec": {
              "type": "<any>",
              "dockerfile_path": "<any>",
              "build_context_path": "<any>",
              "command": "<any>",
              "build_args": "<any>"
            }
          },
          "artifacts_download": {
            "cache_volume": {
              "storage_class": "<any>",
              "cache_size": "<any>"
            },
            "artifacts": [
              "<any>"
            ]
          },
          "resources": {
            "cpu_request": "<any>",
            "cpu_limit": "<any>",
            "memory_request": "<any>",
            "memory_limit": "<any>",
            "ephemeral_storage_request": "<any>",
            "ephemeral_storage_limit": "<any>",
            "shared_memory_size": "<any>",
            "node": "<any>",
            "devices": "<any>"
          },
          "env": null,
          "ports": [
            {
              "port": "<any>",
              "protocol": "<any>",
              "expose": "<any>",
              "app_protocol": "<any>",
              "host": "<any>",
              "path": "<any>",
              "rewrite_path_to": "<any>",
              "auth": "<any>"
            }
          ],
          "service_account": "<string>",
          "mounts": [
            {
              "type": "<any>",
              "mount_path": "<any>",
              "secret_fqn": "<any>"
            }
          ],
          "labels": {},
          "kustomize": {
            "patch": "<any>",
            "additions": "<any>"
          },
          "liveness_probe": {
            "config": {
              "type": "<any>",
              "path": "<any>",
              "port": "<any>",
              "host": "<any>",
              "scheme": "<any>"
            },
            "initial_delay_seconds": 18000,
            "period_seconds": 18000,
            "timeout_seconds": 18000,
            "success_threshold": 2500,
            "failure_threshold": 2500
          },
          "readiness_probe": {
            "config": {
              "type": "<any>",
              "path": "<any>",
              "port": "<any>",
              "host": "<any>",
              "scheme": "<any>"
            },
            "initial_delay_seconds": 18000,
            "period_seconds": 18000,
            "timeout_seconds": 18000,
            "success_threshold": 2500,
            "failure_threshold": 2500
          },
          "startup_probe": {
            "config": {
              "type": "<any>",
              "path": "<any>",
              "port": "<any>",
              "host": "<any>",
              "scheme": "<any>"
            },
            "initial_delay_seconds": 18000,
            "period_seconds": 18000,
            "timeout_seconds": 18000,
            "success_threshold": 2500,
            "failure_threshold": 2500
          },
          "workspace_fqn": "<string>",
          "type": "service",
          "replicas": 250,
          "auto_shutdown": {
            "wait_time": "<any>"
          },
          "allow_interception": false,
          "rollout_strategy": {
            "type": "<any>",
            "max_unavailable_percentage": "<any>",
            "max_surge_percentage": "<any>"
          }
        },
        "application": {},
        "createdBySubject": {
          "subjectId": "<string>",
          "subjectType": "user",
          "subjectSlug": "<string>",
          "subjectDisplayName": "<string>"
        },
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "deploymentBuilds": [
          {
            "name": "<string>",
            "status": 20
          }
        ],
        "deploymentStatuses": [
          {
            "id": "<string>",
            "deploymentId": "<string>",
            "status": "INITIALIZED",
            "state": {},
            "transition": "BUILDING",
            "message": "<string>",
            "retryCount": 123,
            "createdAt": "2023-11-07T05:31:56Z",
            "updatedAt": "2023-11-07T05:31:56Z"
          }
        ],
        "currentStatusId": "<string>",
        "currentStatus": {
          "id": "<string>",
          "deploymentId": "<string>",
          "status": "INITIALIZED",
          "state": {},
          "transition": "BUILDING",
          "message": "<string>",
          "retryCount": 123,
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z"
        },
        "appliedRecommendations": [
          {
            "id": "<string>",
            "clusterId": "<string>",
            "applicationId": "<string>",
            "deploymentId": "<string>",
            "applicationVersion": 123,
            "recommendationData": {},
            "recommendationType": "<string>",
            "appliedDeploymentId": "<string>",
            "expiryTimestamp": "2023-11-07T05:31:56Z",
            "createdAt": "2023-11-07T05:31:56Z",
            "updatedAt": "2023-11-07T05:31:56Z"
          }
        ],
        "createdBy": "<string>"
      },
      "activeDeploymentId": "<string>",
      "lastDeploymentId": "<string>"
    }
  ],
  "pagination": {
    "total": 100,
    "offset": 0,
    "limit": 10
  }
}

Authorizations

Authorization
string
header
required

Query Parameters

limit
integer
default:100
Required range: 1 <= x <= 1000
Example:
offset
integer
default:0
Required range: x >= 0
Example:
applicationId
string
workspaceId
string
applicationName
string
fqn
string
workspaceFqn
string
applicationType
string
nameSearchQuery
string
environmentId
string
clusterId
string
applicationSetId
string
paused
boolean
deviceTypeFilter
enum<string>
Available options:
cpu,
nvidia_gpu,
aws_inferentia,
nvidia_mig_gpu,
nvidia_timeslicing_gpu,
gcp_tpu
lastDeployedBySubjects
string
lifecycleStage
enum<string>
Available options:
active,
deleting,
deletion_failed
isRecommendationPresentAndVisible
boolean

Response

data
Application · object[]
required
pagination
object
required