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

string

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

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

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

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

string

required

JSON string of task specifications for this job.

string

An optional name for the job.

string

JSON string of tags associated with the job.

string

JSON string of job cluster specifications.

string

JSON string of email notification settings.

string

JSON string of webhook notification settings.

integer

Timeout in seconds applied to each run of this job.

string

JSON string of schedule definition with quartz_cron_expression and timezone_id.

integer

Maximum number of concurrent runs for the job.

string

JSON string specifying a remote Git repository for task source code.

string

JSON string of permissions to set on 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

string

required

A human-readable name for the warehouse.

string

required

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

integer

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

integer

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

integer

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

boolean

Whether to use Photon optimized clusters.

boolean

Whether to use serverless compute.

string

Warehouse type: TYPE_UNSPECIFIED, CLASSIC, or PRO.

string

Spot instance policy: POLICY_UNSPECIFIED, COST_OPTIMIZED, RELIABILITY_OPTIMIZED.

string

JSON string of channel details.

string

JSON string of custom key-value tags.

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

string

required

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

string

required

The name of the vector search endpoint.

string

required

Type of index: DELTA_SYNC or DIRECT_ACCESS.

string

required

The primary key column for the index.

string

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

string

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

string

JSON array of embedding source column configs.

string

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

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

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

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

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

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

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

string

required

The name of the vector search index.

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

string

required

The ID of the SQL Warehouse to edit.

string

New logical name for the warehouse.

string

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

integer

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

integer

Minimum number of clusters.

integer

Maximum number of clusters for autoscaling.

boolean

Whether to use Photon optimized clusters.

boolean

Whether to use serverless compute.

string

Warehouse type: TYPE_UNSPECIFIED, CLASSIC, or PRO.

string

Spot instance policy: POLICY_UNSPECIFIED, COST_OPTIMIZED, RELIABILITY_OPTIMIZED.

string

JSON string of custom key-value tags.

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": "EditSqlWarehouseOutput",
  "type": "object"
}

export_run — Export and retrieve the job run task.

Parameters

string

required

Identifier of the run 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

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

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

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

string

required

Identifier of the run.

boolean

Whether to include the repair history in the response.

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

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

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

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

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

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

boolean

Whether to include task and cluster details in the response.

string

Optional name to filter on.

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

string

Identifier of a job to filter runs.

boolean

Set to true to return only active runs.

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

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

string

required

The name of the vector search index.

string

required

JSON array of column names to include in the response.

string

Free-text query for semantic search.

string

JSON array of floats representing the embedding vector.

string

JSON string representing query filters.

integer

Number of results to return. (Default: 10)

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

string

required

Identifier of the run to repair.

string

JSON array of task keys to repair.

boolean

If true, repair all failed tasks.

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

string

required

Identifier of the job.

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

string

required

Identifier of the job to run.

string

JSON array of parameters for jobs with JAR tasks.

string

JSON object of key-value pairs for notebook tasks.

string

JSON array of parameters for Python tasks.

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

string

required

The name of the vector search index.

string

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

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

string

required

Identifier of the job.

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

string

Instance profile ARN for IAM role (AWS).

string

Service account email for GCP workspaces.

string

Security policy: NONE or DATA_ACCESS_CONTROL.

string

JSON string of channel details.

string

JSON array of enabled warehouse type objects.

string

JSON array of general config key/value pairs.

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

string

required

The ID of the SQL Warehouse.

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

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

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

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

string

required

Identifier of the job to update.

string

required

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

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

string

required

The name of the vector search index.

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