List apps

GET

/api/v1/apps/

curl --request GET \
  --url 'https://example.com/api/v1/apps/?only_nexa_apps=true'

List all apps, optionally filtered to Nexa-managed apps only.

Parameters

Query Parameters

page_token

Any of:

string

string

null

null

Pagination token

page_size

Any of:

integer

integer

>= 1 <= 1000

null

null

Upper bound for items returned

only_nexa_apps

Only Nexa Apps

Filter to show only Nexa-managed apps

boolean

default: true

Filter to show only Nexa-managed apps

Responses

200

Successful Response

Media typeapplication/json

ListAppsResponse

Response model for listing apps.

object

apps

Apps

List of apps

Array<object>

App

App model matching Databricks specification exactly.

object

name

required

Name

App name

string

description

Any of:

string

string

null

null

active_deployment

Any of:

AppDeployment

AppDeployment

App deployment model matching Databricks specification.

object

deployment_id

Any of:

string

string

null

null

deployment_artifacts

Any of:

AppDeploymentArtifacts

AppDeploymentArtifacts

Deployment artifacts information.

object

source_code_path

Any of:

string

string

null

null

null

null

mode

Any of:

DeploymentMode

DeploymentMode

Deployment mode enum from Databricks.

string

Allowed values: AUTO_SYNC SNAPSHOT

null

null

source_code_path

Any of:

string

string

null

null

create_time

Any of:

string

string format: date-time

null

null

creator

Any of:

string

string

null

null

deployment_status

Any of:

AppDeploymentStatus

AppDeploymentStatus

Deployment status information.

object

state

required

DeploymentState

Deployment state

string

Allowed values: IN_PROGRESS SUCCEEDED FAILED

message

Any of:

string

string

null

null

null

null

null

null

app_status

Any of:

ApplicationStatus

ApplicationStatus

Application status information.

object

state

required

ApplicationState

Current application state

string

Allowed values: CRASHED DEPLOYING RUNNING UNAVAILABLE

message

Any of:

string

string

null

null

null

null

compute_status

Any of:

ComputeStatus

ComputeStatus

Compute status information.

object

state

required

ComputeState

Current compute state

string

Allowed values: ACTIVE DELETING ERROR STARTING STOPPED STOPPING UPDATING

message

Any of:

string

string

null

null

null

null

create_time

Any of:

string

string format: date-time

null

null

creator

Any of:

string

string

null

null

service_principal_name

Any of:

string

string

null

null

updater

Any of:

string

string

null

null

update_time

Any of:

string

string format: date-time

null

null

url

Any of:

string

string

null

null

next_page_token

Any of:

string

string

null

null

Example

{
  "apps": [
    {
      "active_deployment": {
        "mode": "SNAPSHOT",
        "deployment_status": {
          "state": "IN_PROGRESS"
        }
      },
      "app_status": {
        "state": "CRASHED"
      },
      "compute_status": {
        "state": "ACTIVE"
      }
    }
  ]
}

422

Validation Error

Media typeapplication/json

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string

Example^generated

{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}