GET
/
api
/
svc
/
v1
/
apps
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": "remote",
              "remote_uri": "<string>"
            },
            "build_spec": {
              "type": "dockerfile",
              "dockerfile_path": "<string>",
              "build_context_path": "<string>",
              "command": "<string>",
              "build_args": {}
            }
          },
          "artifacts_download": {
            "cache_volume": {
              "storage_class": "<string>",
              "cache_size": 500
            },
            "artifacts": [
              {
                "type": "truefoundry-artifact",
                "artifact_version_fqn": "<string>",
                "download_path_env_variable": "<string>"
              }
            ]
          },
          "resources": {
            "cpu_request": 128.0005,
            "cpu_limit": 128.0005,
            "memory_request": 1000000,
            "memory_limit": 1000000,
            "ephemeral_storage_request": 1000000,
            "ephemeral_storage_limit": 1000000,
            "shared_memory_size": 1000032,
            "node": {
              "type": "node_selector",
              "instance_families": [
                "<string>"
              ],
              "capacity_type": "spot_fallback_on_demand"
            },
            "devices": [
              {
                "type": "nvidia_gpu",
                "name": "<string>",
                "count": 8
              }
            ]
          },
          "env": null,
          "ports": [
            {
              "port": 32768,
              "protocol": "TCP",
              "expose": true,
              "app_protocol": "http",
              "host": "<string>",
              "path": "<string>",
              "rewrite_path_to": "<string>",
              "auth": {
                "type": "basic_auth",
                "username": "<string>",
                "password": "<string>"
              }
            }
          ],
          "service_account": "<string>",
          "mounts": [
            {
              "type": "secret",
              "mount_path": "<string>",
              "secret_fqn": "<string>"
            }
          ],
          "labels": {},
          "kustomize": {
            "patch": {},
            "additions": [
              {}
            ]
          },
          "liveness_probe": {
            "config": {
              "type": "http",
              "path": "<string>",
              "port": 32767,
              "host": "<string>",
              "scheme": "<string>"
            },
            "initial_delay_seconds": 18000,
            "period_seconds": 18000,
            "timeout_seconds": 18000,
            "success_threshold": 50,
            "failure_threshold": 50
          },
          "readiness_probe": {
            "config": {
              "type": "http",
              "path": "<string>",
              "port": 32767,
              "host": "<string>",
              "scheme": "<string>"
            },
            "initial_delay_seconds": 18000,
            "period_seconds": 18000,
            "timeout_seconds": 18000,
            "success_threshold": 50,
            "failure_threshold": 50
          },
          "workspace_fqn": "<string>",
          "type": "service",
          "replicas": 250,
          "auto_shutdown": {
            "wait_time": 1
          },
          "allow_interception": false,
          "rollout_strategy": {
            "type": "rolling_update",
            "max_unavailable_percentage": 50,
            "max_surge_percentage": 50
          }
        },
        "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

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
limit
integer
default:100

Number of items per page

Required range: 1 <= x <= 1000
Example:

10

​
offset
integer
default:0

Number of items to skip

Required range: x >= 0
Example:

0

​
applicationId
string

Application id of the application

​
workspaceId
string

Workspace id of the application (comma separated for multiple)

​
applicationName
string

Name of application

​
fqn
string

Fully qualified name (FQN) of the application

​
workspaceFqn
string

Fully qualified name (FQN) of the workspace

​
applicationType
string

Type of application (comma separated for multiple). Allowed Values: async-service, service, job, spark-job, helm, notebook, codeserver, rstudio, ssh-server, volume, application, application-set, intercept, workflow

​
nameSearchQuery
string

Search query for application name

​
environmentId
string

Filter by Environment ids of the application (comma separated for multiple)

​
clusterId
string

Filter by Cluster ids of the application (comma separated for multiple)

​
applicationSetId
string

Filter by Application Set id of the application

​
paused
boolean

Filter by Application Paused status

​
deviceTypeFilter
enum<string>

Filter by device type of the application. Allowed values: cpu, nvidia_gpu, aws_inferentia, nvidia_mig_gpu, nvidia_timeslicing_gpu, gcp_tpu

Available options:
cpu,
nvidia_gpu,
aws_inferentia,
nvidia_mig_gpu,
nvidia_timeslicing_gpu,
gcp_tpu
​
lastDeployedBySubjects
string

Filter by last deployed by specific users

​
lifecycleStage
enum<string>

Filter by application lifecycle state

Available options:
active,
deleting,
deletion_failed
​
isRecommendationPresentAndVisible
boolean

Filter out applications with recommendations that are allowed to be shown

Response

200
application/json

Retrieve latest applications based on the specified query parameters. If pagination parameters are provided, the response includes paginated data.

The response is of type object.

GET
/
api
/
svc
/
v1
/
apps
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": "remote",
              "remote_uri": "<string>"
            },
            "build_spec": {
              "type": "dockerfile",
              "dockerfile_path": "<string>",
              "build_context_path": "<string>",
              "command": "<string>",
              "build_args": {}
            }
          },
          "artifacts_download": {
            "cache_volume": {
              "storage_class": "<string>",
              "cache_size": 500
            },
            "artifacts": [
              {
                "type": "truefoundry-artifact",
                "artifact_version_fqn": "<string>",
                "download_path_env_variable": "<string>"
              }
            ]
          },
          "resources": {
            "cpu_request": 128.0005,
            "cpu_limit": 128.0005,
            "memory_request": 1000000,
            "memory_limit": 1000000,
            "ephemeral_storage_request": 1000000,
            "ephemeral_storage_limit": 1000000,
            "shared_memory_size": 1000032,
            "node": {
              "type": "node_selector",
              "instance_families": [
                "<string>"
              ],
              "capacity_type": "spot_fallback_on_demand"
            },
            "devices": [
              {
                "type": "nvidia_gpu",
                "name": "<string>",
                "count": 8
              }
            ]
          },
          "env": null,
          "ports": [
            {
              "port": 32768,
              "protocol": "TCP",
              "expose": true,
              "app_protocol": "http",
              "host": "<string>",
              "path": "<string>",
              "rewrite_path_to": "<string>",
              "auth": {
                "type": "basic_auth",
                "username": "<string>",
                "password": "<string>"
              }
            }
          ],
          "service_account": "<string>",
          "mounts": [
            {
              "type": "secret",
              "mount_path": "<string>",
              "secret_fqn": "<string>"
            }
          ],
          "labels": {},
          "kustomize": {
            "patch": {},
            "additions": [
              {}
            ]
          },
          "liveness_probe": {
            "config": {
              "type": "http",
              "path": "<string>",
              "port": 32767,
              "host": "<string>",
              "scheme": "<string>"
            },
            "initial_delay_seconds": 18000,
            "period_seconds": 18000,
            "timeout_seconds": 18000,
            "success_threshold": 50,
            "failure_threshold": 50
          },
          "readiness_probe": {
            "config": {
              "type": "http",
              "path": "<string>",
              "port": 32767,
              "host": "<string>",
              "scheme": "<string>"
            },
            "initial_delay_seconds": 18000,
            "period_seconds": 18000,
            "timeout_seconds": 18000,
            "success_threshold": 50,
            "failure_threshold": 50
          },
          "workspace_fqn": "<string>",
          "type": "service",
          "replicas": 250,
          "auto_shutdown": {
            "wait_time": 1
          },
          "allow_interception": false,
          "rollout_strategy": {
            "type": "rolling_update",
            "max_unavailable_percentage": 50,
            "max_surge_percentage": 50
          }
        },
        "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

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
limit
integer
default:100

Number of items per page

Required range: 1 <= x <= 1000
Example:

10

​
offset
integer
default:0

Number of items to skip

Required range: x >= 0
Example:

0

​
applicationId
string

Application id of the application

​
workspaceId
string

Workspace id of the application (comma separated for multiple)

​
applicationName
string

Name of application

​
fqn
string

Fully qualified name (FQN) of the application

​
workspaceFqn
string

Fully qualified name (FQN) of the workspace

​
applicationType
string

Type of application (comma separated for multiple). Allowed Values: async-service, service, job, spark-job, helm, notebook, codeserver, rstudio, ssh-server, volume, application, application-set, intercept, workflow

​
nameSearchQuery
string

Search query for application name

​
environmentId
string

Filter by Environment ids of the application (comma separated for multiple)

​
clusterId
string

Filter by Cluster ids of the application (comma separated for multiple)

​
applicationSetId
string

Filter by Application Set id of the application

​
paused
boolean

Filter by Application Paused status

​
deviceTypeFilter
enum<string>

Filter by device type of the application. Allowed values: cpu, nvidia_gpu, aws_inferentia, nvidia_mig_gpu, nvidia_timeslicing_gpu, gcp_tpu

Available options:
cpu,
nvidia_gpu,
aws_inferentia,
nvidia_mig_gpu,
nvidia_timeslicing_gpu,
gcp_tpu
​
lastDeployedBySubjects
string

Filter by last deployed by specific users

​
lifecycleStage
enum<string>

Filter by application lifecycle state

Available options:
active,
deleting,
deletion_failed
​
isRecommendationPresentAndVisible
boolean

Filter out applications with recommendations that are allowed to be shown

Response

200
application/json

Retrieve latest applications based on the specified query parameters. If pagination parameters are provided, the response includes paginated data.

The response is of type object.