Databricks Integration

Field	Description	Required	Format
Workspace Domain	Your Databricks workspace subdomain (the part before .cloud.databricks.com).	Yes	`my-workspace`
Access Token	A Databricks personal access token.	Yes	`dapi0123456789abcdef0123456789abcdef`

cancel_all_runs — Cancel all active runs for a job.

Parameters

job_id

string

Identifier of a job. If omitted with all_queued_runs=true, cancels all queued runs in the workspace.

all_queued_runs

boolean

Cancel all queued runs. If no job_id is provided, all queued runs in the workspace are canceled.

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    }
  },
  "required": [
    "success"
  ],
  "title": "CancelAllRunsOutput",
  "type": "object"
}

cancel_run — Cancel a job run. The run is canceled asynchronously.

Parameters

run_id

string

required

Identifier of the run to cancel.

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    }
  },
  "required": [
    "success"
  ],
  "title": "CancelRunOutput",
  "type": "object"
}

create_endpoint — Create a new vector search endpoint.

Parameters

name

string

required

The name of the vector search endpoint to create.

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "data": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Data"
    }
  },
  "required": [
    "success"
  ],
  "title": "CreateEndpointOutput",
  "type": "object"
}

create_job — Create a new Databricks job.

Parameters

tasks

string

required

JSON string of task specifications for this job.

name

string

An optional name for the job.

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "job_id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Job Id"
    }
  },
  "required": [
    "success"
  ],
  "title": "CreateJobOutput",
  "type": "object"
}

create_sql_warehouse — Create a new SQL Warehouse in Databricks.

Parameters

name

string

required

A human-readable name for the warehouse.

cluster_size

string

required

Size of the cluster: 2X-Small, X-Small, Small, Medium, Large, X-Large, 2X-Large, 3X-Large, 4X-Large.

auto_stop_minutes

integer

Minutes of inactivity before auto-stop. 0 disables. Must be 0 or >= 10. (Default: 10)

min_num_clusters

integer

Minimum number of clusters to maintain. (Default: 1)

max_num_clusters

integer

Maximum number of clusters for autoscaling. (Default: 1)

enable_photon

boolean

Whether to use Photon optimized clusters.

enable_serverless_compute

boolean

Whether to use serverless compute.

warehouse_type

string

Warehouse type: TYPE_UNSPECIFIED, CLASSIC, or PRO.

spot_instance_policy

string

Spot instance policy: POLICY_UNSPECIFIED, COST_OPTIMIZED, RELIABILITY_OPTIMIZED.

channel

string

JSON string of channel details.

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "data": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Data"
    }
  },
  "required": [
    "success"
  ],
  "title": "CreateSqlWarehouseOutput",
  "type": "object"
}

create_vector_search_index — Create a new vector search index in Databricks.

Parameters

name

string

required

A unique name for the index (e.g., main_catalog.docs.en_wiki_index).

endpoint_name

string

required

The name of the vector search endpoint.

index_type

string

required

Type of index: DELTA_SYNC or DIRECT_ACCESS.

primary_key

string

required

The primary key column for the index.

source_table

string

The Delta table backing the index (required for DELTA_SYNC).

columns_to_sync

string

JSON array of column names to sync from the source Delta table.

embedding_source_columns

string

JSON array of embedding source column configs.

index_schema_json

string

The schema of the index in JSON format (required for DIRECT_ACCESS). Sent on the wire as schema_json.

pipeline_type

string

Pipeline type: TRIGGERED or CONTINUOUS. (Default: TRIGGERED)

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "data": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Data"
    }
  },
  "required": [
    "success"
  ],
  "title": "CreateVectorSearchIndexOutput",
  "type": "object"
}

delete_endpoint — Delete a vector search endpoint.

Parameters

endpoint_name

string

required

The name of the vector search endpoint to delete.

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    }
  },
  "required": [
    "success"
  ],
  "title": "DeleteEndpointOutput",
  "type": "object"
}

delete_job — Delete a job. Deleted jobs cannot be recovered.

Parameters

job_id

string

required

Identifier of the job to delete.

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    }
  },
  "required": [
    "success"
  ],
  "title": "DeleteJobOutput",
  "type": "object"
}

delete_run — Delete a non-active run. Returns an error if the run is active.

Parameters

run_id

string

required

Identifier of the run to delete.

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    }
  },
  "required": [
    "success"
  ],
  "title": "DeleteRunOutput",
  "type": "object"
}

delete_sql_warehouse — Delete a SQL Warehouse by ID.

Parameters

warehouse_id

string

required

The ID of the SQL Warehouse to delete.

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    }
  },
  "required": [
    "success"
  ],
  "title": "DeleteSqlWarehouseOutput",
  "type": "object"
}

delete_vector_search_index — Delete a vector search index.

Parameters

index_name

string

required

The name of the vector search index to delete.

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    }
  },
  "required": [
    "success"
  ],
  "title": "DeleteVectorSearchIndexOutput",
  "type": "object"
}

delete_vector_search_index_data — Delete rows from a Direct Access vector index by primary-key values.

Parameters

index_name

string

required

The name of the vector search index.

primary_keys

string

required

JSON array of primary key values to delete.

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "data": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Data"
    }
  },
  "required": [
    "success"
  ],
  "title": "DeleteVectorSearchIndexDataOutput",
  "type": "object"
}

edit_sql_warehouse — Edit the configuration of an existing SQL Warehouse.

Parameters

warehouse_id

string

required

The ID of the SQL Warehouse to edit.

name

string

New logical name for the warehouse.

cluster_size

string

Size of clusters: 2X-Small, X-Small, Small, Medium, Large, X-Large, 2X-Large, 3X-Large, 4X-Large.

auto_stop_mins

integer

Minutes of inactivity before auto-stop. 0 disables. Must be 0 or >= 10.

min_num_clusters

integer

Minimum number of clusters.

max_num_clusters

integer

Maximum number of clusters for autoscaling.

enable_photon

boolean

Whether to use Photon optimized clusters.

enable_serverless_compute

boolean

Whether to use serverless compute.

warehouse_type

string

Warehouse type: TYPE_UNSPECIFIED, CLASSIC, or PRO.

spot_instance_policy

string

Spot instance policy: POLICY_UNSPECIFIED, COST_OPTIMIZED, RELIABILITY_OPTIMIZED.

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "data": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Data"
    }
  },
  "required": [
    "success"
  ],
  "title": "EditSqlWarehouseOutput",
  "type": "object"
}

export_run — Export and retrieve the job run task.

Parameters

run_id

string

required

Identifier of the run to export.

views_to_export

string

Which views to export: CODE, DASHBOARDS, or ALL. Defaults to CODE.

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "data": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Data"
    }
  },
  "required": [
    "success"
  ],
  "title": "ExportRunOutput",
  "type": "object"
}

get_endpoint — Get details of a specific vector search endpoint.

Parameters

endpoint_name

string

required

The name of the vector search endpoint.

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "data": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Data"
    }
  },
  "required": [
    "success"
  ],
  "title": "GetEndpointOutput",
  "type": "object"
}

get_job — Retrieve the details for a single job.

Parameters

job_id

string

required

Identifier of the job.

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "data": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Data"
    }
  },
  "required": [
    "success"
  ],
  "title": "GetJobOutput",
  "type": "object"
}

get_job_permissions — Get permissions of a job.

Parameters

job_id

string

required

Identifier of the job.

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "data": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Data"
    }
  },
  "required": [
    "success"
  ],
  "title": "GetJobPermissionsOutput",
  "type": "object"
}

get_run — Retrieve the metadata of a run.

Parameters

run_id

string

required

Identifier of the run.

include_history

boolean

Whether to include the repair history in the response.

include_resolved_values

boolean

Whether to include resolved parameter values in the response.

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "data": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Data"
    }
  },
  "required": [
    "success"
  ],
  "title": "GetRunOutput",
  "type": "object"
}

get_run_output — Retrieve the output and metadata of a single task run.

Parameters

run_id

string

required

Identifier of the run.

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "data": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Data"
    }
  },
  "required": [
    "success"
  ],
  "title": "GetRunOutputOutput",
  "type": "object"
}

get_sql_warehouse — Retrieve details for a specific SQL Warehouse.

Parameters

warehouse_id

string

required

The ID of the SQL Warehouse.

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "data": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Data"
    }
  },
  "required": [
    "success"
  ],
  "title": "GetSqlWarehouseOutput",
  "type": "object"
}

get_sql_warehouse_config — Retrieve the global configuration for SQL Warehouses.

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "data": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Data"
    }
  },
  "required": [
    "success"
  ],
  "title": "GetSqlWarehouseConfigOutput",
  "type": "object"
}

get_sql_warehouse_permissions — Retrieve the permissions for a specific SQL Warehouse.

Parameters

warehouse_id

string

required

The ID of the SQL Warehouse.

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "data": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Data"
    }
  },
  "required": [
    "success"
  ],
  "title": "GetSqlWarehousePermissionsOutput",
  "type": "object"
}

get_vector_search_index — Retrieve details about a specific vector search index.

Parameters

index_name

string

required

The name of the vector search index.

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "data": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Data"
    }
  },
  "required": [
    "success"
  ],
  "title": "GetVectorSearchIndexOutput",
  "type": "object"
}

list_endpoints — List all vector search endpoints.

Parameters

max_results

integer

Maximum number of endpoints to return. (Default: 100)

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "endpoints": {
      "items": {
        "additionalProperties": true,
        "type": "object"
      },
      "title": "Endpoints",
      "type": "array"
    }
  },
  "required": [
    "success"
  ],
  "title": "ListEndpointsOutput",
  "type": "object"
}

list_jobs — List all jobs using automatic pagination.

Parameters

expand_tasks

boolean

Whether to include task and cluster details in the response.

name

string

Optional name to filter on.

max_requests

integer

Maximum number of API page requests to make (1-10).

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "jobs": {
      "items": {
        "additionalProperties": true,
        "type": "object"
      },
      "title": "Jobs",
      "type": "array"
    }
  },
  "required": [
    "success"
  ],
  "title": "ListJobsOutput",
  "type": "object"
}

list_runs — List all runs available to the user.

Parameters

job_id

string

Identifier of a job to filter runs.

active_only

boolean

Set to true to return only active runs.

max_results

integer

Maximum number of runs to return. (Default: 100)

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "runs": {
      "items": {
        "additionalProperties": true,
        "type": "object"
      },
      "title": "Runs",
      "type": "array"
    }
  },
  "required": [
    "success"
  ],
  "title": "ListRunsOutput",
  "type": "object"
}

list_sql_warehouses — List all SQL Warehouses available in the workspace.

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "warehouses": {
      "items": {
        "additionalProperties": true,
        "type": "object"
      },
      "title": "Warehouses",
      "type": "array"
    }
  },
  "required": [
    "success"
  ],
  "title": "ListSqlWarehousesOutput",
  "type": "object"
}

list_vector_search_indexes — List all vector search indexes for a given endpoint.

Parameters

endpoint_name

string

required

The name of the vector search endpoint.

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "indexes": {
      "items": {
        "additionalProperties": true,
        "type": "object"
      },
      "title": "Indexes",
      "type": "array"
    }
  },
  "required": [
    "success"
  ],
  "title": "ListVectorSearchIndexesOutput",
  "type": "object"
}

query_vector_search_index — Query a specific vector search index.

Parameters

index_name

string

required

The name of the vector search index.

columns

string

required

JSON array of column names to include in the response.

query_text

string

Free-text query for semantic search.

query_vector

string

JSON array of floats representing the embedding vector.

filters_json

string

JSON string representing query filters.

num_results

integer

Number of results to return. (Default: 10)

include_embeddings

boolean

Whether to include embedding vectors in the results.

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "data": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Data"
    }
  },
  "required": [
    "success"
  ],
  "title": "QueryVectorSearchIndexOutput",
  "type": "object"
}

repair_run — Re-run one or more tasks.

Parameters

run_id

string

required

Identifier of the run to repair.

rerun_tasks

string

JSON array of task keys to repair.

rerun_all_failed_tasks

boolean

If true, repair all failed tasks.

pipeline_params_full_refresh

boolean

Controls whether the pipeline should perform a full refresh.

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "repair_id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Repair Id"
    }
  },
  "required": [
    "success"
  ],
  "title": "RepairRunOutput",
  "type": "object"
}

reset_job — Overwrite all settings for a job.

Parameters

job_id

string

required

Identifier of the job.

new_settings

string

required

JSON string of the new settings that fully replaces all existing job settings.

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    }
  },
  "required": [
    "success"
  ],
  "title": "ResetJobOutput",
  "type": "object"
}

run_job_now — Run a job now and return the ID of the triggered run.

Parameters

job_id

string

required

Identifier of the job to run.

jar_params

string

JSON array of parameters for jobs with JAR tasks.

notebook_params

string

JSON object of key-value pairs for notebook tasks.

python_params

string

JSON array of parameters for Python tasks.

spark_submit_params

string

JSON array of parameters for spark submit tasks.

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "run_id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Run Id"
    },
    "number_in_job": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Number In Job"
    }
  },
  "required": [
    "success"
  ],
  "title": "RunJobNowOutput",
  "type": "object"
}

scan_vector_search_index — Scan a vector search index and return entries after a given primary key.

Parameters

index_name

string

required

The name of the vector search index.

last_primary_key

string

Primary key of the last entry returned in the previous scan. Leave empty to start from the beginning.

num_results

integer

Number of results to return. (Default: 10)

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "data": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Data"
    }
  },
  "required": [
    "success"
  ],
  "title": "ScanVectorSearchIndexOutput",
  "type": "object"
}

set_job_permissions — Set permissions on a job.

Parameters

job_id

string

required

Identifier of the job.

access_control_list

string

required

JSON string of permission objects with user_name/group_name/service_principal_name and permission_level.

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "data": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Data"
    }
  },
  "required": [
    "success"
  ],
  "title": "SetJobPermissionsOutput",
  "type": "object"
}

set_sql_warehouse_config — Update the global configuration for SQL Warehouses.

Parameters

instance_profile_arn

string

Instance profile ARN for IAM role (AWS).

google_service_account

string

Service account email for GCP workspaces.

security_policy

string

Security policy: NONE or DATA_ACCESS_CONTROL.

channel

string

JSON string of channel details.

enabled_warehouse_types

string

JSON array of enabled warehouse type objects.

config_param

string

JSON array of general config key/value pairs.

global_param

string

JSON array of global parameter key/value pairs.

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "data": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Data"
    }
  },
  "required": [
    "success"
  ],
  "title": "SetSqlWarehouseConfigOutput",
  "type": "object"
}

set_sql_warehouse_permissions — Update the permissions for a specific SQL Warehouse.

Parameters

warehouse_id

string

required

The ID of the SQL Warehouse.

access_control_list

string

required

JSON string of access control entries with user_name/group_name/service_principal_name and permission_level.

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "data": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Data"
    }
  },
  "required": [
    "success"
  ],
  "title": "SetSqlWarehousePermissionsOutput",
  "type": "object"
}

start_sql_warehouse — Start a SQL Warehouse by ID.

Parameters

warehouse_id

string

required

The ID of the SQL Warehouse to start.

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    }
  },
  "required": [
    "success"
  ],
  "title": "StartSqlWarehouseOutput",
  "type": "object"
}

stop_sql_warehouse — Stop a SQL Warehouse by ID.

Parameters

warehouse_id

string

required

The ID of the SQL Warehouse to stop.

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    }
  },
  "required": [
    "success"
  ],
  "title": "StopSqlWarehouseOutput",
  "type": "object"
}

sync_vector_search_index — Synchronize a Delta Sync vector search index.

Parameters

index_name

string

required

The name of the vector search index to synchronize.

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "data": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Data"
    }
  },
  "required": [
    "success"
  ],
  "title": "SyncVectorSearchIndexOutput",
  "type": "object"
}

update_job — Update an existing job. Only the fields provided will be updated.

Parameters

job_id

string

required

Identifier of the job to update.

new_settings

string

required

JSON string of updated job settings (only fields to change).

fields_to_remove

string

JSON array of field paths to remove from the job settings.

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    }
  },
  "required": [
    "success"
  ],
  "title": "UpdateJobOutput",
  "type": "object"
}

upsert_vector_search_index_data — Upsert data into an existing vector search index.

Parameters

index_name

string

required

The name of the vector search index.

inputs_json

string

required

JSON array of row objects to upsert.

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "data": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Data"
    }
  },
  "required": [
    "success"
  ],
  "title": "UpsertVectorSearchIndexDataOutput",
  "type": "object"
}

​Overview

​Authentication

​Databricks Personal Access Token

​Required Credentials

​Available Actions

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

Overview

Authentication

Databricks Personal Access Token

Required Credentials

Available Actions

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters