Skip to content
Nexa Platform Docs

Overview

Nexa Databricks Platform API 1.0.0-local

Section titled “Nexa Databricks Platform API 1.0.0-local”

Nexa Databricks Platform API providing unified API for Catalog operations, Ingestion and Pipeline orchestration, data lineage tracking, SQL execution, and automated deployment capabilities across environments

Information

  • OpenAPI version: 3.1.0

Operations

Section titled “Operations”
POST
/api/v1/auth/token
GET
/api/v1/auth/status
GET
/api/v1/auth/debug
GET
/api/v1/apps/
GET
/api/v1/apps/health
GET
/api/v1/apps/{app_name}
DELETE
/api/v1/apps/{app_name}
PATCH
/api/v1/apps/{app_name}
GET
/api/v1/apps/{app_name}/deployments
POST
/api/v1/apps/{app_name}/deployments
GET
/api/v1/apps/{app_name}/deployments/{deployment_id}
POST
/api/v1/apps/{app_name}/start
POST
/api/v1/apps/{app_name}/stop
GET
/api/v1/apps/{app_name}/permissions
PUT
/api/v1/apps/{app_name}/permissions
PATCH
/api/v1/apps/{app_name}/permissions
POST
/api/v1/apps/{app_name}/deployments/deploy-and-wait
POST
/api/v1/apps/{app_name}/start-and-wait
POST
/api/v1/deployments/{deployment_id}/finish
GET
/api/v1/deployments/{deployment_id}/status
POST
/api/v1/deployments/
GET
/api/v1/deployments/{deployment_id}
GET
/api/v1/deployments/resources
POST
/api/v1/deployments/submit
GET
/api/v1/catalogs
GET
/api/v1/catalogs/{catalog_name}/schemas
GET
/api/v1/catalogs/{catalog_name}/schemas/{schema_name}/tables
GET
/api/v1/catalogs/{catalog_name}/schemas/{schema_name}/tables/{table_name}
POST
/api/v1/catalogs/execute-sql
GET
/api/v1/catalogs/metadata
GET
/api/v1/catalogs/status
GET
/api/v1/catalogs/test-fetch
POST
/api/v1/catalogs/sync
GET
/api/v1/catalogs/health
GET
/api/v1/environments/
POST
/api/v1/environments/
GET
/api/v1/environments/{environment_id}
DELETE
/api/v1/environments/{environment_id}
PATCH
/api/v1/environments/{environment_id}
GET
/api/v1/jobs/
POST
/api/v1/jobs/
GET
/api/v1/jobs/{job_id}
DELETE
/api/v1/jobs/{job_id}
PATCH
/api/v1/jobs/{job_id}
POST
/api/v1/jobs/{job_id}/run-now
POST
/api/v1/jobs/{job_id}/trigger
POST
/api/v1/jobs/runs/submit
POST
/api/v1/jobs/runs/{run_id}/cancel
POST
/api/v1/jobs/{job_id}/run-now-and-wait
POST
/api/v1/jobs/runs/submit-and-wait
POST
/api/v1/jobs/runs/{run_id}/repair-and-wait
POST
/api/v1/jobs/{job_id}/pause
POST
/api/v1/jobs/{job_id}/resume
POST
/api/v1/jobs/sync
GET
/api/v1/pipelines/
POST
/api/v1/pipelines/
GET
/api/v1/pipelines/{pipeline_id}
PATCH
/api/v1/pipelines/{pipeline_id}
POST
/api/v1/pipelines/{pipeline_id}/start-update
POST
/api/v1/pipelines/{pipeline_id}/stop
POST
/api/v1/pipelines/{pipeline_id}/stop-and-wait
GET
/api/v1/pipelines/{pipeline_id}/wait-until-idle
POST
/api/v1/pipelines/sync
GET
/api/v1/lineage/table/{catalog}/{schema}/{table}
GET
/api/v1/lineage/column/{catalog}/{schema}/{table}/{column_name}
GET
/api/v1/lineage/graph/{catalog}/{schema}/{table}
POST
/api/v1/lineage/system-tables/query
POST
/api/v1/lineage/impact-analysis/{catalog}/{schema}/{table}/{column}
GET
/api/v1/lineage/schema/{catalog}/{schema}/lineage-summary
GET
/api/v1/lineage/popularity
GET
/api/v1/lineage/health
POST
/api/v1/lineage/sync
GET
/api/v1/connectors/
POST
/api/v1/connectors/
GET
/api/v1/connectors/{connector_id}
DELETE
/api/v1/connectors/{connector_id}
POST
/api/v1/connectors/{connector_id}/reset
POST
/api/v1/connectors/{connector_id}/activate
POST
/api/v1/connectors/{connector_id}/pause
POST
/api/v1/connectors/{connector_id}/now
POST
/api/v1/connectors/{connector_id}/runs/{run_id}/cancel
POST
/api/v1/connectors/{connector_id}/sync-secrets
POST
/api/v1/secrets/sync
GET
/api/v1/observability/jobs
POST
/api/v1/observability/jobs/sync-runs
POST
/api/v1/observability/pipelines/sync-updates
GET
/api/v1/observability/jobs/{job_id}/runs
GET
/api/v1/observability/jobs/{job_id}/runs/{run_id}
GET
/api/v1/observability/jobs/{job_id}/runs/{run_id}/output
GET
/api/v1/observability/jobs/{job_id}/runs/{run_id}/tasks/{task_run_id}/output
GET
/api/v1/observability/jobs/{job_id}/runs/{run_id}/export
GET
/api/v1/observability/pipelines/{pipeline_id}/metrics
GET
/api/v1/observability/pipelines
GET
/api/v1/observability/pipelines/{pipeline_id}/updates
GET
/api/v1/observability/pipelines/{pipeline_id}/updates/{update_id}
GET
/api/v1/observability/pipelines/{pipeline_id}/events
POST
/api/v1/observability/usage/sync
GET
/api/v1/observability/usage/daily
GET
/api/v1/observability/connectors
POST
/api/v1/observability/connectors/sync-runs
GET
/api/v1/observability/connectors/runs
GET
/api/v1/observability/connectors/jobs/{job_id}/runs/{run_id}
GET
/api/v1/observability/connectors/jobs/{job_id}/runs/{run_id}/output
GET
/api/v1/observability/connectors/jobs/{job_id}/runs/{run_id}/tasks/{task_run_id}/output
GET
/api/v1/observability/connectors/jobs/{job_id}/runs/{run_id}/export
GET
/api/v1/observability/connectors/jobs/{job_id}
GET
/api/v1/observability/jobs/{job_id}
GET
/api/v1/warehouses/
GET
/api/v1/warehouses/{warehouse_id}/status
POST
/api/v1/warehouses/{warehouse_id}/start
POST
/api/v1/warehouses/{warehouse_id}/stop
GET
/api/v1/warehouses/health
GET
/api/v1/workspace/status
GET
/api/v1/workspace/list
POST
/api/v1/workspace/mkdirs
POST
/api/v1/workspace/delete
GET
/api/v1/workspace/export
POST
/api/v1/workspace/import
GET
/api/v1/workspace/health
POST
/api/v1/statements/execute
GET
/api/v1/statements/{statement_id}/status
POST
/api/v1/statements/{statement_id}/cancel
GET
/api/v1/statements/{statement_id}/result/chunks/{chunk_index}
GET
/api/v1/statements/health
GET
/api/v1/statements/query-history/executed-queries
GET
/api/v1/statements/query-history/top-active-users
GET
/api/v1/statements/query-history/debug
POST
/api/v1/statements/query-history/sync
GET
/api/v1/tags/
GET
/api/v1/tags/policy/{tag_key}
DELETE
/api/v1/tags/policy/{tag_key}
PATCH
/api/v1/tags/policy/{tag_key}
POST
/api/v1/tags/policy
POST
/api/v1/tags/apply
DELETE
/api/v1/tags/apply
GET
/api/v1/tags/applied
GET
/api/v1/iam/users
GET
/api/v1/iam/users/{user_id}
GET
/api/v1/iam/groups
GET
/api/v1/iam/groups/{group_id}
GET
/api/v1/iam/service-principals
GET
/api/v1/iam/service-principals/{sp_id}
POST
/api/v1/iam/sync
POST
/api/v1/codegen/curated
POST
/api/v1/codegen/consumption
POST
/api/v1/codegen/connector
POST
/api/v1/codegen/projection
POST
/api/v1/codegen/alter-metadata
POST
/api/v1/codegen/alter-ddl
POST
/api/v1/codegen/delete
POST
/api/v1/codegen/curated/files
GET
/api/v1/codegen/download/{session_id}/{file_id}
POST
/api/v1/codegen/consumption/files
POST
/api/v1/codegen/connector/files
POST
/api/v1/codegen/projection/files
GET
/api/v1/codegen/health
POST
/api/v1/system-events/{event_batch_id}/acknowledge
GET
/health
GET
/background-sync/status
GET
/pipeline-sync/status
GET
/info