# Databricks (Service Principal) — Pipedream Connect

> Databricks is the lakehouse company, helping data teams solve the world’s toughest problems.

- API slug: `databricks_oauth` (use in MCP headers and tool keys)
- Auth: OAuth (Pipedream-managed)
- Categories: Data Analytics
- Website: https://databricks.com
- Managed OAuth scopes: `all-apis` · `sql`
- This page (HTML): https://pipedream.com/apps/databricks-oauth
- Tools: 42 actions · 0 triggers

## Connect via MCP (recommended)

- Endpoint: `https://remote.mcp.pipedream.net/v3`
- Headers: `Authorization: Bearer <token>` · `x-pd-project-id` · `x-pd-environment` · `x-pd-external-user-id` · `x-pd-app-slug: databricks_oauth`

```ts
import { Client } from "@modelcontextprotocol/sdk/client/index.js"
import { StreamableHTTPClientTransport } from "@modelcontextprotocol/sdk/client/streamableHttp.js"
import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const accessToken = await pd.rawAccessToken

const transport = new StreamableHTTPClientTransport(
  new URL("https://remote.mcp.pipedream.net/v3"),
  {
    requestInit: {
      headers: {
        Authorization: `Bearer ${accessToken}`,
        "x-pd-project-id": process.env.PIPEDREAM_PROJECT_ID!,
        "x-pd-environment": "production",
        "x-pd-external-user-id": "{external_user_id}", // any stable ID for this user in your system
        "x-pd-app-slug": "databricks_oauth",
      },
    },
  },
)

const mcp = new Client({ name: "my-agent", version: "1.0.0" })
await mcp.connect(transport)

const { tools } = await mcp.listTools()

// e.g. run Cancel All Runs:
const result = await mcp.callTool({
  name: "databricks_oauth-cancel-all-runs",
  arguments: {
    jobId: "Job",
    allQueuedRuns: true,
  },
})
```

Docs: [MCP guide](https://pipedream.com/docs/connect/mcp/developers.md)

## API proxy

For a Databricks (Service Principal) endpoint with no pre-built tool, the proxy forwards your request with the connected user's credentials attached.

```bash
# The path segment is the target URL, URL-safe base64 encoded:
# https://api.example.com/v1/me

curl "https://api.pipedream.com/v1/connect/{project_id}/proxy/aHR0cHM6Ly9hcGkuZXhhbXBsZS5jb20vdjEvbWU?external_user_id={external_user_id}&account_id=apn_xxxxxxx" \
  -H "Authorization: Bearer {access_token}" \
  -H "x-pd-environment: production"
```

Docs: [API proxy guide](https://pipedream.com/docs/connect/api-proxy.md)

## SDK

```ts
import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "databricks_oauth-cancel-all-runs",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    databricks_oauth: { authProvisionId: "apn_xxxxxxx" },
    jobId: "Job",
    allQueuedRuns: true,
  },
})
```

Docs: [Managed auth guide](https://pipedream.com/docs/connect/managed-auth/quickstart.md) · [Tools guide](https://pipedream.com/docs/connect/components.md)

## Actions (42)

### `databricks_oauth-cancel-all-runs` — Cancel All Runs (Write)

Cancel all active runs for a job. The runs are canceled asynchronously, so it doesn't prevent new runs from being started. See the documentation

Full schema: https://pipedream.com/apps/databricks-oauth/actions/cancel-all-runs.md

### `databricks_oauth-cancel-run` — Cancel Run (Write)

Cancel a job run. The run is canceled asynchronously, so it may still be running when this request completes. See the documentation

Full schema: https://pipedream.com/apps/databricks-oauth/actions/cancel-run.md

### `databricks_oauth-create-endpoint` — Create Endpoint (Write)

Create a new vector search endpoint. See the documentation

Full schema: https://pipedream.com/apps/databricks-oauth/actions/create-endpoint.md

### `databricks_oauth-create-job` — Create Job (Write)

Create a job. See the documentation

Full schema: https://pipedream.com/apps/databricks-oauth/actions/create-job.md

### `databricks_oauth-create-sql-warehouse` — Create SQL Warehouse (Write)

Creates a new SQL Warehouse in Databricks. See the documentation

Full schema: https://pipedream.com/apps/databricks-oauth/actions/create-sql-warehouse.md

### `databricks_oauth-create-vector-search-index` — Create Vector Search Index (Write)

Creates a new vector search index in Databricks. See the documentation

Full schema: https://pipedream.com/apps/databricks-oauth/actions/create-vector-search-index.md

### `databricks_oauth-delete-vector-search-index-data` — Delete Data from Vector Search Index (Write)

Deletes rows from a Direct Access vector index by primary-key values. See the documentation

Full schema: https://pipedream.com/apps/databricks-oauth/actions/delete-vector-search-index-data.md

### `databricks_oauth-delete-endpoint` — Delete Endpoint (Write)

Delete a vector search endpoint. See the documentation

Full schema: https://pipedream.com/apps/databricks-oauth/actions/delete-endpoint.md

### `databricks_oauth-delete-job` — Delete Job (Write)

Delete a job. Deleted jobs cannot be recovered. See the documentation

Full schema: https://pipedream.com/apps/databricks-oauth/actions/delete-job.md

### `databricks_oauth-delete-run` — Delete Run (Write)

Delete a non-active run. Returns an error if the run is active. See the documentation

Full schema: https://pipedream.com/apps/databricks-oauth/actions/delete-run.md

### `databricks_oauth-delete-sql-warehouse` — Delete SQL Warehouse (Write)

Deletes a SQL Warehouse by ID. See the documentation

Full schema: https://pipedream.com/apps/databricks-oauth/actions/delete-sql-warehouse.md

### `databricks_oauth-delete-vector-search-index` — Delete Vector Search Index (Write)

Deletes a vector search index in Databricks. See the documentation

Full schema: https://pipedream.com/apps/databricks-oauth/actions/delete-vector-search-index.md

### `databricks_oauth-edit-sql-warehouse` — Edit SQL Warehouse (Write)

Edits the configuration of an existing SQL Warehouse. See the documentation

Full schema: https://pipedream.com/apps/databricks-oauth/actions/edit-sql-warehouse.md

### `databricks_oauth-export-run` — Export Run (Read-only)

Export and retrieve the job run task. See the documentation

Full schema: https://pipedream.com/apps/databricks-oauth/actions/export-run.md

### `databricks_oauth-get-endpoint` — Get Endpoint (Read-only)

Get details of a specific vector search endpoint. See the documentation

Full schema: https://pipedream.com/apps/databricks-oauth/actions/get-endpoint.md

### `databricks_oauth-get-job` — Get Job (Read-only)

Retrieves the details for a single job. See the documentation

Full schema: https://pipedream.com/apps/databricks-oauth/actions/get-job.md

### `databricks_oauth-get-job-permissions` — Get Job Permissions (Read-only)

Get permissions of a job. See the documentation

Full schema: https://pipedream.com/apps/databricks-oauth/actions/get-job-permissions.md

### `databricks_oauth-get-run` — Get Run (Read-only)

Retrieve the metadata of a run. See the documentation

Full schema: https://pipedream.com/apps/databricks-oauth/actions/get-run.md

### `databricks_oauth-get-run-output` — Get Run Output (Read-only)

Retrieve the output and metadata of a single task run. See the documentation

Full schema: https://pipedream.com/apps/databricks-oauth/actions/get-run-output.md

### `databricks_oauth-get-sql-warehouse` — Get SQL Warehouse (Read-only)

Retrieves details for a specific SQL Warehouse. See docs

Full schema: https://pipedream.com/apps/databricks-oauth/actions/get-sql-warehouse.md

### `databricks_oauth-get-sql-warehouse-config` — Get SQL Warehouse Config (Read-only)

Retrieves the global configuration for SQL Warehouses. See the documentation

Full schema: https://pipedream.com/apps/databricks-oauth/actions/get-sql-warehouse-config.md

### `databricks_oauth-get-sql-warehouse-permissions` — Get SQL Warehouse Permissions (Read-only)

Retrieves the permissions for a specific SQL Warehouse. See the documentation

Full schema: https://pipedream.com/apps/databricks-oauth/actions/get-sql-warehouse-permissions.md

### `databricks_oauth-get-vector-search-index` — Get Vector Search Index (Read-only)

Retrieves details about a specific vector search index. See the documentation

Full schema: https://pipedream.com/apps/databricks-oauth/actions/get-vector-search-index.md

### `databricks_oauth-list-endpoints` — List Endpoints (Read-only)

List all vector search endpoints. See the documentation

Full schema: https://pipedream.com/apps/databricks-oauth/actions/list-endpoints.md

### `databricks_oauth-list-jobs` — List Jobs (Read-only)

List all jobs using automatic pagination. See the documentation

Full schema: https://pipedream.com/apps/databricks-oauth/actions/list-jobs.md

### `databricks_oauth-list-runs` — List Runs (Read-only)

Lists all runs available to the user. See the documentation

Full schema: https://pipedream.com/apps/databricks-oauth/actions/list-runs.md

### `databricks_oauth-list-sql-warehouses` — List SQL Warehouses (Read-only)

Lists all SQL Warehouses available in the Databricks workspace. See the documentation

Full schema: https://pipedream.com/apps/databricks-oauth/actions/list-sql-warehouses.md

### `databricks_oauth-list-vector-search-indexes` — List Vector Search Indexes (Read-only)

Lists all vector search indexes for a given endpoint. See the documentation

Full schema: https://pipedream.com/apps/databricks-oauth/actions/list-vector-search-indexes.md

### `databricks_oauth-query-vector-search-index` — Query Vector Search Index (Read-only)

Query a specific vector search index in Databricks. See the documentation

Full schema: https://pipedream.com/apps/databricks-oauth/actions/query-vector-search-index.md

### `databricks_oauth-query-vector-search-index-next-page` — Query Vector Search Index Next Page (Read-only)

Fetch the next page of results from a previously executed Databricks Vector Search query, using the next_page_token returned by a prior call. Run Query Vector Search Index first to get an initial page and its next_page_token, then pass that token here (and again on each subsequent call) to walk…

Full schema: https://pipedream.com/apps/databricks-oauth/actions/query-vector-search-index-next-page.md

### `databricks_oauth-repair-run` — Repair Run (Write)

Re-run one or more tasks. See the documentation

Full schema: https://pipedream.com/apps/databricks-oauth/actions/repair-run.md

### `databricks_oauth-reset-job` — Reset Job (Write)

Overwrite all settings for the given job. See the documentation

Full schema: https://pipedream.com/apps/databricks-oauth/actions/reset-job.md

### `databricks_oauth-run-job-now` — Run Job Now (Write)

Run a job now and return the id of the triggered run. See the documentation

Full schema: https://pipedream.com/apps/databricks-oauth/actions/run-job-now.md

### `databricks_oauth-scan-vector-search-index` — Scan Vector Search Index (Read-only)

Scans a vector search index and returns entries after the given primary key. See the documentation

Full schema: https://pipedream.com/apps/databricks-oauth/actions/scan-vector-search-index.md

### `databricks_oauth-set-job-permissions` — Set Job Permissions (Write)

Set permissions on a job. See the documentation

Full schema: https://pipedream.com/apps/databricks-oauth/actions/set-job-permissions.md

### `databricks_oauth-set-sql-warehouse-config` — Set SQL Warehouse Config (Write)

Updates the global configuration for SQL Warehouses. See the documentation

Full schema: https://pipedream.com/apps/databricks-oauth/actions/set-sql-warehouse-config.md

### `databricks_oauth-set-sql-warehouse-permissions` — Set SQL Warehouse Permissions (Write)

Updates the permissions for a specific SQL Warehouse. See the documentation

Full schema: https://pipedream.com/apps/databricks-oauth/actions/set-sql-warehouse-permissions.md

### `databricks_oauth-start-sql-warehouse` — Start SQL Warehouse (Write)

Starts a SQL Warehouse by ID. See the documentation

Full schema: https://pipedream.com/apps/databricks-oauth/actions/start-sql-warehouse.md

### `databricks_oauth-stop-sql-warehouse` — Stop SQL Warehouse (Write)

Stops a SQL Warehouse by ID. See the documentation

Full schema: https://pipedream.com/apps/databricks-oauth/actions/stop-sql-warehouse.md

### `databricks_oauth-sync-vector-search-index` — Sync Vector Search Index (Write)

Synchronize a Delta Sync vector search index in Databricks. See the documentation

Full schema: https://pipedream.com/apps/databricks-oauth/actions/sync-vector-search-index.md

### `databricks_oauth-update-job` — Update Job (Write)

Update an existing job. Only the fields that are provided will be updated. See the documentation

Full schema: https://pipedream.com/apps/databricks-oauth/actions/update-job.md

### `databricks_oauth-upsert-vector-search-index-data` — Upsert Vector Search Index Data (Write)

Upserts (inserts/updates) data into an existing vector search index. See the documentation

Full schema: https://pipedream.com/apps/databricks-oauth/actions/upsert-vector-search-index-data.md

---

- All apps: https://pipedream.com/apps — index: https://pipedream.com/llms.txt
- Pipedream docs for agents: https://pipedream.com/docs/llms.txt