From af56ef693bfb0a3c95eb784534b8b38eedbc42b2 Mon Sep 17 00:00:00 2001 From: Jeffrey Aven Date: Fri, 20 Dec 2024 11:48:29 +1100 Subject: [PATCH 1/7] added dbx providers --- .../v00.00.00000/provider.yaml | 77 + .../v00.00.00000/services/billing.yaml | 758 ++ .../v00.00.00000/services/iam.yaml | 2037 +++++ .../v00.00.00000/services/logging.yaml | 371 + .../v00.00.00000/services/oauth.yaml | 935 ++ .../v00.00.00000/services/provisioning.yaml | 2158 +++++ .../v00.00.00000/services/settings.yaml | 985 ++ .../v00.00.00000/services/unity_catalog.yaml | 1158 +++ .../v00.00.00000/provider.yaml | 176 + .../v00.00.00000/services/apps.yaml | 1854 ++++ .../v00.00.00000/services/cleanrooms.yaml | 1849 ++++ .../v00.00.00000/services/compute.yaml | 4609 ++++++++++ .../v00.00.00000/services/dbsql.yaml | 5452 +++++++++++ .../services/deltalivetables.yaml | 1619 ++++ .../v00.00.00000/services/deltasharing.yaml | 1768 ++++ .../v00.00.00000/services/filemanagement.yaml | 865 ++ .../v00.00.00000/services/iam.yaml | 2891 ++++++ .../v00.00.00000/services/lakeview.yaml | 1270 +++ .../services/machinelearning.yaml | 4891 ++++++++++ .../v00.00.00000/services/marketplace.yaml | 4531 ++++++++++ .../services/realtimeserving.yaml | 1882 ++++ .../v00.00.00000/services/repos.yaml | 907 ++ .../v00.00.00000/services/secrets.yaml | 618 ++ .../v00.00.00000/services/unitycatalog.yaml | 7945 +++++++++++++++++ .../v00.00.00000/services/vectorsearch.yaml | 982 ++ .../v00.00.00000/services/workflows.yaml | 4507 ++++++++++ .../v00.00.00000/services/workspace.yaml | 3401 +++++++ 27 files changed, 60496 insertions(+) create mode 100644 providers/src/databricks_account/v00.00.00000/provider.yaml create mode 100644 providers/src/databricks_account/v00.00.00000/services/billing.yaml create mode 100644 providers/src/databricks_account/v00.00.00000/services/iam.yaml create mode 100644 providers/src/databricks_account/v00.00.00000/services/logging.yaml create mode 100644 providers/src/databricks_account/v00.00.00000/services/oauth.yaml create mode 100644 providers/src/databricks_account/v00.00.00000/services/provisioning.yaml create mode 100644 providers/src/databricks_account/v00.00.00000/services/settings.yaml create mode 100644 providers/src/databricks_account/v00.00.00000/services/unity_catalog.yaml create mode 100644 providers/src/databricks_workspace/v00.00.00000/provider.yaml create mode 100644 providers/src/databricks_workspace/v00.00.00000/services/apps.yaml create mode 100644 providers/src/databricks_workspace/v00.00.00000/services/cleanrooms.yaml create mode 100644 providers/src/databricks_workspace/v00.00.00000/services/compute.yaml create mode 100644 providers/src/databricks_workspace/v00.00.00000/services/dbsql.yaml create mode 100644 providers/src/databricks_workspace/v00.00.00000/services/deltalivetables.yaml create mode 100644 providers/src/databricks_workspace/v00.00.00000/services/deltasharing.yaml create mode 100644 providers/src/databricks_workspace/v00.00.00000/services/filemanagement.yaml create mode 100644 providers/src/databricks_workspace/v00.00.00000/services/iam.yaml create mode 100644 providers/src/databricks_workspace/v00.00.00000/services/lakeview.yaml create mode 100644 providers/src/databricks_workspace/v00.00.00000/services/machinelearning.yaml create mode 100644 providers/src/databricks_workspace/v00.00.00000/services/marketplace.yaml create mode 100644 providers/src/databricks_workspace/v00.00.00000/services/realtimeserving.yaml create mode 100644 providers/src/databricks_workspace/v00.00.00000/services/repos.yaml create mode 100644 providers/src/databricks_workspace/v00.00.00000/services/secrets.yaml create mode 100644 providers/src/databricks_workspace/v00.00.00000/services/unitycatalog.yaml create mode 100644 providers/src/databricks_workspace/v00.00.00000/services/vectorsearch.yaml create mode 100644 providers/src/databricks_workspace/v00.00.00000/services/workflows.yaml create mode 100644 providers/src/databricks_workspace/v00.00.00000/services/workspace.yaml diff --git a/providers/src/databricks_account/v00.00.00000/provider.yaml b/providers/src/databricks_account/v00.00.00000/provider.yaml new file mode 100644 index 00000000..3ee68a22 --- /dev/null +++ b/providers/src/databricks_account/v00.00.00000/provider.yaml @@ -0,0 +1,77 @@ +id: databricks_account +name: databricks_account +version: v00.00.00000 +providerServices: + billing: + id: billing:v00.00.00000 + name: billing + preferred: true + service: + $ref: databricks_account/v00.00.00000/services/billing.yaml + title: Account Billing + version: v00.00.00000 + description: Account Billing + iam: + id: iam:v00.00.00000 + name: iam + preferred: true + service: + $ref: databricks_account/v00.00.00000/services/iam.yaml + title: Identity and Access Management + version: v00.00.00000 + description: Identity and Access Management + logging: + id: logging:v00.00.00000 + name: logging + preferred: true + service: + $ref: databricks_account/v00.00.00000/services/logging.yaml + title: Log Delivery + version: v00.00.00000 + description: Log Delivery + oauth: + id: oauth:v00.00.00000 + name: oauth + preferred: true + service: + $ref: databricks_account/v00.00.00000/services/oauth.yaml + title: OAuth Integrations + version: v00.00.00000 + description: OAuth Integrations + provisioning: + id: provisioning:v00.00.00000 + name: provisioning + preferred: true + service: + $ref: databricks_account/v00.00.00000/services/provisioning.yaml + title: Account Provisioning + version: v00.00.00000 + description: Account Provisioning + settings: + id: settings:v00.00.00000 + name: settings + preferred: true + service: + $ref: databricks_account/v00.00.00000/services/settings.yaml + title: Account Settings + version: v00.00.00000 + description: Account Settings + unity_catalog: + id: unity_catalog:v00.00.00000 + name: unity_catalog + preferred: true + service: + $ref: databricks_account/v00.00.00000/services/unity_catalog.yaml + title: Unity Catalog + version: v00.00.00000 + description: Unity Catalog +config: + auth: + type: oauth2 + client_id_env_var: DATABRICKS_CLIENT_ID + client_secret_env_var: DATABRICKS_CLIENT_SECRET + grant_type: client_credentials + token_url: https://accounts.cloud.databricks.com/oidc/accounts/{{ .__env__DATABRICKS_ACCOUNT_ID + }}/v1/token + scopes: + - all-apis diff --git a/providers/src/databricks_account/v00.00.00000/services/billing.yaml b/providers/src/databricks_account/v00.00.00000/services/billing.yaml new file mode 100644 index 00000000..e10286e9 --- /dev/null +++ b/providers/src/databricks_account/v00.00.00000/services/billing.yaml @@ -0,0 +1,758 @@ +openapi: 3.0.0 +info: + version: 2024-12-19-stackql-generated + contact: + name: StackQL Studios + url: https://stackql.io/ + email: info@stackql.io + title: Databricks Billing API + description: Account Billing +servers: +- url: https://accounts.cloud.databricks.com +paths: + /api/2.0/accounts/{account_id}/usage/download: + get: + operationId: billable-usage-download + externalDocs: + url: https://docs.databricks.com/api/account/billableusage/download + x-stackQL-resource: billable_usage + x-stackQL-method: download + x-stackQL-verb: exec + x-numReqParams: 3 + parameters: + - name: account_id + required: true + description: uuid + in: path + - name: start_month + required: true + description: string + in: query + - name: end_month + required: true + description: string + in: query + - name: personal_data + in: query + responses: + '200': + description: Billable usage data was returned successfully. + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Returns billable usage logs in CSV format for the specified account + and date range. For the data schema, see + /api/2.1/accounts/{account_id}/budgets: + post: + operationId: budgets-create + externalDocs: + url: https://docs.databricks.com/api/account/budgets/create + x-stackQL-resource: budgets + x-stackQL-method: create + x-stackQL-verb: insert + x-numReqParams: 1 + parameters: + - name: account_id + required: true + description: uuid + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + budget: + type: object + properties: + budget_configuration_id: + type: string + account_id: + type: string + create_time: + type: integer + update_time: + type: integer + alert_configurations: + type: array + items: + type: object + properties: + alert_configuration_id: + type: string + time_period: + type: string + trigger_type: + type: string + quantity_type: + type: string + quantity_threshold: + type: string + action_configurations: + type: array + items: + type: object + properties: + action_configuration_id: + type: string + action_type: + type: string + target: + type: string + filter: + type: object + properties: + workspace_id: + type: object + properties: + operator: + type: string + values: + type: array + items: + type: integer + tags: + type: array + items: + type: object + properties: + key: + type: string + value: + type: object + properties: + operator: + type: string + values: + type: array + items: + type: string + display_name: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '429': + description: Operation is rejected due to throttling, e.g. some resource + has been exhausted, per-user quota. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + budget: + type: required + example: + budget: + account_id: 449e7a5c-69d3-4b8a-aaaf-5c9b713ebc65 + alert_configurations: + - time_period: MONTH + trigger_type: CUMULATIVE_SPENDING_EXCEEDED + quantity_type: LIST_PRICE_DOLLARS_USD + quantity_threshold: string + action_configurations: + - action_type: EMAIL_NOTIFICATION + target: string + filter: + workspace_id: + operator: IN + values: + - 0 + tags: + - key: string + value: + operator: IN + values: + - string + display_name: string + description: Create a new budget configuration for an account. For full details, + see + get: + operationId: budgets-list + externalDocs: + url: https://docs.databricks.com/api/account/budgets/list + x-stackQL-resource: budgets + x-stackQL-method: list + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: account_id + required: true + description: uuid + in: path + - name: page_token + in: query + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + budgets: + type: array + items: + type: object + properties: + budget_configuration_id: + type: string + account_id: + type: string + create_time: + type: integer + update_time: + type: integer + alert_configurations: + type: array + items: + type: object + properties: + alert_configuration_id: + type: string + time_period: + type: string + trigger_type: + type: string + quantity_type: + type: string + quantity_threshold: + type: string + action_configurations: + type: array + items: + type: object + properties: + action_configuration_id: + type: string + action_type: + type: string + target: + type: string + filter: + type: object + properties: + workspace_id: + type: object + properties: + operator: + type: string + values: + type: array + items: + type: integer + tags: + type: array + items: + type: object + properties: + key: + type: string + value: + type: object + properties: + operator: + type: string + values: + type: array + items: + type: string + display_name: + type: string + next_page_token: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '500': + description: Internal error. + x-stackQL-objectKey: $.budgets + description: Gets all budgets associated with this account. + /api/2.1/accounts/{account_id}/budgets/{budget_id}: + delete: + operationId: budgets-delete + externalDocs: + url: https://docs.databricks.com/api/account/budgets/delete + x-stackQL-resource: budgets + x-stackQL-method: delete + x-stackQL-verb: delete + x-numReqParams: 2 + parameters: + - name: account_id + required: true + description: uuid + in: path + - name: budget_id + required: true + description: uuid + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: {} + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Deletes a budget configuration for an account. Both account and + budget configuration are specified by ID. This cannot be undone. + get: + operationId: budgets-get + externalDocs: + url: https://docs.databricks.com/api/account/budgets/get + x-stackQL-resource: budgets + x-stackQL-method: get + x-stackQL-verb: select + x-numReqParams: 2 + parameters: + - name: account_id + required: true + description: uuid + in: path + - name: budget_id + required: true + description: uuid + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + budget: + type: object + properties: + budget_configuration_id: + type: string + account_id: + type: string + create_time: + type: integer + update_time: + type: integer + alert_configurations: + type: array + items: + type: object + properties: + alert_configuration_id: + type: string + time_period: + type: string + trigger_type: + type: string + quantity_type: + type: string + quantity_threshold: + type: string + action_configurations: + type: array + items: + type: object + properties: + action_configuration_id: + type: string + action_type: + type: string + target: + type: string + filter: + type: object + properties: + workspace_id: + type: object + properties: + operator: + type: string + values: + type: array + items: + type: integer + tags: + type: array + items: + type: object + properties: + key: + type: string + value: + type: object + properties: + operator: + type: string + values: + type: array + items: + type: string + display_name: + type: string + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + x-stackQL-objectKey: $.budget + description: Gets a budget configuration for an account. Both account and budget + configuration are specified by ID. + put: + operationId: budgets-update + externalDocs: + url: https://docs.databricks.com/api/account/budgets/update + x-stackQL-resource: budgets + x-stackQL-method: update + x-stackQL-verb: replace + x-numReqParams: 2 + parameters: + - name: account_id + required: true + description: uuid + in: path + - name: budget_id + required: true + description: string + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + budget: + type: object + properties: + budget_configuration_id: + type: string + account_id: + type: string + create_time: + type: integer + update_time: + type: integer + alert_configurations: + type: array + items: + type: object + properties: + alert_configuration_id: + type: string + time_period: + type: string + trigger_type: + type: string + quantity_type: + type: string + quantity_threshold: + type: string + action_configurations: + type: array + items: + type: object + properties: + action_configuration_id: + type: string + action_type: + type: string + target: + type: string + filter: + type: object + properties: + workspace_id: + type: object + properties: + operator: + type: string + values: + type: array + items: + type: integer + tags: + type: array + items: + type: object + properties: + key: + type: string + value: + type: object + properties: + operator: + type: string + values: + type: array + items: + type: string + display_name: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '429': + description: Operation is rejected due to throttling, e.g. some resource + has been exhausted, per-user quota. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + budget: + type: required + example: + budget: + budget_configuration_id: dc0b6e4b-23ef-471d-adf9-1d38d9199f98 + account_id: 449e7a5c-69d3-4b8a-aaaf-5c9b713ebc65 + alert_configurations: + - alert_configuration_id: 60deed03-5f33-4eda-ac0b-03b20fccc5d1 + time_period: MONTH + trigger_type: CUMULATIVE_SPENDING_EXCEEDED + quantity_type: LIST_PRICE_DOLLARS_USD + quantity_threshold: string + action_configurations: + - action_configuration_id: 4079440f-2386-43ee-bb12-2fb4137f0080 + action_type: EMAIL_NOTIFICATION + target: string + filter: + workspace_id: + operator: IN + values: + - 0 + tags: + - key: string + value: + operator: IN + values: + - string + display_name: string + description: Updates a budget configuration for an account. Both account and + budget configuration are specified by ID. + /api/2.0/accounts/{account_id}/dashboard: + post: + operationId: usage-dashboards-create + externalDocs: + url: https://docs.databricks.com/api/account/usagedashboards/create + x-stackQL-resource: usage_dashboards + x-stackQL-method: create + x-stackQL-verb: insert + x-numReqParams: 1 + parameters: + - name: account_id + required: true + description: string + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + dashboard_id: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + workspace_id: + type: integer + format: int64 + dashboard_type: + type: string + example: + workspace_id: 0 + dashboard_type: USAGE_DASHBOARD_TYPE_WORKSPACE + description: Create a usage dashboard specified by workspaceId, accountId, and + dashboard type. + get: + operationId: usage-dashboards-get + externalDocs: + url: https://docs.databricks.com/api/account/usagedashboards/get + x-stackQL-resource: usage_dashboards + x-stackQL-method: get + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: account_id + required: true + description: string + in: path + - name: workspace_id + in: query + - name: dashboard_type + in: query + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + dashboard_id: + type: string + dashboard_url: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '500': + description: Internal error. + description: Get a usage dashboard specified by workspaceId, accountId, and + dashboard type. +components: + x-stackQL-resources: + billable_usage: + id: databricks_account.billing.billable_usage + name: billable_usage + title: Billable_usage + methods: + download: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1usage~1download/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: [] + replace: [] + delete: [] + exec: + - $ref: '#/components/x-stackQL-resources/billable_usage/methods/download' + budgets: + id: databricks_account.billing.budgets + name: budgets + title: Budgets + methods: + create: + operation: + $ref: '#/paths/~1api~12.1~1accounts~1{account_id}~1budgets/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1api~12.1~1accounts~1{account_id}~1budgets/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.budgets + delete: + operation: + $ref: '#/paths/~1api~12.1~1accounts~1{account_id}~1budgets~1{budget_id}/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1api~12.1~1accounts~1{account_id}~1budgets~1{budget_id}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.budget + update: + operation: + $ref: '#/paths/~1api~12.1~1accounts~1{account_id}~1budgets~1{budget_id}/put' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/budgets/methods/get' + - $ref: '#/components/x-stackQL-resources/budgets/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/budgets/methods/create' + update: [] + replace: + - $ref: '#/components/x-stackQL-resources/budgets/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/budgets/methods/delete' + exec: [] + usage_dashboards: + id: databricks_account.billing.usage_dashboards + name: usage_dashboards + title: Usage_dashboards + methods: + create: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1dashboard/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1dashboard/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/usage_dashboards/methods/get' + insert: + - $ref: '#/components/x-stackQL-resources/usage_dashboards/methods/create' + update: [] + replace: [] + delete: [] + exec: [] diff --git a/providers/src/databricks_account/v00.00.00000/services/iam.yaml b/providers/src/databricks_account/v00.00.00000/services/iam.yaml new file mode 100644 index 00000000..9986bd7d --- /dev/null +++ b/providers/src/databricks_account/v00.00.00000/services/iam.yaml @@ -0,0 +1,2037 @@ +openapi: 3.0.0 +info: + version: 2024-12-19-stackql-generated + contact: + name: StackQL Studios + url: https://stackql.io/ + email: info@stackql.io + title: Databricks Iam API + description: Identity and Access Management +servers: +- url: https://accounts.cloud.databricks.com +paths: + /api/2.0/preview/accounts/{account_id}/access-control/assignable-roles: + get: + operationId: assignable-roles-getassignablerolesforresource + externalDocs: + url: https://docs.databricks.com/api/account/accountaccesscontrol/getassignablerolesforresource + x-stackQL-resource: assignable_roles + x-stackQL-method: getassignablerolesforresource + x-stackQL-verb: select + x-numReqParams: 2 + parameters: + - name: account_id + required: true + description: uuid + in: path + - name: resource + required: true + description: string + in: query + responses: + '200': + description: Assignable roles were returned successfully. + content: + application/json: + schema: + type: object + properties: + roles: + type: array + items: + type: object + properties: + name: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '500': + description: Internal error. + x-stackQL-objectKey: $.roles + description: Gets all the roles that can be granted on an account level resource. + A role is grantable if the rule set on the resource can contain an access + rule of the role. + /api/2.0/accounts/{account_id}/scim/v2/Groups: + post: + operationId: groups-create + externalDocs: + url: https://docs.databricks.com/api/account/accountgroups/create + x-stackQL-resource: groups + x-stackQL-method: create + x-stackQL-verb: insert + x-numReqParams: 1 + parameters: + - name: account_id + required: true + description: uuid + in: path + responses: + '201': + description: The group creation request succeeded. + content: + application/json: + schema: + type: object + properties: + id: + type: string + displayName: + type: string + members: + type: array + items: + type: object + properties: + $ref: + type: string + value: + type: string + display: + type: string + primary: + type: boolean + type: + type: string + roles: + type: array + items: + type: object + properties: + $ref: + type: string + value: + type: string + display: + type: string + primary: + type: boolean + type: + type: string + externalId: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '409': + description: Request was rejected due a conflict with an existing resource. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + id: + type: integer + format: int64 + displayName: + type: string + externalId: + type: string + members: + type: Array of object + roles: + type: Array of object + example: + id: string + displayName: string + members: + - $ref: string + value: string + display: string + primary: true + type: string + roles: + - $ref: string + value: string + display: string + primary: true + type: string + externalId: string + description: Properties of the new group. + description: Creates a group in the Databricks account with a unique name, using + the supplied group details. + get: + operationId: groups-list + externalDocs: + url: https://docs.databricks.com/api/account/accountgroups/list + x-stackQL-resource: groups + x-stackQL-method: list + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: account_id + required: true + description: uuid + in: path + - name: filter + in: query + - name: attributes + in: query + - name: excludedAttributes + in: query + - name: startIndex + in: query + - name: count + in: query + - name: sortBy + in: query + - name: sortOrder + in: query + responses: + '200': + description: List groups operation was succesful. + content: + application/json: + schema: + type: object + properties: + totalResults: + type: integer + startIndex: + type: integer + itemsPerPage: + type: integer + Resources: + type: array + items: + type: object + properties: + id: + type: string + displayName: + type: string + members: + type: array + items: + type: object + properties: + $ref: + type: string + value: + type: string + display: + type: string + primary: + type: boolean + type: + type: string + roles: + type: array + items: + type: object + properties: + $ref: + type: string + value: + type: string + display: + type: string + primary: + type: boolean + type: + type: string + externalId: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + x-stackQL-objectKey: $.Resources + description: Gets all details of the groups associated with the Databricks account. + /api/2.0/accounts/{account_id}/scim/v2/Groups/{id}: + delete: + operationId: groups-delete + externalDocs: + url: https://docs.databricks.com/api/account/accountgroups/delete + x-stackQL-resource: groups + x-stackQL-method: delete + x-stackQL-verb: delete + x-numReqParams: 2 + parameters: + - name: account_id + required: true + description: uuid + in: path + - name: id + required: true + description: int64 + in: path + responses: + '204': + description: Group was deleted successfully. + content: + application/json: + schema: + type: object + properties: {} + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Deletes a group from the Databricks account. + get: + operationId: groups-get + externalDocs: + url: https://docs.databricks.com/api/account/accountgroups/get + x-stackQL-resource: groups + x-stackQL-method: get + x-stackQL-verb: select + x-numReqParams: 2 + parameters: + - name: account_id + required: true + description: uuid + in: path + - name: id + required: true + description: int64 + in: path + responses: + '200': + description: Group information was returned successfully. + content: + application/json: + schema: + type: object + properties: + id: + type: string + displayName: + type: string + members: + type: array + items: + type: object + properties: + $ref: + type: string + value: + type: string + display: + type: string + primary: + type: boolean + type: + type: string + roles: + type: array + items: + type: object + properties: + $ref: + type: string + value: + type: string + display: + type: string + primary: + type: boolean + type: + type: string + externalId: + type: string + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Gets the information for a specific group in the Databricks account. + patch: + operationId: groups-patch + externalDocs: + url: https://docs.databricks.com/api/account/accountgroups/patch + x-stackQL-resource: groups + x-stackQL-method: patch + x-stackQL-verb: update + x-numReqParams: 2 + parameters: + - name: account_id + required: true + description: uuid + in: path + - name: id + required: true + description: int64 + in: path + responses: + '200': + description: Group information was updated successfully. + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + schemas: + type: Array of string + Operations: + type: Array of object + example: + schemas: + - urn:ietf:params:scim:api:messages:2.0:PatchOp + Operations: + - op: add + path: string + value: null + description: Operations to be applied on group information. + description: Partially updates the details of a group. + put: + operationId: groups-update + externalDocs: + url: https://docs.databricks.com/api/account/accountgroups/update + x-stackQL-resource: groups + x-stackQL-method: update + x-stackQL-verb: replace + x-numReqParams: 2 + parameters: + - name: account_id + required: true + description: uuid + in: path + - name: id + required: true + description: int64 + in: path + responses: + '200': + description: Group information was updated successfully. + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + id: + type: integer + format: int64 + displayName: + type: string + externalId: + type: string + members: + type: Array of object + roles: + type: Array of object + example: + id: string + displayName: string + members: + - $ref: string + value: string + display: string + primary: true + type: string + roles: + - $ref: string + value: string + display: string + primary: true + type: string + externalId: string + description: Operations to be applied on group information. + description: Updates the details of a group by replacing the entire group entity. + /api/2.0/preview/accounts/{account_id}/access-control/rule-sets: + get: + operationId: rule-sets-getruleset + externalDocs: + url: https://docs.databricks.com/api/account/accountaccesscontrol/getruleset + x-stackQL-resource: rule_sets + x-stackQL-method: getruleset + x-stackQL-verb: select + x-numReqParams: 3 + parameters: + - name: account_id + required: true + description: uuid + in: path + - name: name + required: true + description: string + in: query + - name: etag + required: true + description: string + in: query + responses: + '200': + description: The rule set was returned successfully. + content: + application/json: + schema: + type: object + properties: + name: + type: string + grant_rules: + type: array + items: + type: object + properties: + principals: + type: array + items: + type: string + role: + type: string + etag: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '500': + description: Internal error. + description: Get a rule set by its name. A rule set is always attached to a + resource and contains a list of access rules on the said resource. Currently + only a default rule set for each resource is supported. + put: + operationId: rule-sets-updateruleset + externalDocs: + url: https://docs.databricks.com/api/account/accountaccesscontrol/updateruleset + x-stackQL-resource: rule_sets + x-stackQL-method: updateruleset + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: account_id + required: true + description: uuid + in: path + responses: + '200': + description: Rule sets on the resource was updated successfully. + content: + application/json: + schema: + type: object + properties: + name: + type: string + grant_rules: + type: array + items: + type: object + properties: + role: + type: string + principals: + type: array + items: + type: string + etag: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: required + rule_set: + type: object + example: + name: string + rule_set: + name: string + grant_rules: + - principals: + - string + role: string + etag: string + description: The rule set to update to. + description: Replace the rules of a rule set. First, use get to read the current + version of the rule set before modifying it. This pattern helps prevent conflicts + between concurrent updates. + /api/2.0/accounts/{account_id}/scim/v2/ServicePrincipals: + post: + operationId: service-principals-create + externalDocs: + url: https://docs.databricks.com/api/account/accountserviceprincipals/create + x-stackQL-resource: service_principals + x-stackQL-method: create + x-stackQL-verb: insert + x-numReqParams: 1 + parameters: + - name: account_id + required: true + description: uuid + in: path + responses: + '201': + description: The user creation request succeeded. + content: + application/json: + schema: + type: object + properties: + id: + type: string + applicationId: + type: string + displayName: + type: string + roles: + type: array + items: + type: object + properties: + $ref: + type: string + value: + type: string + display: + type: string + primary: + type: boolean + type: + type: string + externalId: + type: string + active: + type: boolean + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '409': + description: Request was rejected due a conflict with an existing resource. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + id: + type: integer + format: int64 + applicationId: + type: uuid + displayName: + type: string + externalId: + type: string + active: + type: boolean + roles: + type: Array of object + example: + id: string + applicationId: 97ab27fa-30e2-43e3-92a3-160e80f4c0d5 + displayName: etl-service + roles: + - $ref: string + value: string + display: string + primary: true + type: string + externalId: string + active: true + description: Properties of the new service principal. + description: Creates a new service principal in the Databricks account. + get: + operationId: service-principals-list + externalDocs: + url: https://docs.databricks.com/api/account/accountserviceprincipals/list + x-stackQL-resource: service_principals + x-stackQL-method: list + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: account_id + required: true + description: uuid + in: path + - name: filter + in: query + - name: attributes + in: query + - name: excludedAttributes + in: query + - name: startIndex + in: query + - name: count + in: query + - name: sortBy + in: query + - name: sortOrder + in: query + responses: + '200': + description: List service principals operation was succesful. + content: + application/json: + schema: + type: object + properties: + totalResults: + type: integer + startIndex: + type: integer + itemsPerPage: + type: integer + Resources: + type: array + items: + type: object + properties: + id: + type: string + applicationId: + type: string + displayName: + type: string + roles: + type: array + items: + type: object + properties: + $ref: + type: string + value: + type: string + display: + type: string + primary: + type: boolean + type: + type: string + externalId: + type: string + active: + type: boolean + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + x-stackQL-objectKey: $.Resources + description: Gets the set of service principals associated with a Databricks + account. + /api/2.0/accounts/{account_id}/scim/v2/ServicePrincipals/{id}: + delete: + operationId: service-principals-delete + externalDocs: + url: https://docs.databricks.com/api/account/accountserviceprincipals/delete + x-stackQL-resource: service_principals + x-stackQL-method: delete + x-stackQL-verb: delete + x-numReqParams: 2 + parameters: + - name: account_id + required: true + description: uuid + in: path + - name: id + required: true + description: int64 + in: path + responses: + '204': + description: Service principal was deleted successfully. + content: + application/json: + schema: + type: object + properties: {} + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Delete a single service principal in the Databricks account. + get: + operationId: service-principals-get + externalDocs: + url: https://docs.databricks.com/api/account/accountserviceprincipals/get + x-stackQL-resource: service_principals + x-stackQL-method: get + x-stackQL-verb: select + x-numReqParams: 2 + parameters: + - name: account_id + required: true + description: uuid + in: path + - name: id + required: true + description: int64 + in: path + responses: + '200': + description: Service principal information was returned successfully. + content: + application/json: + schema: + type: object + properties: + id: + type: string + applicationId: + type: string + displayName: + type: string + roles: + type: array + items: + type: object + properties: + $ref: + type: string + value: + type: string + display: + type: string + primary: + type: boolean + type: + type: string + externalId: + type: string + active: + type: boolean + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Gets the details for a single service principal define in the Databricks + account. + patch: + operationId: service-principals-patch + externalDocs: + url: https://docs.databricks.com/api/account/accountserviceprincipals/patch + x-stackQL-resource: service_principals + x-stackQL-method: patch + x-stackQL-verb: update + x-numReqParams: 2 + parameters: + - name: account_id + required: true + description: uuid + in: path + - name: id + required: true + description: int64 + in: path + responses: + '200': + description: Service principal information was updated successfully. + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + schemas: + type: Array of string + Operations: + type: Array of object + example: + schemas: + - urn:ietf:params:scim:api:messages:2.0:PatchOp + Operations: + - op: add + path: string + value: null + description: Operations to be applied on service principal information. + description: Partially updates the details of a single service principal in + the Databricks account. + put: + operationId: service-principals-update + externalDocs: + url: https://docs.databricks.com/api/account/accountserviceprincipals/update + x-stackQL-resource: service_principals + x-stackQL-method: update + x-stackQL-verb: replace + x-numReqParams: 2 + parameters: + - name: account_id + required: true + description: uuid + in: path + - name: id + required: true + description: int64 + in: path + responses: + '200': + description: Service principal information was updated successfully. + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + id: + type: integer + format: int64 + applicationId: + type: uuid + displayName: + type: string + externalId: + type: string + active: + type: boolean + roles: + type: Array of object + example: + id: string + applicationId: 97ab27fa-30e2-43e3-92a3-160e80f4c0d5 + displayName: etl-service + roles: + - $ref: string + value: string + display: string + primary: true + type: string + externalId: string + active: true + description: Updates the details of a single service principal. + /api/2.0/accounts/{account_id}/scim/v2/Users: + post: + operationId: users-create + externalDocs: + url: https://docs.databricks.com/api/account/accountusers/create + x-stackQL-resource: users + x-stackQL-method: create + x-stackQL-verb: insert + x-numReqParams: 1 + parameters: + - name: account_id + required: true + description: uuid + in: path + responses: + '201': + description: The user creation request succeeded. + content: + application/json: + schema: + type: object + properties: + id: + type: string + userName: + type: string + emails: + type: array + items: + type: object + properties: + $ref: + type: string + value: + type: string + display: + type: string + primary: + type: boolean + type: + type: string + name: + type: object + properties: + givenName: + type: string + familyName: + type: string + displayName: + type: string + roles: + type: array + items: + type: object + properties: + $ref: + type: string + value: + type: string + display: + type: string + primary: + type: boolean + type: + type: string + externalId: + type: string + active: + type: boolean + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '409': + description: Request was rejected due a conflict with an existing resource. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + id: + type: integer + format: int64 + userName: + type: email + displayName: + type: string + externalId: + type: string + active: + type: boolean + emails: + type: Array of object + name: + type: object + roles: + type: Array of object + example: + id: string + userName: user@example.com + emails: + - $ref: string + value: string + display: string + primary: true + type: string + name: + givenName: string + familyName: string + displayName: string + roles: + - $ref: string + value: string + display: string + primary: true + type: string + externalId: string + active: true + description: Properties of the new user. + description: Creates a new user in the Databricks account. This new user will + also be added to the Databricks account. + get: + operationId: users-list + externalDocs: + url: https://docs.databricks.com/api/account/accountusers/list + x-stackQL-resource: users + x-stackQL-method: list + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: account_id + required: true + description: uuid + in: path + - name: filter + in: query + - name: attributes + in: query + - name: excludedAttributes + in: query + - name: startIndex + in: query + - name: count + in: query + - name: sortBy + in: query + - name: sortOrder + in: query + responses: + '200': + description: List users operation was succesful. + content: + application/json: + schema: + type: object + properties: + totalResults: + type: integer + startIndex: + type: integer + itemsPerPage: + type: integer + Resources: + type: array + items: + type: object + properties: + id: + type: string + userName: + type: string + emails: + type: array + items: + type: object + properties: + $ref: + type: string + value: + type: string + display: + type: string + primary: + type: boolean + type: + type: string + name: + type: object + properties: + givenName: + type: string + familyName: + type: string + displayName: + type: string + roles: + type: array + items: + type: object + properties: + $ref: + type: string + value: + type: string + display: + type: string + primary: + type: boolean + type: + type: string + externalId: + type: string + active: + type: boolean + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + x-stackQL-objectKey: $.Resources + description: Gets details for all the users associated with a Databricks account. + /api/2.0/accounts/{account_id}/scim/v2/Users/{id}: + delete: + operationId: users-delete + externalDocs: + url: https://docs.databricks.com/api/account/accountusers/delete + x-stackQL-resource: users + x-stackQL-method: delete + x-stackQL-verb: delete + x-numReqParams: 2 + parameters: + - name: account_id + required: true + description: uuid + in: path + - name: id + required: true + description: int64 + in: path + responses: + '204': + description: User was deleted successfully. + content: + application/json: + schema: + type: object + properties: {} + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Deletes a user. Deleting a user from a Databricks account also + removes objects associated with the user. + get: + operationId: users-get + externalDocs: + url: https://docs.databricks.com/api/account/accountusers/get + x-stackQL-resource: users + x-stackQL-method: get + x-stackQL-verb: select + x-numReqParams: 2 + parameters: + - name: account_id + required: true + description: uuid + in: path + - name: id + required: true + description: int64 + in: path + - name: filter + in: query + - name: attributes + in: query + - name: excludedAttributes + in: query + - name: startIndex + in: query + - name: count + in: query + - name: sortBy + in: query + - name: sortOrder + in: query + responses: + '200': + description: User information was returned successfully. + content: + application/json: + schema: + type: object + properties: + id: + type: string + userName: + type: string + emails: + type: array + items: + type: object + properties: + $ref: + type: string + value: + type: string + display: + type: string + primary: + type: boolean + type: + type: string + name: + type: object + properties: + givenName: + type: string + familyName: + type: string + displayName: + type: string + roles: + type: array + items: + type: object + properties: + $ref: + type: string + value: + type: string + display: + type: string + primary: + type: boolean + type: + type: string + externalId: + type: string + active: + type: boolean + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Gets information for a specific user in Databricks account. + patch: + operationId: users-patch + externalDocs: + url: https://docs.databricks.com/api/account/accountusers/patch + x-stackQL-resource: users + x-stackQL-method: patch + x-stackQL-verb: update + x-numReqParams: 2 + parameters: + - name: account_id + required: true + description: uuid + in: path + - name: id + required: true + description: int64 + in: path + responses: + '200': + description: User information was updated successfully. + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + schemas: + type: Array of string + Operations: + type: Array of object + example: + schemas: + - urn:ietf:params:scim:api:messages:2.0:PatchOp + Operations: + - op: add + path: string + value: null + description: Operations to be applied on user information. + description: Partially updates a user resource by applying the supplied operations + on specific user attributes. + put: + operationId: users-update + externalDocs: + url: https://docs.databricks.com/api/account/accountusers/update + x-stackQL-resource: users + x-stackQL-method: update + x-stackQL-verb: replace + x-numReqParams: 2 + parameters: + - name: account_id + required: true + description: uuid + in: path + - name: id + required: true + description: int64 + in: path + responses: + '200': + description: User information was updated successfully. + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + id: + type: integer + format: int64 + userName: + type: email + displayName: + type: string + externalId: + type: string + active: + type: boolean + emails: + type: Array of object + name: + type: object + roles: + type: Array of object + example: + id: string + userName: user@example.com + emails: + - $ref: string + value: string + display: string + primary: true + type: string + name: + givenName: string + familyName: string + displayName: string + roles: + - $ref: string + value: string + display: string + primary: true + type: string + externalId: string + active: true + description: Replaces a user's information with the data supplied in request. + /api/2.0/accounts/{account_id}/workspaces/{workspace_id}/permissionassignments/permissions: + get: + operationId: workspace-permissions-get + externalDocs: + url: https://docs.databricks.com/api/account/workspaceassignment/get + x-stackQL-resource: workspace_permissions + x-stackQL-method: get + x-stackQL-verb: select + x-numReqParams: 2 + parameters: + - name: account_id + required: true + description: string + in: path + - name: workspace_id + required: true + description: int64 + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + permissions: + type: array + items: + type: object + properties: + permission_level: + type: string + description: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + x-stackQL-objectKey: $.permissions + description: Get an array of workspace permissions for the specified account + and workspace. + /api/2.0/accounts/{account_id}/workspaces/{workspace_id}/permissionassignments/principals/{principal_id}: + put: + operationId: workspace-permission-assignments-createorupdate + externalDocs: + url: https://docs.databricks.com/api/account/workspaceassignment/update + x-stackQL-resource: workspace_permission_assignments + x-stackQL-method: createorupdate + x-stackQL-verb: insert + x-numReqParams: 3 + parameters: + - name: account_id + required: true + description: string + in: path + - name: workspace_id + required: true + description: int64 + in: path + - name: principal_id + required: true + description: int64 + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + principal: + type: object + properties: + user_name: + type: string + group_name: + type: string + service_principal_name: + type: string + principal_id: + type: integer + display_name: + type: string + permissions: + type: array + items: + type: string + error: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + permissions: + type: Array of string + example: + permissions: + - UNKNOWN + description: Creates or updates the workspace permissions assignment in a given + account and workspace for the specified principal. + delete: + operationId: workspace-permission-assignments-delete + externalDocs: + url: https://docs.databricks.com/api/account/workspaceassignment/delete + x-stackQL-resource: workspace_permission_assignments + x-stackQL-method: delete + x-stackQL-verb: delete + x-numReqParams: 3 + parameters: + - name: account_id + required: true + description: string + in: path + - name: workspace_id + required: true + description: int64 + in: path + - name: principal_id + required: true + description: int64 + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '500': + description: Internal error. + description: Deletes the workspace permissions assignment in a given account + and workspace for the specified principal. + /api/2.0/accounts/{account_id}/workspaces/{workspace_id}/permissionassignments: + get: + operationId: workspace-permission-assignments-list + externalDocs: + url: https://docs.databricks.com/api/account/workspaceassignment/list + x-stackQL-resource: workspace_permission_assignments + x-stackQL-method: list + x-stackQL-verb: select + x-numReqParams: 2 + parameters: + - name: account_id + required: true + description: string + in: path + - name: workspace_id + required: true + description: int64 + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + permission_assignments: + type: array + items: + type: object + properties: + principal: + type: object + properties: + user_name: + type: string + group_name: + type: string + service_principal_name: + type: string + principal_id: + type: integer + display_name: + type: string + permissions: + type: array + items: + type: string + error: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + x-stackQL-objectKey: $.permission_assignments + description: Get the permission assignments for the specified Databricks account + and Databricks workspace. +components: + x-stackQL-resources: + assignable_roles: + id: databricks_account.iam.assignable_roles + name: assignable_roles + title: Assignable_roles + methods: + getassignablerolesforresource: + operation: + $ref: '#/paths/~1api~12.0~1preview~1accounts~1{account_id}~1access-control~1assignable-roles/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.roles + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/assignable_roles/methods/getassignablerolesforresource' + insert: [] + update: [] + replace: [] + delete: [] + exec: [] + groups: + id: databricks_account.iam.groups + name: groups + title: Groups + methods: + create: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1scim~1v2~1Groups/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1scim~1v2~1Groups/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.Resources + delete: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1scim~1v2~1Groups~1{id}/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1scim~1v2~1Groups~1{id}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1scim~1v2~1Groups~1{id}/patch' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1scim~1v2~1Groups~1{id}/put' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/groups/methods/get' + - $ref: '#/components/x-stackQL-resources/groups/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/groups/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/groups/methods/patch' + replace: + - $ref: '#/components/x-stackQL-resources/groups/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/groups/methods/delete' + exec: [] + rule_sets: + id: databricks_account.iam.rule_sets + name: rule_sets + title: Rule_sets + methods: + getruleset: + operation: + $ref: '#/paths/~1api~12.0~1preview~1accounts~1{account_id}~1access-control~1rule-sets/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + updateruleset: + operation: + $ref: '#/paths/~1api~12.0~1preview~1accounts~1{account_id}~1access-control~1rule-sets/put' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/rule_sets/methods/updateruleset' + - $ref: '#/components/x-stackQL-resources/rule_sets/methods/getruleset' + insert: [] + update: [] + replace: [] + delete: [] + exec: [] + service_principals: + id: databricks_account.iam.service_principals + name: service_principals + title: Service_principals + methods: + create: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1scim~1v2~1ServicePrincipals/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1scim~1v2~1ServicePrincipals/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.Resources + delete: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1scim~1v2~1ServicePrincipals~1{id}/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1scim~1v2~1ServicePrincipals~1{id}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1scim~1v2~1ServicePrincipals~1{id}/patch' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1scim~1v2~1ServicePrincipals~1{id}/put' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/service_principals/methods/get' + - $ref: '#/components/x-stackQL-resources/service_principals/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/service_principals/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/service_principals/methods/patch' + replace: + - $ref: '#/components/x-stackQL-resources/service_principals/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/service_principals/methods/delete' + exec: [] + users: + id: databricks_account.iam.users + name: users + title: Users + methods: + create: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1scim~1v2~1Users/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1scim~1v2~1Users/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.Resources + delete: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1scim~1v2~1Users~1{id}/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1scim~1v2~1Users~1{id}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1scim~1v2~1Users~1{id}/patch' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1scim~1v2~1Users~1{id}/put' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/users/methods/get' + - $ref: '#/components/x-stackQL-resources/users/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/users/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/users/methods/patch' + replace: + - $ref: '#/components/x-stackQL-resources/users/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/users/methods/delete' + exec: [] + workspace_permissions: + id: databricks_account.iam.workspace_permissions + name: workspace_permissions + title: Workspace_permissions + methods: + get: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1workspaces~1{workspace_id}~1permissionassignments~1permissions/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.permissions + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/workspace_permissions/methods/get' + insert: [] + update: [] + replace: [] + delete: [] + exec: [] + workspace_permission_assignments: + id: databricks_account.iam.workspace_permission_assignments + name: workspace_permission_assignments + title: Workspace_permission_assignments + methods: + createorupdate: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1workspaces~1{workspace_id}~1permissionassignments~1principals~1{principal_id}/put' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1workspaces~1{workspace_id}~1permissionassignments~1principals~1{principal_id}/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1workspaces~1{workspace_id}~1permissionassignments/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.permission_assignments + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/workspace_permission_assignments/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/workspace_permission_assignments/methods/createorupdate' + update: [] + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/workspace_permission_assignments/methods/delete' + exec: [] diff --git a/providers/src/databricks_account/v00.00.00000/services/logging.yaml b/providers/src/databricks_account/v00.00.00000/services/logging.yaml new file mode 100644 index 00000000..e7338fa4 --- /dev/null +++ b/providers/src/databricks_account/v00.00.00000/services/logging.yaml @@ -0,0 +1,371 @@ +openapi: 3.0.0 +info: + version: 2024-12-19-stackql-generated + contact: + name: StackQL Studios + url: https://stackql.io/ + email: info@stackql.io + title: Databricks Logging API + description: Log Delivery +servers: +- url: https://accounts.cloud.databricks.com +paths: + /api/2.0/accounts/{account_id}/log-delivery: + post: + operationId: log-delivery-create + externalDocs: + url: https://docs.databricks.com/api/account/logdelivery/create + x-stackQL-resource: log_delivery + x-stackQL-method: create + x-stackQL-verb: insert + x-numReqParams: 1 + parameters: + - name: account_id + required: true + description: uuid + in: path + responses: + '200': + description: The log delivery configuration creation request succeeded. + content: + application/json: + schema: + type: object + properties: + log_delivery_configuration: + type: object + properties: + account_id: + type: string + config_id: + type: string + creation_time: + type: integer + update_time: + type: integer + log_delivery_status: + type: object + properties: + status: + type: string + message: + type: string + last_attempt_time: + type: string + last_successful_attempt_time: + type: string + config_name: + type: string + status: + type: string + log_type: + type: string + output_format: + type: string + credentials_id: + type: string + storage_configuration_id: + type: string + workspace_ids_filter: + type: array + items: + type: integer + delivery_path_prefix: + type: string + delivery_start_time: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + log_delivery_configuration: + type: object + example: + log_delivery_configuration: + config_name: string + status: ENABLED + log_type: BILLABLE_USAGE + output_format: CSV + credentials_id: c7814269-df58-4ca3-85e9-f6672ef43d77 + storage_configuration_id: 04aae505-1b1e-4cb9-997d-e1c49282675d + workspace_ids_filter: + - 0 + delivery_path_prefix: string + delivery_start_time: string + description: Properties of the new log delivery configuration. + description: Creates a new Databricks log delivery configuration to enable delivery + of the specified type of logs to your storage location. This requires that + you already created a + get: + operationId: log-delivery-list + externalDocs: + url: https://docs.databricks.com/api/account/logdelivery/list + x-stackQL-resource: log_delivery + x-stackQL-method: list + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: account_id + required: true + description: uuid + in: path + - name: status + in: query + - name: credentials_id + in: query + - name: storage_configuration_id + in: query + responses: + '200': + description: Log delivery configurations were returned successfully. + content: + application/json: + schema: + type: object + properties: + log_delivery_configurations: + type: array + items: + type: object + properties: + account_id: + type: string + config_id: + type: string + creation_time: + type: integer + update_time: + type: integer + log_delivery_status: + type: object + properties: + status: + type: string + message: + type: string + last_attempt_time: + type: string + last_successful_attempt_time: + type: string + config_name: + type: string + status: + type: string + log_type: + type: string + output_format: + type: string + credentials_id: + type: string + storage_configuration_id: + type: string + workspace_ids_filter: + type: array + items: + type: integer + delivery_path_prefix: + type: string + delivery_start_time: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + x-stackQL-objectKey: $.log_delivery_configurations + description: Gets all Databricks log delivery configurations associated with + an account specified by ID. + /api/2.0/accounts/{account_id}/log-delivery/{log_delivery_configuration_id}: + get: + operationId: log-delivery-get + externalDocs: + url: https://docs.databricks.com/api/account/logdelivery/get + x-stackQL-resource: log_delivery + x-stackQL-method: get + x-stackQL-verb: select + x-numReqParams: 2 + parameters: + - name: account_id + required: true + description: uuid + in: path + - name: log_delivery_configuration_id + required: true + description: uuid + in: path + responses: + '200': + description: The log delivery configuration was successfully returned. + content: + application/json: + schema: + type: object + properties: + log_delivery_configuration: + type: object + properties: + account_id: + type: string + config_id: + type: string + creation_time: + type: integer + update_time: + type: integer + log_delivery_status: + type: object + properties: + status: + type: string + message: + type: string + last_attempt_time: + type: string + last_successful_attempt_time: + type: string + config_name: + type: string + status: + type: string + log_type: + type: string + output_format: + type: string + credentials_id: + type: string + storage_configuration_id: + type: string + workspace_ids_filter: + type: array + items: + type: integer + delivery_path_prefix: + type: string + delivery_start_time: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + x-stackQL-objectKey: $.log_delivery_configuration + description: Gets a Databricks log delivery configuration object for an account, + both specified by ID. + patch: + operationId: log-delivery-patchstatus + externalDocs: + url: https://docs.databricks.com/api/account/logdelivery/patchstatus + x-stackQL-resource: log_delivery + x-stackQL-method: patchstatus + x-stackQL-verb: exec + x-numReqParams: 2 + parameters: + - name: account_id + required: true + description: uuid + in: path + - name: log_delivery_configuration_id + required: true + description: uuid + in: path + responses: + '200': + description: The log delivery configuration was successfully updated. + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + status: + type: required + example: + status: ENABLED + description: The new status for this log delivery configuration object. + description: Enables or disables a log delivery configuration. Deletion of delivery + configurations is not supported, so disable log delivery configurations that + are no longer needed. Note that you can't re-enable a delivery configuration + if this would violate the delivery configuration limits described under +components: + x-stackQL-resources: + log_delivery: + id: databricks_account.logging.log_delivery + name: log_delivery + title: Log_delivery + methods: + create: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1log-delivery/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1log-delivery/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.log_delivery_configurations + get: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1log-delivery~1{log_delivery_configuration_id}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.log_delivery_configuration + patchstatus: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1log-delivery~1{log_delivery_configuration_id}/patch' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/log_delivery/methods/get' + - $ref: '#/components/x-stackQL-resources/log_delivery/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/log_delivery/methods/create' + update: [] + replace: [] + delete: [] + exec: + - $ref: '#/components/x-stackQL-resources/log_delivery/methods/patchstatus' diff --git a/providers/src/databricks_account/v00.00.00000/services/oauth.yaml b/providers/src/databricks_account/v00.00.00000/services/oauth.yaml new file mode 100644 index 00000000..e8457f4d --- /dev/null +++ b/providers/src/databricks_account/v00.00.00000/services/oauth.yaml @@ -0,0 +1,935 @@ +openapi: 3.0.0 +info: + version: 2024-12-19-stackql-generated + contact: + name: StackQL Studios + url: https://stackql.io/ + email: info@stackql.io + title: Databricks Oauth API + description: OAuth Integrations +servers: +- url: https://accounts.cloud.databricks.com +paths: + /api/2.0/accounts/{account_id}/oauth2/custom-app-integrations: + post: + operationId: custom-app-integrations-create + externalDocs: + url: https://docs.databricks.com/api/account/customappintegration/create + x-stackQL-resource: custom_app_integrations + x-stackQL-method: create + x-stackQL-verb: insert + x-numReqParams: 1 + parameters: + - name: account_id + required: true + description: string + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + client_id: + type: string + client_secret: + type: string + integration_id: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '500': + description: Internal error. + '501': + description: Operation is not implemented or is not supported/enabled in + this service. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + redirect_urls: + type: Array of string + name: + type: string + confidential: + type: boolean + scopes: + type: Array of string + token_access_policy: + type: object + example: + summary: Create Tableau Cloud OAuth App Integration + value: + name: Example Tableau Server + scopes: + - all-apis + - offline_access + token_access_policy: + access_token_ttl_in_minutes: 120 + refresh_token_ttl_in_minutes: 200 + redirect_urls: + - https://example.online.tableau.com/auth/add_oauth_token + confidential: true + description: Create Custom OAuth App Integration. + get: + operationId: custom-app-integrations-list + externalDocs: + url: https://docs.databricks.com/api/account/customappintegration/list + x-stackQL-resource: custom_app_integrations + x-stackQL-method: list + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: account_id + required: true + description: string + in: path + - name: page_token + in: query + - name: page_size + in: query + - name: include_creator_username + in: query + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + apps: + type: array + items: + type: object + properties: + integration_id: + type: string + client_id: + type: string + redirect_urls: + type: array + items: + type: string + name: + type: string + confidential: + type: boolean + token_access_policy: + type: object + properties: + access_token_ttl_in_minutes: + type: integer + refresh_token_ttl_in_minutes: + type: integer + scopes: + type: array + items: + type: string + created_by: + type: integer + create_time: + type: string + creator_username: + type: string + next_page_token: + type: string + '401': + description: The request does not have valid authentication credentials + for the operation. + '500': + description: Internal error. + '501': + description: Operation is not implemented or is not supported/enabled in + this service. + x-stackQL-objectKey: $.apps + description: Get the list of custom OAuth app integrations for the specified + Databricks account + /api/2.0/accounts/{account_id}/oauth2/custom-app-integrations/{integration_id}: + delete: + operationId: custom-app-integrations-delete + externalDocs: + url: https://docs.databricks.com/api/account/customappintegration/delete + x-stackQL-resource: custom_app_integrations + x-stackQL-method: delete + x-stackQL-verb: delete + x-numReqParams: 2 + parameters: + - name: account_id + required: true + description: string + in: path + - name: integration_id + required: true + description: string + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: {} + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + '501': + description: Operation is not implemented or is not supported/enabled in + this service. + description: Delete an existing Custom OAuth App Integration. You can retrieve + the custom OAuth app integration via + get: + operationId: custom-app-integrations-get + externalDocs: + url: https://docs.databricks.com/api/account/customappintegration/get + x-stackQL-resource: custom_app_integrations + x-stackQL-method: get + x-stackQL-verb: select + x-numReqParams: 2 + parameters: + - name: account_id + required: true + description: string + in: path + - name: integration_id + required: true + description: string + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + integration_id: + type: string + client_id: + type: string + redirect_urls: + type: array + items: + type: string + name: + type: string + confidential: + type: boolean + token_access_policy: + type: object + properties: + access_token_ttl_in_minutes: + type: integer + refresh_token_ttl_in_minutes: + type: integer + scopes: + type: array + items: + type: string + created_by: + type: integer + create_time: + type: string + creator_username: + type: string + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + '501': + description: Operation is not implemented or is not supported/enabled in + this service. + description: Gets the Custom OAuth App Integration for the given integration + id. + patch: + operationId: custom-app-integrations-update + externalDocs: + url: https://docs.databricks.com/api/account/customappintegration/update + x-stackQL-resource: custom_app_integrations + x-stackQL-method: update + x-stackQL-verb: update + x-numReqParams: 2 + parameters: + - name: account_id + required: true + description: string + in: path + - name: integration_id + required: true + description: string + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + '501': + description: Operation is not implemented or is not supported/enabled in + this service. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + redirect_urls: + type: Array of string + token_access_policy: + type: object + example: + value: + token_access_policy: + access_token_ttl_in_minutes: 120 + refresh_token_ttl_in_minutes: 200 + description: Updates an existing custom OAuth App Integration. You can retrieve + the custom OAuth app integration via + /api/2.0/accounts/{account_id}/oauth2/published-apps: + get: + operationId: published-apps-list + externalDocs: + url: https://docs.databricks.com/api/account/oauthpublishedapps/list + x-stackQL-resource: published_apps + x-stackQL-method: list + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: account_id + required: true + description: string + in: path + - name: page_token + in: query + - name: page_size + in: query + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + apps: + type: array + items: + type: object + properties: + app_id: + type: string + client_id: + type: string + name: + type: string + description: + type: string + is_confidential_client: + type: boolean + redirect_urls: + type: array + items: + type: string + scopes: + type: array + items: + type: string + next_page_token: + type: string + '401': + description: The request does not have valid authentication credentials + for the operation. + '500': + description: Internal error. + '501': + description: Operation is not implemented or is not supported/enabled in + this service. + x-stackQL-objectKey: $.apps + description: Get all the available published OAuth apps in Databricks. + /api/2.0/accounts/{account_id}/oauth2/published-app-integrations: + post: + operationId: published-app-integrations-create + externalDocs: + url: https://docs.databricks.com/api/account/publishedappintegration/create + x-stackQL-resource: published_app_integrations + x-stackQL-method: create + x-stackQL-verb: insert + x-numReqParams: 1 + parameters: + - name: account_id + required: true + description: string + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + integration_id: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '500': + description: Internal error. + '501': + description: Operation is not implemented or is not supported/enabled in + this service. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + app_id: + type: string + token_access_policy: + type: object + example: + PowerBI: + summary: Enable PowerBI OAuth Login + value: + app_id: power-bi + TableauDesktop: + summary: Enable Tableau Desktop OAuth Login + value: + app_id: tableau-desktop + description: Create Published OAuth App Integration. + get: + operationId: published-app-integrations-list + externalDocs: + url: https://docs.databricks.com/api/account/publishedappintegration/list + x-stackQL-resource: published_app_integrations + x-stackQL-method: list + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: account_id + required: true + description: string + in: path + - name: page_token + in: query + - name: page_size + in: query + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + apps: + type: array + items: + type: object + properties: + app_id: + type: string + integration_id: + type: string + name: + type: string + token_access_policy: + type: object + properties: + access_token_ttl_in_minutes: + type: integer + refresh_token_ttl_in_minutes: + type: integer + created_by: + type: integer + create_time: + type: string + next_page_token: + type: string + '401': + description: The request does not have valid authentication credentials + for the operation. + '500': + description: Internal error. + '501': + description: Operation is not implemented or is not supported/enabled in + this service. + x-stackQL-objectKey: $.apps + description: Get the list of published OAuth app integrations for the specified + Databricks account + /api/2.0/accounts/{account_id}/oauth2/published-app-integrations/{integration_id}: + delete: + operationId: published-app-integrations-delete + externalDocs: + url: https://docs.databricks.com/api/account/publishedappintegration/delete + x-stackQL-resource: published_app_integrations + x-stackQL-method: delete + x-stackQL-verb: delete + x-numReqParams: 2 + parameters: + - name: account_id + required: true + description: string + in: path + - name: integration_id + required: true + description: string + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: {} + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + '501': + description: Operation is not implemented or is not supported/enabled in + this service. + description: Delete an existing Published OAuth App Integration. You can retrieve + the published OAuth app integration via + get: + operationId: published-app-integrations-get + externalDocs: + url: https://docs.databricks.com/api/account/publishedappintegration/get + x-stackQL-resource: published_app_integrations + x-stackQL-method: get + x-stackQL-verb: select + x-numReqParams: 2 + parameters: + - name: account_id + required: true + description: string + in: path + - name: integration_id + required: true + description: string + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + app_id: + type: string + integration_id: + type: string + name: + type: string + token_access_policy: + type: object + properties: + access_token_ttl_in_minutes: + type: integer + refresh_token_ttl_in_minutes: + type: integer + created_by: + type: integer + create_time: + type: string + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + '501': + description: Operation is not implemented or is not supported/enabled in + this service. + description: Gets the Published OAuth App Integration for the given integration + id. + patch: + operationId: published-app-integrations-update + externalDocs: + url: https://docs.databricks.com/api/account/publishedappintegration/update + x-stackQL-resource: published_app_integrations + x-stackQL-method: update + x-stackQL-verb: update + x-numReqParams: 2 + parameters: + - name: account_id + required: true + description: string + in: path + - name: integration_id + required: true + description: string + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + '501': + description: Operation is not implemented or is not supported/enabled in + this service. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + token_access_policy: + type: object + example: + value: + token_access_policy: + access_token_ttl_in_minutes: 120 + refresh_token_ttl_in_minutes: 200 + description: Updates an existing published OAuth App Integration. You can retrieve + the published OAuth app integration via + /api/2.0/accounts/{account_id}/servicePrincipals/{service_principal_id}/credentials/secrets: + post: + operationId: service-principal-secrets-create + externalDocs: + url: https://docs.databricks.com/api/account/serviceprincipalsecrets/create + x-stackQL-resource: service_principal_secrets + x-stackQL-method: create + x-stackQL-verb: insert + x-numReqParams: 2 + parameters: + - name: account_id + required: true + description: string + in: path + - name: service_principal_id + required: true + description: int64 + in: path + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + id: + type: string + secret: + type: string + secret_hash: + type: string + create_time: + type: string + update_time: + type: string + status: + type: string + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Create a secret for the given service principal. + get: + operationId: service-principal-secrets-list + externalDocs: + url: https://docs.databricks.com/api/account/serviceprincipalsecrets/list + x-stackQL-resource: service_principal_secrets + x-stackQL-method: list + x-stackQL-verb: select + x-numReqParams: 2 + parameters: + - name: account_id + required: true + description: string + in: path + - name: service_principal_id + required: true + description: int64 + in: path + - name: page_token + in: query + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + secrets: + type: array + items: + type: object + properties: + id: + type: string + secret_hash: + type: string + create_time: + type: string + update_time: + type: string + status: + type: string + next_page_token: + type: string + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + x-stackQL-objectKey: $.secrets + description: List all secrets associated with the given service principal. This + operation only returns information about the secrets themselves and does not + include the secret values. + /api/2.0/accounts/{account_id}/servicePrincipals/{service_principal_id}/credentials/secrets/{secret_id}: + delete: + operationId: service-principal-secrets-delete + externalDocs: + url: https://docs.databricks.com/api/account/serviceprincipalsecrets/delete + x-stackQL-resource: service_principal_secrets + x-stackQL-method: delete + x-stackQL-verb: delete + x-numReqParams: 3 + parameters: + - name: account_id + required: true + description: string + in: path + - name: service_principal_id + required: true + description: int64 + in: path + - name: secret_id + required: true + description: string + in: path + responses: + '200': + description: The secret was successfully deleted. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Delete a secret from the given service principal. +components: + x-stackQL-resources: + custom_app_integrations: + id: databricks_account.oauth.custom_app_integrations + name: custom_app_integrations + title: Custom_app_integrations + methods: + create: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1oauth2~1custom-app-integrations/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1oauth2~1custom-app-integrations/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.apps + delete: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1oauth2~1custom-app-integrations~1{integration_id}/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1oauth2~1custom-app-integrations~1{integration_id}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1oauth2~1custom-app-integrations~1{integration_id}/patch' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/custom_app_integrations/methods/get' + - $ref: '#/components/x-stackQL-resources/custom_app_integrations/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/custom_app_integrations/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/custom_app_integrations/methods/update' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/custom_app_integrations/methods/delete' + exec: [] + published_apps: + id: databricks_account.oauth.published_apps + name: published_apps + title: Published_apps + methods: + list: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1oauth2~1published-apps/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.apps + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/published_apps/methods/list' + insert: [] + update: [] + replace: [] + delete: [] + exec: [] + published_app_integrations: + id: databricks_account.oauth.published_app_integrations + name: published_app_integrations + title: Published_app_integrations + methods: + create: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1oauth2~1published-app-integrations/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1oauth2~1published-app-integrations/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.apps + delete: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1oauth2~1published-app-integrations~1{integration_id}/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1oauth2~1published-app-integrations~1{integration_id}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1oauth2~1published-app-integrations~1{integration_id}/patch' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/published_app_integrations/methods/get' + - $ref: '#/components/x-stackQL-resources/published_app_integrations/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/published_app_integrations/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/published_app_integrations/methods/update' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/published_app_integrations/methods/delete' + exec: [] + service_principal_secrets: + id: databricks_account.oauth.service_principal_secrets + name: service_principal_secrets + title: Service_principal_secrets + methods: + create: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1servicePrincipals~1{service_principal_id}~1credentials~1secrets/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1servicePrincipals~1{service_principal_id}~1credentials~1secrets/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.secrets + delete: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1servicePrincipals~1{service_principal_id}~1credentials~1secrets~1{secret_id}/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/service_principal_secrets/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/service_principal_secrets/methods/create' + update: [] + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/service_principal_secrets/methods/delete' + exec: [] diff --git a/providers/src/databricks_account/v00.00.00000/services/provisioning.yaml b/providers/src/databricks_account/v00.00.00000/services/provisioning.yaml new file mode 100644 index 00000000..ab254281 --- /dev/null +++ b/providers/src/databricks_account/v00.00.00000/services/provisioning.yaml @@ -0,0 +1,2158 @@ +openapi: 3.0.0 +info: + version: 2024-12-19-stackql-generated + contact: + name: StackQL Studios + url: https://stackql.io/ + email: info@stackql.io + title: Databricks Provisioning API + description: Account Provisioning +servers: +- url: https://accounts.cloud.databricks.com +paths: + /api/2.0/accounts/{account_id}/credentials: + post: + operationId: credentials-create + externalDocs: + url: https://docs.databricks.com/api/account/credentials/create + x-stackQL-resource: credentials + x-stackQL-method: create + x-stackQL-verb: insert + x-numReqParams: 1 + parameters: + - name: account_id + required: true + description: uuid + in: path + responses: + '201': + description: The credential configuration creation request succeeded. + content: + application/json: + schema: + type: object + properties: + credentials_id: + type: string + credentials_name: + type: string + aws_credentials: + type: object + properties: + sts_role: + type: object + properties: + role_arn: + type: string + external_id: + type: string + account_id: + type: string + creation_time: + type: integer + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + credentials_name: + type: required + aws_credentials: + type: required + example: + credentials_name: credential_1 + aws_credentials: + sts_role: + role_arn: arn-aws-iam::111110000000:role/test_role + description: Properties of the new credential configuration. + description: Creates a Databricks credential configuration that represents cloud + cross-account credentials for a specified account. Databricks uses this to + set up network infrastructure properly to host Databricks clusters. For your + AWS IAM role, you need to trust the External ID (the Databricks Account API + account ID) in the returned credential object, and configure the required + access policy. + get: + operationId: credentials-list + externalDocs: + url: https://docs.databricks.com/api/account/credentials/list + x-stackQL-resource: credentials + x-stackQL-method: list + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: account_id + required: true + description: uuid + in: path + responses: + '200': + description: Credential configurations were returned successfully. + content: + application/json: + schema: + type: array + items: + type: object + properties: + credentials_id: + type: string + credentials_name: + type: string + aws_credentials: + type: object + properties: + sts_role: + type: object + properties: + role_arn: + type: string + external_id: + type: string + account_id: + type: string + creation_time: + type: integer + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Gets all Databricks credential configurations associated with an + account specified by ID. + /api/2.0/accounts/{account_id}/credentials/{credentials_id}: + delete: + operationId: credentials-delete + externalDocs: + url: https://docs.databricks.com/api/account/credentials/delete + x-stackQL-resource: credentials + x-stackQL-method: delete + x-stackQL-verb: delete + x-numReqParams: 2 + parameters: + - name: account_id + required: true + description: uuid + in: path + - name: credentials_id + required: true + description: uuid + in: path + responses: + '200': + description: The credential configuration was successfully deleted. + content: + application/json: + schema: + type: object + properties: {} + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '409': + description: Request was rejected due a conflict with an existing resource. + '500': + description: Internal error. + description: Deletes a Databricks credential configuration object for an account, + both specified by ID. You cannot delete a credential that is associated with + any workspace. + get: + operationId: credentials-get + externalDocs: + url: https://docs.databricks.com/api/account/credentials/get + x-stackQL-resource: credentials + x-stackQL-method: get + x-stackQL-verb: select + x-numReqParams: 2 + parameters: + - name: account_id + required: true + description: uuid + in: path + - name: credentials_id + required: true + description: uuid + in: path + responses: + '200': + description: The credential configuration was successfully returned. + content: + application/json: + schema: + type: object + properties: + credentials_id: + type: string + credentials_name: + type: string + aws_credentials: + type: object + properties: + sts_role: + type: object + properties: + role_arn: + type: string + external_id: + type: string + account_id: + type: string + creation_time: + type: integer + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Gets a Databricks credential configuration object for an account, + both specified by ID. + /api/2.0/accounts/{account_id}/customer-managed-keys: + post: + operationId: encryption-keys-create + externalDocs: + url: https://docs.databricks.com/api/account/encryptionkeys/create + x-stackQL-resource: encryption_keys + x-stackQL-method: create + x-stackQL-verb: insert + x-numReqParams: 1 + parameters: + - name: account_id + required: true + description: uuid + in: path + responses: + '201': + description: The encryption key configuration was successfully created. + content: + application/json: + schema: + type: object + properties: + customer_managed_key_id: + type: string + account_id: + type: string + aws_key_info: + type: object + properties: + key_arn: + type: string + key_alias: + type: string + key_region: + type: string + reuse_key_for_cluster_volumes: + type: boolean + creation_time: + type: integer + use_cases: + type: array + items: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + use_cases: + type: required + aws_key_info: + type: object + example: + aws_key_info: + key_arn: arn:aws:kms:us-west-2:111122223333:key/0987dcba-09fe-87dc-65ba-ab0987654321 + key_alias: alias/projectKey + reuse_key_for_cluster_volumes: true + use_cases: + - MANAGED_SERVICES + - STORAGE + description: Properties of the encryption key configuration. + description: Creates a customer-managed key configuration object for an account, + specified by ID. This operation uploads a reference to a customer-managed + key to Databricks. If the key is assigned as a workspace's customer-managed + key for managed services, Databricks uses the key to encrypt the workspaces + notebooks and secrets in the control plane, in addition to Databricks SQL + queries and query history. If it is specified as a workspace's customer-managed + key for workspace storage, the key encrypts the workspace's root S3 bucket + (which contains the workspace's root DBFS and system data) and, optionally, + cluster EBS volume data. + get: + operationId: encryption-keys-list + externalDocs: + url: https://docs.databricks.com/api/account/encryptionkeys/list + x-stackQL-resource: encryption_keys + x-stackQL-method: list + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: account_id + required: true + description: uuid + in: path + responses: + '200': + description: The encryption key configurations were successfully returned. + content: + application/json: + schema: + type: array + items: + type: object + properties: + customer_managed_key_id: + type: string + account_id: + type: string + aws_key_info: + type: object + properties: + key_arn: + type: string + key_alias: + type: string + key_region: + type: string + reuse_key_for_cluster_volumes: + type: boolean + creation_time: + type: integer + use_cases: + type: array + items: + type: string + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Gets all customer-managed key configuration objects for an account. + If the key is specified as a workspace's managed services customer-managed + key, Databricks uses the key to encrypt the workspace's notebooks and secrets + in the control plane, in addition to Databricks SQL queries and query history. + If the key is specified as a workspace's storage customer-managed key, the + key is used to encrypt the workspace's root S3 bucket and optionally can encrypt + cluster EBS volumes data in the data plane. + /api/2.0/accounts/{account_id}/customer-managed-keys/{customer_managed_key_id}: + delete: + operationId: encryption-keys-delete + externalDocs: + url: https://docs.databricks.com/api/account/encryptionkeys/delete + x-stackQL-resource: encryption_keys + x-stackQL-method: delete + x-stackQL-verb: delete + x-numReqParams: 2 + parameters: + - name: account_id + required: true + description: uuid + in: path + - name: customer_managed_key_id + required: true + description: uuid + in: path + responses: + '200': + description: The encryption key configuration was successfully deleted. + content: + application/json: + schema: + type: object + properties: {} + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '409': + description: Request was rejected due a conflict with an existing resource. + '500': + description: Internal error. + description: Deletes a customer-managed key configuration object for an account. + You cannot delete a configuration that is associated with a running workspace. + get: + operationId: encryption-keys-get + externalDocs: + url: https://docs.databricks.com/api/account/encryptionkeys/get + x-stackQL-resource: encryption_keys + x-stackQL-method: get + x-stackQL-verb: select + x-numReqParams: 2 + parameters: + - name: account_id + required: true + description: uuid + in: path + - name: customer_managed_key_id + required: true + description: uuid + in: path + responses: + '200': + description: The encryption key configuration was successfully returned. + content: + application/json: + schema: + type: object + properties: + customer_managed_key_id: + type: string + account_id: + type: string + aws_key_info: + type: object + properties: + key_arn: + type: string + key_alias: + type: string + key_region: + type: string + reuse_key_for_cluster_volumes: + type: boolean + creation_time: + type: integer + use_cases: + type: array + items: + type: string + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Gets a customer-managed key configuration object for an account, + specified by ID. This operation uploads a reference to a customer-managed + key to Databricks. If assigned as a workspace's customer-managed key for managed + services, Databricks uses the key to encrypt the workspaces notebooks and + secrets in the control plane, in addition to Databricks SQL queries and query + history. If it is specified as a workspace's customer-managed key for storage, + the key encrypts the workspace's root S3 bucket (which contains the workspace's + root DBFS and system data) and, optionally, cluster EBS volume data. + /api/2.0/accounts/{account_id}/networks: + post: + operationId: networks-create + externalDocs: + url: https://docs.databricks.com/api/account/networks/create + x-stackQL-resource: networks + x-stackQL-method: create + x-stackQL-verb: insert + x-numReqParams: 1 + parameters: + - name: account_id + required: true + description: uuid + in: path + responses: + '201': + description: The network configuration was successfully created. + content: + application/json: + schema: + type: object + properties: + network_id: + type: string + network_name: + type: string + vpc_id: + type: string + subnet_ids: + type: array + items: + type: string + security_group_ids: + type: array + items: + type: string + vpc_status: + type: string + warning_messages: + type: array + items: + type: object + properties: + warning_type: + type: string + warning_message: + type: string + error_messages: + type: array + items: + type: object + properties: + error_type: + type: string + error_message: + type: string + workspace_id: + type: integer + account_id: + type: string + creation_time: + type: integer + vpc_endpoints: + type: object + properties: + rest_api: + type: array + items: + type: string + dataplane_relay: + type: array + items: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + network_name: + type: required + vpc_id: + type: string + subnet_ids: + type: string + security_group_ids: + type: Array of string + vpc_endpoints: + type: object + example: + network_name: string + vpc_id: string + subnet_ids: + - string + security_group_ids: + - string + vpc_endpoints: + rest_api: + - 497f6eca-6276-4993-bfeb-53cbbbba6f08 + dataplane_relay: + - 497f6eca-6276-4993-bfeb-53cbbbba6f08 + description: Properties of the new network configuration. + description: Creates a Databricks network configuration that represents an AWS + VPC and its resources. The VPC will be used for new Databricks clusters. This + requires a pre-existing VPC and subnets. For VPC requirements, see + get: + operationId: networks-list + externalDocs: + url: https://docs.databricks.com/api/account/networks/list + x-stackQL-resource: networks + x-stackQL-method: list + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: account_id + required: true + description: uuid + in: path + responses: + '200': + description: The network configurations were successfully returned. + content: + application/json: + schema: + type: array + items: + type: object + properties: + network_id: + type: string + network_name: + type: string + vpc_id: + type: string + subnet_ids: + type: array + items: + type: string + security_group_ids: + type: array + items: + type: string + vpc_status: + type: string + warning_messages: + type: array + items: + type: object + properties: + warning_type: + type: string + warning_message: + type: string + error_messages: + type: array + items: + type: object + properties: + error_type: + type: string + error_message: + type: string + workspace_id: + type: integer + account_id: + type: string + creation_time: + type: integer + vpc_endpoints: + type: object + properties: + rest_api: + type: array + items: + type: string + dataplane_relay: + type: array + items: + type: string + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Gets a list of all Databricks network configurations for an account, + specified by ID. + /api/2.0/accounts/{account_id}/networks/{network_id}: + delete: + operationId: networks-delete + externalDocs: + url: https://docs.databricks.com/api/account/networks/delete + x-stackQL-resource: networks + x-stackQL-method: delete + x-stackQL-verb: delete + x-numReqParams: 2 + parameters: + - name: account_id + required: true + description: uuid + in: path + - name: network_id + required: true + description: uuid + in: path + responses: + '200': + description: The network configuration was successfully deleted. + content: + application/json: + schema: + type: object + properties: {} + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '409': + description: Request was rejected due a conflict with an existing resource. + '500': + description: Internal error. + description: Deletes a Databricks network configuration, which represents a + cloud VPC and its resources. You cannot delete a network that is associated + with a workspace. + get: + operationId: networks-get + externalDocs: + url: https://docs.databricks.com/api/account/networks/get + x-stackQL-resource: networks + x-stackQL-method: get + x-stackQL-verb: select + x-numReqParams: 2 + parameters: + - name: account_id + required: true + description: uuid + in: path + - name: network_id + required: true + description: uuid + in: path + responses: + '200': + description: The network configuration was successfully returned. + content: + application/json: + schema: + type: object + properties: + network_id: + type: string + network_name: + type: string + vpc_id: + type: string + subnet_ids: + type: array + items: + type: string + security_group_ids: + type: array + items: + type: string + vpc_status: + type: string + warning_messages: + type: array + items: + type: object + properties: + warning_type: + type: string + warning_message: + type: string + error_messages: + type: array + items: + type: object + properties: + error_type: + type: string + error_message: + type: string + workspace_id: + type: integer + account_id: + type: string + creation_time: + type: integer + vpc_endpoints: + type: object + properties: + rest_api: + type: array + items: + type: string + dataplane_relay: + type: array + items: + type: string + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Gets a Databricks network configuration, which represents an AWS + VPC and its resources. This requires a pre-existing VPC and subnets. + /api/2.0/accounts/{account_id}/private-access-settings: + post: + operationId: private-access-create + externalDocs: + url: https://docs.databricks.com/api/account/privateaccess/create + x-stackQL-resource: private_access + x-stackQL-method: create + x-stackQL-verb: insert + x-numReqParams: 1 + parameters: + - name: account_id + required: true + description: uuid + in: path + responses: + '200': + description: The private access settings object was successfully created. + content: + application/json: + schema: + type: object + properties: + private_access_settings_id: + type: string + private_access_settings_name: + type: string + public_access_enabled: + type: boolean + region: + type: string + account_id: + type: string + private_access_level: + type: string + allowed_vpc_endpoint_ids: + type: array + items: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + private_access_settings_name: + type: required + region: + type: string + public_access_enabled: + type: required + private_access_level: + type: string + allowed_vpc_endpoint_ids: + type: boolean + example: + private_access_settings_name: string + region: string + public_access_enabled: false + private_access_level: ENDPOINT + allowed_vpc_endpoint_ids: + - 497f6eca-6276-4993-bfeb-53cbbbba6f08 + description: Properties of the new private access settings object. + description: Creates a private access settings object, which specifies how your + workspace is accessed over + get: + operationId: private-access-list + externalDocs: + url: https://docs.databricks.com/api/account/privateaccess/list + x-stackQL-resource: private_access + x-stackQL-method: list + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: account_id + required: true + description: uuid + in: path + responses: + '200': + description: The private access settings object was successfully returned. + content: + application/json: + schema: + type: array + items: + type: object + properties: + private_access_settings_id: + type: string + private_access_settings_name: + type: string + public_access_enabled: + type: boolean + region: + type: string + account_id: + type: string + private_access_level: + type: string + allowed_vpc_endpoint_ids: + type: array + items: + type: string + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Gets a list of all private access settings objects for an account, + specified by ID. + /api/2.0/accounts/{account_id}/private-access-settings/{private_access_settings_id}: + delete: + operationId: private-access-delete + externalDocs: + url: https://docs.databricks.com/api/account/privateaccess/delete + x-stackQL-resource: private_access + x-stackQL-method: delete + x-stackQL-verb: delete + x-numReqParams: 2 + parameters: + - name: account_id + required: true + description: uuid + in: path + - name: private_access_settings_id + required: true + description: uuid + in: path + responses: + '200': + description: The private access settings was successfully deleted. + content: + application/json: + schema: + type: object + properties: {} + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '409': + description: Request was rejected due a conflict with an existing resource. + '500': + description: Internal error. + description: Deletes a private access settings object, which determines how + your workspace is accessed over + get: + operationId: private-access-get + externalDocs: + url: https://docs.databricks.com/api/account/privateaccess/get + x-stackQL-resource: private_access + x-stackQL-method: get + x-stackQL-verb: select + x-numReqParams: 2 + parameters: + - name: account_id + required: true + description: uuid + in: path + - name: private_access_settings_id + required: true + description: uuid + in: path + responses: + '200': + description: The private access settings object was successfully returned. + content: + application/json: + schema: + type: object + properties: + private_access_settings_id: + type: string + private_access_settings_name: + type: string + public_access_enabled: + type: boolean + region: + type: string + account_id: + type: string + private_access_level: + type: string + allowed_vpc_endpoint_ids: + type: array + items: + type: string + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Gets a private access settings object, which specifies how your + workspace is accessed over + put: + operationId: private-access-replace + externalDocs: + url: https://docs.databricks.com/api/account/privateaccess/replace + x-stackQL-resource: private_access + x-stackQL-method: replace + x-stackQL-verb: replace + x-numReqParams: 2 + parameters: + - name: account_id + required: true + description: uuid + in: path + - name: private_access_settings_id + required: true + description: uuid + in: path + responses: + '200': + description: The private access settings object was successfully updated. + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + private_access_settings_name: + type: required + region: + type: string + public_access_enabled: + type: required + private_access_level: + type: string + allowed_vpc_endpoint_ids: + type: boolean + example: + private_access_settings_name: string + region: string + public_access_enabled: false + private_access_level: ENDPOINT + allowed_vpc_endpoint_ids: + - 497f6eca-6276-4993-bfeb-53cbbbba6f08 + description: Properties of the new private access settings object. + description: Updates an existing private access settings object, which specifies + how your workspace is accessed over + /api/2.0/accounts/{account_id}/storage-configurations: + post: + operationId: storage-create + externalDocs: + url: https://docs.databricks.com/api/account/storage/create + x-stackQL-resource: storage + x-stackQL-method: create + x-stackQL-verb: insert + x-numReqParams: 1 + parameters: + - name: account_id + required: true + description: uuid + in: path + responses: + '201': + description: The storage configuration was successfully created. + content: + application/json: + schema: + type: object + properties: + storage_configuration_id: + type: string + storage_configuration_name: + type: string + root_bucket_info: + type: object + properties: + bucket_name: + type: string + account_id: + type: string + creation_time: + type: integer + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + storage_configuration_name: + type: required + root_bucket_info: + type: required + example: + storage_configuration_name: storage_conf_1 + root_bucket_info: + bucket_name: string + description: Properties of the new storage configuration. + description: Creates new storage configuration for an account, specified by + ID. Uploads a storage configuration object that represents the root AWS S3 + bucket in your account. Databricks stores related workspace assets including + DBFS, cluster logs, and job results. For the AWS S3 bucket, you need to configure + the required bucket policy. + get: + operationId: storage-list + externalDocs: + url: https://docs.databricks.com/api/account/storage/list + x-stackQL-resource: storage + x-stackQL-method: list + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: account_id + required: true + description: uuid + in: path + responses: + '200': + description: The storage configurations were successfully returned. + content: + application/json: + schema: + type: array + items: + type: object + properties: + storage_configuration_id: + type: string + storage_configuration_name: + type: string + root_bucket_info: + type: object + properties: + bucket_name: + type: string + account_id: + type: string + creation_time: + type: integer + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Gets a list of all Databricks storage configurations for your account, + specified by ID. + /api/2.0/accounts/{account_id}/storage-configurations/{storage_configuration_id}: + delete: + operationId: storage-delete + externalDocs: + url: https://docs.databricks.com/api/account/storage/delete + x-stackQL-resource: storage + x-stackQL-method: delete + x-stackQL-verb: delete + x-numReqParams: 2 + parameters: + - name: account_id + required: true + description: uuid + in: path + - name: storage_configuration_id + required: true + description: uuid + in: path + responses: + '200': + description: The storage configuration was successfully deleted. + content: + application/json: + schema: + type: object + properties: {} + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '409': + description: Request was rejected due a conflict with an existing resource. + '500': + description: Internal error. + description: Deletes a Databricks storage configuration. You cannot delete a + storage configuration that is associated with any workspace. + get: + operationId: storage-get + externalDocs: + url: https://docs.databricks.com/api/account/storage/get + x-stackQL-resource: storage + x-stackQL-method: get + x-stackQL-verb: select + x-numReqParams: 2 + parameters: + - name: account_id + required: true + description: uuid + in: path + - name: storage_configuration_id + required: true + description: uuid + in: path + responses: + '200': + description: The storage configuration was successfully returned. + content: + application/json: + schema: + type: object + properties: + storage_configuration_id: + type: string + storage_configuration_name: + type: string + root_bucket_info: + type: object + properties: + bucket_name: + type: string + account_id: + type: string + creation_time: + type: integer + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Gets a Databricks storage configuration for an account, both specified + by ID. + /api/2.0/accounts/{account_id}/vpc-endpoints: + post: + operationId: vpc-endpoints-create + externalDocs: + url: https://docs.databricks.com/api/account/vpcendpoints/create + x-stackQL-resource: vpc_endpoints + x-stackQL-method: create + x-stackQL-verb: insert + x-numReqParams: 1 + parameters: + - name: account_id + required: true + description: uuid + in: path + responses: + '200': + description: The VPC endpoint configuration was successfully created. + content: + application/json: + schema: + type: object + properties: + vpc_endpoint_id: + type: string + vpc_endpoint_name: + type: string + aws_vpc_endpoint_id: + type: string + aws_endpoint_service_id: + type: string + use_case: + type: string + region: + type: string + account_id: + type: string + aws_account_id: + type: string + state: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + vpc_endpoint_name: + type: required + aws_vpc_endpoint_id: + type: string + region: + type: string + example: + vpc_endpoint_name: string + aws_vpc_endpoint_id: string + region: string + description: Properties of the new VPC endpoint configuration. + description: Creates a VPC endpoint configuration, which represents a + get: + operationId: vpc-endpoints-list + externalDocs: + url: https://docs.databricks.com/api/account/vpcendpoints/list + x-stackQL-resource: vpc_endpoints + x-stackQL-method: list + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: account_id + required: true + description: uuid + in: path + responses: + '200': + description: The VPC endpoints were successfully returned. + content: + application/json: + schema: + type: array + items: + type: object + properties: + vpc_endpoint_id: + type: string + vpc_endpoint_name: + type: string + aws_vpc_endpoint_id: + type: string + aws_endpoint_service_id: + type: string + use_case: + type: string + region: + type: string + account_id: + type: string + aws_account_id: + type: string + state: + type: string + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Gets a list of all VPC endpoints for an account, specified by ID. + /api/2.0/accounts/{account_id}/vpc-endpoints/{vpc_endpoint_id}: + delete: + operationId: vpc-endpoints-delete + externalDocs: + url: https://docs.databricks.com/api/account/vpcendpoints/delete + x-stackQL-resource: vpc_endpoints + x-stackQL-method: delete + x-stackQL-verb: delete + x-numReqParams: 2 + parameters: + - name: account_id + required: true + description: uuid + in: path + - name: vpc_endpoint_id + required: true + description: uuid + in: path + responses: + '200': + description: The VPC endpoint configuration was successfully deleted. + content: + application/json: + schema: + type: object + properties: {} + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '409': + description: Request was rejected due a conflict with an existing resource. + '500': + description: Internal error. + description: Deletes a VPC endpoint configuration, which represents an + get: + operationId: vpc-endpoints-get + externalDocs: + url: https://docs.databricks.com/api/account/vpcendpoints/get + x-stackQL-resource: vpc_endpoints + x-stackQL-method: get + x-stackQL-verb: select + x-numReqParams: 2 + parameters: + - name: account_id + required: true + description: uuid + in: path + - name: vpc_endpoint_id + required: true + description: uuid + in: path + responses: + '200': + description: The VPC endpoint was successfully returned. + content: + application/json: + schema: + type: object + properties: + vpc_endpoint_id: + type: string + vpc_endpoint_name: + type: string + aws_vpc_endpoint_id: + type: string + aws_endpoint_service_id: + type: string + use_case: + type: string + region: + type: string + account_id: + type: string + aws_account_id: + type: string + state: + type: string + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Gets a VPC endpoint configuration, which represents a + /api/2.0/accounts/{account_id}/workspaces: + post: + operationId: workspaces-create + externalDocs: + url: https://docs.databricks.com/api/account/workspaces/create + x-stackQL-resource: workspaces + x-stackQL-method: create + x-stackQL-verb: insert + x-numReqParams: 1 + parameters: + - name: account_id + required: true + description: uuid + in: path + responses: + '201': + description: Workspace creation request was received. Check workspace status. + content: + application/json: + schema: + type: object + properties: + workspace_id: + type: integer + workspace_name: + type: string + deployment_name: + type: string + network_id: + type: string + aws_region: + type: string + credentials_id: + type: string + storage_configuration_id: + type: string + account_id: + type: string + workspace_status: + type: string + workspace_status_message: + type: string + managed_services_customer_managed_key_id: + type: string + private_access_settings_id: + type: string + creation_time: + type: integer + pricing_tier: + type: string + storage_customer_managed_key_id: + type: string + custom_tags: + type: object + properties: + property1: + type: string + property2: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + workspace_name: + type: required + network_id: + type: string + deployment_name: + type: uuid + aws_region: + type: string + credentials_id: + type: string + storage_configuration_id: + type: uuid + managed_services_customer_managed_key_id: + type: uuid + private_access_settings_id: + type: uuid + pricing_tier: + type: uuid + storage_customer_managed_key_id: + type: string + custom_tags: + type: object + example: + workspace_name: string + network_id: fd0cc5bc-683c-47e9-b15e-144d7744a496 + deployment_name: workspace_1 + aws_region: us-west-2 + credentials_id: ccc64f28-ebdc-4c89-add9-5dcb6d7727d8 + storage_configuration_id: b43a6064-04c1-4e1c-88b6-d91e5b136b13 + managed_services_customer_managed_key_id: 849b3d6b-e68e-468d-b3e5-deb08b03c56d + private_access_settings_id: 3b3bbcb5-46bd-4b03-944e-97eb44ed7991 + pricing_tier: PREMIUM + storage_customer_managed_key_id: 14138d0f-a575-4ae2-be71-ddfd0b602286 + custom_tags: + property1: string + property2: string + description: Properties of the new workspace. + description: Creates a new workspace using a credential configuration and a + storage configuration, an optional network configuration (if using a customer-managed + VPC), an optional managed services key configuration (if using customer-managed + keys for managed services), and an optional storage key configuration (if + using customer-managed keys for storage). The key configurations used for + managed services and storage encryption can be the same or different. + get: + operationId: workspaces-list + externalDocs: + url: https://docs.databricks.com/api/account/workspaces/list + x-stackQL-resource: workspaces + x-stackQL-method: list + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: account_id + required: true + description: uuid + in: path + responses: + '200': + description: The workspaces were returned successfully. + content: + application/json: + schema: + type: array + items: + type: object + properties: + workspace_id: + type: integer + workspace_name: + type: string + deployment_name: + type: string + network_id: + type: string + aws_region: + type: string + credentials_id: + type: string + storage_configuration_id: + type: string + account_id: + type: string + workspace_status: + type: string + workspace_status_message: + type: string + managed_services_customer_managed_key_id: + type: string + private_access_settings_id: + type: string + creation_time: + type: integer + pricing_tier: + type: string + storage_customer_managed_key_id: + type: string + custom_tags: + type: object + properties: + property1: + type: string + property2: + type: string + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Gets a list of all workspaces associated with an account, specified + by ID. + /api/2.0/accounts/{account_id}/workspaces/{workspace_id}: + delete: + operationId: workspaces-delete + externalDocs: + url: https://docs.databricks.com/api/account/workspaces/delete + x-stackQL-resource: workspaces + x-stackQL-method: delete + x-stackQL-verb: delete + x-numReqParams: 2 + parameters: + - name: account_id + required: true + description: uuid + in: path + - name: workspace_id + required: true + description: int64 + in: path + responses: + '200': + description: The workspace was successfully deleted. + content: + application/json: + schema: + type: object + properties: {} + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '409': + description: Request was rejected due a conflict with an existing resource. + '500': + description: Internal error. + description: Terminates and deletes a Databricks workspace. From an API perspective, + deletion is immediate. However, it might take a few minutes for all workspaces + resources to be deleted, depending on the size and number of workspace resources. + get: + operationId: workspaces-get + externalDocs: + url: https://docs.databricks.com/api/account/workspaces/get + x-stackQL-resource: workspaces + x-stackQL-method: get + x-stackQL-verb: select + x-numReqParams: 2 + parameters: + - name: account_id + required: true + description: uuid + in: path + - name: workspace_id + required: true + description: int64 + in: path + responses: + '200': + description: The workspace configuration was successfully returned. + content: + application/json: + schema: + type: object + properties: + workspace_id: + type: integer + workspace_name: + type: string + deployment_name: + type: string + network_id: + type: string + aws_region: + type: string + credentials_id: + type: string + storage_configuration_id: + type: string + account_id: + type: string + workspace_status: + type: string + workspace_status_message: + type: string + managed_services_customer_managed_key_id: + type: string + private_access_settings_id: + type: string + creation_time: + type: integer + pricing_tier: + type: string + storage_customer_managed_key_id: + type: string + custom_tags: + type: object + properties: + property1: + type: string + property2: + type: string + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Gets information including status for a Databricks workspace, specified + by ID. In the response, the + patch: + operationId: workspaces-update + externalDocs: + url: https://docs.databricks.com/api/account/workspaces/update + x-stackQL-resource: workspaces + x-stackQL-method: update + x-stackQL-verb: update + x-numReqParams: 2 + parameters: + - name: account_id + required: true + description: uuid + in: path + - name: workspace_id + required: true + description: int64 + in: path + responses: + '200': + description: The workspace update request is accepted. + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '409': + description: Request was rejected due a conflict with an existing resource. + '500': + description: Internal error. + '509': + description: An external service is unavailable temporarily as it is being + updated. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + aws_region: + type: string + credentials_id: + type: uuid + storage_configuration_id: + type: uuid + network_id: + type: uuid + managed_services_customer_managed_key_id: + type: uuid + private_access_settings_id: + type: uuid + storage_customer_managed_key_id: + type: uuid + network_connectivity_config_id: + type: uuid + custom_tags: + type: object + example: + aws_region: us-west-2 + credentials_id: c7814269-df58-4ca3-85e9-f6672ef43d77 + storage_configuration_id: 04aae505-1b1e-4cb9-997d-e1c49282675d + network_id: d6797cf4-42b9-4cad-8591-9dd91c3f0fc3 + managed_services_customer_managed_key_id: faacdc79-6530-4583-a154-5d427a663e53 + private_access_settings_id: 3b3bbcb5-46bd-4b03-944e-97eb44ed7991 + storage_customer_managed_key_id: 14138d0f-a575-4ae2-be71-ddfd0b602286 + custom_tags: + property1: string + property2: string + network_connectivity_config_id: 390afeb4-1111-2222-af33-ca3965c04068 + description: Changes of the workspace properties. + description: Updates a workspace configuration for either a running workspace + or a failed workspace. The elements that can be updated varies between these + two use cases. +components: + x-stackQL-resources: + credentials: + id: databricks_account.provisioning.credentials + name: credentials + title: Credentials + methods: + create: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1credentials/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1credentials/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1credentials~1{credentials_id}/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1credentials~1{credentials_id}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/credentials/methods/get' + - $ref: '#/components/x-stackQL-resources/credentials/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/credentials/methods/create' + update: [] + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/credentials/methods/delete' + exec: [] + encryption_keys: + id: databricks_account.provisioning.encryption_keys + name: encryption_keys + title: Encryption_keys + methods: + create: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1customer-managed-keys/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1customer-managed-keys/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1customer-managed-keys~1{customer_managed_key_id}/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1customer-managed-keys~1{customer_managed_key_id}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/encryption_keys/methods/get' + - $ref: '#/components/x-stackQL-resources/encryption_keys/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/encryption_keys/methods/create' + update: [] + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/encryption_keys/methods/delete' + exec: [] + networks: + id: databricks_account.provisioning.networks + name: networks + title: Networks + methods: + create: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1networks/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1networks/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1networks~1{network_id}/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1networks~1{network_id}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/networks/methods/get' + - $ref: '#/components/x-stackQL-resources/networks/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/networks/methods/create' + update: [] + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/networks/methods/delete' + exec: [] + private_access: + id: databricks_account.provisioning.private_access + name: private_access + title: Private_access + methods: + create: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1private-access-settings/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1private-access-settings/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1private-access-settings~1{private_access_settings_id}/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1private-access-settings~1{private_access_settings_id}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + replace: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1private-access-settings~1{private_access_settings_id}/put' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/private_access/methods/get' + - $ref: '#/components/x-stackQL-resources/private_access/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/private_access/methods/create' + update: [] + replace: + - $ref: '#/components/x-stackQL-resources/private_access/methods/replace' + delete: + - $ref: '#/components/x-stackQL-resources/private_access/methods/delete' + exec: [] + storage: + id: databricks_account.provisioning.storage + name: storage + title: Storage + methods: + create: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1storage-configurations/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1storage-configurations/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1storage-configurations~1{storage_configuration_id}/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1storage-configurations~1{storage_configuration_id}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/storage/methods/get' + - $ref: '#/components/x-stackQL-resources/storage/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/storage/methods/create' + update: [] + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/storage/methods/delete' + exec: [] + vpc_endpoints: + id: databricks_account.provisioning.vpc_endpoints + name: vpc_endpoints + title: Vpc_endpoints + methods: + create: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1vpc-endpoints/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1vpc-endpoints/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1vpc-endpoints~1{vpc_endpoint_id}/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1vpc-endpoints~1{vpc_endpoint_id}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/vpc_endpoints/methods/get' + - $ref: '#/components/x-stackQL-resources/vpc_endpoints/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/vpc_endpoints/methods/create' + update: [] + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/vpc_endpoints/methods/delete' + exec: [] + workspaces: + id: databricks_account.provisioning.workspaces + name: workspaces + title: Workspaces + methods: + create: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1workspaces/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1workspaces/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1workspaces~1{workspace_id}/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1workspaces~1{workspace_id}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1workspaces~1{workspace_id}/patch' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/workspaces/methods/get' + - $ref: '#/components/x-stackQL-resources/workspaces/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/workspaces/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/workspaces/methods/update' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/workspaces/methods/delete' + exec: [] diff --git a/providers/src/databricks_account/v00.00.00000/services/settings.yaml b/providers/src/databricks_account/v00.00.00000/services/settings.yaml new file mode 100644 index 00000000..ae5a1c1a --- /dev/null +++ b/providers/src/databricks_account/v00.00.00000/services/settings.yaml @@ -0,0 +1,985 @@ +openapi: 3.0.0 +info: + version: 2024-12-19-stackql-generated + contact: + name: StackQL Studios + url: https://stackql.io/ + email: info@stackql.io + title: Databricks Settings API + description: Account Settings +servers: +- url: https://accounts.cloud.databricks.com +paths: + /api/2.0/accounts/{account_id}/settings/types/shield_csp_enablement_ac/names/default: + get: + operationId: compliance-security-profile-get + externalDocs: + url: https://docs.databricks.com/api/account/cspenablementaccount/get + x-stackQL-resource: compliance_security_profile + x-stackQL-method: get + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: account_id + required: true + description: string + in: path + - name: etag + in: query + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + etag: + type: string + setting_name: + type: string + csp_enablement_account: + type: object + properties: + is_enforced: + type: boolean + compliance_standards: + type: array + items: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Gets the compliance security profile setting for new workspaces. + patch: + operationId: compliance-security-profile-update + externalDocs: + url: https://docs.databricks.com/api/account/cspenablementaccount/update + x-stackQL-resource: compliance_security_profile + x-stackQL-method: update + x-stackQL-verb: update + x-numReqParams: 1 + parameters: + - name: account_id + required: true + description: uuid + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + etag: + type: string + setting_name: + type: string + csp_enablement_account: + type: object + properties: + is_enforced: + type: boolean + compliance_standards: + type: array + items: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '409': + description: Request was rejected due a conflict with an existing resource. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + allow_missing: + type: required + field_mask: + type: boolean + setting: + type: object + example: + allow_missing: true + setting: + etag: string + setting_name: string + csp_enablement_account: + is_enforced: true + compliance_standards: + - NONE + field_mask: string + description: Details required to update a setting. + description: Updates the value of the compliance security profile setting for + new workspaces. + /api/2.0/accounts/{account_id}/settings/types/shield_esm_enablement_ac/names/default: + get: + operationId: enhanced-security-monitoring-get + externalDocs: + url: https://docs.databricks.com/api/account/esmenablementaccount/get + x-stackQL-resource: enhanced_security_monitoring + x-stackQL-method: get + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: account_id + required: true + description: string + in: path + - name: etag + in: query + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + etag: + type: string + setting_name: + type: string + esm_enablement_account: + type: object + properties: + is_enforced: + type: boolean + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Gets the enhanced security monitoring setting for new workspaces. + patch: + operationId: enhanced-security-monitoring-update + externalDocs: + url: https://docs.databricks.com/api/account/esmenablementaccount/update + x-stackQL-resource: enhanced_security_monitoring + x-stackQL-method: update + x-stackQL-verb: update + x-numReqParams: 1 + parameters: + - name: account_id + required: true + description: uuid + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + etag: + type: string + setting_name: + type: string + esm_enablement_account: + type: object + properties: + is_enforced: + type: boolean + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '409': + description: Request was rejected due a conflict with an existing resource. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + allow_missing: + type: required + field_mask: + type: boolean + setting: + type: object + example: + allow_missing: true + setting: + etag: string + setting_name: string + esm_enablement_account: + is_enforced: true + field_mask: string + description: Details required to update a setting. + description: Updates the value of the enhanced security monitoring setting for + new workspaces. + /api/2.0/accounts/{account_id}/ip-access-lists: + post: + operationId: ip-access-lists-create + externalDocs: + url: https://docs.databricks.com/api/account/accountipaccesslists/create + x-stackQL-resource: ip_access_lists + x-stackQL-method: create + x-stackQL-verb: insert + x-numReqParams: 1 + parameters: + - name: account_id + required: true + description: string + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + ip_access_list: + type: object + properties: + list_id: + type: string + label: + type: string + ip_addresses: + type: array + items: + type: string + address_count: + type: integer + list_type: + type: string + created_at: + type: integer + created_by: + type: integer + updated_at: + type: integer + updated_by: + type: integer + enabled: + type: boolean + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + label: + type: required + list_type: + type: string + ip_addresses: + type: required + example: + label: Office VPN + list_type: ALLOW + ip_addresses: + - 192.168.100.0/22 + description: Details required to configure a block list or allow list. + description: Creates an IP access list for the account. + get: + operationId: ip-access-lists-list + externalDocs: + url: https://docs.databricks.com/api/account/accountipaccesslists/list + x-stackQL-resource: ip_access_lists + x-stackQL-method: list + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: account_id + required: true + description: string + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + ip_access_lists: + type: array + items: + type: object + properties: + address_count: + type: integer + created_at: + type: integer + created_by: + type: integer + enabled: + type: boolean + ip_addresses: + type: array + items: + type: string + label: + type: string + list_id: + type: string + list_type: + type: string + updated_at: + type: integer + updated_by: + type: integer + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '500': + description: Internal error. + x-stackQL-objectKey: $.ip_access_lists + description: Gets all IP access lists for the specified account. + /api/2.0/accounts/{account_id}/ip-access-lists/{ip_access_list_id}: + delete: + operationId: ip-access-lists-delete + externalDocs: + url: https://docs.databricks.com/api/account/accountipaccesslists/delete + x-stackQL-resource: ip_access_lists + x-stackQL-method: delete + x-stackQL-verb: delete + x-numReqParams: 2 + parameters: + - name: account_id + required: true + description: string + in: path + - name: ip_access_list_id + required: true + description: string + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: {} + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Deletes an IP access list, specified by its list ID. + get: + operationId: ip-access-lists-get + externalDocs: + url: https://docs.databricks.com/api/account/accountipaccesslists/get + x-stackQL-resource: ip_access_lists + x-stackQL-method: get + x-stackQL-verb: select + x-numReqParams: 2 + parameters: + - name: account_id + required: true + description: string + in: path + - name: ip_access_list_id + required: true + description: string + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + ip_access_list: + type: object + properties: + list_id: + type: string + label: + type: string + ip_addresses: + type: array + items: + type: string + address_count: + type: integer + list_type: + type: string + created_at: + type: integer + created_by: + type: integer + updated_at: + type: integer + updated_by: + type: integer + enabled: + type: boolean + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + x-stackQL-objectKey: $.ip_access_list + description: Gets an IP access list, specified by its list ID. + put: + operationId: ip-access-lists-replace + externalDocs: + url: https://docs.databricks.com/api/account/accountipaccesslists/replace + x-stackQL-resource: ip_access_lists + x-stackQL-method: replace + x-stackQL-verb: replace + x-numReqParams: 2 + parameters: + - name: account_id + required: true + description: string + in: path + - name: ip_access_list_id + required: true + description: string + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + label: + type: required + list_type: + type: string + ip_addresses: + type: required + enabled: + type: string + example: + label: Office VPN + list_type: ALLOW + ip_addresses: + - 192.168.100.0/22 + enabled: true + description: Details required to replace an IP access list. + description: Replaces an IP access list, specified by its ID. + patch: + operationId: ip-access-lists-update + externalDocs: + url: https://docs.databricks.com/api/account/accountipaccesslists/update + x-stackQL-resource: ip_access_lists + x-stackQL-method: update + x-stackQL-verb: update + x-numReqParams: 2 + parameters: + - name: account_id + required: true + description: string + in: path + - name: ip_access_list_id + required: true + description: string + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + label: + type: string + list_type: + type: string + ip_addresses: + type: Array of string + enabled: + type: boolean + example: + label: Office VPN + list_type: ALLOW + ip_addresses: + - 192.168.100.0/22 + enabled: true + description: Details required to update an IP access list. + description: Updates an existing IP access list, specified by its ID. + /api/2.0/accounts/{account_id}/network-connectivity-configs: + post: + operationId: network-connectivity-createnetworkconnectivityconfiguration + externalDocs: + url: https://docs.databricks.com/api/account/networkconnectivity/createnetworkconnectivityconfiguration + x-stackQL-resource: network_connectivity + x-stackQL-method: createnetworkconnectivityconfiguration + x-stackQL-verb: insert + x-numReqParams: 1 + parameters: + - name: account_id + required: true + description: uuid + in: path + responses: + '200': + description: The network connectivity configuration was successfully created. + content: + application/json: + schema: + type: object + properties: + network_connectivity_config_id: + type: string + account_id: + type: string + name: + type: string + region: + type: string + egress_config: + type: object + properties: + default_rules: + type: object + properties: + aws_stable_ip_rule: + type: object + properties: + cidr_blocks: + type: array + items: + type: string + creation_time: + type: integer + updated_time: + type: integer + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: required + region: + type: uuid + example: + name: 9ffa9185-7453-4fb2-aa6a-3105a6ae83a8 + region: string + description: Properties of the new network connectivity configuration. + description: Creates a network connectivity configuration (NCC), which provides + stable IP CIDR blocks that are associated with your workspace. You can assign + an NCC to one or more workspaces in the same region. Once assigned, the workspace + serverless compute resources use the same set of stable IP CIDR blocks to + access your resources. + get: + operationId: network-connectivity-listnetworkconnectivityconfigurations + externalDocs: + url: https://docs.databricks.com/api/account/networkconnectivity/listnetworkconnectivityconfigurations + x-stackQL-resource: network_connectivity + x-stackQL-method: listnetworkconnectivityconfigurations + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: account_id + required: true + description: uuid + in: path + - name: page_token + in: query + responses: + '200': + description: The network connectivity configuration list was successfully + retrieved. + content: + application/json: + schema: + type: object + properties: + items: + type: array + items: + type: object + properties: + network_connectivity_config_id: + type: string + account_id: + type: string + name: + type: string + region: + type: string + egress_config: + type: object + properties: + default_rules: + type: object + properties: + aws_stable_ip_rule: + type: object + properties: + cidr_blocks: + type: array + items: + type: string + creation_time: + type: integer + updated_time: + type: integer + next_page_token: + type: string + description: Gets an array of network connectivity configurations. + /api/2.0/accounts/{account_id}/network-connectivity-configs/{network_connectivity_config_id}: + delete: + operationId: network-connectivity-deletenetworkconnectivityconfiguration + externalDocs: + url: https://docs.databricks.com/api/account/networkconnectivity/deletenetworkconnectivityconfiguration + x-stackQL-resource: network_connectivity + x-stackQL-method: deletenetworkconnectivityconfiguration + x-stackQL-verb: delete + x-numReqParams: 2 + parameters: + - name: account_id + required: true + description: uuid + in: path + - name: network_connectivity_config_id + required: true + description: uuid + in: path + responses: + '200': + description: The network connectivity config was successfully deleted. + content: + application/json: + schema: + type: object + properties: {} + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '409': + description: Request was rejected due a conflict with an existing resource. + '500': + description: Internal error. + description: Deletes a network connectivity configuration. + get: + operationId: network-connectivity-getnetworkconnectivityconfiguration + externalDocs: + url: https://docs.databricks.com/api/account/networkconnectivity/getnetworkconnectivityconfiguration + x-stackQL-resource: network_connectivity + x-stackQL-method: getnetworkconnectivityconfiguration + x-stackQL-verb: select + x-numReqParams: 2 + parameters: + - name: account_id + required: true + description: uuid + in: path + - name: network_connectivity_config_id + required: true + description: uuid + in: path + responses: + '200': + description: The network connectivity configuration was successfully returned. + content: + application/json: + schema: + type: object + properties: + network_connectivity_config_id: + type: string + account_id: + type: string + name: + type: string + region: + type: string + egress_config: + type: object + properties: + default_rules: + type: object + properties: + aws_stable_ip_rule: + type: object + properties: + cidr_blocks: + type: array + items: + type: string + creation_time: + type: integer + updated_time: + type: integer + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Gets a network connectivity configuration. +components: + x-stackQL-resources: + compliance_security_profile: + id: databricks_account.settings.compliance_security_profile + name: compliance_security_profile + title: Compliance_security_profile + methods: + get: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1settings~1types~1shield_csp_enablement_ac~1names~1default/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1settings~1types~1shield_csp_enablement_ac~1names~1default/patch' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/compliance_security_profile/methods/get' + insert: [] + update: + - $ref: '#/components/x-stackQL-resources/compliance_security_profile/methods/update' + replace: [] + delete: [] + exec: [] + enhanced_security_monitoring: + id: databricks_account.settings.enhanced_security_monitoring + name: enhanced_security_monitoring + title: Enhanced_security_monitoring + methods: + get: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1settings~1types~1shield_esm_enablement_ac~1names~1default/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1settings~1types~1shield_esm_enablement_ac~1names~1default/patch' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/enhanced_security_monitoring/methods/get' + insert: [] + update: + - $ref: '#/components/x-stackQL-resources/enhanced_security_monitoring/methods/update' + replace: [] + delete: [] + exec: [] + ip_access_lists: + id: databricks_account.settings.ip_access_lists + name: ip_access_lists + title: Ip_access_lists + methods: + create: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1ip-access-lists/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1ip-access-lists/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.ip_access_lists + delete: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1ip-access-lists~1{ip_access_list_id}/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1ip-access-lists~1{ip_access_list_id}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.ip_access_list + replace: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1ip-access-lists~1{ip_access_list_id}/put' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1ip-access-lists~1{ip_access_list_id}/patch' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/ip_access_lists/methods/get' + - $ref: '#/components/x-stackQL-resources/ip_access_lists/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/ip_access_lists/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/ip_access_lists/methods/update' + replace: + - $ref: '#/components/x-stackQL-resources/ip_access_lists/methods/replace' + delete: + - $ref: '#/components/x-stackQL-resources/ip_access_lists/methods/delete' + exec: [] + network_connectivity: + id: databricks_account.settings.network_connectivity + name: network_connectivity + title: Network_connectivity + methods: + createnetworkconnectivityconfiguration: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1network-connectivity-configs/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + listnetworkconnectivityconfigurations: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1network-connectivity-configs/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + deletenetworkconnectivityconfiguration: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1network-connectivity-configs~1{network_connectivity_config_id}/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + getnetworkconnectivityconfiguration: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1network-connectivity-configs~1{network_connectivity_config_id}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/network_connectivity/methods/getnetworkconnectivityconfiguration' + - $ref: '#/components/x-stackQL-resources/network_connectivity/methods/listnetworkconnectivityconfigurations' + insert: + - $ref: '#/components/x-stackQL-resources/network_connectivity/methods/createnetworkconnectivityconfiguration' + update: [] + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/network_connectivity/methods/deletenetworkconnectivityconfiguration' + exec: [] diff --git a/providers/src/databricks_account/v00.00.00000/services/unity_catalog.yaml b/providers/src/databricks_account/v00.00.00000/services/unity_catalog.yaml new file mode 100644 index 00000000..792fe362 --- /dev/null +++ b/providers/src/databricks_account/v00.00.00000/services/unity_catalog.yaml @@ -0,0 +1,1158 @@ +openapi: 3.0.0 +info: + version: 2024-12-19-stackql-generated + contact: + name: StackQL Studios + url: https://stackql.io/ + email: info@stackql.io + title: Databricks Unity_catalog API + description: Unity Catalog +servers: +- url: https://accounts.cloud.databricks.com +paths: + /api/2.0/accounts/{account_id}/metastores: + post: + operationId: metastores-create + externalDocs: + url: https://docs.databricks.com/api/account/accountmetastores/create + x-stackQL-resource: metastores + x-stackQL-method: create + x-stackQL-verb: insert + x-numReqParams: 1 + parameters: + - name: account_id + required: true + description: uuid + in: path + responses: + '201': + description: The metastore was successfully created. + content: + application/json: + schema: + type: object + properties: + metastore_info: + type: object + properties: + name: + type: string + storage_root: + type: string + default_data_access_config_id: + type: string + storage_root_credential_id: + type: string + delta_sharing_scope: + type: string + delta_sharing_recipient_token_lifetime_in_seconds: + type: integer + delta_sharing_organization_name: + type: string + owner: + type: string + privilege_model_version: + type: string + region: + type: string + metastore_id: + type: string + created_at: + type: integer + created_by: + type: string + updated_at: + type: integer + updated_by: + type: string + storage_root_credential_name: + type: string + cloud: + type: string + global_metastore_id: + type: string + external_access_enabled: + type: boolean + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + metastore_info: + type: object + example: + metastore_info: + name: string + storage_root: string + region: string + description: Properties of the new metastore. + description: Creates a Unity Catalog metastore. + get: + operationId: metastores-list + externalDocs: + url: https://docs.databricks.com/api/account/accountmetastores/list + x-stackQL-resource: metastores + x-stackQL-method: list + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: account_id + required: true + description: uuid + in: path + responses: + '200': + description: Metastores were returned successfully. + content: + application/json: + schema: + type: object + properties: + metastores: + type: array + items: + type: object + properties: + name: + type: string + storage_root: + type: string + default_data_access_config_id: + type: string + storage_root_credential_id: + type: string + delta_sharing_scope: + type: string + delta_sharing_recipient_token_lifetime_in_seconds: + type: integer + delta_sharing_organization_name: + type: string + owner: + type: string + privilege_model_version: + type: string + region: + type: string + metastore_id: + type: string + created_at: + type: integer + created_by: + type: string + updated_at: + type: integer + updated_by: + type: string + storage_root_credential_name: + type: string + cloud: + type: string + global_metastore_id: + type: string + external_access_enabled: + type: boolean + x-stackQL-objectKey: $.metastores + description: Gets all Unity Catalog metastores associated with an account specified + by ID. + /api/2.0/accounts/{account_id}/metastores/{metastore_id}: + delete: + operationId: metastores-delete + externalDocs: + url: https://docs.databricks.com/api/account/accountmetastores/delete + x-stackQL-resource: metastores + x-stackQL-method: delete + x-stackQL-verb: delete + x-numReqParams: 2 + parameters: + - name: account_id + required: true + description: uuid + in: path + - name: metastore_id + required: true + description: uuid + in: path + - name: force + in: query + responses: + '200': + description: The metastore was successfully deleted. + content: + application/json: + schema: + type: object + properties: {} + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Deletes a Unity Catalog metastore for an account, both specified + by ID. + get: + operationId: metastores-get + externalDocs: + url: https://docs.databricks.com/api/account/accountmetastores/get + x-stackQL-resource: metastores + x-stackQL-method: get + x-stackQL-verb: select + x-numReqParams: 2 + parameters: + - name: account_id + required: true + description: uuid + in: path + - name: metastore_id + required: true + description: uuid + in: path + responses: + '200': + description: The metastore was successfully returned. + content: + application/json: + schema: + type: object + properties: + metastore_info: + type: object + properties: + name: + type: string + storage_root: + type: string + default_data_access_config_id: + type: string + storage_root_credential_id: + type: string + delta_sharing_scope: + type: string + delta_sharing_recipient_token_lifetime_in_seconds: + type: integer + delta_sharing_organization_name: + type: string + owner: + type: string + privilege_model_version: + type: string + region: + type: string + metastore_id: + type: string + created_at: + type: integer + created_by: + type: string + updated_at: + type: integer + updated_by: + type: string + storage_root_credential_name: + type: string + cloud: + type: string + global_metastore_id: + type: string + external_access_enabled: + type: boolean + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + x-stackQL-objectKey: $.metastore_info + description: Gets a Unity Catalog metastore from an account, both specified + by ID. + put: + operationId: metastores-update + externalDocs: + url: https://docs.databricks.com/api/account/accountmetastores/update + x-stackQL-resource: metastores + x-stackQL-method: update + x-stackQL-verb: replace + x-numReqParams: 2 + parameters: + - name: account_id + required: true + description: uuid + in: path + - name: metastore_id + required: true + description: uuid + in: path + responses: + '201': + description: The metastore update request succeeded. + content: + application/json: + schema: + type: object + properties: + metastore_info: + type: object + properties: + name: + type: string + storage_root: + type: string + default_data_access_config_id: + type: string + storage_root_credential_id: + type: string + delta_sharing_scope: + type: string + delta_sharing_recipient_token_lifetime_in_seconds: + type: integer + delta_sharing_organization_name: + type: string + owner: + type: string + privilege_model_version: + type: string + region: + type: string + metastore_id: + type: string + created_at: + type: integer + created_by: + type: string + updated_at: + type: integer + updated_by: + type: string + storage_root_credential_name: + type: string + cloud: + type: string + global_metastore_id: + type: string + external_access_enabled: + type: boolean + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + metastore_info: + type: object + example: + metastore_info: + storage_root_credential_id: string + delta_sharing_recipient_token_lifetime_in_seconds: 0 + delta_sharing_organization_name: string + owner: string + privilege_model_version: string + new_name: string + delta_sharing_scope: INTERNAL + description: Properties of the metastore to change. + description: Updates an existing Unity Catalog metastore. + /api/2.0/accounts/{account_id}/workspaces/{workspace_id}/metastores/{metastore_id}: + post: + operationId: metastore-assignments-create + externalDocs: + url: https://docs.databricks.com/api/account/accountmetastoreassignments/create + x-stackQL-resource: metastore_assignments + x-stackQL-method: create + x-stackQL-verb: insert + x-numReqParams: 3 + parameters: + - name: account_id + required: true + description: uuid + in: path + - name: workspace_id + required: true + description: int64 + in: path + - name: metastore_id + required: true + description: uuid + in: path + responses: + '201': + description: The metastore assignment was successfully created. + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + metastore_assignment: + type: object + example: + metastore_assignment: + metastore_id: string + default_catalog_name: string + description: The mapping from workspace to metastore. + description: Creates an assignment to a metastore for a workspace + delete: + operationId: metastore-assignments-delete + externalDocs: + url: https://docs.databricks.com/api/account/accountmetastoreassignments/delete + x-stackQL-resource: metastore_assignments + x-stackQL-method: delete + x-stackQL-verb: delete + x-numReqParams: 3 + parameters: + - name: account_id + required: true + description: uuid + in: path + - name: workspace_id + required: true + description: int64 + in: path + - name: metastore_id + required: true + description: uuid + in: path + responses: + '200': + description: The metastore assignment was successfully deleted. + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Deletes a metastore assignment to a workspace, leaving the workspace + with no metastore. + put: + operationId: metastore-assignments-update + externalDocs: + url: https://docs.databricks.com/api/account/accountmetastoreassignments/update + x-stackQL-resource: metastore_assignments + x-stackQL-method: update + x-stackQL-verb: replace + x-numReqParams: 3 + parameters: + - name: account_id + required: true + description: uuid + in: path + - name: workspace_id + required: true + description: int64 + in: path + - name: metastore_id + required: true + description: uuid + in: path + responses: + '201': + description: The metastore assignment was successfully updated. + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + metastore_assignment: + type: object + example: + metastore_assignment: + metastore_id: string + default_catalog_name: string + description: The metastore assignment to update. + description: Updates an assignment to a metastore for a workspace. Currently, + only the default catalog may be updated. + /api/2.0/accounts/{account_id}/workspaces/{workspace_id}/metastore: + get: + operationId: metastore-assignments-get + externalDocs: + url: https://docs.databricks.com/api/account/accountmetastoreassignments/get + x-stackQL-resource: metastore_assignments + x-stackQL-method: get + x-stackQL-verb: select + x-numReqParams: 2 + parameters: + - name: account_id + required: true + description: uuid + in: path + - name: workspace_id + required: true + description: int64 + in: path + responses: + '200': + description: The workspace metastore assignment was successfully returned. + content: + application/json: + schema: + type: object + properties: + metastore_assignment: + type: object + properties: + metastore_id: + type: string + workspace_id: + type: integer + default_catalog_name: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + x-stackQL-objectKey: $.metastore_assignment + description: Gets the metastore assignment, if any, for the workspace specified + by ID. If the workspace is assigned a metastore, the mappig will be returned. + If no metastore is assigned to the workspace, the assignment will not be found + and a 404 returned. + /api/2.0/accounts/{account_id}/metastores/{metastore_id}/storage-credentials: + post: + operationId: storage-credentials-create + externalDocs: + url: https://docs.databricks.com/api/account/accountstoragecredentials/create + x-stackQL-resource: storage_credentials + x-stackQL-method: create + x-stackQL-verb: insert + x-numReqParams: 2 + parameters: + - name: account_id + required: true + description: uuid + in: path + - name: metastore_id + required: true + description: uuid + in: path + responses: + '200': + description: The new storage credential was successfully created. + content: + application/json: + schema: + type: object + properties: + credential_info: + type: object + properties: + name: + type: string + aws_iam_role: + type: object + properties: + role_arn: + type: string + unity_catalog_iam_arn: + type: string + external_id: + type: string + comment: + type: string + read_only: + type: boolean + owner: + type: string + full_name: + type: string + id: + type: string + metastore_id: + type: string + created_at: + type: integer + created_by: + type: string + updated_at: + type: integer + updated_by: + type: string + used_for_managed_storage: + type: boolean + isolation_mode: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + credential_info: + type: object + example: + credential_info: + name: string + comment: string + read_only: true + aws_iam_role: + role_arn: string + skip_validation: false + description: 'Creates a new storage credential. The request object is specific + to the cloud:' + get: + operationId: storage-credentials-list + externalDocs: + url: https://docs.databricks.com/api/account/accountstoragecredentials/list + x-stackQL-resource: storage_credentials + x-stackQL-method: list + x-stackQL-verb: select + x-numReqParams: 2 + parameters: + - name: account_id + required: true + description: uuid + in: path + - name: metastore_id + required: true + description: uuid + in: path + responses: + '200': + description: The metastore storage credentials were successfully returned. + content: + application/json: + schema: + type: object + properties: + storage_credentials: + type: array + items: + type: object + properties: + name: + type: string + aws_iam_role: + type: object + properties: + role_arn: + type: string + unity_catalog_iam_arn: + type: string + external_id: + type: string + comment: + type: string + read_only: + type: boolean + owner: + type: string + full_name: + type: string + id: + type: string + metastore_id: + type: string + created_at: + type: integer + created_by: + type: string + updated_at: + type: integer + updated_by: + type: string + used_for_managed_storage: + type: boolean + isolation_mode: + type: string + x-stackQL-objectKey: $.storage_credentials + description: Gets a list of all storage credentials that have been assigned + to given metastore. + /api/2.0/accounts/{account_id}/metastores/{metastore_id}/storage-credentials/{storage_credential_name}: + delete: + operationId: storage-credentials-delete + externalDocs: + url: https://docs.databricks.com/api/account/accountstoragecredentials/delete + x-stackQL-resource: storage_credentials + x-stackQL-method: delete + x-stackQL-verb: delete + x-numReqParams: 3 + parameters: + - name: account_id + required: true + description: uuid + in: path + - name: metastore_id + required: true + description: uuid + in: path + - name: storage_credential_name + required: true + description: string + in: path + - name: force + in: query + responses: + '200': + description: The storage credential was successfully deleted. + content: + application/json: + schema: + type: object + properties: {} + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Deletes a storage credential from the metastore. The caller must + be an owner of the storage credential. + get: + operationId: storage-credentials-get + externalDocs: + url: https://docs.databricks.com/api/account/accountstoragecredentials/get + x-stackQL-resource: storage_credentials + x-stackQL-method: get + x-stackQL-verb: select + x-numReqParams: 3 + parameters: + - name: account_id + required: true + description: uuid + in: path + - name: metastore_id + required: true + description: uuid + in: path + - name: storage_credential_name + required: true + description: string + in: path + responses: + '200': + description: The storage credential was successfully retrieved. + content: + application/json: + schema: + type: object + properties: + credential_info: + type: object + properties: + name: + type: string + aws_iam_role: + type: object + properties: + role_arn: + type: string + unity_catalog_iam_arn: + type: string + external_id: + type: string + comment: + type: string + read_only: + type: boolean + owner: + type: string + full_name: + type: string + id: + type: string + metastore_id: + type: string + created_at: + type: integer + created_by: + type: string + updated_at: + type: integer + updated_by: + type: string + used_for_managed_storage: + type: boolean + isolation_mode: + type: string + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + x-stackQL-objectKey: $.credential_info + description: Gets a storage credential from the metastore. The caller must be + a metastore admin, the owner of the storage credential, or have a level of + privilege on the storage credential. + put: + operationId: storage-credentials-update + externalDocs: + url: https://docs.databricks.com/api/account/accountstoragecredentials/update + x-stackQL-resource: storage_credentials + x-stackQL-method: update + x-stackQL-verb: replace + x-numReqParams: 3 + parameters: + - name: account_id + required: true + description: uuid + in: path + - name: metastore_id + required: true + description: uuid + in: path + - name: storage_credential_name + required: true + description: string + in: path + responses: + '201': + description: The storage credential was successfully updated. + content: + application/json: + schema: + type: object + properties: + credential_info: + type: object + properties: + name: + type: string + aws_iam_role: + type: object + properties: + role_arn: + type: string + unity_catalog_iam_arn: + type: string + external_id: + type: string + comment: + type: string + read_only: + type: boolean + owner: + type: string + full_name: + type: string + id: + type: string + metastore_id: + type: string + created_at: + type: integer + created_by: + type: string + updated_at: + type: integer + updated_by: + type: string + used_for_managed_storage: + type: boolean + isolation_mode: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + credential_info: + type: object + example: + credential_info: + comment: string + read_only: true + owner: string + aws_iam_role: + role_arn: string + isolation_mode: ISOLATION_MODE_OPEN + new_name: string + skip_validation: false + force: true + description: The storage credential to update. + description: Updates a storage credential on the metastore. The caller must + be the owner of the storage credential. If the caller is a metastore admin, + only the + /api/2.0/accounts/{account_id}/metastores/{metastore_id}/workspaces: + get: + operationId: workspace-assignments-list + externalDocs: + url: https://docs.databricks.com/api/account/accountmetastoreassignments/list + x-stackQL-resource: workspace_assignments + x-stackQL-method: list + x-stackQL-verb: select + x-numReqParams: 2 + parameters: + - name: account_id + required: true + description: uuid + in: path + - name: metastore_id + required: true + description: uuid + in: path + responses: + '200': + description: The metastore assignments were successfully returned. + content: + application/json: + schema: + type: object + properties: + workspace_ids: + type: array + items: + type: integer + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Gets a list of all Databricks workspace IDs that have been assigned + to given metastore. +components: + x-stackQL-resources: + metastores: + id: databricks_account.unity_catalog.metastores + name: metastores + title: Metastores + methods: + create: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1metastores/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1metastores/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.metastores + delete: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1metastores~1{metastore_id}/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1metastores~1{metastore_id}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.metastore_info + update: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1metastores~1{metastore_id}/put' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/metastores/methods/get' + - $ref: '#/components/x-stackQL-resources/metastores/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/metastores/methods/create' + update: [] + replace: + - $ref: '#/components/x-stackQL-resources/metastores/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/metastores/methods/delete' + exec: [] + metastore_assignments: + id: databricks_account.unity_catalog.metastore_assignments + name: metastore_assignments + title: Metastore_assignments + methods: + create: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1workspaces~1{workspace_id}~1metastores~1{metastore_id}/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1workspaces~1{workspace_id}~1metastores~1{metastore_id}/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1workspaces~1{workspace_id}~1metastores~1{metastore_id}/put' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1workspaces~1{workspace_id}~1metastore/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.metastore_assignment + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/metastore_assignments/methods/get' + insert: + - $ref: '#/components/x-stackQL-resources/metastore_assignments/methods/create' + update: [] + replace: + - $ref: '#/components/x-stackQL-resources/metastore_assignments/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/metastore_assignments/methods/delete' + exec: [] + storage_credentials: + id: databricks_account.unity_catalog.storage_credentials + name: storage_credentials + title: Storage_credentials + methods: + create: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1metastores~1{metastore_id}~1storage-credentials/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1metastores~1{metastore_id}~1storage-credentials/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.storage_credentials + delete: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1metastores~1{metastore_id}~1storage-credentials~1{storage_credential_name}/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1metastores~1{metastore_id}~1storage-credentials~1{storage_credential_name}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.credential_info + update: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1metastores~1{metastore_id}~1storage-credentials~1{storage_credential_name}/put' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/storage_credentials/methods/get' + - $ref: '#/components/x-stackQL-resources/storage_credentials/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/storage_credentials/methods/create' + update: [] + replace: + - $ref: '#/components/x-stackQL-resources/storage_credentials/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/storage_credentials/methods/delete' + exec: [] + workspace_assignments: + id: databricks_account.unity_catalog.workspace_assignments + name: workspace_assignments + title: Workspace_assignments + methods: + list: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1metastores~1{metastore_id}~1workspaces/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/workspace_assignments/methods/list' + insert: [] + update: [] + replace: [] + delete: [] + exec: [] diff --git a/providers/src/databricks_workspace/v00.00.00000/provider.yaml b/providers/src/databricks_workspace/v00.00.00000/provider.yaml new file mode 100644 index 00000000..eeeb005f --- /dev/null +++ b/providers/src/databricks_workspace/v00.00.00000/provider.yaml @@ -0,0 +1,176 @@ +id: databricks_workspace +name: databricks_workspace +version: v00.00.00000 +providerServices: + apps: + id: apps:v00.00.00000 + name: apps + preferred: true + service: + $ref: databricks_workspace/v00.00.00000/services/apps.yaml + title: Apps + version: v00.00.00000 + description: Apps + cleanrooms: + id: cleanrooms:v00.00.00000 + name: cleanrooms + preferred: true + service: + $ref: databricks_workspace/v00.00.00000/services/cleanrooms.yaml + title: Cleanrooms + version: v00.00.00000 + description: Cleanrooms + compute: + id: compute:v00.00.00000 + name: compute + preferred: true + service: + $ref: databricks_workspace/v00.00.00000/services/compute.yaml + title: Compute + version: v00.00.00000 + description: Compute + dbsql: + id: dbsql:v00.00.00000 + name: dbsql + preferred: true + service: + $ref: databricks_workspace/v00.00.00000/services/dbsql.yaml + title: Dbsql + version: v00.00.00000 + description: Dbsql + deltalivetables: + id: deltalivetables:v00.00.00000 + name: deltalivetables + preferred: true + service: + $ref: databricks_workspace/v00.00.00000/services/deltalivetables.yaml + title: Deltalivetables + version: v00.00.00000 + description: Deltalivetables + deltasharing: + id: deltasharing:v00.00.00000 + name: deltasharing + preferred: true + service: + $ref: databricks_workspace/v00.00.00000/services/deltasharing.yaml + title: Deltasharing + version: v00.00.00000 + description: Deltasharing + filemanagement: + id: filemanagement:v00.00.00000 + name: filemanagement + preferred: true + service: + $ref: databricks_workspace/v00.00.00000/services/filemanagement.yaml + title: Filemanagement + version: v00.00.00000 + description: Filemanagement + iam: + id: iam:v00.00.00000 + name: iam + preferred: true + service: + $ref: databricks_workspace/v00.00.00000/services/iam.yaml + title: Iam + version: v00.00.00000 + description: Iam + lakeview: + id: lakeview:v00.00.00000 + name: lakeview + preferred: true + service: + $ref: databricks_workspace/v00.00.00000/services/lakeview.yaml + title: Lakeview + version: v00.00.00000 + description: Lakeview + machinelearning: + id: machinelearning:v00.00.00000 + name: machinelearning + preferred: true + service: + $ref: databricks_workspace/v00.00.00000/services/machinelearning.yaml + title: Machinelearning + version: v00.00.00000 + description: Machinelearning + marketplace: + id: marketplace:v00.00.00000 + name: marketplace + preferred: true + service: + $ref: databricks_workspace/v00.00.00000/services/marketplace.yaml + title: Marketplace + version: v00.00.00000 + description: Marketplace + realtimeserving: + id: realtimeserving:v00.00.00000 + name: realtimeserving + preferred: true + service: + $ref: databricks_workspace/v00.00.00000/services/realtimeserving.yaml + title: Realtimeserving + version: v00.00.00000 + description: Realtimeserving + repos: + id: repos:v00.00.00000 + name: repos + preferred: true + service: + $ref: databricks_workspace/v00.00.00000/services/repos.yaml + title: Repos + version: v00.00.00000 + description: Repos + secrets: + id: secrets:v00.00.00000 + name: secrets + preferred: true + service: + $ref: databricks_workspace/v00.00.00000/services/secrets.yaml + title: Secrets + version: v00.00.00000 + description: Secrets + unitycatalog: + id: unitycatalog:v00.00.00000 + name: unitycatalog + preferred: true + service: + $ref: databricks_workspace/v00.00.00000/services/unitycatalog.yaml + title: Unitycatalog + version: v00.00.00000 + description: Unitycatalog + vectorsearch: + id: vectorsearch:v00.00.00000 + name: vectorsearch + preferred: true + service: + $ref: databricks_workspace/v00.00.00000/services/vectorsearch.yaml + title: Vectorsearch + version: v00.00.00000 + description: Vectorsearch + workflows: + id: workflows:v00.00.00000 + name: workflows + preferred: true + service: + $ref: databricks_workspace/v00.00.00000/services/workflows.yaml + title: Workflows + version: v00.00.00000 + description: Workflows + workspace: + id: workspace:v00.00.00000 + name: workspace + preferred: true + service: + $ref: databricks_workspace/v00.00.00000/services/workspace.yaml + title: Workspace + version: v00.00.00000 + description: Workspace +config: + auth: + type: oauth2 + client_id_env_var: DATABRICKS_CLIENT_ID + client_secret_env_var: DATABRICKS_CLIENT_SECRET + grant_type: client_credentials + token_url: https://accounts.cloud.databricks.com/oidc/accounts/{{ .__env__DATABRICKS_ACCOUNT_ID + }}/v1/token + scopes: + - all-apis diff --git a/providers/src/databricks_workspace/v00.00.00000/services/apps.yaml b/providers/src/databricks_workspace/v00.00.00000/services/apps.yaml new file mode 100644 index 00000000..1277adac --- /dev/null +++ b/providers/src/databricks_workspace/v00.00.00000/services/apps.yaml @@ -0,0 +1,1854 @@ +openapi: 3.0.0 +info: + version: 2024-12-19-stackql-generated + contact: + name: StackQL Studios + url: https://stackql.io/ + email: info@stackql.io + title: Databricks Apps API + description: Apps +servers: +- url: https://{deployment_name}.cloud.databricks.com + variables: + deployment_name: + description: The Databricks Workspace Deployment Name + default: dbc-abcd0123-a1bc +paths: + /api/2.0/apps: + post: + operationId: apps-create + externalDocs: + url: https://docs.databricks.com/api/workspace/apps/create + x-stackQL-resource: apps + x-stackQL-method: create + x-stackQL-verb: insert + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: + type: string + compute_status: + type: object + properties: + state: + type: string + message: + type: string + app_status: + type: object + properties: + state: + type: string + message: + type: string + url: + type: string + active_deployment: + type: object + properties: + deployment_id: + type: string + source_code_path: + type: string + mode: + type: string + deployment_artifacts: + type: object + properties: + source_code_path: + type: string + status: + type: object + properties: + state: + type: string + message: + type: string + create_time: + type: string + creator: + type: string + update_time: + type: string + create_time: + type: string + creator: + type: string + update_time: + type: string + updater: + type: string + pending_deployment: + type: object + properties: + deployment_id: + type: string + source_code_path: + type: string + mode: + type: string + deployment_artifacts: + type: object + properties: + source_code_path: + type: string + status: + type: object + properties: + state: + type: string + message: + type: string + create_time: + type: string + creator: + type: string + update_time: + type: string + resources: + type: array + items: + type: object + properties: + name: + type: string + description: + type: string + secret: + type: object + properties: + scope: + type: string + key: + type: string + permission: + type: string + sql_warehouse: + type: object + properties: + id: + type: string + permission: + type: string + serving_endpoint: + type: object + properties: + name: + type: string + permission: + type: string + job: + type: object + properties: + id: + type: string + permission: + type: string + service_principal_id: + type: integer + service_principal_name: + type: string + default_source_code_path: + type: string + service_principal_client_id: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '409': + description: Request was rejected due a conflict with an existing resource. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: required + description: + type: string + resources: + type: Array of object + example: + name: my-custom-app + description: My app description. + resources: + - name: api-key + description: API key for external service. + secret: + scope: my-scope + key: my-key + permission: READ + sql_warehouse: + id: e9ca293f79a74b5c + permission: CAN_MANAGE + serving_endpoint: + name: databricks-meta-llama-3-1-70b-instruct + permission: CAN_MANAGE + job: + id: '1234' + permission: CAN_MANAGE + description: Creates a new app. + get: + operationId: apps-list + externalDocs: + url: https://docs.databricks.com/api/workspace/apps/list + x-stackQL-resource: apps + x-stackQL-method: list + x-stackQL-verb: select + x-numReqParams: 0 + parameters: + - name: page_token + in: query + - name: page_size + in: query + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + apps: + type: array + items: + type: object + properties: + name: + type: string + description: + type: string + compute_status: + type: object + properties: + state: + type: string + message: + type: string + app_status: + type: object + properties: + state: + type: string + message: + type: string + url: + type: string + active_deployment: + type: object + properties: + deployment_id: + type: string + source_code_path: + type: string + mode: + type: string + deployment_artifacts: + type: object + properties: + source_code_path: + type: string + status: + type: object + properties: + state: + type: string + message: + type: string + create_time: + type: string + creator: + type: string + update_time: + type: string + create_time: + type: string + creator: + type: string + update_time: + type: string + updater: + type: string + pending_deployment: + type: object + properties: + deployment_id: + type: string + source_code_path: + type: string + mode: + type: string + deployment_artifacts: + type: object + properties: + source_code_path: + type: string + status: + type: object + properties: + state: + type: string + message: + type: string + create_time: + type: string + creator: + type: string + update_time: + type: string + resources: + type: array + items: + type: object + properties: + name: + type: string + description: + type: string + secret: + type: object + properties: + scope: + type: string + key: + type: string + permission: + type: string + sql_warehouse: + type: object + properties: + id: + type: string + permission: + type: string + serving_endpoint: + type: object + properties: + name: + type: string + permission: + type: string + job: + type: object + properties: + id: + type: string + permission: + type: string + service_principal_id: + type: integer + service_principal_name: + type: string + default_source_code_path: + type: string + service_principal_client_id: + type: string + next_page_token: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '500': + description: Internal error. + x-stackQL-objectKey: $.apps + description: Lists all apps in the workspace. + /api/2.0/apps/{name}: + delete: + operationId: apps-delete + externalDocs: + url: https://docs.databricks.com/api/workspace/apps/delete + x-stackQL-resource: apps + x-stackQL-method: delete + x-stackQL-verb: delete + x-numReqParams: 1 + parameters: + - name: name + required: true + description: string + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: + type: string + compute_status: + type: object + properties: + state: + type: string + message: + type: string + app_status: + type: object + properties: + state: + type: string + message: + type: string + url: + type: string + active_deployment: + type: object + properties: + deployment_id: + type: string + source_code_path: + type: string + mode: + type: string + deployment_artifacts: + type: object + properties: + source_code_path: + type: string + status: + type: object + properties: + state: + type: string + message: + type: string + create_time: + type: string + creator: + type: string + update_time: + type: string + create_time: + type: string + creator: + type: string + update_time: + type: string + updater: + type: string + pending_deployment: + type: object + properties: + deployment_id: + type: string + source_code_path: + type: string + mode: + type: string + deployment_artifacts: + type: object + properties: + source_code_path: + type: string + status: + type: object + properties: + state: + type: string + message: + type: string + create_time: + type: string + creator: + type: string + update_time: + type: string + resources: + type: array + items: + type: object + properties: + name: + type: string + description: + type: string + secret: + type: object + properties: + scope: + type: string + key: + type: string + permission: + type: string + sql_warehouse: + type: object + properties: + id: + type: string + permission: + type: string + serving_endpoint: + type: object + properties: + name: + type: string + permission: + type: string + job: + type: object + properties: + id: + type: string + permission: + type: string + service_principal_id: + type: integer + service_principal_name: + type: string + default_source_code_path: + type: string + service_principal_client_id: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Deletes an app. + get: + operationId: apps-get + externalDocs: + url: https://docs.databricks.com/api/workspace/apps/get + x-stackQL-resource: apps + x-stackQL-method: get + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: name + required: true + description: string + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: + type: string + compute_status: + type: object + properties: + state: + type: string + message: + type: string + app_status: + type: object + properties: + state: + type: string + message: + type: string + url: + type: string + active_deployment: + type: object + properties: + deployment_id: + type: string + source_code_path: + type: string + mode: + type: string + deployment_artifacts: + type: object + properties: + source_code_path: + type: string + status: + type: object + properties: + state: + type: string + message: + type: string + create_time: + type: string + creator: + type: string + update_time: + type: string + create_time: + type: string + creator: + type: string + update_time: + type: string + updater: + type: string + pending_deployment: + type: object + properties: + deployment_id: + type: string + source_code_path: + type: string + mode: + type: string + deployment_artifacts: + type: object + properties: + source_code_path: + type: string + status: + type: object + properties: + state: + type: string + message: + type: string + create_time: + type: string + creator: + type: string + update_time: + type: string + resources: + type: array + items: + type: object + properties: + name: + type: string + description: + type: string + secret: + type: object + properties: + scope: + type: string + key: + type: string + permission: + type: string + sql_warehouse: + type: object + properties: + id: + type: string + permission: + type: string + serving_endpoint: + type: object + properties: + name: + type: string + permission: + type: string + job: + type: object + properties: + id: + type: string + permission: + type: string + service_principal_id: + type: integer + service_principal_name: + type: string + default_source_code_path: + type: string + service_principal_client_id: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Retrieves information for the app with the supplied name. + patch: + operationId: apps-update + externalDocs: + url: https://docs.databricks.com/api/workspace/apps/update + x-stackQL-resource: apps + x-stackQL-method: update + x-stackQL-verb: update + x-numReqParams: 1 + parameters: + - name: name + required: true + description: string + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: + type: string + compute_status: + type: object + properties: + state: + type: string + message: + type: string + app_status: + type: object + properties: + state: + type: string + message: + type: string + url: + type: string + active_deployment: + type: object + properties: + deployment_id: + type: string + source_code_path: + type: string + mode: + type: string + deployment_artifacts: + type: object + properties: + source_code_path: + type: string + status: + type: object + properties: + state: + type: string + message: + type: string + create_time: + type: string + creator: + type: string + update_time: + type: string + create_time: + type: string + creator: + type: string + update_time: + type: string + updater: + type: string + pending_deployment: + type: object + properties: + deployment_id: + type: string + source_code_path: + type: string + mode: + type: string + deployment_artifacts: + type: object + properties: + source_code_path: + type: string + status: + type: object + properties: + state: + type: string + message: + type: string + create_time: + type: string + creator: + type: string + update_time: + type: string + resources: + type: array + items: + type: object + properties: + name: + type: string + description: + type: string + secret: + type: object + properties: + scope: + type: string + key: + type: string + permission: + type: string + sql_warehouse: + type: object + properties: + id: + type: string + permission: + type: string + serving_endpoint: + type: object + properties: + name: + type: string + permission: + type: string + job: + type: object + properties: + id: + type: string + permission: + type: string + service_principal_id: + type: integer + service_principal_name: + type: string + default_source_code_path: + type: string + service_principal_client_id: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: required + description: + type: string + resources: + type: Array of object + example: + name: my-custom-app + description: My app description. + resources: + - name: api-key + description: API key for external service. + secret: + scope: my-scope + key: my-key + permission: READ + sql_warehouse: + id: e9ca293f79a74b5c + permission: CAN_MANAGE + serving_endpoint: + name: databricks-meta-llama-3-1-70b-instruct + permission: CAN_MANAGE + job: + id: '1234' + permission: CAN_MANAGE + description: Updates the app with the supplied name. + /api/2.0/apps/{app_name}/deployments: + post: + operationId: apps-deploy + externalDocs: + url: https://docs.databricks.com/api/workspace/apps/deploy + x-stackQL-resource: apps + x-stackQL-method: deploy + x-stackQL-verb: exec + x-numReqParams: 1 + parameters: + - name: app_name + required: true + description: string + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + deployment_id: + type: string + source_code_path: + type: string + mode: + type: string + deployment_artifacts: + type: object + properties: + source_code_path: + type: string + status: + type: object + properties: + state: + type: string + message: + type: string + create_time: + type: string + creator: + type: string + update_time: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + deployment_id: + type: string + source_code_path: + type: string + mode: + type: string + example: + deployment_id: 01ef0bda89f21f08a8351f41e4a9b948 + source_code_path: /Workspace/user@test.com/my_custom_app + mode: SNAPSHOT + description: Creates an app deployment for the app with the supplied name. + get: + operationId: deployments-listdeployments + externalDocs: + url: https://docs.databricks.com/api/workspace/apps/listdeployments + x-stackQL-resource: deployments + x-stackQL-method: listdeployments + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: app_name + required: true + description: string + in: path + - name: page_token + in: query + - name: page_size + in: query + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + app_deployments: + type: array + items: + type: object + properties: + deployment_id: + type: string + source_code_path: + type: string + mode: + type: string + deployment_artifacts: + type: object + properties: + source_code_path: + type: string + status: + type: object + properties: + state: + type: string + message: + type: string + create_time: + type: string + creator: + type: string + update_time: + type: string + next_page_token: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '500': + description: Internal error. + x-stackQL-objectKey: $.app_deployments + description: Lists all app deployments for the app with the supplied name. + /api/2.0/apps/{name}/start: + post: + operationId: apps-start + externalDocs: + url: https://docs.databricks.com/api/workspace/apps/start + x-stackQL-resource: apps + x-stackQL-method: start + x-stackQL-verb: exec + x-numReqParams: 1 + parameters: + - name: name + required: true + description: string + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: + type: string + compute_status: + type: object + properties: + state: + type: string + message: + type: string + app_status: + type: object + properties: + state: + type: string + message: + type: string + url: + type: string + active_deployment: + type: object + properties: + deployment_id: + type: string + source_code_path: + type: string + mode: + type: string + deployment_artifacts: + type: object + properties: + source_code_path: + type: string + status: + type: object + properties: + state: + type: string + message: + type: string + create_time: + type: string + creator: + type: string + update_time: + type: string + create_time: + type: string + creator: + type: string + update_time: + type: string + updater: + type: string + pending_deployment: + type: object + properties: + deployment_id: + type: string + source_code_path: + type: string + mode: + type: string + deployment_artifacts: + type: object + properties: + source_code_path: + type: string + status: + type: object + properties: + state: + type: string + message: + type: string + create_time: + type: string + creator: + type: string + update_time: + type: string + resources: + type: array + items: + type: object + properties: + name: + type: string + description: + type: string + secret: + type: object + properties: + scope: + type: string + key: + type: string + permission: + type: string + sql_warehouse: + type: object + properties: + id: + type: string + permission: + type: string + serving_endpoint: + type: object + properties: + name: + type: string + permission: + type: string + job: + type: object + properties: + id: + type: string + permission: + type: string + service_principal_id: + type: integer + service_principal_name: + type: string + default_source_code_path: + type: string + service_principal_client_id: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Start the last active deployment of the app in the workspace. + /api/2.0/apps/{name}/stop: + post: + operationId: apps-stop + externalDocs: + url: https://docs.databricks.com/api/workspace/apps/stop + x-stackQL-resource: apps + x-stackQL-method: stop + x-stackQL-verb: exec + x-numReqParams: 1 + parameters: + - name: name + required: true + description: string + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: + type: string + compute_status: + type: object + properties: + state: + type: string + message: + type: string + app_status: + type: object + properties: + state: + type: string + message: + type: string + url: + type: string + active_deployment: + type: object + properties: + deployment_id: + type: string + source_code_path: + type: string + mode: + type: string + deployment_artifacts: + type: object + properties: + source_code_path: + type: string + status: + type: object + properties: + state: + type: string + message: + type: string + create_time: + type: string + creator: + type: string + update_time: + type: string + create_time: + type: string + creator: + type: string + update_time: + type: string + updater: + type: string + pending_deployment: + type: object + properties: + deployment_id: + type: string + source_code_path: + type: string + mode: + type: string + deployment_artifacts: + type: object + properties: + source_code_path: + type: string + status: + type: object + properties: + state: + type: string + message: + type: string + create_time: + type: string + creator: + type: string + update_time: + type: string + resources: + type: array + items: + type: object + properties: + name: + type: string + description: + type: string + secret: + type: object + properties: + scope: + type: string + key: + type: string + permission: + type: string + sql_warehouse: + type: object + properties: + id: + type: string + permission: + type: string + serving_endpoint: + type: object + properties: + name: + type: string + permission: + type: string + job: + type: object + properties: + id: + type: string + permission: + type: string + service_principal_id: + type: integer + service_principal_name: + type: string + default_source_code_path: + type: string + service_principal_client_id: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Stops the active deployment of the app in the workspace. + /api/2.0/apps/{app_name}/deployments/{deployment_id}: + get: + operationId: deployments-getdeployment + externalDocs: + url: https://docs.databricks.com/api/workspace/apps/getdeployment + x-stackQL-resource: deployments + x-stackQL-method: getdeployment + x-stackQL-verb: select + x-numReqParams: 2 + parameters: + - name: app_name + required: true + description: string + in: path + - name: deployment_id + required: true + description: string + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + deployment_id: + type: string + source_code_path: + type: string + mode: + type: string + deployment_artifacts: + type: object + properties: + source_code_path: + type: string + status: + type: object + properties: + state: + type: string + message: + type: string + create_time: + type: string + creator: + type: string + update_time: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Retrieves information for the app deployment with the supplied + name and deployment id. + /api/2.0/permissions/apps/{app_name}: + get: + operationId: permissions-getpermissions + externalDocs: + url: https://docs.databricks.com/api/workspace/apps/getpermissions + x-stackQL-resource: permissions + x-stackQL-method: getpermissions + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: app_name + required: true + description: string + in: path + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + object_id: + type: string + object_type: + type: string + access_control_list: + type: array + items: + type: object + properties: + user_name: + type: string + group_name: + type: string + service_principal_name: + type: string + display_name: + type: string + all_permissions: + type: array + items: + type: object + properties: + permission_level: + type: string + inherited: + type: boolean + inherited_from_object: + type: array + items: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Gets the permissions of an app. Apps can inherit permissions from + their root object. + put: + operationId: permissions-setpermissions + externalDocs: + url: https://docs.databricks.com/api/workspace/apps/setpermissions + x-stackQL-resource: permissions + x-stackQL-method: setpermissions + x-stackQL-verb: replace + x-numReqParams: 1 + parameters: + - name: app_name + required: true + description: string + in: path + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + object_id: + type: string + object_type: + type: string + access_control_list: + type: array + items: + type: object + properties: + user_name: + type: string + group_name: + type: string + service_principal_name: + type: string + display_name: + type: string + all_permissions: + type: array + items: + type: object + properties: + permission_level: + type: string + inherited: + type: boolean + inherited_from_object: + type: array + items: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + access_control_list: + type: Array of object + example: + access_control_list: + - user_name: string + group_name: string + service_principal_name: string + permission_level: CAN_MANAGE + description: Sets permissions on an object, replacing existing permissions if + they exist. Deletes all direct permissions if none are specified. Objects + can inherit permissions from their root object. + patch: + operationId: permissions-updatepermissions + externalDocs: + url: https://docs.databricks.com/api/workspace/apps/updatepermissions + x-stackQL-resource: permissions + x-stackQL-method: updatepermissions + x-stackQL-verb: update + x-numReqParams: 1 + parameters: + - name: app_name + required: true + description: string + in: path + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + object_id: + type: string + object_type: + type: string + access_control_list: + type: array + items: + type: object + properties: + user_name: + type: string + group_name: + type: string + service_principal_name: + type: string + display_name: + type: string + all_permissions: + type: array + items: + type: object + properties: + permission_level: + type: string + inherited: + type: boolean + inherited_from_object: + type: array + items: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + access_control_list: + type: Array of object + example: + access_control_list: + - user_name: string + group_name: string + service_principal_name: string + permission_level: CAN_MANAGE + description: Updates the permissions on an app. Apps can inherit permissions + from their root object. + /api/2.0/permissions/apps/{app_name}/permissionLevels: + get: + operationId: permission-levels-getpermissionlevels + externalDocs: + url: https://docs.databricks.com/api/workspace/apps/getpermissionlevels + x-stackQL-resource: permission_levels + x-stackQL-method: getpermissionlevels + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: app_name + required: true + description: string + in: path + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + permission_levels: + type: array + items: + type: object + properties: + permission_level: + type: string + description: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + x-stackQL-objectKey: $.permission_levels + description: Gets the permission levels that a user can have on an object. +components: + x-stackQL-resources: + apps: + id: databricks_workspace.apps.apps + name: apps + title: Apps + methods: + create: + operation: + $ref: '#/paths/~1api~12.0~1apps/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1api~12.0~1apps/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.apps + delete: + operation: + $ref: '#/paths/~1api~12.0~1apps~1{name}/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1api~12.0~1apps~1{name}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: '#/paths/~1api~12.0~1apps~1{name}/patch' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + deploy: + operation: + $ref: '#/paths/~1api~12.0~1apps~1{app_name}~1deployments/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + start: + operation: + $ref: '#/paths/~1api~12.0~1apps~1{name}~1start/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + stop: + operation: + $ref: '#/paths/~1api~12.0~1apps~1{name}~1stop/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/apps/methods/get' + - $ref: '#/components/x-stackQL-resources/apps/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/apps/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/apps/methods/update' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/apps/methods/delete' + exec: + - $ref: '#/components/x-stackQL-resources/apps/methods/stop' + - $ref: '#/components/x-stackQL-resources/apps/methods/start' + - $ref: '#/components/x-stackQL-resources/apps/methods/deploy' + deployments: + id: databricks_workspace.apps.deployments + name: deployments + title: Deployments + methods: + listdeployments: + operation: + $ref: '#/paths/~1api~12.0~1apps~1{app_name}~1deployments/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.app_deployments + getdeployment: + operation: + $ref: '#/paths/~1api~12.0~1apps~1{app_name}~1deployments~1{deployment_id}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/deployments/methods/getdeployment' + - $ref: '#/components/x-stackQL-resources/deployments/methods/listdeployments' + insert: [] + update: [] + replace: [] + delete: [] + exec: [] + permissions: + id: databricks_workspace.apps.permissions + name: permissions + title: Permissions + methods: + getpermissions: + operation: + $ref: '#/paths/~1api~12.0~1permissions~1apps~1{app_name}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + setpermissions: + operation: + $ref: '#/paths/~1api~12.0~1permissions~1apps~1{app_name}/put' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + updatepermissions: + operation: + $ref: '#/paths/~1api~12.0~1permissions~1apps~1{app_name}/patch' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/permissions/methods/getpermissions' + insert: [] + update: + - $ref: '#/components/x-stackQL-resources/permissions/methods/updatepermissions' + replace: + - $ref: '#/components/x-stackQL-resources/permissions/methods/setpermissions' + delete: [] + exec: [] + permission_levels: + id: databricks_workspace.apps.permission_levels + name: permission_levels + title: Permission_levels + methods: + getpermissionlevels: + operation: + $ref: '#/paths/~1api~12.0~1permissions~1apps~1{app_name}~1permissionLevels/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.permission_levels + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/permission_levels/methods/getpermissionlevels' + insert: [] + update: [] + replace: [] + delete: [] + exec: [] diff --git a/providers/src/databricks_workspace/v00.00.00000/services/cleanrooms.yaml b/providers/src/databricks_workspace/v00.00.00000/services/cleanrooms.yaml new file mode 100644 index 00000000..5bcb6f2e --- /dev/null +++ b/providers/src/databricks_workspace/v00.00.00000/services/cleanrooms.yaml @@ -0,0 +1,1849 @@ +openapi: 3.0.0 +info: + version: 2024-12-19-stackql-generated + contact: + name: StackQL Studios + url: https://stackql.io/ + email: info@stackql.io + title: Databricks Cleanrooms API + description: Cleanrooms +servers: +- url: https://{deployment_name}.cloud.databricks.com + variables: + deployment_name: + description: The Databricks Workspace Deployment Name + default: dbc-abcd0123-a1bc +paths: + /api/2.0/clean-rooms/{clean_room_name}/assets: + post: + operationId: assets-create + externalDocs: + url: https://docs.databricks.com/api/workspace/cleanroomassets/create + x-stackQL-resource: assets + x-stackQL-method: create + x-stackQL-verb: insert + x-numReqParams: 1 + parameters: + - name: clean_room_name + required: true + description: string + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + name: + type: string + asset_type: + type: string + added_at: + type: integer + status: + type: string + owner_collaborator_alias: + type: string + table_local_details: + type: object + properties: + local_name: + type: string + partitions: + type: array + items: + type: object + properties: + values: + type: array + items: + type: object + properties: + name: + type: string + value: + type: string + recipient_property_key: + type: string + op: + type: string + volume_local_details: + type: object + properties: + local_name: + type: string + view_local_details: + type: object + properties: + local_name: + type: string + foreign_table_local_details: + type: object + properties: + local_name: + type: string + table: + type: object + properties: + columns: + type: array + items: + type: object + properties: + name: + type: string + type_text: + type: string + type_name: + type: string + position: + type: integer + type_precision: + type: integer + type_scale: + type: integer + type_interval_type: + type: string + type_json: + type: string + comment: + type: string + nullable: + type: boolean + partition_index: + type: integer + mask: + type: object + properties: + function_name: + type: string + using_column_names: + type: array + items: + type: string + notebook: + type: object + properties: + notebook_content: + type: string + etag: + type: string + view: + type: object + properties: + columns: + type: array + items: + type: object + properties: + name: + type: string + type_text: + type: string + type_name: + type: string + position: + type: integer + type_precision: + type: integer + type_scale: + type: integer + type_interval_type: + type: string + type_json: + type: string + comment: + type: string + nullable: + type: boolean + partition_index: + type: integer + mask: + type: object + properties: + function_name: + type: string + using_column_names: + type: array + items: + type: string + foreign_table: + type: object + properties: + columns: + type: array + items: + type: object + properties: + name: + type: string + type_text: + type: string + type_name: + type: string + position: + type: integer + type_precision: + type: integer + type_scale: + type: integer + type_interval_type: + type: string + type_json: + type: string + comment: + type: string + nullable: + type: boolean + partition_index: + type: integer + mask: + type: object + properties: + function_name: + type: string + using_column_names: + type: array + items: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: string + asset_type: + type: string + table_local_details: + type: object + volume_local_details: + type: object + view_local_details: + type: object + foreign_table_local_details: + type: object + table: + type: object + notebook: + type: object + view: + type: object + foreign_table: + type: object + example: + name: creator.sales.products + asset_type: TABLE + table_local_details: + local_name: demo.sales.products + partitions: + - values: + - name: string + value: string + recipient_property_key: string + op: EQUAL + volume_local_details: + local_name: demo.sales.products + view_local_details: + local_name: demo.sales.products + foreign_table_local_details: + local_name: demo.sales.products + table: + columns: + - name: string + type_text: string + type_name: BOOLEAN + position: 0 + type_precision: 0 + type_scale: 0 + type_interval_type: string + type_json: string + comment: string + nullable: true + partition_index: 0 + mask: + function_name: string + using_column_names: + - string + notebook: + notebook_content: string + etag: string + view: + columns: + - name: string + type_text: string + type_name: BOOLEAN + position: 0 + type_precision: 0 + type_scale: 0 + type_interval_type: string + type_json: string + comment: string + nullable: true + partition_index: 0 + mask: + function_name: string + using_column_names: + - string + foreign_table: + columns: + - name: string + type_text: string + type_name: BOOLEAN + position: 0 + type_precision: 0 + type_scale: 0 + type_interval_type: string + type_json: string + comment: string + nullable: true + partition_index: 0 + mask: + function_name: string + using_column_names: + - string + description: Metadata of the clean room asset + description: "Create a clean room asset \u2014share an asset like a notebook\ + \ or table into the clean room. For each UC asset that is added through this\ + \ method, the clean room owner must also have enough privilege on the asset\ + \ to consume it. The privilege must be maintained indefinitely for the clean\ + \ room to be able to access the asset. Typically, you should use a group as\ + \ the clean room owner." + get: + operationId: assets-list + externalDocs: + url: https://docs.databricks.com/api/workspace/cleanroomassets/list + x-stackQL-resource: assets + x-stackQL-method: list + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: clean_room_name + required: true + description: string + in: path + - name: page_token + in: query + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + assets: + type: array + items: + type: object + properties: + name: + type: string + asset_type: + type: string + added_at: + type: integer + status: + type: string + owner_collaborator_alias: + type: string + table_local_details: + type: object + properties: + local_name: + type: string + partitions: + type: array + items: + type: object + properties: + values: + type: array + items: + type: object + properties: + name: + type: string + value: + type: string + recipient_property_key: + type: string + op: + type: string + volume_local_details: + type: object + properties: + local_name: + type: string + view_local_details: + type: object + properties: + local_name: + type: string + foreign_table_local_details: + type: object + properties: + local_name: + type: string + table: + type: object + properties: + columns: + type: array + items: + type: object + properties: + name: + type: string + type_text: + type: string + type_name: + type: string + position: + type: integer + type_precision: + type: integer + type_scale: + type: integer + type_interval_type: + type: string + type_json: + type: string + comment: + type: string + nullable: + type: boolean + partition_index: + type: integer + mask: + type: object + properties: + function_name: + type: string + using_column_names: + type: array + items: + type: string + notebook: + type: object + properties: + notebook_content: + type: string + etag: + type: string + view: + type: object + properties: + columns: + type: array + items: + type: object + properties: + name: + type: string + type_text: + type: string + type_name: + type: string + position: + type: integer + type_precision: + type: integer + type_scale: + type: integer + type_interval_type: + type: string + type_json: + type: string + comment: + type: string + nullable: + type: boolean + partition_index: + type: integer + mask: + type: object + properties: + function_name: + type: string + using_column_names: + type: array + items: + type: string + foreign_table: + type: object + properties: + columns: + type: array + items: + type: object + properties: + name: + type: string + type_text: + type: string + type_name: + type: string + position: + type: integer + type_precision: + type: integer + type_scale: + type: integer + type_interval_type: + type: string + type_json: + type: string + comment: + type: string + nullable: + type: boolean + partition_index: + type: integer + mask: + type: object + properties: + function_name: + type: string + using_column_names: + type: array + items: + type: string + next_page_token: + type: string + x-stackQL-objectKey: $.assets + /api/2.0/clean-rooms/{clean_room_name}/assets/{asset_type}/{asset_full_name}: + delete: + operationId: assets-delete + externalDocs: + url: https://docs.databricks.com/api/workspace/cleanroomassets/delete + x-stackQL-resource: assets + x-stackQL-method: delete + x-stackQL-verb: delete + x-numReqParams: 3 + parameters: + - name: clean_room_name + required: true + description: string + in: path + - name: asset_type + required: true + description: string + in: path + - name: asset_full_name + required: true + description: string + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: {} + description: Delete a clean room asset - unshare/remove the asset from the clean + room + /api/2.0/clean-rooms/{clean_room_name}/assets/{asset_type}/{name}: + patch: + operationId: assets-update + externalDocs: + url: https://docs.databricks.com/api/workspace/cleanroomassets/update + x-stackQL-resource: assets + x-stackQL-method: update + x-stackQL-verb: update + x-numReqParams: 3 + parameters: + - name: clean_room_name + required: true + description: string + in: path + - name: asset_type + required: true + description: string + in: path + - name: name + required: true + description: string + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + name: + type: string + asset_type: + type: string + added_at: + type: integer + status: + type: string + owner_collaborator_alias: + type: string + table_local_details: + type: object + properties: + local_name: + type: string + partitions: + type: array + items: + type: object + properties: + values: + type: array + items: + type: object + properties: + name: + type: string + value: + type: string + recipient_property_key: + type: string + op: + type: string + volume_local_details: + type: object + properties: + local_name: + type: string + view_local_details: + type: object + properties: + local_name: + type: string + foreign_table_local_details: + type: object + properties: + local_name: + type: string + table: + type: object + properties: + columns: + type: array + items: + type: object + properties: + name: + type: string + type_text: + type: string + type_name: + type: string + position: + type: integer + type_precision: + type: integer + type_scale: + type: integer + type_interval_type: + type: string + type_json: + type: string + comment: + type: string + nullable: + type: boolean + partition_index: + type: integer + mask: + type: object + properties: + function_name: + type: string + using_column_names: + type: array + items: + type: string + notebook: + type: object + properties: + notebook_content: + type: string + etag: + type: string + view: + type: object + properties: + columns: + type: array + items: + type: object + properties: + name: + type: string + type_text: + type: string + type_name: + type: string + position: + type: integer + type_precision: + type: integer + type_scale: + type: integer + type_interval_type: + type: string + type_json: + type: string + comment: + type: string + nullable: + type: boolean + partition_index: + type: integer + mask: + type: object + properties: + function_name: + type: string + using_column_names: + type: array + items: + type: string + foreign_table: + type: object + properties: + columns: + type: array + items: + type: object + properties: + name: + type: string + type_text: + type: string + type_name: + type: string + position: + type: integer + type_precision: + type: integer + type_scale: + type: integer + type_interval_type: + type: string + type_json: + type: string + comment: + type: string + nullable: + type: boolean + partition_index: + type: integer + mask: + type: object + properties: + function_name: + type: string + using_column_names: + type: array + items: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: string + asset_type: + type: string + table_local_details: + type: object + volume_local_details: + type: object + view_local_details: + type: object + foreign_table_local_details: + type: object + table: + type: object + notebook: + type: object + view: + type: object + foreign_table: + type: object + example: + name: creator.sales.products + asset_type: TABLE + table_local_details: + local_name: demo.sales.products + partitions: + - values: + - name: string + value: string + recipient_property_key: string + op: EQUAL + volume_local_details: + local_name: demo.sales.products + view_local_details: + local_name: demo.sales.products + foreign_table_local_details: + local_name: demo.sales.products + table: + columns: + - name: string + type_text: string + type_name: BOOLEAN + position: 0 + type_precision: 0 + type_scale: 0 + type_interval_type: string + type_json: string + comment: string + nullable: true + partition_index: 0 + mask: + function_name: string + using_column_names: + - string + notebook: + notebook_content: string + etag: string + view: + columns: + - name: string + type_text: string + type_name: BOOLEAN + position: 0 + type_precision: 0 + type_scale: 0 + type_interval_type: string + type_json: string + comment: string + nullable: true + partition_index: 0 + mask: + function_name: string + using_column_names: + - string + foreign_table: + columns: + - name: string + type_text: string + type_name: BOOLEAN + position: 0 + type_precision: 0 + type_scale: 0 + type_interval_type: string + type_json: string + comment: string + nullable: true + partition_index: 0 + mask: + function_name: string + using_column_names: + - string + description: Metadata of the clean room asset + description: Update a clean room asset. For example, updating the content of + a notebook; changing the shared partitions of a table; etc. + /api/2.0/clean-rooms: + post: + operationId: clean-rooms-create + externalDocs: + url: https://docs.databricks.com/api/workspace/cleanrooms/create + x-stackQL-resource: clean_rooms + x-stackQL-method: create + x-stackQL-verb: insert + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + name: + type: string + remote_detailed_info: + type: object + properties: + central_clean_room_id: + type: string + cloud_vendor: + type: string + region: + type: string + collaborators: + type: array + items: + type: object + properties: + global_metastore_id: + type: string + organization_name: + type: string + invite_recipient_workspace_id: + type: integer + invite_recipient_email: + type: string + collaborator_alias: + type: string + display_name: + type: string + creator: + type: object + properties: + global_metastore_id: + type: string + organization_name: + type: string + invite_recipient_workspace_id: + type: integer + invite_recipient_email: + type: string + collaborator_alias: + type: string + display_name: + type: string + egress_network_policy: + type: object + properties: + internet_access: + type: object + properties: + restriction_mode: + type: string + allowed_internet_destinations: + type: array + items: + type: object + properties: + destination: + type: string + type: + type: string + protocol: + type: string + allowed_storage_destinations: + type: array + items: + type: object + properties: + bucket_name: + type: string + region: + type: string + type: + type: string + azure_storage_account: + type: string + allowed_paths: + type: array + items: + type: string + azure_storage_service: + type: string + azure_dns_zone: + type: string + azure_container: + type: string + log_only_mode: + type: object + properties: + log_only_mode_type: + type: string + workloads: + type: array + items: + type: string + compliance_security_profile: + type: object + properties: + is_enabled: + type: boolean + compliance_standards: + type: array + items: + type: string + owner: + type: string + comment: + type: string + created_at: + type: integer + updated_at: + type: integer + status: + type: string + local_collaborator_alias: + type: string + output_catalog: + type: object + properties: + status: + type: string + catalog_name: + type: string + access_restricted: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: string + owner: + type: string + comment: + type: string + remote_detailed_info: + type: object + example: + name: test-clean-room1 + remote_detailed_info: + central_clean_room_id: b5c8d856-ff41-4c5f-8ccd-2b13b44fec27 + cloud_vendor: aws + region: us-west-2 + collaborators: + - global_metastore_id: aws:us-west-2:aff56c64-a34e-4c1f-a24c-c2dd2889517a + organization_name: acme corporation + invite_recipient_workspace_id: 6822898386300992 + invite_recipient_email: john.doe@databricks.com + collaborator_alias: creator + display_name: acme corporation + creator: + global_metastore_id: aws:us-west-2:aff56c64-a34e-4c1f-a24c-c2dd2889517a + organization_name: acme corporation + invite_recipient_workspace_id: 6822898386300992 + invite_recipient_email: john.doe@databricks.com + collaborator_alias: creator + display_name: acme corporation + egress_network_policy: + internet_access: + restriction_mode: FULL_ACCESS + allowed_internet_destinations: + - destination: string + type: FQDN + protocol: TCP + allowed_storage_destinations: + - bucket_name: string + region: string + type: AWS_S3 + azure_storage_account: string + allowed_paths: + - string + azure_storage_service: string + azure_dns_zone: string + azure_container: string + log_only_mode: + log_only_mode_type: ALL_SERVICES + workloads: + - DBSQL + compliance_security_profile: + is_enabled: true + compliance_standards: + - NONE + owner: alice@example.com + comment: This is a clean room for demo + description: Create a new clean room with the specified collaborators. This + method is asynchronous; the returned name field inside the clean_room field + can be used to poll the clean room status, using the + get: + operationId: clean-rooms-list + externalDocs: + url: https://docs.databricks.com/api/workspace/cleanrooms/list + x-stackQL-resource: clean_rooms + x-stackQL-method: list + x-stackQL-verb: select + x-numReqParams: 0 + parameters: + - name: page_size + in: query + - name: page_token + in: query + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + clean_rooms: + type: array + items: + type: object + properties: + name: + type: string + remote_detailed_info: + type: object + properties: + central_clean_room_id: + type: string + cloud_vendor: + type: string + region: + type: string + collaborators: + type: array + items: + type: object + properties: + global_metastore_id: + type: string + organization_name: + type: string + invite_recipient_workspace_id: + type: integer + invite_recipient_email: + type: string + collaborator_alias: + type: string + display_name: + type: string + creator: + type: object + properties: + global_metastore_id: + type: string + organization_name: + type: string + invite_recipient_workspace_id: + type: integer + invite_recipient_email: + type: string + collaborator_alias: + type: string + display_name: + type: string + egress_network_policy: + type: object + properties: + internet_access: + type: object + properties: + restriction_mode: + type: string + allowed_internet_destinations: + type: array + items: + type: object + properties: + destination: + type: string + type: + type: string + protocol: + type: string + allowed_storage_destinations: + type: array + items: + type: object + properties: + bucket_name: + type: string + region: + type: string + type: + type: string + azure_storage_account: + type: string + allowed_paths: + type: array + items: + type: string + azure_storage_service: + type: string + azure_dns_zone: + type: string + azure_container: + type: string + log_only_mode: + type: object + properties: + log_only_mode_type: + type: string + workloads: + type: array + items: + type: string + compliance_security_profile: + type: object + properties: + is_enabled: + type: boolean + compliance_standards: + type: array + items: + type: string + owner: + type: string + comment: + type: string + created_at: + type: integer + updated_at: + type: integer + status: + type: string + local_collaborator_alias: + type: string + output_catalog: + type: object + properties: + status: + type: string + catalog_name: + type: string + access_restricted: + type: string + next_page_token: + type: string + x-stackQL-objectKey: $.clean_rooms + description: Get a list of all clean rooms of the metastore. Only clean rooms + the caller has access to are returned. + /api/2.0/clean-rooms/{name}: + delete: + operationId: clean-rooms-delete + externalDocs: + url: https://docs.databricks.com/api/workspace/cleanrooms/delete + x-stackQL-resource: clean_rooms + x-stackQL-method: delete + x-stackQL-verb: delete + x-numReqParams: 1 + parameters: + - name: name + required: true + description: string + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: {} + description: Delete a clean room. After deletion, the clean room will be removed + from the metastore. If the other collaborators have not deleted the clean + room, they will still have the clean room in their metastore, but it will + be in a DELETED state and no operations other than deletion can be performed + on it. + get: + operationId: clean-rooms-get + externalDocs: + url: https://docs.databricks.com/api/workspace/cleanrooms/get + x-stackQL-resource: clean_rooms + x-stackQL-method: get + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: name + required: true + description: string + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + name: + type: string + remote_detailed_info: + type: object + properties: + central_clean_room_id: + type: string + cloud_vendor: + type: string + region: + type: string + collaborators: + type: array + items: + type: object + properties: + global_metastore_id: + type: string + organization_name: + type: string + invite_recipient_workspace_id: + type: integer + invite_recipient_email: + type: string + collaborator_alias: + type: string + display_name: + type: string + creator: + type: object + properties: + global_metastore_id: + type: string + organization_name: + type: string + invite_recipient_workspace_id: + type: integer + invite_recipient_email: + type: string + collaborator_alias: + type: string + display_name: + type: string + egress_network_policy: + type: object + properties: + internet_access: + type: object + properties: + restriction_mode: + type: string + allowed_internet_destinations: + type: array + items: + type: object + properties: + destination: + type: string + type: + type: string + protocol: + type: string + allowed_storage_destinations: + type: array + items: + type: object + properties: + bucket_name: + type: string + region: + type: string + type: + type: string + azure_storage_account: + type: string + allowed_paths: + type: array + items: + type: string + azure_storage_service: + type: string + azure_dns_zone: + type: string + azure_container: + type: string + log_only_mode: + type: object + properties: + log_only_mode_type: + type: string + workloads: + type: array + items: + type: string + compliance_security_profile: + type: object + properties: + is_enabled: + type: boolean + compliance_standards: + type: array + items: + type: string + owner: + type: string + comment: + type: string + created_at: + type: integer + updated_at: + type: integer + status: + type: string + local_collaborator_alias: + type: string + output_catalog: + type: object + properties: + status: + type: string + catalog_name: + type: string + access_restricted: + type: string + description: Get the details of a clean room given its name. + patch: + operationId: clean-rooms-update + externalDocs: + url: https://docs.databricks.com/api/workspace/cleanrooms/update + x-stackQL-resource: clean_rooms + x-stackQL-method: update + x-stackQL-verb: update + x-numReqParams: 1 + parameters: + - name: name + required: true + description: string + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + name: + type: string + remote_detailed_info: + type: object + properties: + central_clean_room_id: + type: string + cloud_vendor: + type: string + region: + type: string + collaborators: + type: array + items: + type: object + properties: + global_metastore_id: + type: string + organization_name: + type: string + invite_recipient_workspace_id: + type: integer + invite_recipient_email: + type: string + collaborator_alias: + type: string + display_name: + type: string + creator: + type: object + properties: + global_metastore_id: + type: string + organization_name: + type: string + invite_recipient_workspace_id: + type: integer + invite_recipient_email: + type: string + collaborator_alias: + type: string + display_name: + type: string + egress_network_policy: + type: object + properties: + internet_access: + type: object + properties: + restriction_mode: + type: string + allowed_internet_destinations: + type: array + items: + type: object + properties: + destination: + type: string + type: + type: string + protocol: + type: string + allowed_storage_destinations: + type: array + items: + type: object + properties: + bucket_name: + type: string + region: + type: string + type: + type: string + azure_storage_account: + type: string + allowed_paths: + type: array + items: + type: string + azure_storage_service: + type: string + azure_dns_zone: + type: string + azure_container: + type: string + log_only_mode: + type: object + properties: + log_only_mode_type: + type: string + workloads: + type: array + items: + type: string + compliance_security_profile: + type: object + properties: + is_enabled: + type: boolean + compliance_standards: + type: array + items: + type: string + owner: + type: string + comment: + type: string + created_at: + type: integer + updated_at: + type: integer + status: + type: string + local_collaborator_alias: + type: string + output_catalog: + type: object + properties: + status: + type: string + catalog_name: + type: string + access_restricted: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + clean_room: + type: object + example: + clean_room: + name: test-clean-room1 + remote_detailed_info: + central_clean_room_id: b5c8d856-ff41-4c5f-8ccd-2b13b44fec27 + cloud_vendor: aws + region: us-west-2 + collaborators: + - global_metastore_id: aws:us-west-2:aff56c64-a34e-4c1f-a24c-c2dd2889517a + organization_name: acme corporation + invite_recipient_workspace_id: 6822898386300992 + invite_recipient_email: john.doe@databricks.com + collaborator_alias: creator + display_name: acme corporation + creator: + global_metastore_id: aws:us-west-2:aff56c64-a34e-4c1f-a24c-c2dd2889517a + organization_name: acme corporation + invite_recipient_workspace_id: 6822898386300992 + invite_recipient_email: john.doe@databricks.com + collaborator_alias: creator + display_name: acme corporation + egress_network_policy: + internet_access: + restriction_mode: FULL_ACCESS + allowed_internet_destinations: + - destination: string + type: FQDN + protocol: TCP + allowed_storage_destinations: + - bucket_name: string + region: string + type: AWS_S3 + azure_storage_account: string + allowed_paths: + - string + azure_storage_service: string + azure_dns_zone: string + azure_container: string + log_only_mode: + log_only_mode_type: ALL_SERVICES + workloads: + - DBSQL + compliance_security_profile: + is_enabled: true + compliance_standards: + - NONE + owner: alice@example.com + comment: This is a clean room for demo + created_at: 1716424663321 + updated_at: 1716424663321 + status: ACTIVE + local_collaborator_alias: creator + output_catalog: + status: NOT_ELIGIBLE + catalog_name: string + access_restricted: NO_RESTRICTION + description: Update a clean room. The caller must be the owner of the clean + room, have + /api/2.0/clean-rooms/{clean_room_name}/output-catalogs: + post: + operationId: output-catalog-createoutputcatalog + externalDocs: + url: https://docs.databricks.com/api/workspace/cleanrooms/createoutputcatalog + x-stackQL-resource: output_catalog + x-stackQL-method: createoutputcatalog + x-stackQL-verb: insert + x-numReqParams: 1 + parameters: + - name: clean_room_name + required: true + description: string + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + output_catalog: + type: object + properties: + status: + type: string + catalog_name: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + catalog_name: + type: string + example: + catalog_name: string + description: Create the output catalog of the clean room. + /api/2.0/clean-rooms/{clean_room_name}/runs: + get: + operationId: task-runs-list + externalDocs: + url: https://docs.databricks.com/api/workspace/cleanroomtaskruns/list + x-stackQL-resource: task_runs + x-stackQL-method: list + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: clean_room_name + required: true + description: string + in: path + - name: notebook_name + in: query + - name: page_size + in: query + - name: page_token + in: query + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + runs: + type: array + items: + type: object + properties: + notebook_name: + type: string + start_time: + type: integer + run_duration: + type: integer + notebook_job_run_state: + type: object + properties: + life_cycle_state: + type: string + result_state: + type: string + collaborator_job_run_info: + type: object + properties: + collaborator_job_id: + type: integer + collaborator_job_run_id: + type: integer + collaborator_task_run_id: + type: integer + collaborator_workspace_id: + type: integer + collaborator_alias: + type: string + output_schema_name: + type: string + output_schema_expiration_time: + type: integer + next_page_token: + type: string + x-stackQL-objectKey: $.runs + description: List all the historical notebook task runs in a clean room. +components: + x-stackQL-resources: + assets: + id: databricks_workspace.cleanrooms.assets + name: assets + title: Assets + methods: + create: + operation: + $ref: '#/paths/~1api~12.0~1clean-rooms~1{clean_room_name}~1assets/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1api~12.0~1clean-rooms~1{clean_room_name}~1assets/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.assets + delete: + operation: + $ref: '#/paths/~1api~12.0~1clean-rooms~1{clean_room_name}~1assets~1{asset_type}~1{asset_full_name}/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: '#/paths/~1api~12.0~1clean-rooms~1{clean_room_name}~1assets~1{asset_type}~1{name}/patch' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/assets/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/assets/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/assets/methods/update' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/assets/methods/delete' + exec: [] + clean_rooms: + id: databricks_workspace.cleanrooms.clean_rooms + name: clean_rooms + title: Clean_rooms + methods: + create: + operation: + $ref: '#/paths/~1api~12.0~1clean-rooms/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1api~12.0~1clean-rooms/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.clean_rooms + delete: + operation: + $ref: '#/paths/~1api~12.0~1clean-rooms~1{name}/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1api~12.0~1clean-rooms~1{name}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: '#/paths/~1api~12.0~1clean-rooms~1{name}/patch' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/clean_rooms/methods/get' + - $ref: '#/components/x-stackQL-resources/clean_rooms/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/clean_rooms/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/clean_rooms/methods/update' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/clean_rooms/methods/delete' + exec: [] + output_catalog: + id: databricks_workspace.cleanrooms.output_catalog + name: output_catalog + title: Output_catalog + methods: + createoutputcatalog: + operation: + $ref: '#/paths/~1api~12.0~1clean-rooms~1{clean_room_name}~1output-catalogs/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: '#/components/x-stackQL-resources/output_catalog/methods/createoutputcatalog' + update: [] + replace: [] + delete: [] + exec: [] + task_runs: + id: databricks_workspace.cleanrooms.task_runs + name: task_runs + title: Task_runs + methods: + list: + operation: + $ref: '#/paths/~1api~12.0~1clean-rooms~1{clean_room_name}~1runs/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.runs + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/task_runs/methods/list' + insert: [] + update: [] + replace: [] + delete: [] + exec: [] diff --git a/providers/src/databricks_workspace/v00.00.00000/services/compute.yaml b/providers/src/databricks_workspace/v00.00.00000/services/compute.yaml new file mode 100644 index 00000000..b4499f14 --- /dev/null +++ b/providers/src/databricks_workspace/v00.00.00000/services/compute.yaml @@ -0,0 +1,4609 @@ +openapi: 3.0.0 +info: + version: 2024-12-19-stackql-generated + contact: + name: StackQL Studios + url: https://stackql.io/ + email: info@stackql.io + title: Databricks Compute API + description: Compute +servers: +- url: https://{deployment_name}.cloud.databricks.com + variables: + deployment_name: + description: The Databricks Workspace Deployment Name + default: dbc-abcd0123-a1bc +paths: + /api/2.0/policies/clusters/list-compliance: + get: + operationId: all-clusters-policy-compliance-listcompliance + externalDocs: + url: https://docs.databricks.com/api/workspace/policycomplianceforclusters/listcompliance + x-stackQL-resource: all_clusters_policy_compliance + x-stackQL-method: listcompliance + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: policy_id + required: true + description: string + in: query + - name: page_token + in: query + - name: page_size + in: query + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + clusters: + type: array + items: + type: object + properties: + cluster_id: + type: string + is_compliant: + type: boolean + violations: + type: object + properties: + custom_tags.test_tag: + type: string + next_page_token: + type: string + prev_page_token: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '429': + description: Operation is rejected due to throttling, e.g. some resource + has been exhausted, per-user quota. + '500': + description: Internal error. + x-stackQL-objectKey: $.clusters + description: Returns the policy compliance status of all clusters that use a + given policy. Clusters could be out of compliance if their policy was updated + after the cluster was last edited. + /api/2.1/clusters/change-owner: + post: + operationId: clusters-changeowner + externalDocs: + url: https://docs.databricks.com/api/workspace/clusters/changeowner + x-stackQL-resource: clusters + x-stackQL-method: changeowner + x-stackQL-verb: exec + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + cluster_id: + type: required + owner_username: + type: string + example: + cluster_id: string + owner_username: string + description: Change the owner of the cluster. You must be an admin and the cluster + must be terminated to perform this operation. The service principal application + ID can be supplied as an argument to + /api/2.1/clusters/create: + post: + operationId: clusters-create + externalDocs: + url: https://docs.databricks.com/api/workspace/clusters/create + x-stackQL-resource: clusters + x-stackQL-method: create + x-stackQL-verb: insert + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + cluster_id: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + num_workers: + type: int32 + kind: + type: string + cluster_name: + type: string + spark_version: + type: required + use_ml_runtime: + type: string + is_single_node: + type: boolean + node_type_id: + type: boolean + driver_node_type_id: + type: string + ssh_public_keys: + type: string + autotermination_minutes: + type: Array of string + enable_elastic_disk: + type: int32 + instance_pool_id: + type: boolean + policy_id: + type: string + enable_local_disk_encryption: + type: string + driver_instance_pool_id: + type: boolean + runtime_engine: + type: string + data_security_mode: + type: string + single_user_name: + type: string + apply_policy_default_values: + type: string + autoscale: + type: object + spark_conf: + type: object + aws_attributes: + type: object + custom_tags: + type: object + cluster_log_conf: + type: object + init_scripts: + type: Array of object + spark_env_vars: + type: object + workload_type: + type: object + docker_image: + type: object + clone_from: + type: object + example: + cluster_name: single-node-with-kind-cluster + is_single_node: true + kind: CLASSIC_PREVIEW + spark_version: 14.3.x-scala2.12 + node_type_id: i3.xlarge + aws_attributes: + first_on_demand: 1 + availability: SPOT_WITH_FALLBACK + zone_id: auto + spot_bid_price_percent: 100 + ebs_volume_count: 0 + description: Creates a new Spark cluster. This method will acquire new instances + from the cloud provider if necessary. This method is asynchronous; the returned + /api/2.1/clusters/delete: + post: + operationId: clusters-delete + externalDocs: + url: https://docs.databricks.com/api/workspace/clusters/delete + x-stackQL-resource: clusters + x-stackQL-method: delete + x-stackQL-verb: delete + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + cluster_id: + type: required + example: + cluster_id: 1234-567890-frays123 + description: Terminates the Spark cluster with the specified ID. The cluster + is removed asynchronously. Once the termination has completed, the cluster + will be in a + /api/2.1/clusters/edit: + post: + operationId: clusters-edit + externalDocs: + url: https://docs.databricks.com/api/workspace/clusters/edit + x-stackQL-resource: clusters + x-stackQL-method: edit + x-stackQL-verb: replace + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + cluster_id: + type: required + num_workers: + type: string + kind: + type: int32 + cluster_name: + type: string + spark_version: + type: string + use_ml_runtime: + type: required + is_single_node: + type: string + node_type_id: + type: boolean + driver_node_type_id: + type: boolean + ssh_public_keys: + type: string + autotermination_minutes: + type: string + enable_elastic_disk: + type: Array of string + instance_pool_id: + type: int32 + policy_id: + type: boolean + enable_local_disk_encryption: + type: string + driver_instance_pool_id: + type: string + runtime_engine: + type: boolean + data_security_mode: + type: string + single_user_name: + type: string + apply_policy_default_values: + type: string + autoscale: + type: object + spark_conf: + type: object + aws_attributes: + type: object + custom_tags: + type: object + cluster_log_conf: + type: object + init_scripts: + type: Array of object + spark_env_vars: + type: object + workload_type: + type: object + docker_image: + type: object + example: + cluster_id: 1202-211320-brick1 + num_workers: 10 + spark_version: 3.3.x-scala2.11 + node_type_id: i3.2xlarge + description: Updates the configuration of a cluster to match the provided attributes + and size. A cluster can be updated if it is in a + /api/2.1/clusters/get: + get: + operationId: clusters-get + externalDocs: + url: https://docs.databricks.com/api/workspace/clusters/get + x-stackQL-resource: clusters + x-stackQL-method: get + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: cluster_id + required: true + description: string + in: query + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + cluster_id: + type: string + spark_context_id: + type: integer + cluster_name: + type: string + spark_version: + type: string + aws_attributes: + type: object + properties: + zone_id: + type: string + first_on_demand: + type: integer + availability: + type: string + spot_bid_price_percent: + type: integer + ebs_volume_count: + type: integer + node_type_id: + type: string + driver_node_type_id: + type: string + autotermination_minutes: + type: integer + enable_elastic_disk: + type: boolean + disk_spec: + type: object + properties: + disk_count: + type: integer + cluster_source: + type: string + enable_local_disk_encryption: + type: boolean + instance_source: + type: object + properties: + node_type_id: + type: string + driver_instance_source: + type: object + properties: + node_type_id: + type: string + state: + type: string + state_message: + type: string + start_time: + type: integer + terminated_time: + type: integer + last_state_loss_time: + type: integer + num_workers: + type: integer + default_tags: + type: object + properties: + Vendor: + type: string + Creator: + type: string + ClusterName: + type: string + ClusterId: + type: string + creator_user_name: + type: string + termination_reason: + type: object + properties: + code: + type: string + parameters: + type: object + properties: + inactivity_duration_min: + type: string + type: + type: string + init_scripts_safe_mode: + type: boolean + spec: + type: object + properties: + spark_version: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Retrieves the information for a cluster given its identifier. Clusters + can be described while they are running, or up to 60 days after they are terminated. + /api/2.1/clusters/list: + get: + operationId: clusters-list + externalDocs: + url: https://docs.databricks.com/api/workspace/clusters/list + x-stackQL-resource: clusters + x-stackQL-method: list + x-stackQL-verb: select + x-numReqParams: 0 + parameters: + - name: page_token + in: query + - name: page_size + in: query + - name: null + in: query + - name: null + in: query + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + clusters: + type: array + items: + type: object + properties: + cluster_id: + type: string + spark_context_id: + type: integer + cluster_name: + type: string + spark_version: + type: string + aws_attributes: + type: object + properties: + zone_id: + type: string + first_on_demand: + type: integer + availability: + type: string + spot_bid_price_percent: + type: integer + ebs_volume_count: + type: integer + node_type_id: + type: string + driver_node_type_id: + type: string + autotermination_minutes: + type: integer + enable_elastic_disk: + type: boolean + disk_spec: + type: object + properties: + disk_count: + type: integer + cluster_source: + type: string + enable_local_disk_encryption: + type: boolean + instance_source: + type: object + properties: + node_type_id: + type: string + driver_instance_source: + type: object + properties: + node_type_id: + type: string + state: + type: string + state_message: + type: string + start_time: + type: integer + terminated_time: + type: integer + last_state_loss_time: + type: integer + num_workers: + type: integer + default_tags: + type: object + properties: + Vendor: + type: string + Creator: + type: string + ClusterName: + type: string + ClusterId: + type: string + creator_user_name: + type: string + termination_reason: + type: object + properties: + code: + type: string + parameters: + type: object + properties: + inactivity_duration_min: + type: string + type: + type: string + init_scripts_safe_mode: + type: boolean + prev_page_token: + type: string + next_page_token: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '500': + description: Internal error. + x-stackQL-objectKey: $.clusters + description: Return information about all pinned and active clusters, and all + clusters terminated within the last 30 days. Clusters terminated prior to + this period are not included. + /api/2.1/clusters/permanent-delete: + post: + operationId: clusters-permanentdelete + externalDocs: + url: https://docs.databricks.com/api/workspace/clusters/permanentdelete + x-stackQL-resource: clusters + x-stackQL-method: permanentdelete + x-stackQL-verb: exec + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + cluster_id: + type: required + example: + cluster_id: 1202-211320-brick1 + description: Permanently deletes a Spark cluster. This cluster is terminated + and resources are asynchronously removed. + /api/2.1/clusters/pin: + post: + operationId: clusters-pin + externalDocs: + url: https://docs.databricks.com/api/workspace/clusters/pin + x-stackQL-resource: clusters + x-stackQL-method: pin + x-stackQL-verb: exec + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + cluster_id: + type: required + example: + cluster_id: 1234-567890-reef123 + description: Pinning a cluster ensures that the cluster will always be returned + by the ListClusters API. Pinning a cluster that is already pinned will have + no effect. This API can only be called by workspace admins. + /api/2.1/clusters/resize: + post: + operationId: clusters-resize + externalDocs: + url: https://docs.databricks.com/api/workspace/clusters/resize + x-stackQL-resource: clusters + x-stackQL-method: resize + x-stackQL-verb: exec + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + num_workers: + type: int32 + cluster_id: + type: required + autoscale: + type: object + example: + cluster_id: 1202-211320-brick1 + num_workers: 30 + description: Resizes a cluster to have a desired number of workers. This will + fail unless the cluster is in a + /api/2.1/clusters/restart: + post: + operationId: clusters-restart + externalDocs: + url: https://docs.databricks.com/api/workspace/clusters/restart + x-stackQL-resource: clusters + x-stackQL-method: restart + x-stackQL-verb: exec + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + cluster_id: + type: required + restart_user: + type: string + example: + cluster_id: 1202-211320-brick1 + description: Restarts a Spark cluster with the supplied ID. If the cluster is + not currently in a + /api/2.1/clusters/start: + post: + operationId: clusters-start + externalDocs: + url: https://docs.databricks.com/api/workspace/clusters/start + x-stackQL-resource: clusters + x-stackQL-method: start + x-stackQL-verb: exec + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + cluster_id: + type: required + example: + cluster_id: 1202-211320-brick1 + description: Starts a terminated Spark cluster with the supplied ID. This works + similar to + /api/2.1/clusters/unpin: + post: + operationId: clusters-unpin + externalDocs: + url: https://docs.databricks.com/api/workspace/clusters/unpin + x-stackQL-resource: clusters + x-stackQL-method: unpin + x-stackQL-verb: exec + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + cluster_id: + type: required + example: + cluster_id: 1234-567890-reef123 + description: Unpinning a cluster will allow the cluster to eventually be removed + from the ListClusters API. Unpinning a cluster that is not pinned will have + no effect. This API can only be called by workspace admins. + /api/2.1/clusters/update: + post: + operationId: clusters-update + externalDocs: + url: https://docs.databricks.com/api/workspace/clusters/update + x-stackQL-resource: clusters + x-stackQL-method: update + x-stackQL-verb: update + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + cluster_id: + type: required + update_mask: + type: string + cluster: + type: object + example: + cluster_id: 1202-211320-brick1 + cluster: + num_workers: 10 + spark_version: 14.3.x-scala2.12 + spark_conf: + spark.databricks.cluster.profile: singleNode + spark.master: '[*, 4]' + update_mask: num_workers,spark_version,spark_conf + description: Updates the configuration of a cluster to match the partial set + of attributes and size. Denote which fields to update using the + /api/2.1/clusters/events: + post: + operationId: cluster-events-events + externalDocs: + url: https://docs.databricks.com/api/workspace/clusters/events + x-stackQL-resource: cluster_events + x-stackQL-method: events + x-stackQL-verb: select + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + events: + type: array + items: + type: object + properties: + cluster_id: + type: string + timestamp: + type: integer + event_type: + type: string + event_details: + type: object + properties: + username: + type: string + next_page: + type: object + properties: + cluster_id: + type: string + end_time: + type: integer + order: + type: string + offset: + type: integer + total_count: + type: integer + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + cluster_id: + type: required + start_time: + type: string + end_time: + type: integer + format: int64 + order: + type: integer + format: int64 + event_types: + type: string + offset: + type: Array of string + limit: + type: integer + format: int64 + example: + start_time: 1617238800000 + end_time: 1619485200000 + offset: 5 + order: DESC + event_types: + - RUNNING + cluster_id: 1234-567890-reef123 + limit: 5 + description: Retrieves a list of events about the activity of a cluster. This + API is paginated. If there are more events to read, the response includes + all the nparameters necessary to request the next page of events. + /api/2.0/permissions/clusters/{cluster_id}: + get: + operationId: cluster-permissions-getpermissions + externalDocs: + url: https://docs.databricks.com/api/workspace/clusters/getpermissions + x-stackQL-resource: cluster_permissions + x-stackQL-method: getpermissions + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: cluster_id + required: true + description: string + in: path + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + object_id: + type: string + object_type: + type: string + access_control_list: + type: array + items: + type: object + properties: + user_name: + type: string + group_name: + type: string + service_principal_name: + type: string + display_name: + type: string + all_permissions: + type: array + items: + type: object + properties: + permission_level: + type: string + inherited: + type: boolean + inherited_from_object: + type: array + items: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Gets the permissions of a cluster. Clusters can inherit permissions + from their root object. + put: + operationId: cluster-permissions-setpermissions + externalDocs: + url: https://docs.databricks.com/api/workspace/clusters/setpermissions + x-stackQL-resource: cluster_permissions + x-stackQL-method: setpermissions + x-stackQL-verb: replace + x-numReqParams: 1 + parameters: + - name: cluster_id + required: true + description: string + in: path + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + object_id: + type: string + object_type: + type: string + access_control_list: + type: array + items: + type: object + properties: + user_name: + type: string + group_name: + type: string + service_principal_name: + type: string + display_name: + type: string + all_permissions: + type: array + items: + type: object + properties: + permission_level: + type: string + inherited: + type: boolean + inherited_from_object: + type: array + items: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + access_control_list: + type: Array of object + example: + access_control_list: + - user_name: string + group_name: string + service_principal_name: string + permission_level: CAN_MANAGE + description: Sets permissions on an object, replacing existing permissions if + they exist. Deletes all direct permissions if none are specified. Objects + can inherit permissions from their root object. + patch: + operationId: cluster-permissions-updatepermissions + externalDocs: + url: https://docs.databricks.com/api/workspace/clusters/updatepermissions + x-stackQL-resource: cluster_permissions + x-stackQL-method: updatepermissions + x-stackQL-verb: update + x-numReqParams: 1 + parameters: + - name: cluster_id + required: true + description: string + in: path + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + object_id: + type: string + object_type: + type: string + access_control_list: + type: array + items: + type: object + properties: + user_name: + type: string + group_name: + type: string + service_principal_name: + type: string + display_name: + type: string + all_permissions: + type: array + items: + type: object + properties: + permission_level: + type: string + inherited: + type: boolean + inherited_from_object: + type: array + items: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + access_control_list: + type: Array of object + example: + access_control_list: + - user_name: string + group_name: string + service_principal_name: string + permission_level: CAN_MANAGE + description: Updates the permissions on a cluster. Clusters can inherit permissions + from their root object. + /api/2.0/permissions/clusters/{cluster_id}/permissionLevels: + get: + operationId: cluster-permission-levels-getpermissionlevels + externalDocs: + url: https://docs.databricks.com/api/workspace/clusters/getpermissionlevels + x-stackQL-resource: cluster_permission_levels + x-stackQL-method: getpermissionlevels + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: cluster_id + required: true + description: string + in: path + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + permission_levels: + type: array + items: + type: object + properties: + permission_level: + type: string + description: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + x-stackQL-objectKey: $.permission_levels + description: Gets the permission levels that a user can have on an object. + /api/2.0/policies/clusters/create: + post: + operationId: cluster-policies-create + externalDocs: + url: https://docs.databricks.com/api/workspace/clusterpolicies/create + x-stackQL-resource: cluster_policies + x-stackQL-method: create + x-stackQL-verb: insert + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + policy_id: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '429': + description: Operation is rejected due to throttling, e.g. some resource + has been exhausted, per-user quota. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: string + definition: + type: JSON + description: + type: string + policy_family_id: + type: string + policy_family_definition_overrides: + type: JSON + max_clusters_per_user: + type: integer + format: int64 + libraries: + type: Array of object + example: + definition: '{ "custom_tags.test_tag": { "type": "fixed", "value": + "test_value" } }' + name: Test policy + description: Creates a new policy with prescribed settings. + /api/2.0/policies/clusters/delete: + post: + operationId: cluster-policies-delete + externalDocs: + url: https://docs.databricks.com/api/workspace/clusterpolicies/delete + x-stackQL-resource: cluster_policies + x-stackQL-method: delete + x-stackQL-verb: delete + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '429': + description: Operation is rejected due to throttling, e.g. some resource + has been exhausted, per-user quota. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + policy_id: + type: required + example: + policy_id: string + description: Delete a policy for a cluster. Clusters governed by this policy + can still run, but cannot be edited. + /api/2.0/policies/clusters/edit: + post: + operationId: cluster-policies-edit + externalDocs: + url: https://docs.databricks.com/api/workspace/clusterpolicies/edit + x-stackQL-resource: cluster_policies + x-stackQL-method: edit + x-stackQL-verb: replace + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '429': + description: Operation is rejected due to throttling, e.g. some resource + has been exhausted, per-user quota. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + policy_id: + type: required + name: + type: string + definition: + type: string + description: + type: JSON + policy_family_id: + type: string + policy_family_definition_overrides: + type: string + max_clusters_per_user: + type: JSON + libraries: + type: Array of object + example: + definition: '{ "custom_tags.test_tag": { "type": "fixed", "value": + "test_value" } }' + name: Test policy + policy_id: ABCD000000000000 + description: Update an existing policy for cluster. This operation may make + some clusters governed by the previous policy invalid. + /api/2.0/policies/clusters/get: + get: + operationId: cluster-policies-get + externalDocs: + url: https://docs.databricks.com/api/workspace/clusterpolicies/get + x-stackQL-resource: cluster_policies + x-stackQL-method: get + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: policy_id + required: true + description: string + in: query + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + policy_id: + type: string + name: + type: string + definition: + type: object + properties: + custom_tags.test_tag: + type: object + properties: + type: + type: string + value: + type: string + description: + type: string + policy_family_id: + type: string + policy_family_definition_overrides: + type: object + properties: + custom_tags.test_tag: + type: object + properties: + type: + type: string + value: + type: string + max_clusters_per_user: + type: integer + libraries: + type: array + items: + type: object + properties: + jar: + type: string + egg: + type: string + pypi: + type: object + properties: + package: + type: string + repo: + type: string + maven: + type: object + properties: + coordinates: + type: string + repo: + type: string + exclusions: + type: array + items: + type: string + cran: + type: object + properties: + package: + type: string + repo: + type: string + whl: + type: string + requirements: + type: string + creator_user_name: + type: string + created_at_timestamp: + type: integer + is_default: + type: boolean + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '429': + description: Operation is rejected due to throttling, e.g. some resource + has been exhausted, per-user quota. + '500': + description: Internal error. + description: Get a cluster policy entity. Creation and editing is available + to admins only. + /api/2.0/policies/clusters/list: + get: + operationId: cluster-policies-list + externalDocs: + url: https://docs.databricks.com/api/workspace/clusterpolicies/list + x-stackQL-resource: cluster_policies + x-stackQL-method: list + x-stackQL-verb: select + x-numReqParams: 0 + parameters: + - name: sort_order + in: query + - name: sort_column + in: query + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + policies: + type: array + items: + type: object + properties: + policy_id: + type: string + name: + type: string + definition: + type: object + properties: + custom_tags.test_tag: + type: object + properties: + type: + type: string + value: + type: string + description: + type: string + policy_family_id: + type: string + policy_family_definition_overrides: + type: object + properties: + custom_tags.test_tag: + type: object + properties: + type: + type: string + value: + type: string + max_clusters_per_user: + type: integer + libraries: + type: array + items: + type: object + properties: + jar: + type: string + egg: + type: string + pypi: + type: object + properties: + package: + type: string + repo: + type: string + maven: + type: object + properties: + coordinates: + type: string + repo: + type: string + exclusions: + type: array + items: + type: string + cran: + type: object + properties: + package: + type: string + repo: + type: string + whl: + type: string + requirements: + type: string + creator_user_name: + type: string + created_at_timestamp: + type: integer + is_default: + type: boolean + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '429': + description: Operation is rejected due to throttling, e.g. some resource + has been exhausted, per-user quota. + '500': + description: Internal error. + '503': + description: Service is currently unavailable. + '504': + description: Deadline expired before the operation could complete. + x-stackQL-objectKey: $.policies + description: Returns a list of policies accessible by the requesting user. + /api/2.0/permissions/cluster-policies/{cluster_policy_id}: + get: + operationId: cluster-policies-permissions-getpermissions + externalDocs: + url: https://docs.databricks.com/api/workspace/clusterpolicies/getpermissions + x-stackQL-resource: cluster_policies_permissions + x-stackQL-method: getpermissions + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: cluster_policy_id + required: true + description: string + in: path + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + object_id: + type: string + object_type: + type: string + access_control_list: + type: array + items: + type: object + properties: + user_name: + type: string + group_name: + type: string + service_principal_name: + type: string + display_name: + type: string + all_permissions: + type: array + items: + type: object + properties: + permission_level: + type: string + inherited: + type: boolean + inherited_from_object: + type: array + items: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Gets the permissions of a cluster policy. Cluster policies can + inherit permissions from their root object. + put: + operationId: cluster-policies-permissions-setpermissions + externalDocs: + url: https://docs.databricks.com/api/workspace/clusterpolicies/setpermissions + x-stackQL-resource: cluster_policies_permissions + x-stackQL-method: setpermissions + x-stackQL-verb: replace + x-numReqParams: 1 + parameters: + - name: cluster_policy_id + required: true + description: string + in: path + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + object_id: + type: string + object_type: + type: string + access_control_list: + type: array + items: + type: object + properties: + user_name: + type: string + group_name: + type: string + service_principal_name: + type: string + display_name: + type: string + all_permissions: + type: array + items: + type: object + properties: + permission_level: + type: string + inherited: + type: boolean + inherited_from_object: + type: array + items: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + access_control_list: + type: Array of object + example: + access_control_list: + - user_name: string + group_name: string + service_principal_name: string + permission_level: CAN_USE + description: Sets permissions on an object, replacing existing permissions if + they exist. Deletes all direct permissions if none are specified. Objects + can inherit permissions from their root object. + patch: + operationId: cluster-policies-permissions-updatepermissions + externalDocs: + url: https://docs.databricks.com/api/workspace/clusterpolicies/updatepermissions + x-stackQL-resource: cluster_policies_permissions + x-stackQL-method: updatepermissions + x-stackQL-verb: update + x-numReqParams: 1 + parameters: + - name: cluster_policy_id + required: true + description: string + in: path + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + object_id: + type: string + object_type: + type: string + access_control_list: + type: array + items: + type: object + properties: + user_name: + type: string + group_name: + type: string + service_principal_name: + type: string + display_name: + type: string + all_permissions: + type: array + items: + type: object + properties: + permission_level: + type: string + inherited: + type: boolean + inherited_from_object: + type: array + items: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + access_control_list: + type: Array of object + example: + access_control_list: + - user_name: string + group_name: string + service_principal_name: string + permission_level: CAN_USE + description: Updates the permissions on a cluster policy. Cluster policies can + inherit permissions from their root object. + /api/2.0/policies/clusters/enforce-compliance: + post: + operationId: cluster-policy-compliance-enforcecompliance + externalDocs: + url: https://docs.databricks.com/api/workspace/policycomplianceforclusters/enforcecompliance + x-stackQL-resource: cluster_policy_compliance + x-stackQL-method: enforcecompliance + x-stackQL-verb: replace + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + has_changes: + type: boolean + changes: + type: array + items: + type: object + properties: + field: + type: string + previous_value: + type: string + new_value: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '429': + description: Operation is rejected due to throttling, e.g. some resource + has been exhausted, per-user quota. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + cluster_id: + type: required + validate_only: + type: string + example: + cluster_id: string + validate_only: false + description: Updates a cluster to be compliant with the current version of its + policy. A cluster can be updated if it is in a + /api/2.0/policies/clusters/get-compliance: + get: + operationId: cluster-policy-compliance-getcompliance + externalDocs: + url: https://docs.databricks.com/api/workspace/policycomplianceforclusters/getcompliance + x-stackQL-resource: cluster_policy_compliance + x-stackQL-method: getcompliance + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: cluster_id + required: true + description: string + in: query + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + is_compliant: + type: boolean + violations: + type: object + properties: + custom_tags.test_tag: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '429': + description: Operation is rejected due to throttling, e.g. some resource + has been exhausted, per-user quota. + '500': + description: Internal error. + description: Returns the policy compliance status of a cluster. Clusters could + be out of compliance if their policy was updated after the cluster was last + edited. + /api/1.2/commands/cancel: + post: + operationId: commands-cancel + externalDocs: + url: https://docs.databricks.com/api/workspace/commandexecution/cancel + x-stackQL-resource: commands + x-stackQL-method: cancel + x-stackQL-verb: exec + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Status was returned successfully. + content: + application/json: + schema: + type: object + properties: {} + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + clusterId: + type: string + contextId: + type: string + commandId: + type: string + example: + clusterId: string + contextId: string + commandId: string + description: Cancels a currently running command within an execution context. + /api/1.2/commands/status: + get: + operationId: commands-commandstatus + externalDocs: + url: https://docs.databricks.com/api/workspace/commandexecution/commandstatus + x-stackQL-resource: commands + x-stackQL-method: commandstatus + x-stackQL-verb: select + x-numReqParams: 3 + parameters: + - name: clusterId + required: true + description: string + in: query + - name: contextId + required: true + description: string + in: query + - name: commandId + required: true + description: string + in: query + responses: + '200': + description: Status was returned successfully. + content: + application/json: + schema: + type: object + properties: + id: + type: string + status: + type: string + results: + type: object + properties: + resultType: + type: string + data: + type: string + description: Gets the status of and, if available, the results from a currently + executing command. + /api/1.2/contexts/create: + post: + operationId: commands-create + externalDocs: + url: https://docs.databricks.com/api/workspace/commandexecution/create + x-stackQL-resource: commands + x-stackQL-method: create + x-stackQL-verb: insert + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Status was returned successfully. + content: + application/json: + schema: + type: object + properties: + id: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + clusterId: + type: string + language: + type: string + example: + clusterId: string + language: python + description: Creates an execution context for running cluster commands. + /api/1.2/contexts/destroy: + post: + operationId: commands-destroy + externalDocs: + url: https://docs.databricks.com/api/workspace/commandexecution/destroy + x-stackQL-resource: commands + x-stackQL-method: destroy + x-stackQL-verb: exec + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Status was returned successfully. + content: + application/json: + schema: + type: object + properties: {} + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + clusterId: + type: required + contextId: + type: string + example: + clusterId: string + contextId: string + description: Deletes an execution context. + /api/1.2/commands/execute: + post: + operationId: commands-execute + externalDocs: + url: https://docs.databricks.com/api/workspace/commandexecution/execute + x-stackQL-resource: commands + x-stackQL-method: execute + x-stackQL-verb: exec + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Status was returned successfully. + content: + application/json: + schema: + type: object + properties: + id: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + clusterId: + type: string + contextId: + type: string + language: + type: string + command: + type: string + example: + clusterId: 1234-567890-span123 + contextId: '1234567890123456789' + language: python + command: print('Hello, World!') + description: Runs a cluster command in the given execution context, using the + provided language. + /api/1.2/contexts/status: + get: + operationId: command-status-contextstatus + externalDocs: + url: https://docs.databricks.com/api/workspace/commandexecution/contextstatus + x-stackQL-resource: command_status + x-stackQL-method: contextstatus + x-stackQL-verb: select + x-numReqParams: 2 + parameters: + - name: clusterId + required: true + description: string + in: query + - name: contextId + required: true + description: string + in: query + responses: + '200': + description: Status was returned successfully. + content: + application/json: + schema: + type: object + properties: + id: + type: string + status: + type: string + description: Gets the status for an execution context. + /api/2.0/global-init-scripts: + post: + operationId: global-init-scripts-create + externalDocs: + url: https://docs.databricks.com/api/workspace/globalinitscripts/create + x-stackQL-resource: global_init_scripts + x-stackQL-method: create + x-stackQL-verb: insert + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Response indicating that the script was created successfully. + content: + application/json: + schema: + type: object + properties: + script_id: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: required + script: + type: string + position: + type: required + enabled: + type: byte + example: + name: My example script name + script: ZWNobyBoZWxsbw== + position: 0 + enabled: false + description: Manages global init scripts for this workspace. + get: + operationId: global-init-scripts-list + externalDocs: + url: https://docs.databricks.com/api/workspace/globalinitscripts/list + x-stackQL-resource: global_init_scripts + x-stackQL-method: list + x-stackQL-verb: select + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Response indicating that the scripts were retrieved successfully. + content: + application/json: + schema: + type: object + properties: + scripts: + type: array + items: + type: object + properties: + script_id: + type: string + name: + type: string + position: + type: integer + enabled: + type: boolean + created_by: + type: string + created_at: + type: integer + updated_by: + type: string + updated_at: + type: integer + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '500': + description: Internal error. + x-stackQL-objectKey: $.scripts + description: Manages global init scripts for this workspace. + /api/2.0/global-init-scripts/{script_id}: + delete: + operationId: global-init-scripts-delete + externalDocs: + url: https://docs.databricks.com/api/workspace/globalinitscripts/delete + x-stackQL-resource: global_init_scripts + x-stackQL-method: delete + x-stackQL-verb: delete + x-numReqParams: 1 + parameters: + - name: script_id + required: true + description: string + in: path + responses: + '200': + description: The script was deleted successfully. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Manage a specific global init script with ID + get: + operationId: global-init-scripts-get + externalDocs: + url: https://docs.databricks.com/api/workspace/globalinitscripts/get + x-stackQL-resource: global_init_scripts + x-stackQL-method: get + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: script_id + required: true + description: string + in: path + responses: + '200': + description: Response indicating that the script was retrieved successfully. + content: + application/json: + schema: + type: object + properties: + script_id: + type: string + name: + type: string + position: + type: integer + enabled: + type: boolean + created_by: + type: string + created_at: + type: integer + updated_by: + type: string + updated_at: + type: integer + script: + type: string + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Manage a specific global init script with ID + patch: + operationId: global-init-scripts-update + externalDocs: + url: https://docs.databricks.com/api/workspace/globalinitscripts/update + x-stackQL-resource: global_init_scripts + x-stackQL-method: update + x-stackQL-verb: update + x-numReqParams: 1 + parameters: + - name: script_id + required: true + description: string + in: path + responses: + '200': + description: The script was updated successfully. + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: required + script: + type: string + position: + type: required + enabled: + type: byte + example: + name: My example script name + script: ZWNobyBoZWxsbw== + position: 0 + enabled: false + description: Manage a specific global init script with ID + /api/2.0/instance-pools/create: + post: + operationId: instance-pools-create + externalDocs: + url: https://docs.databricks.com/api/workspace/instancepools/create + x-stackQL-resource: instance_pools + x-stackQL-method: create + x-stackQL-verb: insert + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + instance_pool_id: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + instance_pool_name: + type: required + min_idle_instances: + type: string + max_capacity: + type: int32 + node_type_id: + type: int32 + idle_instance_autotermination_minutes: + type: required + enable_elastic_disk: + type: string + preloaded_spark_versions: + type: int32 + aws_attributes: + type: object + custom_tags: + type: object + disk_spec: + type: object + preloaded_docker_images: + type: Array of object + example: + instance_pool_name: my-pool + node_type_id: i3.xlarge + min_idle_instances: 10 + aws_attributes: + availability: SPOT + custom_tags: + - key: my-key + value: my-value + description: Creates a new instance pool using idle and ready-to-use cloud instances. + /api/2.0/instance-pools/delete: + post: + operationId: instance-pools-delete + externalDocs: + url: https://docs.databricks.com/api/workspace/instancepools/delete + x-stackQL-resource: instance_pools + x-stackQL-method: delete + x-stackQL-verb: delete + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + instance_pool_id: + type: required + example: + instance_pool_id: 1234-567890-fetch12-pool-A3BcdEFg + description: Deletes the instance pool permanently. The idle instances in the + pool are terminated asynchronously. + /api/2.0/instance-pools/edit: + post: + operationId: instance-pools-edit + externalDocs: + url: https://docs.databricks.com/api/workspace/instancepools/edit + x-stackQL-resource: instance_pools + x-stackQL-method: edit + x-stackQL-verb: replace + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + instance_pool_name: + type: required + min_idle_instances: + type: string + max_capacity: + type: int32 + idle_instance_autotermination_minutes: + type: int32 + instance_pool_id: + type: int32 + node_type_id: + type: required + custom_tags: + type: object + example: + max_capacity: 200 + idle_instance_autotermination_minutes: 30 + min_idle_instances: 5 + instance_pool_id: 1234-567890-fetch12-pool-A3BcdEFg + instance_pool_name: my-edited-pool + description: Modifies the configuration of an existing instance pool. + /api/2.0/instance-pools/get: + get: + operationId: instance-pools-get + externalDocs: + url: https://docs.databricks.com/api/workspace/instancepools/get + x-stackQL-resource: instance_pools + x-stackQL-method: get + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: instance_pool_id + required: true + description: string + in: query + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + instance_pool_name: + type: string + min_idle_instances: + type: integer + aws_attributes: + type: object + properties: + availability: + type: string + zone_id: + type: string + spot_bid_price_percent: + type: integer + node_type_id: + type: string + custom_tags: + type: object + properties: + my-key: + type: string + idle_instance_autotermination_minutes: + type: integer + enable_elastic_disk: + type: boolean + disk_spec: + type: object + properties: + disk_type: + type: object + properties: + ebs_volume_type: + type: string + disk_count: + type: integer + disk_size: + type: integer + preloaded_spark_versions: + type: array + items: + type: string + instance_pool_id: + type: string + default_tags: + type: object + properties: + Vendor: + type: string + DatabricksInstancePoolCreatorId: + type: string + DatabricksInstancePoolId: + type: string + state: + type: string + stats: + type: object + properties: + used_count: + type: integer + idle_count: + type: integer + pending_used_count: + type: integer + pending_idle_count: + type: integer + status: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Retrieve the information for an instance pool based on its identifier. + /api/2.0/instance-pools/list: + get: + operationId: instance-pools-list + externalDocs: + url: https://docs.databricks.com/api/workspace/instancepools/list + x-stackQL-resource: instance_pools + x-stackQL-method: list + x-stackQL-verb: select + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + instance_pools: + type: array + items: + type: object + properties: + instance_pool_name: + type: string + min_idle_instances: + type: integer + aws_attributes: + type: object + properties: + availability: + type: string + zone_id: + type: string + spot_bid_price_percent: + type: integer + node_type_id: + type: string + idle_instance_autotermination_minutes: + type: integer + enable_elastic_disk: + type: boolean + disk_spec: + type: object + properties: + disk_type: + type: object + properties: + ebs_volume_type: + type: string + disk_count: + type: integer + disk_size: + type: integer + preloaded_spark_versions: + type: array + items: + type: string + instance_pool_id: + type: string + default_tags: + type: object + properties: + Vendor: + type: string + DatabricksInstancePoolCreatorId: + type: string + DatabricksInstancePoolId: + type: string + state: + type: string + stats: + type: object + properties: + used_count: + type: integer + idle_count: + type: integer + pending_used_count: + type: integer + pending_idle_count: + type: integer + status: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '500': + description: Internal error. + x-stackQL-objectKey: $.instance_pools + description: Gets a list of instance pools with their statistics. + /api/2.0/permissions/instance-pools/{instance_pool_id}: + get: + operationId: instance-pool-permissions-getpermissions + externalDocs: + url: https://docs.databricks.com/api/workspace/instancepools/getpermissions + x-stackQL-resource: instance_pool_permissions + x-stackQL-method: getpermissions + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: instance_pool_id + required: true + description: string + in: path + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + object_id: + type: string + object_type: + type: string + access_control_list: + type: array + items: + type: object + properties: + user_name: + type: string + group_name: + type: string + service_principal_name: + type: string + display_name: + type: string + all_permissions: + type: array + items: + type: object + properties: + permission_level: + type: string + inherited: + type: boolean + inherited_from_object: + type: array + items: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Gets the permissions of an instance pool. Instance pools can inherit + permissions from their root object. + put: + operationId: instance-pool-permissions-setpermissions + externalDocs: + url: https://docs.databricks.com/api/workspace/instancepools/setpermissions + x-stackQL-resource: instance_pool_permissions + x-stackQL-method: setpermissions + x-stackQL-verb: replace + x-numReqParams: 1 + parameters: + - name: instance_pool_id + required: true + description: string + in: path + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + object_id: + type: string + object_type: + type: string + access_control_list: + type: array + items: + type: object + properties: + user_name: + type: string + group_name: + type: string + service_principal_name: + type: string + display_name: + type: string + all_permissions: + type: array + items: + type: object + properties: + permission_level: + type: string + inherited: + type: boolean + inherited_from_object: + type: array + items: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + access_control_list: + type: Array of object + example: + access_control_list: + - user_name: string + group_name: string + service_principal_name: string + permission_level: CAN_MANAGE + description: Sets permissions on an object, replacing existing permissions if + they exist. Deletes all direct permissions if none are specified. Objects + can inherit permissions from their root object. + patch: + operationId: instance-pool-permissions-updatepermissions + externalDocs: + url: https://docs.databricks.com/api/workspace/instancepools/updatepermissions + x-stackQL-resource: instance_pool_permissions + x-stackQL-method: updatepermissions + x-stackQL-verb: update + x-numReqParams: 1 + parameters: + - name: instance_pool_id + required: true + description: string + in: path + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + object_id: + type: string + object_type: + type: string + access_control_list: + type: array + items: + type: object + properties: + user_name: + type: string + group_name: + type: string + service_principal_name: + type: string + display_name: + type: string + all_permissions: + type: array + items: + type: object + properties: + permission_level: + type: string + inherited: + type: boolean + inherited_from_object: + type: array + items: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + access_control_list: + type: Array of object + example: + access_control_list: + - user_name: string + group_name: string + service_principal_name: string + permission_level: CAN_MANAGE + description: Updates the permissions on an instance pool. Instance pools can + inherit permissions from their root object. + /api/2.0/permissions/instance-pools/{instance_pool_id}/permissionLevels: + get: + operationId: instance-pool-permission-levels-getpermissionlevels + externalDocs: + url: https://docs.databricks.com/api/workspace/instancepools/getpermissionlevels + x-stackQL-resource: instance_pool_permission_levels + x-stackQL-method: getpermissionlevels + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: instance_pool_id + required: true + description: string + in: path + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + permission_levels: + type: array + items: + type: object + properties: + permission_level: + type: string + description: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + x-stackQL-objectKey: $.permission_levels + description: Gets the permission levels that a user can have on an object. + /api/2.0/instance-profiles/add: + post: + operationId: instance-profiles-add + externalDocs: + url: https://docs.databricks.com/api/workspace/instanceprofiles/add + x-stackQL-resource: instance_profiles + x-stackQL-method: add + x-stackQL-verb: insert + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + skip_validation: + type: boolean + instance_profile_arn: + type: required + iam_role_arn: + type: string + is_meta_instance_profile: + type: string + example: + instance_profile_arn: arn:aws:iam::123456789012:instance-profile/my-profile + description: In the UI, you can select the instance profile when launching clusters. + This API is only available to admin users. + /api/2.0/instance-profiles/edit: + post: + operationId: instance-profiles-edit + externalDocs: + url: https://docs.databricks.com/api/workspace/instanceprofiles/edit + x-stackQL-resource: instance_profiles + x-stackQL-method: edit + x-stackQL-verb: replace + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + instance_profile_arn: + type: required + iam_role_arn: + type: string + is_meta_instance_profile: + type: string + example: + instance_profile_arn: arn:aws:iam::123456789012:instance-profile/my-profile + iam_role_arn: arn:aws:iam::123456789012:role/my-profile2 + description: 'The only supported field to change is the optional IAM role ARN + associated with the instance profile. It is required to specify the IAM role + ARN if both of the following are true:' + /api/2.0/instance-profiles/list: + get: + operationId: instance-profiles-list + externalDocs: + url: https://docs.databricks.com/api/workspace/instanceprofiles/list + x-stackQL-resource: instance_profiles + x-stackQL-method: list + x-stackQL-verb: select + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + instance_profiles: + type: array + items: + type: object + properties: + instance_profile_arn: + type: string + is_meta_instance_profile: + type: boolean + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '500': + description: Internal error. + x-stackQL-objectKey: $.instance_profiles + description: List the instance profiles that the calling user can use to launch + a cluster. + /api/2.0/instance-profiles/remove: + post: + operationId: instance-profiles-remove + externalDocs: + url: https://docs.databricks.com/api/workspace/instanceprofiles/remove + x-stackQL-resource: instance_profiles + x-stackQL-method: remove + x-stackQL-verb: delete + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + instance_profile_arn: + type: required + example: + instance_profile_arn: arn:aws:iam::123456789012:instance-profile/my-profile + description: Remove the instance profile with the provided ARN. Existing clusters + with this instance profile will continue to function. + /api/2.0/libraries/all-cluster-statuses: + get: + operationId: libraries-allclusterlibrarystatuses + externalDocs: + url: https://docs.databricks.com/api/workspace/libraries/allclusterlibrarystatuses + x-stackQL-resource: libraries + x-stackQL-method: allclusterlibrarystatuses + x-stackQL-verb: select + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + statuses: + type: array + items: + type: object + properties: + cluster_id: + type: string + library_statuses: + type: array + items: + type: object + properties: + is_library_for_all_clusters: + type: boolean + library: + type: object + properties: + pypi: + type: object + properties: + package: + type: string + repo: + type: string + status: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '429': + description: Operation is rejected due to throttling, e.g. some resource + has been exhausted, per-user quota. + '500': + description: Internal error. + x-stackQL-objectKey: $.statuses + description: Get the status of all libraries on all clusters. A status is returned + for all libraries installed on this cluster via the API or the libraries UI. + /api/2.0/libraries/cluster-status: + get: + operationId: libraries-clusterstatus + externalDocs: + url: https://docs.databricks.com/api/workspace/libraries/clusterstatus + x-stackQL-resource: libraries + x-stackQL-method: clusterstatus + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: cluster_id + required: true + description: string + in: query + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + cluster_id: + type: string + library_statuses: + type: array + items: + type: object + properties: + is_library_for_all_clusters: + type: boolean + library: + type: object + properties: + pypi: + type: object + properties: + package: + type: string + repo: + type: string + status: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '429': + description: Operation is rejected due to throttling, e.g. some resource + has been exhausted, per-user quota. + '500': + description: Internal error. + description: 'Get the status of libraries on a cluster. A status is returned + for all libraries installed on this cluster via the API or the libraries UI. + The order of returned libraries is as follows:' + /api/2.0/libraries/install: + post: + operationId: libraries-install + externalDocs: + url: https://docs.databricks.com/api/workspace/libraries/install + x-stackQL-resource: libraries + x-stackQL-method: install + x-stackQL-verb: insert + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '429': + description: Operation is rejected due to throttling, e.g. some resource + has been exhausted, per-user quota. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + cluster_id: + type: required + libraries: + type: required + example: + cluster_id: 1234-56789-abcde + libraries: + - pypi: + package: numpy + repo: http://my-pypi-repo.com + - jar: /Workspace/path/to/library.jar + - whl: /Workspace/path/to/library.whl + - maven: + coordinates: com.databricks:spark-csv_2.11:1.5.0 + exclusions: + - org.slf4j:slf4j-log4j12 + repo: http://my-maven-repo.com + - cran: + package: ggplot2 + repo: http://cran.us.r-project.org + - requirements: /Workspace/path/to/requirements.txt + description: Add libraries to install on a cluster. The installation is asynchronous; + it happens in the background after the completion of this request. + /api/2.0/libraries/uninstall: + post: + operationId: libraries-uninstall + externalDocs: + url: https://docs.databricks.com/api/workspace/libraries/uninstall + x-stackQL-resource: libraries + x-stackQL-method: uninstall + x-stackQL-verb: delete + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '429': + description: Operation is rejected due to throttling, e.g. some resource + has been exhausted, per-user quota. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + cluster_id: + type: required + libraries: + type: required + example: + cluster_id: 1234-56789-abcde + libraries: + - pypi: + package: numpy + repo: http://my-pypi-repo.com + - jar: /Workspace/path/to/library.jar + - whl: /Workspace/path/to/library.whl + - maven: + coordinates: com.databricks:spark-csv_2.11:1.5.0 + exclusions: + - org.slf4j:slf4j-log4j12 + repo: http://my-maven-repo.com + - cran: + package: ggplot2 + repo: http://cran.us.r-project.org + - requirements: /Workspace/path/to/requirements.txt + description: Set libraries to uninstall from a cluster. The libraries won't + be uninstalled until the cluster is restarted. A request to uninstall a library + that is not currently installed is ignored. + /api/2.1/clusters/list-node-types: + get: + operationId: node-types-listnodetypes + externalDocs: + url: https://docs.databricks.com/api/workspace/clusters/listnodetypes + x-stackQL-resource: node_types + x-stackQL-method: listnodetypes + x-stackQL-verb: select + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + node_types: + type: array + items: + type: object + properties: + node_type_id: + type: string + memory_mb: + type: integer + num_cores: + type: integer + description: + type: string + instance_type_id: + type: string + is_deprecated: + type: boolean + category: + type: string + support_ebs_volumes: + type: boolean + support_cluster_tags: + type: boolean + num_gpus: + type: integer + node_instance_type: + type: object + properties: + instance_type_id: + type: string + local_disks: + type: integer + local_disk_size_gb: + type: integer + instance_family: + type: string + swap_size: + type: string + is_hidden: + type: boolean + support_port_forwarding: + type: boolean + supports_elastic_disk: + type: boolean + display_order: + type: integer + is_io_cache_enabled: + type: boolean + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '500': + description: Internal error. + x-stackQL-objectKey: $.node_types + description: Returns a list of supported Spark node types. These node types + can be used to launch a cluster. + /api/2.0/policy-families/{policy_family_id}: + get: + operationId: policy-families-get + externalDocs: + url: https://docs.databricks.com/api/workspace/policyfamilies/get + x-stackQL-resource: policy_families + x-stackQL-method: get + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: policy_family_id + required: true + description: string + in: path + - name: version + in: query + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + policy_family_id: + type: string + name: + type: string + description: + type: string + definition: + type: object + properties: + custom_tags.test_tag: + type: object + properties: + type: + type: string + value: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Retrieve the information for an policy family based on its identifier + and version + /api/2.0/policy-families: + get: + operationId: policy-families-list + externalDocs: + url: https://docs.databricks.com/api/workspace/policyfamilies/list + x-stackQL-resource: policy_families + x-stackQL-method: list + x-stackQL-verb: select + x-numReqParams: 0 + parameters: + - name: max_results + in: query + - name: page_token + in: query + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + policy_families: + type: array + items: + type: object + properties: + policy_family_id: + type: string + name: + type: string + description: + type: string + definition: + type: object + properties: + custom_tags.test_tag: + type: object + properties: + type: + type: string + value: + type: string + next_page_token: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '500': + description: Internal error. + x-stackQL-objectKey: $.policy_families + description: Returns the list of policy definition types available to use at + their latest version. This API is paginated. + /api/2.0/permissions/cluster-policies/{cluster_policy_id}/permissionLevels: + get: + operationId: policy-permission-levels-getpermissionlevels + externalDocs: + url: https://docs.databricks.com/api/workspace/clusterpolicies/getpermissionlevels + x-stackQL-resource: policy_permission_levels + x-stackQL-method: getpermissionlevels + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: cluster_policy_id + required: true + description: string + in: path + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + permission_levels: + type: array + items: + type: object + properties: + permission_level: + type: string + description: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + x-stackQL-objectKey: $.permission_levels + description: Gets the permission levels that a user can have on an object. + /api/2.1/clusters/spark-versions: + get: + operationId: spark-versions-sparkversions + externalDocs: + url: https://docs.databricks.com/api/workspace/clusters/sparkversions + x-stackQL-resource: spark_versions + x-stackQL-method: sparkversions + x-stackQL-verb: select + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + versions: + type: array + items: + type: object + properties: + key: + type: string + name: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '500': + description: Internal error. + x-stackQL-objectKey: $.versions + description: Returns the list of available Spark versions. These versions can + be used to launch a cluster. + /api/2.1/clusters/list-zones: + get: + operationId: zones-listzones + externalDocs: + url: https://docs.databricks.com/api/workspace/clusters/listzones + x-stackQL-resource: zones + x-stackQL-method: listzones + x-stackQL-verb: select + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + zones: + type: array + items: + type: string + default_zone: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '500': + description: Internal error. + description: Returns a list of availability zones where clusters can be created + in (For example, us-west-2a). These zones can be used to launch a cluster. +components: + x-stackQL-resources: + all_clusters_policy_compliance: + id: databricks_workspace.compute.all_clusters_policy_compliance + name: all_clusters_policy_compliance + title: All_clusters_policy_compliance + methods: + listcompliance: + operation: + $ref: '#/paths/~1api~12.0~1policies~1clusters~1list-compliance/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.clusters + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/all_clusters_policy_compliance/methods/listcompliance' + insert: [] + update: [] + replace: [] + delete: [] + exec: [] + clusters: + id: databricks_workspace.compute.clusters + name: clusters + title: Clusters + methods: + changeowner: + operation: + $ref: '#/paths/~1api~12.1~1clusters~1change-owner/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + create: + operation: + $ref: '#/paths/~1api~12.1~1clusters~1create/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: '#/paths/~1api~12.1~1clusters~1delete/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + edit: + operation: + $ref: '#/paths/~1api~12.1~1clusters~1edit/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1api~12.1~1clusters~1get/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1api~12.1~1clusters~1list/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.clusters + permanentdelete: + operation: + $ref: '#/paths/~1api~12.1~1clusters~1permanent-delete/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + pin: + operation: + $ref: '#/paths/~1api~12.1~1clusters~1pin/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + resize: + operation: + $ref: '#/paths/~1api~12.1~1clusters~1resize/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + restart: + operation: + $ref: '#/paths/~1api~12.1~1clusters~1restart/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + start: + operation: + $ref: '#/paths/~1api~12.1~1clusters~1start/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + unpin: + operation: + $ref: '#/paths/~1api~12.1~1clusters~1unpin/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: '#/paths/~1api~12.1~1clusters~1update/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/clusters/methods/list' + - $ref: '#/components/x-stackQL-resources/clusters/methods/get' + insert: + - $ref: '#/components/x-stackQL-resources/clusters/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/clusters/methods/update' + replace: + - $ref: '#/components/x-stackQL-resources/clusters/methods/edit' + delete: + - $ref: '#/components/x-stackQL-resources/clusters/methods/delete' + exec: + - $ref: '#/components/x-stackQL-resources/clusters/methods/unpin' + - $ref: '#/components/x-stackQL-resources/clusters/methods/start' + - $ref: '#/components/x-stackQL-resources/clusters/methods/restart' + - $ref: '#/components/x-stackQL-resources/clusters/methods/resize' + - $ref: '#/components/x-stackQL-resources/clusters/methods/pin' + - $ref: '#/components/x-stackQL-resources/clusters/methods/permanentdelete' + - $ref: '#/components/x-stackQL-resources/clusters/methods/changeowner' + cluster_events: + id: databricks_workspace.compute.cluster_events + name: cluster_events + title: Cluster_events + methods: + events: + operation: + $ref: '#/paths/~1api~12.1~1clusters~1events/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/cluster_events/methods/events' + insert: [] + update: [] + replace: [] + delete: [] + exec: [] + cluster_permissions: + id: databricks_workspace.compute.cluster_permissions + name: cluster_permissions + title: Cluster_permissions + methods: + getpermissions: + operation: + $ref: '#/paths/~1api~12.0~1permissions~1clusters~1{cluster_id}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + setpermissions: + operation: + $ref: '#/paths/~1api~12.0~1permissions~1clusters~1{cluster_id}/put' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + updatepermissions: + operation: + $ref: '#/paths/~1api~12.0~1permissions~1clusters~1{cluster_id}/patch' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/cluster_permissions/methods/getpermissions' + insert: [] + update: + - $ref: '#/components/x-stackQL-resources/cluster_permissions/methods/updatepermissions' + replace: + - $ref: '#/components/x-stackQL-resources/cluster_permissions/methods/setpermissions' + delete: [] + exec: [] + cluster_permission_levels: + id: databricks_workspace.compute.cluster_permission_levels + name: cluster_permission_levels + title: Cluster_permission_levels + methods: + getpermissionlevels: + operation: + $ref: '#/paths/~1api~12.0~1permissions~1clusters~1{cluster_id}~1permissionLevels/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.permission_levels + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/cluster_permission_levels/methods/getpermissionlevels' + insert: [] + update: [] + replace: [] + delete: [] + exec: [] + cluster_policies: + id: databricks_workspace.compute.cluster_policies + name: cluster_policies + title: Cluster_policies + methods: + create: + operation: + $ref: '#/paths/~1api~12.0~1policies~1clusters~1create/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: '#/paths/~1api~12.0~1policies~1clusters~1delete/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + edit: + operation: + $ref: '#/paths/~1api~12.0~1policies~1clusters~1edit/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1api~12.0~1policies~1clusters~1get/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1api~12.0~1policies~1clusters~1list/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.policies + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/cluster_policies/methods/list' + - $ref: '#/components/x-stackQL-resources/cluster_policies/methods/get' + insert: + - $ref: '#/components/x-stackQL-resources/cluster_policies/methods/create' + update: [] + replace: + - $ref: '#/components/x-stackQL-resources/cluster_policies/methods/edit' + delete: + - $ref: '#/components/x-stackQL-resources/cluster_policies/methods/delete' + exec: [] + cluster_policies_permissions: + id: databricks_workspace.compute.cluster_policies_permissions + name: cluster_policies_permissions + title: Cluster_policies_permissions + methods: + getpermissions: + operation: + $ref: '#/paths/~1api~12.0~1permissions~1cluster-policies~1{cluster_policy_id}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + setpermissions: + operation: + $ref: '#/paths/~1api~12.0~1permissions~1cluster-policies~1{cluster_policy_id}/put' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + updatepermissions: + operation: + $ref: '#/paths/~1api~12.0~1permissions~1cluster-policies~1{cluster_policy_id}/patch' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/cluster_policies_permissions/methods/getpermissions' + insert: [] + update: + - $ref: '#/components/x-stackQL-resources/cluster_policies_permissions/methods/updatepermissions' + replace: + - $ref: '#/components/x-stackQL-resources/cluster_policies_permissions/methods/setpermissions' + delete: [] + exec: [] + cluster_policy_compliance: + id: databricks_workspace.compute.cluster_policy_compliance + name: cluster_policy_compliance + title: Cluster_policy_compliance + methods: + enforcecompliance: + operation: + $ref: '#/paths/~1api~12.0~1policies~1clusters~1enforce-compliance/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + getcompliance: + operation: + $ref: '#/paths/~1api~12.0~1policies~1clusters~1get-compliance/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/cluster_policy_compliance/methods/getcompliance' + insert: [] + update: [] + replace: + - $ref: '#/components/x-stackQL-resources/cluster_policy_compliance/methods/enforcecompliance' + delete: [] + exec: [] + commands: + id: databricks_workspace.compute.commands + name: commands + title: Commands + methods: + cancel: + operation: + $ref: '#/paths/~1api~11.2~1commands~1cancel/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + commandstatus: + operation: + $ref: '#/paths/~1api~11.2~1commands~1status/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + create: + operation: + $ref: '#/paths/~1api~11.2~1contexts~1create/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + destroy: + operation: + $ref: '#/paths/~1api~11.2~1contexts~1destroy/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + execute: + operation: + $ref: '#/paths/~1api~11.2~1commands~1execute/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/commands/methods/commandstatus' + insert: + - $ref: '#/components/x-stackQL-resources/commands/methods/create' + update: [] + replace: [] + delete: [] + exec: + - $ref: '#/components/x-stackQL-resources/commands/methods/execute' + - $ref: '#/components/x-stackQL-resources/commands/methods/destroy' + - $ref: '#/components/x-stackQL-resources/commands/methods/cancel' + command_status: + id: databricks_workspace.compute.command_status + name: command_status + title: Command_status + methods: + contextstatus: + operation: + $ref: '#/paths/~1api~11.2~1contexts~1status/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/command_status/methods/contextstatus' + insert: [] + update: [] + replace: [] + delete: [] + exec: [] + global_init_scripts: + id: databricks_workspace.compute.global_init_scripts + name: global_init_scripts + title: Global_init_scripts + methods: + create: + operation: + $ref: '#/paths/~1api~12.0~1global-init-scripts/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1api~12.0~1global-init-scripts/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.scripts + delete: + operation: + $ref: '#/paths/~1api~12.0~1global-init-scripts~1{script_id}/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1api~12.0~1global-init-scripts~1{script_id}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: '#/paths/~1api~12.0~1global-init-scripts~1{script_id}/patch' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/global_init_scripts/methods/get' + - $ref: '#/components/x-stackQL-resources/global_init_scripts/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/global_init_scripts/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/global_init_scripts/methods/update' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/global_init_scripts/methods/delete' + exec: [] + instance_pools: + id: databricks_workspace.compute.instance_pools + name: instance_pools + title: Instance_pools + methods: + create: + operation: + $ref: '#/paths/~1api~12.0~1instance-pools~1create/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: '#/paths/~1api~12.0~1instance-pools~1delete/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + edit: + operation: + $ref: '#/paths/~1api~12.0~1instance-pools~1edit/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1api~12.0~1instance-pools~1get/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1api~12.0~1instance-pools~1list/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.instance_pools + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/instance_pools/methods/list' + - $ref: '#/components/x-stackQL-resources/instance_pools/methods/get' + insert: + - $ref: '#/components/x-stackQL-resources/instance_pools/methods/create' + update: [] + replace: + - $ref: '#/components/x-stackQL-resources/instance_pools/methods/edit' + delete: + - $ref: '#/components/x-stackQL-resources/instance_pools/methods/delete' + exec: [] + instance_pool_permissions: + id: databricks_workspace.compute.instance_pool_permissions + name: instance_pool_permissions + title: Instance_pool_permissions + methods: + getpermissions: + operation: + $ref: '#/paths/~1api~12.0~1permissions~1instance-pools~1{instance_pool_id}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + setpermissions: + operation: + $ref: '#/paths/~1api~12.0~1permissions~1instance-pools~1{instance_pool_id}/put' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + updatepermissions: + operation: + $ref: '#/paths/~1api~12.0~1permissions~1instance-pools~1{instance_pool_id}/patch' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/instance_pool_permissions/methods/getpermissions' + insert: [] + update: + - $ref: '#/components/x-stackQL-resources/instance_pool_permissions/methods/updatepermissions' + replace: + - $ref: '#/components/x-stackQL-resources/instance_pool_permissions/methods/setpermissions' + delete: [] + exec: [] + instance_pool_permission_levels: + id: databricks_workspace.compute.instance_pool_permission_levels + name: instance_pool_permission_levels + title: Instance_pool_permission_levels + methods: + getpermissionlevels: + operation: + $ref: '#/paths/~1api~12.0~1permissions~1instance-pools~1{instance_pool_id}~1permissionLevels/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.permission_levels + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/instance_pool_permission_levels/methods/getpermissionlevels' + insert: [] + update: [] + replace: [] + delete: [] + exec: [] + instance_profiles: + id: databricks_workspace.compute.instance_profiles + name: instance_profiles + title: Instance_profiles + methods: + add: + operation: + $ref: '#/paths/~1api~12.0~1instance-profiles~1add/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + edit: + operation: + $ref: '#/paths/~1api~12.0~1instance-profiles~1edit/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1api~12.0~1instance-profiles~1list/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.instance_profiles + remove: + operation: + $ref: '#/paths/~1api~12.0~1instance-profiles~1remove/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/instance_profiles/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/instance_profiles/methods/add' + update: [] + replace: + - $ref: '#/components/x-stackQL-resources/instance_profiles/methods/edit' + delete: + - $ref: '#/components/x-stackQL-resources/instance_profiles/methods/remove' + exec: [] + libraries: + id: databricks_workspace.compute.libraries + name: libraries + title: Libraries + methods: + allclusterlibrarystatuses: + operation: + $ref: '#/paths/~1api~12.0~1libraries~1all-cluster-statuses/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.statuses + clusterstatus: + operation: + $ref: '#/paths/~1api~12.0~1libraries~1cluster-status/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + install: + operation: + $ref: '#/paths/~1api~12.0~1libraries~1install/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + uninstall: + operation: + $ref: '#/paths/~1api~12.0~1libraries~1uninstall/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/libraries/methods/clusterstatus' + - $ref: '#/components/x-stackQL-resources/libraries/methods/allclusterlibrarystatuses' + insert: + - $ref: '#/components/x-stackQL-resources/libraries/methods/install' + update: [] + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/libraries/methods/uninstall' + exec: [] + node_types: + id: databricks_workspace.compute.node_types + name: node_types + title: Node_types + methods: + listnodetypes: + operation: + $ref: '#/paths/~1api~12.1~1clusters~1list-node-types/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.node_types + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/node_types/methods/listnodetypes' + insert: [] + update: [] + replace: [] + delete: [] + exec: [] + policy_families: + id: databricks_workspace.compute.policy_families + name: policy_families + title: Policy_families + methods: + get: + operation: + $ref: '#/paths/~1api~12.0~1policy-families~1{policy_family_id}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1api~12.0~1policy-families/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.policy_families + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/policy_families/methods/list' + - $ref: '#/components/x-stackQL-resources/policy_families/methods/get' + insert: [] + update: [] + replace: [] + delete: [] + exec: [] + policy_permission_levels: + id: databricks_workspace.compute.policy_permission_levels + name: policy_permission_levels + title: Policy_permission_levels + methods: + getpermissionlevels: + operation: + $ref: '#/paths/~1api~12.0~1permissions~1cluster-policies~1{cluster_policy_id}~1permissionLevels/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.permission_levels + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/policy_permission_levels/methods/getpermissionlevels' + insert: [] + update: [] + replace: [] + delete: [] + exec: [] + spark_versions: + id: databricks_workspace.compute.spark_versions + name: spark_versions + title: Spark_versions + methods: + sparkversions: + operation: + $ref: '#/paths/~1api~12.1~1clusters~1spark-versions/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.versions + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/spark_versions/methods/sparkversions' + insert: [] + update: [] + replace: [] + delete: [] + exec: [] + zones: + id: databricks_workspace.compute.zones + name: zones + title: Zones + methods: + listzones: + operation: + $ref: '#/paths/~1api~12.1~1clusters~1list-zones/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/zones/methods/listzones' + insert: [] + update: [] + replace: [] + delete: [] + exec: [] diff --git a/providers/src/databricks_workspace/v00.00.00000/services/dbsql.yaml b/providers/src/databricks_workspace/v00.00.00000/services/dbsql.yaml new file mode 100644 index 00000000..343fbd17 --- /dev/null +++ b/providers/src/databricks_workspace/v00.00.00000/services/dbsql.yaml @@ -0,0 +1,5452 @@ +openapi: 3.0.0 +info: + version: 2024-12-19-stackql-generated + contact: + name: StackQL Studios + url: https://stackql.io/ + email: info@stackql.io + title: Databricks Dbsql API + description: Dbsql +servers: +- url: https://{deployment_name}.cloud.databricks.com + variables: + deployment_name: + description: The Databricks Workspace Deployment Name + default: dbc-abcd0123-a1bc +paths: + /api/2.0/sql/alerts: + post: + operationId: alerts-create + externalDocs: + url: https://docs.databricks.com/api/workspace/alerts/create + x-stackQL-resource: alerts + x-stackQL-method: create + x-stackQL-verb: insert + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + state: + type: string + seconds_to_retrigger: + type: integer + owner_user_name: + type: string + display_name: + type: string + id: + type: string + condition: + type: object + properties: + op: + type: string + operand: + type: object + properties: + column: + type: object + properties: + name: + type: string + threshold: + type: object + properties: + value: + type: object + properties: + double_value: + type: integer + query_id: + type: string + parent_path: + type: string + lifecycle_state: + type: string + update_time: + type: string + create_time: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + alert: + type: object + example: + alert: + seconds_to_retrigger: 0 + display_name: Test alert + condition: + op: GREATER_THAN + operand: + column: + name: foo + threshold: + value: + double_value: 1 + query_id: dee5cca8-1c79-4b5e-a71m1-e7f9d241bdf6 + parent_path: /Workspace/Users/user.name@acme.com + description: Creates an alert. + get: + operationId: alerts-list + externalDocs: + url: https://docs.databricks.com/api/workspace/alerts/list + x-stackQL-resource: alerts + x-stackQL-method: list + x-stackQL-verb: select + x-numReqParams: 0 + parameters: + - name: page_token + in: query + - name: page_size + in: query + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + next_page_token: + type: string + results: + type: array + items: + type: object + properties: + state: + type: string + seconds_to_retrigger: + type: integer + owner_user_name: + type: string + display_name: + type: string + id: + type: string + condition: + type: object + properties: + op: + type: string + operand: + type: object + properties: + column: + type: object + properties: + name: + type: string + threshold: + type: object + properties: + value: + type: object + properties: + double_value: + type: integer + query_id: + type: string + lifecycle_state: + type: string + update_time: + type: string + create_time: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '500': + description: Internal error. + x-stackQL-objectKey: $.results + description: Gets a list of alerts accessible to the user, ordered by creation + time. + /api/2.0/sql/alerts/{id}: + delete: + operationId: alerts-delete + externalDocs: + url: https://docs.databricks.com/api/workspace/alerts/delete + x-stackQL-resource: alerts + x-stackQL-method: delete + x-stackQL-verb: delete + x-numReqParams: 1 + parameters: + - name: id + required: true + description: string + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Moves an alert to the trash. Trashed alerts immediately disappear + from searches and list views, and can no longer trigger. You can restore a + trashed alert through the UI. A trashed alert is permanently deleted after + 30 days. + get: + operationId: alerts-get + externalDocs: + url: https://docs.databricks.com/api/workspace/alerts/get + x-stackQL-resource: alerts + x-stackQL-method: get + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: id + required: true + description: string + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + state: + type: string + seconds_to_retrigger: + type: integer + owner_user_name: + type: string + display_name: + type: string + id: + type: string + condition: + type: object + properties: + op: + type: string + operand: + type: object + properties: + column: + type: object + properties: + name: + type: string + threshold: + type: object + properties: + value: + type: object + properties: + string_value: + type: string + query_id: + type: string + parent_path: + type: string + lifecycle_state: + type: string + update_time: + type: string + create_time: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Gets an alert. + patch: + operationId: alerts-update + externalDocs: + url: https://docs.databricks.com/api/workspace/alerts/update + x-stackQL-resource: alerts + x-stackQL-method: update + x-stackQL-verb: update + x-numReqParams: 1 + parameters: + - name: id + required: true + description: string + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + state: + type: string + seconds_to_retrigger: + type: integer + owner_user_name: + type: string + display_name: + type: string + id: + type: string + condition: + type: object + properties: + op: + type: string + operand: + type: object + properties: + column: + type: object + properties: + name: + type: string + threshold: + type: object + properties: + value: + type: object + properties: + bool_value: + type: boolean + query_id: + type: string + parent_path: + type: string + lifecycle_state: + type: string + update_time: + type: string + create_time: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + update_mask: + type: required + alert: + type: object + example: + alert: + condition: + op: EQUAL + operand: + column: + name: bar + threshold: + value: + bool_value: true + display_name: Renamed alert + id: fe25e731-92f2-4838-9fb2-1ca364320a3d + update_mask: display_name,condition + description: Updates an alert. + /api/2.0/preview/sql/alerts: + post: + operationId: alerts-legacy-create + externalDocs: + url: https://docs.databricks.com/api/workspace/alertslegacy/create + x-stackQL-resource: alerts_legacy + x-stackQL-method: create + x-stackQL-verb: insert + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: An alert was successfully created + content: + application/json: + schema: + type: object + properties: + created_at: + type: string + id: + type: string + parent: + type: string + last_triggered_at: + type: string + name: + type: string + options: + type: object + properties: + column: + type: string + custom_body: + type: string + custom_subject: + type: string + muted: + type: boolean + op: + type: string + value: + type: 'null' + empty_result_state: + type: string + query: + type: object + properties: + created_at: + type: string + data_source_id: + type: string + description: + type: string + id: + type: string + is_archived: + type: boolean + is_draft: + type: boolean + is_safe: + type: boolean + name: + type: string + options: + type: object + properties: + moved_to_trash_at: + type: string + catalog: + type: string + schema: + type: string + parameters: + type: array + items: + type: object + properties: + title: + type: string + name: + type: string + type: + type: string + enumOptions: + type: string + queryId: + type: string + multiValuesOptions: + type: object + properties: + prefix: + type: string + separator: + type: string + suffix: + type: string + value: + type: 'null' + query: + type: string + updated_at: + type: string + tags: + type: array + items: + type: string + user_id: + type: integer + rearm: + type: integer + state: + type: string + updated_at: + type: string + user: + type: object + properties: + id: + type: integer + name: + type: string + email: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: required + query_id: + type: string + rearm: + type: required + parent: + type: UUID + options: + type: object + example: + name: Total Trips > 300 + options: + column: total_trips + custom_body: Total trips exceeded + custom_subject: The total trips has exceeded 300. + muted: false + op: '>' + value: null + empty_result_state: unknown + query_id: dee5cca8-1c79-4b5e-a711-e7f9d241bdf6 + rearm: 0 + parent: folders/2025532471912059 + description: Creates an alert. An alert is a Databricks SQL object that periodically + runs a query, evaluates a condition of its result, and notifies users or notification + destinations if the condition was met. + get: + operationId: alerts-legacy-list + externalDocs: + url: https://docs.databricks.com/api/workspace/alertslegacy/list + x-stackQL-resource: alerts_legacy + x-stackQL-method: list + x-stackQL-verb: select + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: List of alerts was successfully fetched. + content: + application/json: + schema: + type: array + items: + type: object + properties: + created_at: + type: string + id: + type: string + parent: + type: string + last_triggered_at: + type: string + name: + type: string + options: + type: object + properties: + column: + type: string + custom_body: + type: string + custom_subject: + type: string + muted: + type: boolean + op: + type: string + value: + type: 'null' + empty_result_state: + type: string + query: + type: object + properties: + created_at: + type: string + data_source_id: + type: string + description: + type: string + id: + type: string + is_archived: + type: boolean + is_draft: + type: boolean + is_safe: + type: boolean + name: + type: string + options: + type: object + properties: + moved_to_trash_at: + type: string + catalog: + type: string + schema: + type: string + parameters: + type: array + items: + type: object + properties: + title: + type: string + name: + type: string + type: + type: string + enumOptions: + type: string + queryId: + type: string + multiValuesOptions: + type: object + properties: + prefix: + type: string + separator: + type: string + suffix: + type: string + value: + type: 'null' + query: + type: string + updated_at: + type: string + tags: + type: array + items: + type: string + user_id: + type: integer + rearm: + type: integer + state: + type: string + updated_at: + type: string + user: + type: object + properties: + id: + type: integer + name: + type: string + email: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '500': + description: Internal error. + description: Gets a list of alerts. + /api/2.0/preview/sql/alerts/{alert_id}: + delete: + operationId: alerts-legacy-delete + externalDocs: + url: https://docs.databricks.com/api/workspace/alertslegacy/delete + x-stackQL-resource: alerts_legacy + x-stackQL-method: delete + x-stackQL-verb: delete + x-numReqParams: 1 + parameters: + - name: alert_id + required: true + description: string + in: path + responses: + '200': + description: Alert was successfully deleted. + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Deletes an alert. Deleted alerts are no longer accessible and cannot + be restored. + get: + operationId: alerts-legacy-get + externalDocs: + url: https://docs.databricks.com/api/workspace/alertslegacy/get + x-stackQL-resource: alerts_legacy + x-stackQL-method: get + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: alert_id + required: true + description: string + in: path + responses: + '200': + description: Alert was successfully fetched. + content: + application/json: + schema: + type: object + properties: + created_at: + type: string + id: + type: string + parent: + type: string + last_triggered_at: + type: string + name: + type: string + options: + type: object + properties: + column: + type: string + custom_body: + type: string + custom_subject: + type: string + muted: + type: boolean + op: + type: string + value: + type: 'null' + empty_result_state: + type: string + query: + type: object + properties: + created_at: + type: string + data_source_id: + type: string + description: + type: string + id: + type: string + is_archived: + type: boolean + is_draft: + type: boolean + is_safe: + type: boolean + name: + type: string + options: + type: object + properties: + moved_to_trash_at: + type: string + catalog: + type: string + schema: + type: string + parameters: + type: array + items: + type: object + properties: + title: + type: string + name: + type: string + type: + type: string + enumOptions: + type: string + queryId: + type: string + multiValuesOptions: + type: object + properties: + prefix: + type: string + separator: + type: string + suffix: + type: string + value: + type: 'null' + query: + type: string + updated_at: + type: string + tags: + type: array + items: + type: string + user_id: + type: integer + rearm: + type: integer + state: + type: string + updated_at: + type: string + user: + type: object + properties: + id: + type: integer + name: + type: string + email: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Gets an alert. + put: + operationId: alerts-legacy-update + externalDocs: + url: https://docs.databricks.com/api/workspace/alertslegacy/update + x-stackQL-resource: alerts_legacy + x-stackQL-method: update + x-stackQL-verb: update + x-numReqParams: 1 + parameters: + - name: alert_id + required: true + description: string + in: path + responses: + '200': + description: Alert was successfully updated. + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: required + query_id: + type: string + rearm: + type: required + options: + type: object + example: + name: Total Trips > 300 + options: + column: total_trips + custom_body: Total trips exceeded + custom_subject: The total trips has exceeded 300. + muted: false + op: '>' + value: null + empty_result_state: unknown + query_id: dee5cca8-1c79-4b5e-a711-e7f9d241bdf6 + rearm: 0 + description: Updates an alert. + /api/2.0/preview/sql/dashboards: + post: + operationId: dashboards-create + externalDocs: + url: https://docs.databricks.com/api/workspace/dashboards/create + x-stackQL-resource: dashboards + x-stackQL-method: create + x-stackQL-verb: insert + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: A dashboard object was successfully created. + content: + application/json: + schema: + type: object + properties: + id: + type: string + slug: + type: string + parent: + type: string + name: + type: string + user_id: + type: integer + dashboard_filters_enabled: + type: boolean + widgets: + type: array + items: + type: object + properties: + id: + type: string + width: + type: integer + options: + type: object + properties: + parameterMappings: + type: object + properties: + param: + type: object + properties: + name: + type: string + mapTo: + type: string + title: + type: string + type: + type: string + value: + type: 'null' + isHidden: + type: boolean + position: + type: object + properties: + autoHeight: + type: boolean + sizeX: + type: integer + sizeY: + type: integer + col: + type: integer + row: + type: integer + title: + type: string + description: + type: string + updated_at: + type: string + created_at: + type: string + visualization: + type: object + properties: + id: + type: string + type: + type: string + name: + type: string + description: + type: string + options: + type: 'null' + updated_at: + type: string + created_at: + type: string + query: + type: object + properties: + id: + type: string + parent: + type: string + latest_query_data_id: + type: string + name: + type: string + description: + type: string + query: + type: string + query_hash: + type: string + is_archived: + type: boolean + is_draft: + type: boolean + updated_at: + type: string + created_at: + type: string + data_source_id: + type: string + options: + type: object + properties: + moved_to_trash_at: + type: string + catalog: + type: string + schema: + type: string + parameters: + type: array + items: + type: object + properties: + title: + type: string + name: + type: string + type: + type: string + enumOptions: + type: string + queryId: + type: string + multiValuesOptions: + type: object + properties: + prefix: + type: string + separator: + type: string + suffix: + type: string + value: + type: 'null' + tags: + type: array + items: + type: string + is_safe: + type: boolean + user_id: + type: integer + last_modified_by_id: + type: integer + visualizations: + type: array + items: + type: object + properties: {} + is_favorite: + type: boolean + user: + type: object + properties: + id: + type: integer + name: + type: string + email: + type: string + last_modified_by: + type: object + properties: + id: + type: integer + name: + type: string + email: + type: string + can_edit: + type: boolean + permission_tier: + type: string + run_as_role: + type: string + is_archived: + type: boolean + is_draft: + type: boolean + tags: + type: array + items: + type: string + updated_at: + type: string + created_at: + type: string + is_favorite: + type: boolean + can_edit: + type: boolean + permission_tier: + type: string + user: + type: object + properties: + id: + type: integer + name: + type: string + email: + type: string + options: + type: object + properties: + moved_to_trash_at: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: required + parent: + type: string + tags: + type: string + is_favorite: + type: Array of string + run_as_role: + type: boolean + dashboard_filters_enabled: + type: string + example: + name: Sales Dashboard + parent: folders/2025532471912059 + tags: + - Payroll + is_favorite: true + run_as_role: viewer + dashboard_filters_enabled: true + description: Creates a new dashboard object. Only the + get: + operationId: dashboards-list + externalDocs: + url: https://docs.databricks.com/api/workspace/dashboards/list + x-stackQL-resource: dashboards + x-stackQL-method: list + x-stackQL-verb: select + x-numReqParams: 0 + parameters: + - name: page_size + in: query + - name: page + in: query + - name: order + in: query + - name: q + in: query + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + count: + type: integer + page: + type: integer + page_size: + type: integer + results: + type: array + items: + type: object + properties: + id: + type: string + slug: + type: string + parent: + type: string + name: + type: string + user_id: + type: integer + dashboard_filters_enabled: + type: boolean + widgets: + type: array + items: + type: object + properties: + id: + type: string + width: + type: integer + options: + type: object + properties: + parameterMappings: + type: object + properties: + param: + type: object + properties: + name: + type: string + mapTo: + type: string + title: + type: string + type: + type: string + value: + type: 'null' + isHidden: + type: boolean + position: + type: object + properties: + autoHeight: + type: boolean + sizeX: + type: integer + sizeY: + type: integer + col: + type: integer + row: + type: integer + title: + type: string + description: + type: string + updated_at: + type: string + created_at: + type: string + visualization: + type: object + properties: + id: + type: string + type: + type: string + name: + type: string + description: + type: string + options: + type: 'null' + updated_at: + type: string + created_at: + type: string + query: + type: object + properties: + id: + type: string + parent: + type: string + latest_query_data_id: + type: string + name: + type: string + description: + type: string + query: + type: string + query_hash: + type: string + is_archived: + type: boolean + is_draft: + type: boolean + updated_at: + type: string + created_at: + type: string + data_source_id: + type: string + options: + type: object + properties: + moved_to_trash_at: + type: string + catalog: + type: string + schema: + type: string + parameters: + type: array + items: + type: object + properties: + title: + type: string + name: + type: string + type: + type: string + enumOptions: + type: string + queryId: + type: string + multiValuesOptions: + type: object + properties: + prefix: + type: string + separator: + type: string + suffix: + type: string + value: + type: 'null' + tags: + type: array + items: + type: string + is_safe: + type: boolean + user_id: + type: integer + last_modified_by_id: + type: integer + visualizations: + type: array + items: + type: object + properties: {} + is_favorite: + type: boolean + user: + type: object + properties: + id: + type: integer + name: + type: string + email: + type: string + last_modified_by: + type: object + properties: + id: + type: integer + name: + type: string + email: + type: string + can_edit: + type: boolean + permission_tier: + type: string + run_as_role: + type: string + is_archived: + type: boolean + is_draft: + type: boolean + tags: + type: array + items: + type: string + updated_at: + type: string + created_at: + type: string + is_favorite: + type: boolean + can_edit: + type: boolean + permission_tier: + type: string + user: + type: object + properties: + id: + type: integer + name: + type: string + email: + type: string + options: + type: object + properties: + moved_to_trash_at: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + x-stackQL-objectKey: $.results + description: Fetch a paginated list of dashboard objects. + /api/2.0/preview/sql/dashboards/{dashboard_id}: + delete: + operationId: dashboards-delete + externalDocs: + url: https://docs.databricks.com/api/workspace/dashboards/delete + x-stackQL-resource: dashboards + x-stackQL-method: delete + x-stackQL-verb: delete + x-numReqParams: 1 + parameters: + - name: dashboard_id + required: true + description: string + in: path + responses: + '200': + description: Dashboard successfully moved to trash. + content: + application/json: + schema: + type: object + properties: {} + description: Moves a dashboard to the trash. Trashed dashboards do not appear + in list views or searches, and cannot be shared. + get: + operationId: dashboards-get + externalDocs: + url: https://docs.databricks.com/api/workspace/dashboards/get + x-stackQL-resource: dashboards + x-stackQL-method: get + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: dashboard_id + required: true + description: string + in: path + responses: + '200': + description: Dashboard fetched successfully. + content: + application/json: + schema: + type: object + properties: + id: + type: string + slug: + type: string + parent: + type: string + name: + type: string + user_id: + type: integer + dashboard_filters_enabled: + type: boolean + widgets: + type: array + items: + type: object + properties: + id: + type: string + width: + type: integer + options: + type: object + properties: + parameterMappings: + type: object + properties: + param: + type: object + properties: + name: + type: string + mapTo: + type: string + title: + type: string + type: + type: string + value: + type: 'null' + isHidden: + type: boolean + position: + type: object + properties: + autoHeight: + type: boolean + sizeX: + type: integer + sizeY: + type: integer + col: + type: integer + row: + type: integer + title: + type: string + description: + type: string + updated_at: + type: string + created_at: + type: string + visualization: + type: object + properties: + id: + type: string + type: + type: string + name: + type: string + description: + type: string + options: + type: 'null' + updated_at: + type: string + created_at: + type: string + query: + type: object + properties: + id: + type: string + parent: + type: string + latest_query_data_id: + type: string + name: + type: string + description: + type: string + query: + type: string + query_hash: + type: string + is_archived: + type: boolean + is_draft: + type: boolean + updated_at: + type: string + created_at: + type: string + data_source_id: + type: string + options: + type: object + properties: + moved_to_trash_at: + type: string + catalog: + type: string + schema: + type: string + parameters: + type: array + items: + type: object + properties: + title: + type: string + name: + type: string + type: + type: string + enumOptions: + type: string + queryId: + type: string + multiValuesOptions: + type: object + properties: + prefix: + type: string + separator: + type: string + suffix: + type: string + value: + type: 'null' + tags: + type: array + items: + type: string + is_safe: + type: boolean + user_id: + type: integer + last_modified_by_id: + type: integer + visualizations: + type: array + items: + type: object + properties: {} + is_favorite: + type: boolean + user: + type: object + properties: + id: + type: integer + name: + type: string + email: + type: string + last_modified_by: + type: object + properties: + id: + type: integer + name: + type: string + email: + type: string + can_edit: + type: boolean + permission_tier: + type: string + run_as_role: + type: string + is_archived: + type: boolean + is_draft: + type: boolean + tags: + type: array + items: + type: string + updated_at: + type: string + created_at: + type: string + is_favorite: + type: boolean + can_edit: + type: boolean + permission_tier: + type: string + user: + type: object + properties: + id: + type: integer + name: + type: string + email: + type: string + options: + type: object + properties: + moved_to_trash_at: + type: string + description: Returns a JSON representation of a dashboard object, including + its visualization and query objects. + post: + operationId: dashboards-update + externalDocs: + url: https://docs.databricks.com/api/workspace/dashboards/update + x-stackQL-resource: dashboards + x-stackQL-method: update + x-stackQL-verb: update + x-numReqParams: 1 + parameters: + - name: dashboard_id + required: true + description: string + in: path + responses: + '200': + description: Dashboard updated successfully. + content: + application/json: + schema: + type: object + properties: + id: + type: string + slug: + type: string + parent: + type: string + name: + type: string + user_id: + type: integer + dashboard_filters_enabled: + type: boolean + widgets: + type: array + items: + type: object + properties: + id: + type: string + width: + type: integer + options: + type: object + properties: + parameterMappings: + type: object + properties: + param: + type: object + properties: + name: + type: string + mapTo: + type: string + title: + type: string + type: + type: string + value: + type: 'null' + isHidden: + type: boolean + position: + type: object + properties: + autoHeight: + type: boolean + sizeX: + type: integer + sizeY: + type: integer + col: + type: integer + row: + type: integer + title: + type: string + description: + type: string + updated_at: + type: string + created_at: + type: string + visualization: + type: object + properties: + id: + type: string + type: + type: string + name: + type: string + description: + type: string + options: + type: 'null' + updated_at: + type: string + created_at: + type: string + query: + type: object + properties: + id: + type: string + parent: + type: string + latest_query_data_id: + type: string + name: + type: string + description: + type: string + query: + type: string + query_hash: + type: string + is_archived: + type: boolean + is_draft: + type: boolean + updated_at: + type: string + created_at: + type: string + data_source_id: + type: string + options: + type: object + properties: + moved_to_trash_at: + type: string + catalog: + type: string + schema: + type: string + parameters: + type: array + items: + type: object + properties: + title: + type: string + name: + type: string + type: + type: string + enumOptions: + type: string + queryId: + type: string + multiValuesOptions: + type: object + properties: + prefix: + type: string + separator: + type: string + suffix: + type: string + value: + type: 'null' + tags: + type: array + items: + type: string + is_safe: + type: boolean + user_id: + type: integer + last_modified_by_id: + type: integer + visualizations: + type: array + items: + type: object + properties: {} + is_favorite: + type: boolean + user: + type: object + properties: + id: + type: integer + name: + type: string + email: + type: string + last_modified_by: + type: object + properties: + id: + type: integer + name: + type: string + email: + type: string + can_edit: + type: boolean + permission_tier: + type: string + run_as_role: + type: string + is_archived: + type: boolean + is_draft: + type: boolean + tags: + type: array + items: + type: string + updated_at: + type: string + created_at: + type: string + is_favorite: + type: boolean + can_edit: + type: boolean + permission_tier: + type: string + user: + type: object + properties: + id: + type: integer + name: + type: string + email: + type: string + options: + type: object + properties: + moved_to_trash_at: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: string + run_as_role: + type: string + tags: + type: Array of string + example: + name: Sales Dashboard + run_as_role: viewer + tags: + - Payroll + description: The dashboard definition that replaces the current definition + for this + description: Modify this dashboard definition. This operation only affects attributes + of the dashboard object. It does not add, modify, or remove widgets. + /api/2.0/preview/sql/dashboards/trash/{dashboard_id}: + post: + operationId: dashboards-restore + externalDocs: + url: https://docs.databricks.com/api/workspace/dashboards/restore + x-stackQL-resource: dashboards + x-stackQL-method: restore + x-stackQL-verb: exec + x-numReqParams: 1 + parameters: + - name: dashboard_id + required: true + description: string + in: path + responses: + '200': + description: Dashboard restored successfully. + content: + application/json: + schema: + type: object + properties: {} + description: A restored dashboard appears in list views and searches and can + be shared. + /api/2.0/preview/sql/permissions/{objectType}/{objectId}: + get: + operationId: permissions-get + externalDocs: + url: https://docs.databricks.com/api/workspace/dbsqlpermissions/get + x-stackQL-resource: permissions + x-stackQL-method: get + x-stackQL-verb: select + x-numReqParams: 2 + parameters: + - name: objectType + required: true + description: string + in: path + - name: objectId + required: true + description: uuid + in: path + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + object_id: + type: string + object_type: + type: string + access_control_list: + type: array + items: + type: object + properties: + user_name: + type: string + group_name: + type: string + permission_level: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Gets a JSON representation of the access control list (ACL) for + a specified object. + post: + operationId: permissions-set + externalDocs: + url: https://docs.databricks.com/api/workspace/dbsqlpermissions/set + x-stackQL-resource: permissions + x-stackQL-method: set + x-stackQL-verb: replace + x-numReqParams: 2 + parameters: + - name: objectType + required: true + description: string + in: path + - name: objectId + required: true + description: uuid + in: path + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + object_id: + type: string + object_type: + type: string + access_control_list: + type: array + items: + type: object + properties: + user_name: + type: string + group_name: + type: string + permission_level: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + access_control_list: + type: Array of object + example: + access_control_list: + - user_name: user@example.com + group_name: admins + permission_level: CAN_VIEW + description: An ACL list to be applied to the object specified in the URL. + description: Sets the access control list (ACL) for a specified object. This + operation will complete rewrite the ACL. + /api/2.0/preview/sql/permissions/{objectType}/{objectId}/transfer: + post: + operationId: permissions-transferownership + externalDocs: + url: https://docs.databricks.com/api/workspace/dbsqlpermissions/transferownership + x-stackQL-resource: permissions + x-stackQL-method: transferownership + x-stackQL-verb: exec + x-numReqParams: 1 + parameters: + - name: objectType + required: true + description: string + in: path + - name: null + in: path + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + message: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + new_owner: + type: email + example: + new_owner: user@example.com + description: Email address for the new owner, who must exist in the workspace. + description: Transfer ownership of a single object. + /api/2.0/sql/queries: + post: + operationId: queries-create + externalDocs: + url: https://docs.databricks.com/api/workspace/queries/create + x-stackQL-resource: queries + x-stackQL-method: create + x-stackQL-verb: insert + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + description: + type: string + owner_user_name: + type: string + tags: + type: array + items: + type: string + display_name: + type: string + id: + type: string + parent_path: + type: string + lifecycle_state: + type: string + last_modifier_user_name: + type: string + query_text: + type: string + parameters: + type: array + items: + type: object + properties: + name: + type: string + text_value: + type: object + properties: + value: + type: string + title: + type: string + warehouse_id: + type: string + run_as_mode: + type: string + create_time: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + query: + type: object + example: + query: + description: Example description + tags: + - Tag 1 + display_name: Example query + parent_path: /Workspace/Users/user@acme.com + query_text: SELECT 1 + parameters: + - name: foo + text_value: + value: bar + title: foo + warehouse_id: a7066a8ef796be84 + run_as_mode: OWNER + description: Creates a query. + get: + operationId: queries-list + externalDocs: + url: https://docs.databricks.com/api/workspace/queries/list + x-stackQL-resource: queries + x-stackQL-method: list + x-stackQL-verb: select + x-numReqParams: 0 + parameters: + - name: page_token + in: query + - name: page_size + in: query + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + next_page_token: + type: string + results: + type: array + items: + type: object + properties: + description: + type: string + owner_user_name: + type: string + tags: + type: array + items: + type: string + display_name: + type: string + id: + type: string + lifecycle_state: + type: string + last_modifier_user_name: + type: string + query_text: + type: string + parameters: + type: array + items: + type: object + properties: + name: + type: string + text_value: + type: object + properties: + value: + type: string + title: + type: string + update_time: + type: string + warehouse_id: + type: string + run_as_mode: + type: string + create_time: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '500': + description: Internal error. + x-stackQL-objectKey: $.results + description: Gets a list of queries accessible to the user, ordered by creation + time. + /api/2.0/sql/queries/{id}: + delete: + operationId: queries-delete + externalDocs: + url: https://docs.databricks.com/api/workspace/queries/delete + x-stackQL-resource: queries + x-stackQL-method: delete + x-stackQL-verb: delete + x-numReqParams: 1 + parameters: + - name: id + required: true + description: string + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Moves a query to the trash. Trashed queries immediately disappear + from searches and list views, and cannot be used for alerts. You can restore + a trashed query through the UI. A trashed query is permanently deleted after + 30 days. + get: + operationId: queries-get + externalDocs: + url: https://docs.databricks.com/api/workspace/queries/get + x-stackQL-resource: queries + x-stackQL-method: get + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: id + required: true + description: string + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + description: + type: string + owner_user_name: + type: string + tags: + type: array + items: + type: string + display_name: + type: string + id: + type: string + parent_path: + type: string + lifecycle_state: + type: string + last_modifier_user_name: + type: string + query_text: + type: string + parameters: + type: array + items: + type: object + properties: + name: + type: string + text_value: + type: object + properties: + value: + type: string + title: + type: string + update_time: + type: string + warehouse_id: + type: string + run_as_mode: + type: string + create_time: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Gets a query. + patch: + operationId: queries-update + externalDocs: + url: https://docs.databricks.com/api/workspace/queries/update + x-stackQL-resource: queries + x-stackQL-method: update + x-stackQL-verb: update + x-numReqParams: 1 + parameters: + - name: id + required: true + description: string + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + description: + type: string + owner_user_name: + type: string + tags: + type: array + items: + type: string + display_name: + type: string + id: + type: string + parent_path: + type: string + lifecycle_state: + type: string + last_modifier_user_name: + type: string + query_text: + type: string + parameters: + type: array + items: + type: object + properties: + name: + type: string + text_value: + type: object + properties: + value: + type: string + title: + type: string + update_time: + type: string + warehouse_id: + type: string + run_as_mode: + type: string + create_time: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + update_mask: + type: required + query: + type: object + example: + id: fe25e731-92f2-4838-9fb2-1ca364320a3d + query: + description: Example description updated + display_name: Example query updated + query_text: SELECT 2 + update_mask: display_name,description,query_text + description: Updates a query. + /api/2.0/preview/sql/queries: + post: + operationId: queries-legacy-create + externalDocs: + url: https://docs.databricks.com/api/workspace/querieslegacy/create + x-stackQL-resource: queries_legacy + x-stackQL-method: create + x-stackQL-verb: insert + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Query created successfully + content: + application/json: + schema: + type: object + properties: + id: + type: string + parent: + type: string + latest_query_data_id: + type: string + name: + type: string + description: + type: string + query: + type: string + query_hash: + type: string + is_archived: + type: boolean + is_draft: + type: boolean + updated_at: + type: string + created_at: + type: string + data_source_id: + type: string + options: + type: object + properties: + moved_to_trash_at: + type: string + catalog: + type: string + schema: + type: string + parameters: + type: array + items: + type: object + properties: + title: + type: string + name: + type: string + type: + type: string + enumOptions: + type: string + queryId: + type: string + multiValuesOptions: + type: object + properties: + prefix: + type: string + separator: + type: string + suffix: + type: string + value: + type: 'null' + tags: + type: array + items: + type: string + is_safe: + type: boolean + user_id: + type: integer + last_modified_by_id: + type: integer + visualizations: + type: array + items: + type: object + properties: + id: + type: string + type: + type: string + name: + type: string + description: + type: string + options: + type: 'null' + updated_at: + type: string + created_at: + type: string + query: + type: object + properties: + id: + type: string + parent: + type: string + latest_query_data_id: + type: string + name: + type: string + description: + type: string + query: + type: string + query_hash: + type: string + is_archived: + type: boolean + is_draft: + type: boolean + updated_at: + type: string + created_at: + type: string + data_source_id: + type: string + options: + type: object + properties: + moved_to_trash_at: + type: string + catalog: + type: string + schema: + type: string + parameters: + type: array + items: + type: object + properties: + title: + type: string + name: + type: string + type: + type: string + enumOptions: + type: string + queryId: + type: string + multiValuesOptions: + type: object + properties: + prefix: + type: string + separator: + type: string + suffix: + type: string + value: + type: 'null' + tags: + type: array + items: + type: string + is_safe: + type: boolean + user_id: + type: integer + last_modified_by_id: + type: integer + visualizations: + type: array + items: {} + is_favorite: + type: boolean + user: + type: object + properties: + id: + type: integer + name: + type: string + email: + type: string + last_modified_by: + type: object + properties: + id: + type: integer + name: + type: string + email: + type: string + can_edit: + type: boolean + permission_tier: + type: string + run_as_role: + type: string + is_favorite: + type: boolean + user: + type: object + properties: + id: + type: integer + name: + type: string + email: + type: string + last_modified_by: + type: object + properties: + id: + type: integer + name: + type: string + email: + type: string + can_edit: + type: boolean + permission_tier: + type: string + run_as_role: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + data_source_id: + type: UUID + query: + type: string + name: + type: string + parent: + type: string + description: + type: string + options: + type: object + run_as_role: + type: string + tags: + type: Array of string + example: + data_source_id: 0c205e24-5db2-4940-adb1-fb13c7ce960b + query: SELECT field FROM table WHERE field = {{ param }} + name: Orders by month by customer + parent: folders/2025532471912059 + description: Summarizes total order dollars for customers in the Europe/Asia + region. + options: + parameters: + - title: customer + name: param + type: text + value: acme + run_as_role: viewer + tags: + - Payroll + description: A query object to be created. + description: Creates a new query definition. Queries created with this endpoint + belong to the authenticated user making the request. + get: + operationId: queries-legacy-list + externalDocs: + url: https://docs.databricks.com/api/workspace/querieslegacy/list + x-stackQL-resource: queries_legacy + x-stackQL-method: list + x-stackQL-verb: select + x-numReqParams: 0 + parameters: + - name: page_size + in: query + - name: page + in: query + - name: order + in: query + - name: q + in: query + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + count: + type: integer + page: + type: integer + page_size: + type: integer + results: + type: array + items: + type: object + properties: + id: + type: string + parent: + type: string + latest_query_data_id: + type: string + name: + type: string + description: + type: string + query: + type: string + query_hash: + type: string + is_archived: + type: boolean + is_draft: + type: boolean + updated_at: + type: string + created_at: + type: string + data_source_id: + type: string + options: + type: object + properties: + moved_to_trash_at: + type: string + catalog: + type: string + schema: + type: string + parameters: + type: array + items: + type: object + properties: + title: + type: string + name: + type: string + type: + type: string + enumOptions: + type: string + queryId: + type: string + multiValuesOptions: + type: object + properties: + prefix: + type: string + separator: + type: string + suffix: + type: string + value: + type: 'null' + tags: + type: array + items: + type: string + is_safe: + type: boolean + user_id: + type: integer + last_modified_by_id: + type: integer + visualizations: + type: array + items: + type: object + properties: + id: + type: string + type: + type: string + name: + type: string + description: + type: string + options: + type: 'null' + updated_at: + type: string + created_at: + type: string + query: + type: object + properties: {} + is_favorite: + type: boolean + user: + type: object + properties: + id: + type: integer + name: + type: string + email: + type: string + last_modified_by: + type: object + properties: + id: + type: integer + name: + type: string + email: + type: string + can_edit: + type: boolean + permission_tier: + type: string + run_as_role: + type: string + x-stackQL-objectKey: $.results + description: Gets a list of queries. Optionally, this list can be filtered by + a search term. + /api/2.0/preview/sql/queries/{query_id}: + delete: + operationId: queries-legacy-delete + externalDocs: + url: https://docs.databricks.com/api/workspace/querieslegacy/delete + x-stackQL-resource: queries_legacy + x-stackQL-method: delete + x-stackQL-verb: delete + x-numReqParams: 1 + parameters: + - name: query_id + required: true + description: UUID + in: path + responses: + '200': + description: Query moved to trash. + content: + application/json: + schema: + type: object + properties: {} + description: Moves a query to the trash. Trashed queries immediately disappear + from searches and list views, and they cannot be used for alerts. The trash + is deleted after 30 days. + get: + operationId: queries-legacy-get + externalDocs: + url: https://docs.databricks.com/api/workspace/querieslegacy/get + x-stackQL-resource: queries_legacy + x-stackQL-method: get + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: query_id + required: true + description: UUID + in: path + responses: + '200': + description: Query fetched successfully. + content: + application/json: + schema: + type: object + properties: + id: + type: string + parent: + type: string + latest_query_data_id: + type: string + name: + type: string + description: + type: string + query: + type: string + query_hash: + type: string + is_archived: + type: boolean + is_draft: + type: boolean + updated_at: + type: string + created_at: + type: string + data_source_id: + type: string + options: + type: object + properties: + moved_to_trash_at: + type: string + catalog: + type: string + schema: + type: string + parameters: + type: array + items: + type: object + properties: + title: + type: string + name: + type: string + type: + type: string + enumOptions: + type: string + queryId: + type: string + multiValuesOptions: + type: object + properties: + prefix: + type: string + separator: + type: string + suffix: + type: string + value: + type: 'null' + tags: + type: array + items: + type: string + is_safe: + type: boolean + user_id: + type: integer + last_modified_by_id: + type: integer + visualizations: + type: array + items: + type: object + properties: + id: + type: string + type: + type: string + name: + type: string + description: + type: string + options: + type: 'null' + updated_at: + type: string + created_at: + type: string + query: + type: object + properties: + id: + type: string + parent: + type: string + latest_query_data_id: + type: string + name: + type: string + description: + type: string + query: + type: string + query_hash: + type: string + is_archived: + type: boolean + is_draft: + type: boolean + updated_at: + type: string + created_at: + type: string + data_source_id: + type: string + options: + type: object + properties: + moved_to_trash_at: + type: string + catalog: + type: string + schema: + type: string + parameters: + type: array + items: + type: object + properties: + title: + type: string + name: + type: string + type: + type: string + enumOptions: + type: string + queryId: + type: string + multiValuesOptions: + type: object + properties: + prefix: + type: string + separator: + type: string + suffix: + type: string + value: + type: 'null' + tags: + type: array + items: + type: string + is_safe: + type: boolean + user_id: + type: integer + last_modified_by_id: + type: integer + visualizations: + type: array + items: {} + is_favorite: + type: boolean + user: + type: object + properties: + id: + type: integer + name: + type: string + email: + type: string + last_modified_by: + type: object + properties: + id: + type: integer + name: + type: string + email: + type: string + can_edit: + type: boolean + permission_tier: + type: string + run_as_role: + type: string + is_favorite: + type: boolean + user: + type: object + properties: + id: + type: integer + name: + type: string + email: + type: string + last_modified_by: + type: object + properties: + id: + type: integer + name: + type: string + email: + type: string + can_edit: + type: boolean + permission_tier: + type: string + run_as_role: + type: string + description: Retrieve a query object definition along with contextual permissions + information about the currently authenticated user. + post: + operationId: queries-legacy-update + externalDocs: + url: https://docs.databricks.com/api/workspace/querieslegacy/update + x-stackQL-resource: queries_legacy + x-stackQL-method: update + x-stackQL-verb: update + x-numReqParams: 1 + parameters: + - name: query_id + required: true + description: UUID + in: path + responses: + '200': + description: Query updated successfully. + content: + application/json: + schema: + type: object + properties: + id: + type: string + parent: + type: string + latest_query_data_id: + type: string + name: + type: string + description: + type: string + query: + type: string + query_hash: + type: string + is_archived: + type: boolean + is_draft: + type: boolean + updated_at: + type: string + created_at: + type: string + data_source_id: + type: string + options: + type: object + properties: + moved_to_trash_at: + type: string + catalog: + type: string + schema: + type: string + parameters: + type: array + items: + type: object + properties: + title: + type: string + name: + type: string + type: + type: string + enumOptions: + type: string + queryId: + type: string + multiValuesOptions: + type: object + properties: + prefix: + type: string + separator: + type: string + suffix: + type: string + value: + type: 'null' + tags: + type: array + items: + type: string + is_safe: + type: boolean + user_id: + type: integer + last_modified_by_id: + type: integer + visualizations: + type: array + items: + type: object + properties: + id: + type: string + type: + type: string + name: + type: string + description: + type: string + options: + type: 'null' + updated_at: + type: string + created_at: + type: string + query: + type: object + properties: + id: + type: string + parent: + type: string + latest_query_data_id: + type: string + name: + type: string + description: + type: string + query: + type: string + query_hash: + type: string + is_archived: + type: boolean + is_draft: + type: boolean + updated_at: + type: string + created_at: + type: string + data_source_id: + type: string + options: + type: object + properties: + moved_to_trash_at: + type: string + catalog: + type: string + schema: + type: string + parameters: + type: array + items: + type: object + properties: + title: + type: string + name: + type: string + type: + type: string + enumOptions: + type: string + queryId: + type: string + multiValuesOptions: + type: object + properties: + prefix: + type: string + separator: + type: string + suffix: + type: string + value: + type: 'null' + tags: + type: array + items: + type: string + is_safe: + type: boolean + user_id: + type: integer + last_modified_by_id: + type: integer + visualizations: + type: array + items: {} + is_favorite: + type: boolean + user: + type: object + properties: + id: + type: integer + name: + type: string + email: + type: string + last_modified_by: + type: object + properties: + id: + type: integer + name: + type: string + email: + type: string + can_edit: + type: boolean + permission_tier: + type: string + run_as_role: + type: string + is_favorite: + type: boolean + user: + type: object + properties: + id: + type: integer + name: + type: string + email: + type: string + last_modified_by: + type: object + properties: + id: + type: integer + name: + type: string + email: + type: string + can_edit: + type: boolean + permission_tier: + type: string + run_as_role: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + data_source_id: + type: UUID + query: + type: string + name: + type: string + description: + type: string + options: + type: object + run_as_role: + type: string + tags: + type: Array of string + example: + data_source_id: 0c205e24-5db2-4940-adb1-fb13c7ce960b + query: SELECT field FROM table WHERE field = {{ param }} + name: Orders by month by customer + description: Summarizes total order dollars for customers in the Europe/Asia + region. + options: + parameters: + - title: customer + name: param + type: text + value: acme + run_as_role: viewer + tags: + - Payroll + description: The query definition that will replace the current definition + for this + description: Modify this query definition. + /api/2.0/preview/sql/queries/trash/{query_id}: + post: + operationId: queries-legacy-restore + externalDocs: + url: https://docs.databricks.com/api/workspace/querieslegacy/restore + x-stackQL-resource: queries_legacy + x-stackQL-method: restore + x-stackQL-verb: exec + x-numReqParams: 1 + parameters: + - name: query_id + required: true + description: UUID + in: path + responses: + '200': + description: Query restored successfully. + content: + application/json: + schema: + type: object + properties: {} + description: Restore a query that has been moved to the trash. A restored query + appears in list views and searches. You can use restored queries for alerts. + /api/2.0/sql/history/queries: + get: + operationId: query-history-list + externalDocs: + url: https://docs.databricks.com/api/workspace/queryhistory/list + x-stackQL-resource: query_history + x-stackQL-method: list + x-stackQL-verb: select + x-numReqParams: 0 + parameters: + - name: null + in: query + - name: max_results + in: query + - name: page_token + in: query + - name: include_metrics + in: query + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + next_page_token: + type: string + has_next_page: + type: boolean + res: + type: array + items: + type: object + properties: + query_id: + type: string + status: + type: string + query_text: + type: string + query_start_time_ms: + type: integer + execution_end_time_ms: + type: integer + query_end_time_ms: + type: integer + user_id: + type: integer + user_name: + type: string + spark_ui_url: + type: string + endpoint_id: + type: string + rows_produced: + type: integer + error_message: + type: string + lookup_key: + type: string + metrics: + type: object + properties: + total_time_ms: + type: integer + read_bytes: + type: integer + rows_produced_count: + type: integer + compilation_time_ms: + type: integer + execution_time_ms: + type: integer + read_remote_bytes: + type: integer + write_remote_bytes: + type: integer + read_cache_bytes: + type: integer + spill_to_disk_bytes: + type: integer + task_total_time_ms: + type: integer + read_files_count: + type: integer + read_partitions_count: + type: integer + photon_total_time_ms: + type: integer + rows_read_count: + type: integer + result_fetch_time_ms: + type: integer + network_sent_bytes: + type: integer + result_from_cache: + type: boolean + pruned_bytes: + type: integer + pruned_files_count: + type: integer + provisioning_queue_start_timestamp: + type: integer + overloading_queue_start_timestamp: + type: integer + query_compilation_start_timestamp: + type: integer + executed_as_user_id: + type: integer + executed_as_user_name: + type: string + is_final: + type: boolean + channel_used: + type: object + properties: + name: + type: string + dbsql_version: + type: string + plans_state: + type: string + statement_type: + type: string + warehouse_id: + type: string + duration: + type: integer + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '429': + description: Operation is rejected due to throttling, e.g. some resource + has been exhausted, per-user quota. + '499': + description: Operation was canceled by the caller. + '500': + description: Internal error. + '503': + description: Service is currently unavailable. + x-stackQL-objectKey: $.res + description: List the history of queries through SQL warehouses, and serverless + compute. + /api/2.0/sql/statements/{statement_id}/cancel: + post: + operationId: statement-execution-cancelexecution + externalDocs: + url: https://docs.databricks.com/api/workspace/statementexecution/cancelexecution + x-stackQL-resource: statement_execution + x-stackQL-method: cancelexecution + x-stackQL-verb: exec + x-numReqParams: 2 + parameters: + - name: statement_id + required: true + description: string + in: path + - name: statement_id + required: true + description: string + in: path + responses: + '200': + description: Cancel response is empty; receiving response indicates successful + receipt. + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '429': + description: Operation is rejected due to throttling, e.g. some resource + has been exhausted, per-user quota. + '500': + description: Internal error. + '503': + description: Service is currently unavailable. + description: Requests that an executing statement be canceled. Callers must + poll for status to see the terminal state. + /api/2.0/sql/statements/: + post: + operationId: statement-execution-executestatement + externalDocs: + url: https://docs.databricks.com/api/workspace/statementexecution/executestatement + x-stackQL-resource: statement_execution + x-stackQL-method: executestatement + x-stackQL-verb: exec + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: StatementResponse contains `statement_id` and `status`; other + fields might be absent or present depending on context. If the SQL warehouse + fails to execute the provided statement, a 200 response is returned with + `status.state` set to `FAILED` (in constract to a failure when accepting + the request, which results in a non-200 response). Details of the error + can be found at `status.error` in case of execution failures. + content: + application/json: + schema: + type: object + properties: + statement_id: + type: string + status: + type: object + properties: + state: + type: string + manifest: + type: object + properties: + format: + type: string + schema: + type: object + properties: + column_count: + type: integer + columns: + type: array + items: + type: object + properties: + name: + type: string + position: + type: integer + type_name: + type: string + type_text: + type: string + result: + type: object + properties: + chunk_index: + type: integer + row_offset: + type: integer + row_count: + type: integer + data_array: + type: array + items: + type: array + items: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '429': + description: Operation is rejected due to throttling, e.g. some resource + has been exhausted, per-user quota. + '500': + description: Internal error. + '503': + description: Service is currently unavailable. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + statement: + type: required + warehouse_id: + type: string + catalog: + type: required + schema: + type: string + row_limit: + type: string + byte_limit: + type: string + disposition: + type: integer + format: int64 + format: + type: integer + format: int64 + wait_timeout: + type: string + on_wait_timeout: + type: string + parameters: + type: Array of object + example: + warehouse_id: abcdef0123456789 + statement: SELECT * FROM range(100) + wait_timeout: 0s + description: Execute a SQL statement and optionally await its results for a + specified time. + /api/2.0/sql/statements/{statement_id}: + get: + operationId: statement-execution-getstatement + externalDocs: + url: https://docs.databricks.com/api/workspace/statementexecution/getstatement + x-stackQL-resource: statement_execution + x-stackQL-method: getstatement + x-stackQL-verb: select + x-numReqParams: 2 + parameters: + - name: statement_id + required: true + description: string + in: path + - name: statement_id + required: true + description: string + in: path + responses: + '200': + description: StatementResponse contains `statement_id` and `status`; other + fields might be absent or present depending on context. In case of an + error during execution of the SQL statement -- as opposed to an error + while processing the request -- a 200 response is returned with error + details in the `status` field. + content: + application/json: + schema: + type: object + properties: + statement_id: + type: string + status: + type: object + properties: + state: + type: string + manifest: + type: object + properties: + format: + type: string + schema: + type: object + properties: + column_count: + type: integer + columns: + type: array + items: + type: object + properties: + name: + type: string + position: + type: integer + type_name: + type: string + type_text: + type: string + result: + type: object + properties: + chunk_index: + type: integer + row_offset: + type: integer + row_count: + type: integer + data_array: + type: array + items: + type: array + items: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '429': + description: Operation is rejected due to throttling, e.g. some resource + has been exhausted, per-user quota. + '500': + description: Internal error. + '503': + description: Service is currently unavailable. + description: This request can be used to poll for the statement's status. When + the + /api/2.0/sql/statements/{statement_id}/result/chunks/{chunk_index}: + get: + operationId: statement-execution-results-getstatementresultchunkn + externalDocs: + url: https://docs.databricks.com/api/workspace/statementexecution/getstatementresultchunkn + x-stackQL-resource: statement_execution_results + x-stackQL-method: getstatementresultchunkn + x-stackQL-verb: select + x-numReqParams: 4 + parameters: + - name: statement_id + required: true + description: string + in: path + - name: chunk_index + required: true + description: int32 + in: path + - name: statement_id + required: true + description: string + in: path + - name: chunk_index + required: true + description: string + in: path + responses: + '200': + description: Successful return; depending on `disposition` returns chunks + of data either inline, or as links. + content: + application/json: + schema: + type: object + properties: + chunk_index: + type: integer + row_offset: + type: integer + row_count: + type: integer + next_chunk_index: + type: integer + next_chunk_internal_link: + type: string + data_array: + type: array + items: + type: array + items: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '429': + description: Operation is rejected due to throttling, e.g. some resource + has been exhausted, per-user quota. + '500': + description: Internal error. + '503': + description: Service is currently unavailable. + description: After the statement execution has + /api/2.0/sql/warehouses: + post: + operationId: warehouses-create + externalDocs: + url: https://docs.databricks.com/api/workspace/warehouses/create + x-stackQL-resource: warehouses + x-stackQL-method: create + x-stackQL-verb: insert + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + id: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: string + cluster_size: + type: string + min_num_clusters: + type: int32 + max_num_clusters: + type: int32 + auto_stop_mins: + type: int32 + creator_name: + type: string + instance_profile_arn: + type: string + spot_instance_policy: + type: string + enable_photon: + type: boolean + enable_serverless_compute: + type: boolean + warehouse_type: + type: string + tags: + type: object + channel: + type: object + example: + name: string + cluster_size: string + min_num_clusters: '1' + max_num_clusters: 0 + auto_stop_mins: '120' + creator_name: string + instance_profile_arn: string + tags: + custom_tags: + - key: string + value: string + spot_instance_policy: POLICY_UNSPECIFIED + enable_photon: true + channel: + name: CHANNEL_NAME_PREVIEW + dbsql_version: string + enable_serverless_compute: true + warehouse_type: TYPE_UNSPECIFIED + description: Creates a new SQL warehouse. + get: + operationId: warehouses-list + externalDocs: + url: https://docs.databricks.com/api/workspace/warehouses/list + x-stackQL-resource: warehouses + x-stackQL-method: list + x-stackQL-verb: select + x-numReqParams: 0 + parameters: + - name: run_as_user_id + in: query + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + warehouses: + type: array + items: + type: object + properties: + id: + type: string + name: + type: string + cluster_size: + type: string + min_num_clusters: + type: string + max_num_clusters: + type: integer + auto_stop_mins: + type: string + creator_name: + type: string + instance_profile_arn: + type: string + tags: + type: object + properties: + custom_tags: + type: array + items: + type: object + properties: + key: + type: string + value: + type: string + spot_instance_policy: + type: string + enable_photon: + type: boolean + channel: + type: object + properties: + name: + type: string + dbsql_version: + type: string + enable_serverless_compute: + type: boolean + warehouse_type: + type: string + num_clusters: + type: integer + num_active_sessions: + type: integer + state: + type: string + jdbc_url: + type: string + odbc_params: + type: object + properties: + hostname: + type: string + path: + type: string + protocol: + type: string + port: + type: integer + health: + type: object + properties: + status: + type: string + message: + type: string + failure_reason: + type: object + properties: + code: + type: string + type: + type: string + parameters: + type: object + properties: + property1: + type: string + property2: + type: string + summary: + type: string + details: + type: string + x-stackQL-objectKey: $.warehouses + description: Lists all SQL warehouses that a user has manager permissions on. + /api/2.0/sql/warehouses/{id}: + delete: + operationId: warehouses-delete + externalDocs: + url: https://docs.databricks.com/api/workspace/warehouses/delete + x-stackQL-resource: warehouses + x-stackQL-method: delete + x-stackQL-verb: delete + x-numReqParams: 1 + parameters: + - name: id + required: true + description: string + in: path + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: {} + description: Deletes a SQL warehouse. + get: + operationId: warehouses-get + externalDocs: + url: https://docs.databricks.com/api/workspace/warehouses/get + x-stackQL-resource: warehouses + x-stackQL-method: get + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: id + required: true + description: string + in: path + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + id: + type: string + name: + type: string + cluster_size: + type: string + min_num_clusters: + type: string + max_num_clusters: + type: integer + auto_stop_mins: + type: string + creator_name: + type: string + instance_profile_arn: + type: string + tags: + type: object + properties: + custom_tags: + type: array + items: + type: object + properties: + key: + type: string + value: + type: string + spot_instance_policy: + type: string + enable_photon: + type: boolean + channel: + type: object + properties: + name: + type: string + dbsql_version: + type: string + enable_serverless_compute: + type: boolean + warehouse_type: + type: string + num_clusters: + type: integer + num_active_sessions: + type: integer + state: + type: string + jdbc_url: + type: string + odbc_params: + type: object + properties: + hostname: + type: string + path: + type: string + protocol: + type: string + port: + type: integer + health: + type: object + properties: + status: + type: string + message: + type: string + failure_reason: + type: object + properties: + code: + type: string + type: + type: string + parameters: + type: object + properties: + property1: + type: string + property2: + type: string + summary: + type: string + details: + type: string + description: Gets the information for a single SQL warehouse. + /api/2.0/sql/warehouses/{id}/edit: + post: + operationId: warehouses-edit + externalDocs: + url: https://docs.databricks.com/api/workspace/warehouses/edit + x-stackQL-resource: warehouses + x-stackQL-method: edit + x-stackQL-verb: replace + x-numReqParams: 1 + parameters: + - name: id + required: true + description: string + in: path + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: {} + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: string + cluster_size: + type: string + min_num_clusters: + type: int32 + max_num_clusters: + type: int32 + auto_stop_mins: + type: int32 + creator_name: + type: string + instance_profile_arn: + type: string + spot_instance_policy: + type: string + enable_photon: + type: boolean + enable_serverless_compute: + type: boolean + warehouse_type: + type: string + tags: + type: object + channel: + type: object + example: + name: string + cluster_size: string + min_num_clusters: '1' + max_num_clusters: 0 + auto_stop_mins: '120' + creator_name: string + instance_profile_arn: string + tags: + custom_tags: + - key: string + value: string + spot_instance_policy: POLICY_UNSPECIFIED + enable_photon: true + channel: + name: CHANNEL_NAME_PREVIEW + dbsql_version: string + enable_serverless_compute: true + warehouse_type: TYPE_UNSPECIFIED + description: Updates the configuration for a SQL warehouse. + /api/2.0/sql/warehouses/{id}/start: + post: + operationId: warehouses-start + externalDocs: + url: https://docs.databricks.com/api/workspace/warehouses/start + x-stackQL-resource: warehouses + x-stackQL-method: start + x-stackQL-verb: exec + x-numReqParams: 1 + parameters: + - name: id + required: true + description: string + in: path + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: {} + description: Starts a SQL warehouse. + /api/2.0/sql/warehouses/{id}/stop: + post: + operationId: warehouses-stop + externalDocs: + url: https://docs.databricks.com/api/workspace/warehouses/stop + x-stackQL-resource: warehouses + x-stackQL-method: stop + x-stackQL-verb: exec + x-numReqParams: 1 + parameters: + - name: id + required: true + description: string + in: path + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: {} + description: Stops a SQL warehouse. + /api/2.0/sql/config/warehouses: + get: + operationId: warehouse-config-getworkspacewarehouseconfig + externalDocs: + url: https://docs.databricks.com/api/workspace/warehouses/getworkspacewarehouseconfig + x-stackQL-resource: warehouse_config + x-stackQL-method: getworkspacewarehouseconfig + x-stackQL-verb: select + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + security_policy: + type: string + data_access_config: + type: array + items: + type: object + properties: + key: + type: string + value: + type: string + instance_profile_arn: + type: string + channel: + type: object + properties: + name: + type: string + dbsql_version: + type: string + global_param: + type: object + properties: + config_pair: + type: array + items: + type: object + properties: + key: + type: string + value: + type: string + configuration_pairs: + type: array + items: + type: object + properties: + key: + type: string + value: + type: string + config_param: + type: object + properties: + config_pair: + type: array + items: + type: object + properties: + key: + type: string + value: + type: string + configuration_pairs: + type: array + items: + type: object + properties: + key: + type: string + value: + type: string + sql_configuration_parameters: + type: object + properties: + config_pair: + type: array + items: + type: object + properties: + key: + type: string + value: + type: string + configuration_pairs: + type: array + items: + type: object + properties: + key: + type: string + value: + type: string + google_service_account: + type: string + enabled_warehouse_types: + type: array + items: + type: object + properties: + warehouse_type: + type: string + enabled: + type: boolean + description: Gets the workspace level configuration that is shared by all SQL + warehouses in a workspace. + put: + operationId: warehouse-config-setworkspacewarehouseconfig + externalDocs: + url: https://docs.databricks.com/api/workspace/warehouses/setworkspacewarehouseconfig + x-stackQL-resource: warehouse_config + x-stackQL-method: setworkspacewarehouseconfig + x-stackQL-verb: replace + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: {} + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + security_policy: + type: string + instance_profile_arn: + type: string + google_service_account: + type: string + data_access_config: + type: Array of object + channel: + type: object + global_param: + type: object + config_param: + type: object + sql_configuration_parameters: + type: object + enabled_warehouse_types: + type: Array of object + example: + security_policy: NONE + data_access_config: + - key: string + value: string + instance_profile_arn: string + channel: + name: CHANNEL_NAME_PREVIEW + dbsql_version: string + global_param: + config_pair: + - key: string + value: string + configuration_pairs: + - key: string + value: string + config_param: + config_pair: + - key: string + value: string + configuration_pairs: + - key: string + value: string + sql_configuration_parameters: + config_pair: + - key: string + value: string + configuration_pairs: + - key: string + value: string + google_service_account: string + enabled_warehouse_types: + - warehouse_type: TYPE_UNSPECIFIED + enabled: true + description: Sets the workspace level configuration that is shared by all SQL + warehouses in a workspace. + /api/2.0/permissions/warehouses/{warehouse_id}: + get: + operationId: warehouse-permissions-getpermissions + externalDocs: + url: https://docs.databricks.com/api/workspace/warehouses/getpermissions + x-stackQL-resource: warehouse_permissions + x-stackQL-method: getpermissions + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: warehouse_id + required: true + description: string + in: path + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + object_id: + type: string + object_type: + type: string + access_control_list: + type: array + items: + type: object + properties: + user_name: + type: string + group_name: + type: string + service_principal_name: + type: string + display_name: + type: string + all_permissions: + type: array + items: + type: object + properties: + permission_level: + type: string + inherited: + type: boolean + inherited_from_object: + type: array + items: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Gets the permissions of a SQL warehouse. SQL warehouses can inherit + permissions from their root object. + put: + operationId: warehouse-permissions-setpermissions + externalDocs: + url: https://docs.databricks.com/api/workspace/warehouses/setpermissions + x-stackQL-resource: warehouse_permissions + x-stackQL-method: setpermissions + x-stackQL-verb: replace + x-numReqParams: 1 + parameters: + - name: warehouse_id + required: true + description: string + in: path + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + object_id: + type: string + object_type: + type: string + access_control_list: + type: array + items: + type: object + properties: + user_name: + type: string + group_name: + type: string + service_principal_name: + type: string + display_name: + type: string + all_permissions: + type: array + items: + type: object + properties: + permission_level: + type: string + inherited: + type: boolean + inherited_from_object: + type: array + items: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + access_control_list: + type: Array of object + example: + access_control_list: + - user_name: string + group_name: string + service_principal_name: string + permission_level: CAN_MANAGE + description: Sets permissions on an object, replacing existing permissions if + they exist. Deletes all direct permissions if none are specified. Objects + can inherit permissions from their root object. + patch: + operationId: warehouse-permissions-updatepermissions + externalDocs: + url: https://docs.databricks.com/api/workspace/warehouses/updatepermissions + x-stackQL-resource: warehouse_permissions + x-stackQL-method: updatepermissions + x-stackQL-verb: update + x-numReqParams: 1 + parameters: + - name: warehouse_id + required: true + description: string + in: path + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + object_id: + type: string + object_type: + type: string + access_control_list: + type: array + items: + type: object + properties: + user_name: + type: string + group_name: + type: string + service_principal_name: + type: string + display_name: + type: string + all_permissions: + type: array + items: + type: object + properties: + permission_level: + type: string + inherited: + type: boolean + inherited_from_object: + type: array + items: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + access_control_list: + type: Array of object + example: + access_control_list: + - user_name: string + group_name: string + service_principal_name: string + permission_level: CAN_MANAGE + description: Updates the permissions on a SQL warehouse. SQL warehouses can + inherit permissions from their root object. + /api/2.0/permissions/warehouses/{warehouse_id}/permissionLevels: + get: + operationId: warehouse-permission-levels-getpermissionlevels + externalDocs: + url: https://docs.databricks.com/api/workspace/warehouses/getpermissionlevels + x-stackQL-resource: warehouse_permission_levels + x-stackQL-method: getpermissionlevels + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: warehouse_id + required: true + description: string + in: path + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + permission_levels: + type: array + items: + type: object + properties: + permission_level: + type: string + description: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + x-stackQL-objectKey: $.permission_levels + description: Gets the permission levels that a user can have on an object. +components: + x-stackQL-resources: + alerts: + id: databricks_workspace.dbsql.alerts + name: alerts + title: Alerts + methods: + create: + operation: + $ref: '#/paths/~1api~12.0~1sql~1alerts/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1api~12.0~1sql~1alerts/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.results + delete: + operation: + $ref: '#/paths/~1api~12.0~1sql~1alerts~1{id}/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1api~12.0~1sql~1alerts~1{id}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: '#/paths/~1api~12.0~1sql~1alerts~1{id}/patch' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/alerts/methods/get' + - $ref: '#/components/x-stackQL-resources/alerts/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/alerts/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/alerts/methods/update' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/alerts/methods/delete' + exec: [] + alerts_legacy: + id: databricks_workspace.dbsql.alerts_legacy + name: alerts_legacy + title: Alerts_legacy + methods: + create: + operation: + $ref: '#/paths/~1api~12.0~1preview~1sql~1alerts/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1api~12.0~1preview~1sql~1alerts/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: '#/paths/~1api~12.0~1preview~1sql~1alerts~1{alert_id}/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1api~12.0~1preview~1sql~1alerts~1{alert_id}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: '#/paths/~1api~12.0~1preview~1sql~1alerts~1{alert_id}/put' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/alerts_legacy/methods/get' + - $ref: '#/components/x-stackQL-resources/alerts_legacy/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/alerts_legacy/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/alerts_legacy/methods/update' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/alerts_legacy/methods/delete' + exec: [] + dashboards: + id: databricks_workspace.dbsql.dashboards + name: dashboards + title: Dashboards + methods: + create: + operation: + $ref: '#/paths/~1api~12.0~1preview~1sql~1dashboards/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1api~12.0~1preview~1sql~1dashboards/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.results + delete: + operation: + $ref: '#/paths/~1api~12.0~1preview~1sql~1dashboards~1{dashboard_id}/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1api~12.0~1preview~1sql~1dashboards~1{dashboard_id}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: '#/paths/~1api~12.0~1preview~1sql~1dashboards~1{dashboard_id}/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + restore: + operation: + $ref: '#/paths/~1api~12.0~1preview~1sql~1dashboards~1trash~1{dashboard_id}/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/dashboards/methods/get' + - $ref: '#/components/x-stackQL-resources/dashboards/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/dashboards/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/dashboards/methods/update' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/dashboards/methods/delete' + exec: + - $ref: '#/components/x-stackQL-resources/dashboards/methods/restore' + permissions: + id: databricks_workspace.dbsql.permissions + name: permissions + title: Permissions + methods: + get: + operation: + $ref: '#/paths/~1api~12.0~1preview~1sql~1permissions~1{objectType}~1{objectId}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + set: + operation: + $ref: '#/paths/~1api~12.0~1preview~1sql~1permissions~1{objectType}~1{objectId}/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + transferownership: + operation: + $ref: '#/paths/~1api~12.0~1preview~1sql~1permissions~1{objectType}~1{objectId}~1transfer/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/permissions/methods/get' + insert: [] + update: [] + replace: + - $ref: '#/components/x-stackQL-resources/permissions/methods/set' + delete: [] + exec: + - $ref: '#/components/x-stackQL-resources/permissions/methods/transferownership' + queries: + id: databricks_workspace.dbsql.queries + name: queries + title: Queries + methods: + create: + operation: + $ref: '#/paths/~1api~12.0~1sql~1queries/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1api~12.0~1sql~1queries/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.results + delete: + operation: + $ref: '#/paths/~1api~12.0~1sql~1queries~1{id}/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1api~12.0~1sql~1queries~1{id}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: '#/paths/~1api~12.0~1sql~1queries~1{id}/patch' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/queries/methods/get' + - $ref: '#/components/x-stackQL-resources/queries/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/queries/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/queries/methods/update' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/queries/methods/delete' + exec: [] + queries_legacy: + id: databricks_workspace.dbsql.queries_legacy + name: queries_legacy + title: Queries_legacy + methods: + create: + operation: + $ref: '#/paths/~1api~12.0~1preview~1sql~1queries/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1api~12.0~1preview~1sql~1queries/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.results + delete: + operation: + $ref: '#/paths/~1api~12.0~1preview~1sql~1queries~1{query_id}/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1api~12.0~1preview~1sql~1queries~1{query_id}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: '#/paths/~1api~12.0~1preview~1sql~1queries~1{query_id}/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + restore: + operation: + $ref: '#/paths/~1api~12.0~1preview~1sql~1queries~1trash~1{query_id}/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/queries_legacy/methods/get' + - $ref: '#/components/x-stackQL-resources/queries_legacy/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/queries_legacy/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/queries_legacy/methods/update' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/queries_legacy/methods/delete' + exec: + - $ref: '#/components/x-stackQL-resources/queries_legacy/methods/restore' + query_history: + id: databricks_workspace.dbsql.query_history + name: query_history + title: Query_history + methods: + list: + operation: + $ref: '#/paths/~1api~12.0~1sql~1history~1queries/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.res + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/query_history/methods/list' + insert: [] + update: [] + replace: [] + delete: [] + exec: [] + statement_execution: + id: databricks_workspace.dbsql.statement_execution + name: statement_execution + title: Statement_execution + methods: + cancelexecution: + operation: + $ref: '#/paths/~1api~12.0~1sql~1statements~1{statement_id}~1cancel/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + executestatement: + operation: + $ref: '#/paths/~1api~12.0~1sql~1statements~1/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + getstatement: + operation: + $ref: '#/paths/~1api~12.0~1sql~1statements~1{statement_id}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/statement_execution/methods/getstatement' + insert: [] + update: [] + replace: [] + delete: [] + exec: + - $ref: '#/components/x-stackQL-resources/statement_execution/methods/executestatement' + - $ref: '#/components/x-stackQL-resources/statement_execution/methods/cancelexecution' + statement_execution_results: + id: databricks_workspace.dbsql.statement_execution_results + name: statement_execution_results + title: Statement_execution_results + methods: + getstatementresultchunkn: + operation: + $ref: '#/paths/~1api~12.0~1sql~1statements~1{statement_id}~1result~1chunks~1{chunk_index}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/statement_execution_results/methods/getstatementresultchunkn' + insert: [] + update: [] + replace: [] + delete: [] + exec: [] + warehouses: + id: databricks_workspace.dbsql.warehouses + name: warehouses + title: Warehouses + methods: + create: + operation: + $ref: '#/paths/~1api~12.0~1sql~1warehouses/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1api~12.0~1sql~1warehouses/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.warehouses + delete: + operation: + $ref: '#/paths/~1api~12.0~1sql~1warehouses~1{id}/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1api~12.0~1sql~1warehouses~1{id}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + edit: + operation: + $ref: '#/paths/~1api~12.0~1sql~1warehouses~1{id}~1edit/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + start: + operation: + $ref: '#/paths/~1api~12.0~1sql~1warehouses~1{id}~1start/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + stop: + operation: + $ref: '#/paths/~1api~12.0~1sql~1warehouses~1{id}~1stop/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/warehouses/methods/get' + - $ref: '#/components/x-stackQL-resources/warehouses/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/warehouses/methods/create' + update: [] + replace: + - $ref: '#/components/x-stackQL-resources/warehouses/methods/edit' + delete: + - $ref: '#/components/x-stackQL-resources/warehouses/methods/delete' + exec: + - $ref: '#/components/x-stackQL-resources/warehouses/methods/stop' + - $ref: '#/components/x-stackQL-resources/warehouses/methods/start' + warehouse_config: + id: databricks_workspace.dbsql.warehouse_config + name: warehouse_config + title: Warehouse_config + methods: + getworkspacewarehouseconfig: + operation: + $ref: '#/paths/~1api~12.0~1sql~1config~1warehouses/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + setworkspacewarehouseconfig: + operation: + $ref: '#/paths/~1api~12.0~1sql~1config~1warehouses/put' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/warehouse_config/methods/getworkspacewarehouseconfig' + insert: [] + update: [] + replace: + - $ref: '#/components/x-stackQL-resources/warehouse_config/methods/setworkspacewarehouseconfig' + delete: [] + exec: [] + warehouse_permissions: + id: databricks_workspace.dbsql.warehouse_permissions + name: warehouse_permissions + title: Warehouse_permissions + methods: + getpermissions: + operation: + $ref: '#/paths/~1api~12.0~1permissions~1warehouses~1{warehouse_id}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + setpermissions: + operation: + $ref: '#/paths/~1api~12.0~1permissions~1warehouses~1{warehouse_id}/put' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + updatepermissions: + operation: + $ref: '#/paths/~1api~12.0~1permissions~1warehouses~1{warehouse_id}/patch' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/warehouse_permissions/methods/getpermissions' + insert: [] + update: + - $ref: '#/components/x-stackQL-resources/warehouse_permissions/methods/updatepermissions' + replace: + - $ref: '#/components/x-stackQL-resources/warehouse_permissions/methods/setpermissions' + delete: [] + exec: [] + warehouse_permission_levels: + id: databricks_workspace.dbsql.warehouse_permission_levels + name: warehouse_permission_levels + title: Warehouse_permission_levels + methods: + getpermissionlevels: + operation: + $ref: '#/paths/~1api~12.0~1permissions~1warehouses~1{warehouse_id}~1permissionLevels/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.permission_levels + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/warehouse_permission_levels/methods/getpermissionlevels' + insert: [] + update: [] + replace: [] + delete: [] + exec: [] diff --git a/providers/src/databricks_workspace/v00.00.00000/services/deltalivetables.yaml b/providers/src/databricks_workspace/v00.00.00000/services/deltalivetables.yaml new file mode 100644 index 00000000..b9e362d1 --- /dev/null +++ b/providers/src/databricks_workspace/v00.00.00000/services/deltalivetables.yaml @@ -0,0 +1,1619 @@ +openapi: 3.0.0 +info: + version: 2024-12-19-stackql-generated + contact: + name: StackQL Studios + url: https://stackql.io/ + email: info@stackql.io + title: Databricks Deltalivetables API + description: Deltalivetables +servers: +- url: https://{deployment_name}.cloud.databricks.com + variables: + deployment_name: + description: The Databricks Workspace Deployment Name + default: dbc-abcd0123-a1bc +paths: + /api/2.0/pipelines: + post: + operationId: pipelines-create + externalDocs: + url: https://docs.databricks.com/api/workspace/pipelines/create + x-stackQL-resource: pipelines + x-stackQL-method: create + x-stackQL-verb: insert + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + pipeline_id: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '409': + description: Request was rejected due a conflict with an existing resource. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + id: + type: string + name: + type: string + storage: + type: string + target: + type: string + schema: + type: string + continuous: + type: boolean + development: + type: boolean + photon: + type: boolean + edition: + type: string + channel: + type: string + catalog: + type: string + serverless: + type: boolean + allow_duplicate_names: + type: boolean + dry_run: + type: boolean + configuration: + type: object + clusters: + type: Array of object + libraries: + type: Array of object + trigger: + type: object + filters: + type: object + notifications: + type: Array of object + deployment: + type: object + ingestion_definition: + type: object + example: + continuous: false + name: Wikipedia pipeline (SQL) + clusters: + - label: default + autoscale: + min_workers: 1 + max_workers: 5 + mode: ENHANCED + libraries: + - notebook: + path: /Users/username/DLT Notebooks/Delta Live Tables quickstart + (SQL) + storage: /Users/username/data + description: Creates a new data processing pipeline based on the requested configuration. + If successful, this method returns the ID of the new pipeline. + get: + operationId: pipelines-listpipelines + externalDocs: + url: https://docs.databricks.com/api/workspace/pipelines/listpipelines + x-stackQL-resource: pipelines + x-stackQL-method: listpipelines + x-stackQL-verb: select + x-numReqParams: 0 + parameters: + - name: max_results + in: query + - name: page_token + in: query + - name: order_by + in: query + - name: filter + in: query + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + statuses: + type: array + items: + type: object + properties: + name: + type: string + pipeline_id: + type: string + state: + type: string + latest_updates: + type: array + items: + type: object + properties: + update_id: + type: string + state: + type: string + creation_time: + type: string + creator_user_name: + type: string + next_page_token: + type: string + prev_page_token: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '500': + description: Internal error. + x-stackQL-objectKey: $.statuses + description: Lists pipelines defined in the Delta Live Tables system. + /api/2.0/pipelines/{pipeline_id}: + delete: + operationId: pipelines-delete + externalDocs: + url: https://docs.databricks.com/api/workspace/pipelines/delete + x-stackQL-resource: pipelines + x-stackQL-method: delete + x-stackQL-verb: delete + x-numReqParams: 1 + parameters: + - name: pipeline_id + required: true + description: string + in: path + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Deletes a pipeline. + get: + operationId: pipelines-get + externalDocs: + url: https://docs.databricks.com/api/workspace/pipelines/get + x-stackQL-resource: pipelines + x-stackQL-method: get + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: pipeline_id + required: true + description: string + in: path + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + name: + type: string + pipeline_id: + type: string + state: + type: string + latest_updates: + type: array + items: + type: object + properties: + update_id: + type: string + state: + type: string + creation_time: + type: string + creator_user_name: + type: string + spec: + type: object + properties: + continuous: + type: boolean + name: + type: string + deployment: + type: object + properties: + kind: + type: string + metadata_file_path: + type: string + clusters: + type: array + items: + type: object + properties: + label: + type: string + autoscale: + type: object + properties: + min_workers: + type: integer + max_workers: + type: integer + mode: + type: string + id: + type: string + libraries: + type: array + items: + type: object + properties: + notebook: + type: object + properties: + path: + type: string + storage: + type: string + target: + type: string + run_as_user_name: + type: string + cluster_id: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + put: + operationId: pipelines-update + externalDocs: + url: https://docs.databricks.com/api/workspace/pipelines/update + x-stackQL-resource: pipelines + x-stackQL-method: update + x-stackQL-verb: update + x-numReqParams: 1 + parameters: + - name: pipeline_id + required: true + description: string + in: path + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '409': + description: Request was rejected due a conflict with an existing resource. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + id: + type: string + name: + type: string + storage: + type: string + target: + type: string + schema: + type: string + continuous: + type: boolean + development: + type: boolean + photon: + type: boolean + edition: + type: string + channel: + type: string + catalog: + type: string + serverless: + type: boolean + pipeline_id: + type: string + allow_duplicate_names: + type: boolean + expected_last_modified: + type: integer + format: int64 + configuration: + type: object + clusters: + type: Array of object + libraries: + type: Array of object + trigger: + type: object + filters: + type: object + notifications: + type: Array of object + deployment: + type: object + ingestion_definition: + type: object + example: + continuous: false + name: Wikipedia pipeline (SQL) + clusters: + - label: default + autoscale: + min_workers: 1 + max_workers: 5 + mode: ENHANCED + id: a12cd3e4-0ab1-1abc-1a2b-1a2bcd3e4fg5 + libraries: + - notebook: + path: /Users/username/DLT Notebooks/Delta Live Tables quickstart + (SQL) + storage: /Users/username/data + target: wikipedia_quickstart_data + description: Updates a pipeline with the supplied configuration. + /api/2.0/pipelines/{pipeline_id}/stop: + post: + operationId: pipelines-stop + externalDocs: + url: https://docs.databricks.com/api/workspace/pipelines/stop + x-stackQL-resource: pipelines + x-stackQL-method: stop + x-stackQL-verb: exec + x-numReqParams: 1 + parameters: + - name: pipeline_id + required: true + description: string + in: path + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Stops the pipeline by canceling the active update. If there is + no active update for the pipeline, this request is a no-op. + /api/2.0/pipelines/{pipeline_id}/events: + get: + operationId: pipeline-events-listpipelineevents + externalDocs: + url: https://docs.databricks.com/api/workspace/pipelines/listpipelineevents + x-stackQL-resource: pipeline_events + x-stackQL-method: listpipelineevents + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: pipeline_id + required: true + description: string + in: path + - name: max_results + in: query + - name: order_by + in: query + - name: filter + in: query + - name: page_token + in: query + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + next_page_token: + type: string + prev_page_token: + type: string + events: + type: array + items: + type: object + properties: + id: + type: string + sequence: + type: object + properties: + data_plane_id: + type: object + properties: + instance: + type: string + seq_no: + type: integer + control_plane_seq_no: + type: integer + origin: + type: object + properties: + cloud: + type: string + region: + type: string + org_id: + type: integer + pipeline_id: + type: string + pipeline_name: + type: string + cluster_id: + type: string + update_id: + type: string + maintenance_id: + type: string + table_id: + type: string + dataset_name: + type: string + flow_id: + type: string + flow_name: + type: string + batch_id: + type: integer + request_id: + type: string + uc_resource_id: + type: string + host: + type: string + materialization_name: + type: string + timestamp: + type: string + message: + type: string + level: + type: string + error: + type: object + properties: + fatal: + type: boolean + exceptions: + type: array + items: + type: object + properties: + class_name: + type: string + message: + type: string + stack: + type: array + items: + type: object + properties: + declaring_class: + type: string + method_name: + type: string + file_name: + type: string + line_number: + type: integer + event_type: + type: string + maturity_level: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + x-stackQL-objectKey: $.events + description: Retrieves events for a pipeline. + /api/2.0/permissions/pipelines/{pipeline_id}: + get: + operationId: pipeline-permissions-getpermissions + externalDocs: + url: https://docs.databricks.com/api/workspace/pipelines/getpermissions + x-stackQL-resource: pipeline_permissions + x-stackQL-method: getpermissions + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: pipeline_id + required: true + description: string + in: path + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + object_id: + type: string + object_type: + type: string + access_control_list: + type: array + items: + type: object + properties: + user_name: + type: string + group_name: + type: string + service_principal_name: + type: string + display_name: + type: string + all_permissions: + type: array + items: + type: object + properties: + permission_level: + type: string + inherited: + type: boolean + inherited_from_object: + type: array + items: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Gets the permissions of a pipeline. Pipelines can inherit permissions + from their root object. + put: + operationId: pipeline-permissions-setpermissions + externalDocs: + url: https://docs.databricks.com/api/workspace/pipelines/setpermissions + x-stackQL-resource: pipeline_permissions + x-stackQL-method: setpermissions + x-stackQL-verb: replace + x-numReqParams: 1 + parameters: + - name: pipeline_id + required: true + description: string + in: path + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + object_id: + type: string + object_type: + type: string + access_control_list: + type: array + items: + type: object + properties: + user_name: + type: string + group_name: + type: string + service_principal_name: + type: string + display_name: + type: string + all_permissions: + type: array + items: + type: object + properties: + permission_level: + type: string + inherited: + type: boolean + inherited_from_object: + type: array + items: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + access_control_list: + type: Array of object + example: + access_control_list: + - user_name: string + group_name: string + service_principal_name: string + permission_level: CAN_MANAGE + description: Sets permissions on an object, replacing existing permissions if + they exist. Deletes all direct permissions if none are specified. Objects + can inherit permissions from their root object. + patch: + operationId: pipeline-permissions-updatepermissions + externalDocs: + url: https://docs.databricks.com/api/workspace/pipelines/updatepermissions + x-stackQL-resource: pipeline_permissions + x-stackQL-method: updatepermissions + x-stackQL-verb: update + x-numReqParams: 1 + parameters: + - name: pipeline_id + required: true + description: string + in: path + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + object_id: + type: string + object_type: + type: string + access_control_list: + type: array + items: + type: object + properties: + user_name: + type: string + group_name: + type: string + service_principal_name: + type: string + display_name: + type: string + all_permissions: + type: array + items: + type: object + properties: + permission_level: + type: string + inherited: + type: boolean + inherited_from_object: + type: array + items: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + access_control_list: + type: Array of object + example: + access_control_list: + - user_name: string + group_name: string + service_principal_name: string + permission_level: CAN_MANAGE + description: Updates the permissions on a pipeline. Pipelines can inherit permissions + from their root object. + /api/2.0/permissions/pipelines/{pipeline_id}/permissionLevels: + get: + operationId: pipeline-permission-levels-getpermissionlevels + externalDocs: + url: https://docs.databricks.com/api/workspace/pipelines/getpermissionlevels + x-stackQL-resource: pipeline_permission_levels + x-stackQL-method: getpermissionlevels + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: pipeline_id + required: true + description: string + in: path + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + permission_levels: + type: array + items: + type: object + properties: + permission_level: + type: string + description: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + x-stackQL-objectKey: $.permission_levels + description: Gets the permission levels that a user can have on an object. + /api/2.0/pipelines/{pipeline_id}/updates/{update_id}: + get: + operationId: pipeline-updates-getupdate + externalDocs: + url: https://docs.databricks.com/api/workspace/pipelines/getupdate + x-stackQL-resource: pipeline_updates + x-stackQL-method: getupdate + x-stackQL-verb: select + x-numReqParams: 2 + parameters: + - name: pipeline_id + required: true + description: string + in: path + - name: update_id + required: true + description: string + in: path + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + update: + type: object + properties: + creation_time: + type: integer + pipeline_id: + type: string + state: + type: string + update_id: + type: string + config: + type: object + properties: + continuous: + type: boolean + name: + type: string + clusters: + type: array + items: + type: object + properties: + label: + type: string + autoscale: + type: object + properties: + min_workers: + type: integer + max_workers: + type: integer + mode: + type: string + id: + type: string + libraries: + type: array + items: + type: object + properties: + notebook: + type: object + properties: + path: + type: string + configuration: + type: object + properties: + pipelines.numStreamRetryAttempts: + type: string + storage: + type: string + target: + type: string + development: + type: boolean + full_refresh: + type: boolean + cause: + type: string + request_id: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + x-stackQL-objectKey: $.update + description: Gets an update from an active pipeline. + /api/2.0/pipelines/{pipeline_id}/updates: + get: + operationId: pipeline-updates-listupdates + externalDocs: + url: https://docs.databricks.com/api/workspace/pipelines/listupdates + x-stackQL-resource: pipeline_updates + x-stackQL-method: listupdates + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: pipeline_id + required: true + description: string + in: path + - name: page_token + in: query + - name: max_results + in: query + - name: until_update_id + in: query + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + updates: + type: array + items: + type: object + properties: + pipeline_id: + type: string + update_id: + type: string + config: + type: object + properties: + id: + type: string + name: + type: string + storage: + type: string + configuration: + type: object + properties: + property1: + type: string + property2: + type: string + clusters: + type: array + items: + type: object + properties: + label: + type: string + spark_conf: + type: object + properties: + spark.speculation: + type: boolean + spark.streaming.ui.retainedBatches: + type: integer + aws_attributes: + type: object + properties: + first_on_demand: + type: string + availability: + type: string + zone_id: + type: string + instance_profile_arn: + type: string + spot_bid_price_percent: + type: string + ebs_volume_type: + type: string + ebs_volume_count: + type: string + ebs_volume_size: + type: integer + ebs_volume_iops: + type: integer + ebs_volume_throughput: + type: integer + node_type_id: + type: string + driver_node_type_id: + type: string + ssh_public_keys: + type: array + items: + type: string + custom_tags: + type: object + properties: + property1: + type: string + property2: + type: string + cluster_log_conf: + type: object + properties: + dbfs: + type: object + properties: + destination: + type: string + s3: + type: object + properties: + destination: + type: string + region: + type: string + endpoint: + type: string + enable_encryption: + type: boolean + encryption_type: + type: string + kms_key: + type: string + canned_acl: + type: string + init_scripts: + type: array + items: + type: object + properties: + workspace: + type: object + properties: + destination: + type: string + volumes: + type: object + properties: + destination: + type: string + s3: + type: object + properties: + destination: + type: string + region: + type: string + endpoint: + type: string + enable_encryption: + type: boolean + encryption_type: + type: string + kms_key: + type: string + canned_acl: + type: string + file: + type: object + properties: + destination: + type: string + dbfs: + type: object + properties: + destination: + type: string + abfss: + type: object + properties: + destination: + type: string + gcs: + type: object + properties: + destination: + type: string + spark_env_vars: + type: object + properties: + property1: + type: string + property2: + type: string + instance_pool_id: + type: string + driver_instance_pool_id: + type: string + policy_id: + type: string + num_workers: + type: integer + autoscale: + type: object + properties: + min_workers: + type: integer + max_workers: + type: integer + mode: + type: string + apply_policy_default_values: + type: boolean + enable_local_disk_encryption: + type: boolean + libraries: + type: array + items: + type: object + properties: + notebook: + type: object + properties: + path: + type: string + file: + type: object + properties: + path: + type: string + whl: + type: string + trigger: + type: object + properties: + manual: + type: object + properties: {} + cron: + type: object + properties: + quartz_cron_schedule: + type: string + timezone_id: + type: string + target: + type: string + schema: + type: string + filters: + type: object + properties: + include: + type: array + items: + type: string + exclude: + type: array + items: + type: string + continuous: + type: boolean + development: + type: boolean + photon: + type: boolean + edition: + type: string + channel: + type: string + catalog: + type: string + notifications: + type: array + items: + type: object + properties: + email_recipients: + type: array + items: + type: string + alerts: + type: array + items: + type: string + serverless: + type: boolean + deployment: + type: object + properties: + kind: + type: string + metadata_file_path: + type: string + ingestion_definition: + type: object + properties: + connection_name: + type: string + ingestion_gateway_id: + type: string + objects: + type: array + items: + type: object + properties: + schema: + type: object + properties: + source_catalog: + type: string + source_schema: + type: string + destination_catalog: + type: string + destination_schema: + type: string + table_configuration: + type: object + properties: + primary_keys: + type: array + items: + type: string + sequence_by: + type: array + items: + type: string + table: + type: object + properties: + source_catalog: + type: string + source_schema: + type: string + source_table: + type: string + destination_catalog: + type: string + destination_schema: + type: string + destination_table: + type: string + table_configuration: + type: object + properties: + primary_keys: + type: array + items: + type: string + sequence_by: + type: array + items: + type: string + report: + type: object + properties: + source_url: + type: string + destination_catalog: + type: string + destination_schema: + type: string + destination_table: + type: string + table_configuration: + type: object + properties: + primary_keys: + type: array + items: + type: string + sequence_by: + type: array + items: + type: string + table_configuration: + type: object + properties: + primary_keys: + type: array + items: + type: string + sequence_by: + type: array + items: + type: string + cause: + type: string + state: + type: string + cluster_id: + type: string + creation_time: + type: integer + validate_only: + type: boolean + full_refresh: + type: boolean + refresh_selection: + type: array + items: + type: string + full_refresh_selection: + type: array + items: + type: string + next_page_token: + type: string + prev_page_token: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + x-stackQL-objectKey: $.updates + description: List updates for an active pipeline. + post: + operationId: pipeline-updates-startupdate + externalDocs: + url: https://docs.databricks.com/api/workspace/pipelines/startupdate + x-stackQL-resource: pipeline_updates + x-stackQL-method: startupdate + x-stackQL-verb: exec + x-numReqParams: 1 + parameters: + - name: pipeline_id + required: true + description: string + in: path + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + update_id: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '409': + description: Request was rejected due a conflict with an existing resource. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + full_refresh: + type: boolean + validate_only: + type: boolean + cause: + type: string + refresh_selection: + type: Array of string + full_refresh_selection: + type: Array of string + example: + full_refresh: true + description: Starts a new update for the pipeline. If there is already an active + update for the pipeline, the request will fail and the active update will + remain running. +components: + x-stackQL-resources: + pipelines: + id: databricks_workspace.deltalivetables.pipelines + name: pipelines + title: Pipelines + methods: + create: + operation: + $ref: '#/paths/~1api~12.0~1pipelines/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + listpipelines: + operation: + $ref: '#/paths/~1api~12.0~1pipelines/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.statuses + delete: + operation: + $ref: '#/paths/~1api~12.0~1pipelines~1{pipeline_id}/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1api~12.0~1pipelines~1{pipeline_id}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: '#/paths/~1api~12.0~1pipelines~1{pipeline_id}/put' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + stop: + operation: + $ref: '#/paths/~1api~12.0~1pipelines~1{pipeline_id}~1stop/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/pipelines/methods/get' + - $ref: '#/components/x-stackQL-resources/pipelines/methods/listpipelines' + insert: + - $ref: '#/components/x-stackQL-resources/pipelines/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/pipelines/methods/update' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/pipelines/methods/delete' + exec: + - $ref: '#/components/x-stackQL-resources/pipelines/methods/stop' + pipeline_events: + id: databricks_workspace.deltalivetables.pipeline_events + name: pipeline_events + title: Pipeline_events + methods: + listpipelineevents: + operation: + $ref: '#/paths/~1api~12.0~1pipelines~1{pipeline_id}~1events/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.events + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/pipeline_events/methods/listpipelineevents' + insert: [] + update: [] + replace: [] + delete: [] + exec: [] + pipeline_permissions: + id: databricks_workspace.deltalivetables.pipeline_permissions + name: pipeline_permissions + title: Pipeline_permissions + methods: + getpermissions: + operation: + $ref: '#/paths/~1api~12.0~1permissions~1pipelines~1{pipeline_id}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + setpermissions: + operation: + $ref: '#/paths/~1api~12.0~1permissions~1pipelines~1{pipeline_id}/put' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + updatepermissions: + operation: + $ref: '#/paths/~1api~12.0~1permissions~1pipelines~1{pipeline_id}/patch' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/pipeline_permissions/methods/getpermissions' + insert: [] + update: + - $ref: '#/components/x-stackQL-resources/pipeline_permissions/methods/updatepermissions' + replace: + - $ref: '#/components/x-stackQL-resources/pipeline_permissions/methods/setpermissions' + delete: [] + exec: [] + pipeline_permission_levels: + id: databricks_workspace.deltalivetables.pipeline_permission_levels + name: pipeline_permission_levels + title: Pipeline_permission_levels + methods: + getpermissionlevels: + operation: + $ref: '#/paths/~1api~12.0~1permissions~1pipelines~1{pipeline_id}~1permissionLevels/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.permission_levels + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/pipeline_permission_levels/methods/getpermissionlevels' + insert: [] + update: [] + replace: [] + delete: [] + exec: [] + pipeline_updates: + id: databricks_workspace.deltalivetables.pipeline_updates + name: pipeline_updates + title: Pipeline_updates + methods: + getupdate: + operation: + $ref: '#/paths/~1api~12.0~1pipelines~1{pipeline_id}~1updates~1{update_id}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.update + listupdates: + operation: + $ref: '#/paths/~1api~12.0~1pipelines~1{pipeline_id}~1updates/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.updates + startupdate: + operation: + $ref: '#/paths/~1api~12.0~1pipelines~1{pipeline_id}~1updates/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/pipeline_updates/methods/listupdates' + - $ref: '#/components/x-stackQL-resources/pipeline_updates/methods/getupdate' + insert: [] + update: [] + replace: [] + delete: [] + exec: + - $ref: '#/components/x-stackQL-resources/pipeline_updates/methods/startupdate' diff --git a/providers/src/databricks_workspace/v00.00.00000/services/deltasharing.yaml b/providers/src/databricks_workspace/v00.00.00000/services/deltasharing.yaml new file mode 100644 index 00000000..79240229 --- /dev/null +++ b/providers/src/databricks_workspace/v00.00.00000/services/deltasharing.yaml @@ -0,0 +1,1768 @@ +openapi: 3.0.0 +info: + version: 2024-12-19-stackql-generated + contact: + name: StackQL Studios + url: https://stackql.io/ + email: info@stackql.io + title: Databricks Deltasharing API + description: Deltasharing +servers: +- url: https://{deployment_name}.cloud.databricks.com + variables: + deployment_name: + description: The Databricks Workspace Deployment Name + default: dbc-abcd0123-a1bc +paths: + /api/2.1/unity-catalog/providers: + post: + operationId: providers-create + externalDocs: + url: https://docs.databricks.com/api/workspace/providers/create + x-stackQL-resource: providers + x-stackQL-method: create + x-stackQL-verb: insert + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: The new provider was successfully created. + content: + application/json: + schema: + type: object + properties: + name: + type: string + authentication_type: + type: string + recipient_profile_str: + type: string + comment: + type: string + owner: + type: string + recipient_profile: + type: object + properties: + share_credentials_version: + type: integer + endpoint: + type: string + bearer_token: + type: string + created_at: + type: integer + created_by: + type: string + updated_at: + type: integer + updated_by: + type: string + cloud: + type: string + region: + type: string + metastore_id: + type: string + data_provider_global_metastore_id: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: required + authentication_type: + type: string + comment: + type: required + recipient_profile_str: + type: string + example: + name: string + authentication_type: TOKEN + comment: string + recipient_profile_str: string + description: Creates a new authentication provider minimally based on a name + and authentication type. The caller must be an admin on the metastore. + get: + operationId: providers-list + externalDocs: + url: https://docs.databricks.com/api/workspace/providers/list + x-stackQL-resource: providers + x-stackQL-method: list + x-stackQL-verb: select + x-numReqParams: 0 + parameters: + - name: data_provider_global_metastore_id + in: query + - name: max_results + in: query + - name: page_token + in: query + responses: + '200': + description: The provider list was successfully retrieved. + content: + application/json: + schema: + type: object + properties: + providers: + type: array + items: + type: object + properties: + name: + type: string + authentication_type: + type: string + recipient_profile_str: + type: string + comment: + type: string + owner: + type: string + recipient_profile: + type: object + properties: + share_credentials_version: + type: integer + endpoint: + type: string + bearer_token: + type: string + created_at: + type: integer + created_by: + type: string + updated_at: + type: integer + updated_by: + type: string + cloud: + type: string + region: + type: string + metastore_id: + type: string + data_provider_global_metastore_id: + type: string + next_page_token: + type: string + x-stackQL-objectKey: $.providers + description: Gets an array of available authentication providers. The caller + must either be a metastore admin or the owner of the providers. Providers + not owned by the caller are not included in the response. There is no guarantee + of a specific ordering of the elements in the array. + /api/2.1/unity-catalog/providers/{name}: + delete: + operationId: providers-delete + externalDocs: + url: https://docs.databricks.com/api/workspace/providers/delete + x-stackQL-resource: providers + x-stackQL-method: delete + x-stackQL-verb: delete + x-numReqParams: 1 + parameters: + - name: name + required: true + description: string + in: path + responses: + '200': + description: The provider was successfully deleted. + content: + application/json: + schema: + type: object + properties: {} + description: Deletes an authentication provider, if the caller is a metastore + admin or is the owner of the provider. + get: + operationId: providers-get + externalDocs: + url: https://docs.databricks.com/api/workspace/providers/get + x-stackQL-resource: providers + x-stackQL-method: get + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: name + required: true + description: string + in: path + responses: + '200': + description: The provider was successfully retrieved. + content: + application/json: + schema: + type: object + properties: + name: + type: string + authentication_type: + type: string + recipient_profile_str: + type: string + comment: + type: string + owner: + type: string + recipient_profile: + type: object + properties: + share_credentials_version: + type: integer + endpoint: + type: string + bearer_token: + type: string + created_at: + type: integer + created_by: + type: string + updated_at: + type: integer + updated_by: + type: string + cloud: + type: string + region: + type: string + metastore_id: + type: string + data_provider_global_metastore_id: + type: string + description: Gets a specific authentication provider. The caller must supply + the name of the provider, and must either be a metastore admin or the owner + of the provider. + patch: + operationId: providers-update + externalDocs: + url: https://docs.databricks.com/api/workspace/providers/update + x-stackQL-resource: providers + x-stackQL-method: update + x-stackQL-verb: update + x-numReqParams: 1 + parameters: + - name: name + required: true + description: string + in: path + responses: + '200': + description: The provider was successfully updated. + content: + application/json: + schema: + type: object + properties: + name: + type: string + authentication_type: + type: string + recipient_profile_str: + type: string + comment: + type: string + owner: + type: string + recipient_profile: + type: object + properties: + share_credentials_version: + type: integer + endpoint: + type: string + bearer_token: + type: string + created_at: + type: integer + created_by: + type: string + updated_at: + type: integer + updated_by: + type: string + cloud: + type: string + region: + type: string + metastore_id: + type: string + data_provider_global_metastore_id: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + recipient_profile_str: + type: string + comment: + type: string + owner: + type: string + new_name: + type: string + example: + recipient_profile_str: string + comment: string + owner: string + new_name: string + description: Updates the information for an authentication provider, if the + caller is a metastore admin or is the owner of the provider. If the update + changes the provider name, the caller must be both a metastore admin and the + owner of the provider. + /api/2.1/unity-catalog/providers/{name}/shares: + get: + operationId: provider-shares-listshares + externalDocs: + url: https://docs.databricks.com/api/workspace/providers/listshares + x-stackQL-resource: provider_shares + x-stackQL-method: listshares + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: name + required: true + description: string + in: path + - name: max_results + in: query + - name: page_token + in: query + responses: + '200': + description: The provider shares list was successfully retrieved. + content: + application/json: + schema: + type: object + properties: + shares: + type: array + items: + type: object + properties: + name: + type: string + next_page_token: + type: string + x-stackQL-objectKey: $.shares + description: 'Gets an array of a specified provider''s shares within the metastore + where:' + /api/2.1/unity-catalog/recipients: + post: + operationId: recipients-create + externalDocs: + url: https://docs.databricks.com/api/workspace/recipients/create + x-stackQL-resource: recipients + x-stackQL-method: create + x-stackQL-verb: insert + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: The new recipient was successfully created. + content: + application/json: + schema: + type: object + properties: + name: + type: string + authentication_type: + type: string + sharing_code: + type: string + data_recipient_global_metastore_id: + type: string + owner: + type: string + comment: + type: string + ip_access_list: + type: object + properties: + allowed_ip_addresses: + type: array + items: + type: string + properties_kvpairs: + type: object + properties: + properties: + type: object + properties: + property1: + type: string + property2: + type: string + activation_url: + type: string + activated: + type: boolean + created_at: + type: integer + created_by: + type: string + tokens: + type: array + items: + type: object + properties: + id: + type: string + created_at: + type: integer + created_by: + type: string + activation_url: + type: string + expiration_time: + type: integer + updated_at: + type: integer + updated_by: + type: string + updated_at: + type: integer + updated_by: + type: string + cloud: + type: string + region: + type: string + metastore_id: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: required + authentication_type: + type: string + owner: + type: required + comment: + type: string + data_recipient_global_metastore_id: + type: string + sharing_code: + type: string + expiration_time: + type: string + ip_access_list: + type: object + properties_kvpairs: + type: object + example: + name: string + authentication_type: TOKEN + owner: string + comment: string + ip_access_list: + allowed_ip_addresses: + - string + properties_kvpairs: + properties: + property1: string + property2: string + data_recipient_global_metastore_id: string + sharing_code: string + expiration_time: 0 + description: Creates a new recipient with the delta sharing authentication type + in the metastore. The caller must be a metastore admin or has the + get: + operationId: recipients-list + externalDocs: + url: https://docs.databricks.com/api/workspace/recipients/list + x-stackQL-resource: recipients + x-stackQL-method: list + x-stackQL-verb: select + x-numReqParams: 0 + parameters: + - name: data_recipient_global_metastore_id + in: query + - name: max_results + in: query + - name: page_token + in: query + responses: + '200': + description: The list of recipients was successfully retrieved. + content: + application/json: + schema: + type: object + properties: + recipients: + type: array + items: + type: object + properties: + name: + type: string + authentication_type: + type: string + sharing_code: + type: string + data_recipient_global_metastore_id: + type: string + owner: + type: string + comment: + type: string + ip_access_list: + type: object + properties: + allowed_ip_addresses: + type: array + items: + type: string + properties_kvpairs: + type: object + properties: + properties: + type: object + properties: + property1: + type: string + property2: + type: string + activation_url: + type: string + activated: + type: boolean + created_at: + type: integer + created_by: + type: string + tokens: + type: array + items: + type: object + properties: + id: + type: string + created_at: + type: integer + created_by: + type: string + activation_url: + type: string + expiration_time: + type: integer + updated_at: + type: integer + updated_by: + type: string + updated_at: + type: integer + updated_by: + type: string + cloud: + type: string + region: + type: string + metastore_id: + type: string + next_page_token: + type: string + x-stackQL-objectKey: $.recipients + description: 'Gets an array of all share recipients within the current metastore + where:' + /api/2.1/unity-catalog/recipients/{name}: + delete: + operationId: recipients-delete + externalDocs: + url: https://docs.databricks.com/api/workspace/recipients/delete + x-stackQL-resource: recipients + x-stackQL-method: delete + x-stackQL-verb: delete + x-numReqParams: 1 + parameters: + - name: name + required: true + description: string + in: path + responses: + '200': + description: The recipient was successfully deleted. + content: + application/json: + schema: + type: object + properties: {} + description: Deletes the specified recipient from the metastore. The caller + must be the owner of the recipient. + get: + operationId: recipients-get + externalDocs: + url: https://docs.databricks.com/api/workspace/recipients/get + x-stackQL-resource: recipients + x-stackQL-method: get + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: name + required: true + description: string + in: path + responses: + '200': + description: The recipient was successfully retrieved. + content: + application/json: + schema: + type: object + properties: + name: + type: string + authentication_type: + type: string + sharing_code: + type: string + data_recipient_global_metastore_id: + type: string + owner: + type: string + comment: + type: string + ip_access_list: + type: object + properties: + allowed_ip_addresses: + type: array + items: + type: string + properties_kvpairs: + type: object + properties: + properties: + type: object + properties: + property1: + type: string + property2: + type: string + activation_url: + type: string + activated: + type: boolean + created_at: + type: integer + created_by: + type: string + tokens: + type: array + items: + type: object + properties: + id: + type: string + created_at: + type: integer + created_by: + type: string + activation_url: + type: string + expiration_time: + type: integer + updated_at: + type: integer + updated_by: + type: string + updated_at: + type: integer + updated_by: + type: string + cloud: + type: string + region: + type: string + metastore_id: + type: string + description: 'Gets a share recipient from the metastore if:' + patch: + operationId: recipients-update + externalDocs: + url: https://docs.databricks.com/api/workspace/recipients/update + x-stackQL-resource: recipients + x-stackQL-method: update + x-stackQL-verb: update + x-numReqParams: 1 + parameters: + - name: name + required: true + description: string + in: path + responses: + '200': + description: The recipient was successfully updated. + content: + application/json: + schema: + type: object + properties: {} + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + owner: + type: string + comment: + type: string + new_name: + type: string + expiration_time: + type: integer + format: int64 + ip_access_list: + type: object + properties_kvpairs: + type: object + example: + owner: string + comment: string + ip_access_list: + allowed_ip_addresses: + - string + new_name: string + properties_kvpairs: + properties: + property1: string + property2: string + expiration_time: 0 + description: Updates an existing recipient in the metastore. The caller must + be a metastore admin or the owner of the recipient. If the recipient name + will be updated, the user must be both a metastore admin and the owner of + the recipient. + /api/2.1/unity-catalog/recipients/{name}/rotate-token: + post: + operationId: recipients-rotatetoken + externalDocs: + url: https://docs.databricks.com/api/workspace/recipients/rotatetoken + x-stackQL-resource: recipients + x-stackQL-method: rotatetoken + x-stackQL-verb: exec + x-numReqParams: 1 + parameters: + - name: name + required: true + description: string + in: path + responses: + '200': + description: The recipient token was successfully rotated. + content: + application/json: + schema: + type: object + properties: + name: + type: string + authentication_type: + type: string + sharing_code: + type: string + data_recipient_global_metastore_id: + type: string + owner: + type: string + comment: + type: string + ip_access_list: + type: object + properties: + allowed_ip_addresses: + type: array + items: + type: string + properties_kvpairs: + type: object + properties: + properties: + type: object + properties: + property1: + type: string + property2: + type: string + activation_url: + type: string + activated: + type: boolean + created_at: + type: integer + created_by: + type: string + tokens: + type: array + items: + type: object + properties: + id: + type: string + created_at: + type: integer + created_by: + type: string + activation_url: + type: string + expiration_time: + type: integer + updated_at: + type: integer + updated_by: + type: string + updated_at: + type: integer + updated_by: + type: string + cloud: + type: string + region: + type: string + metastore_id: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + existing_token_expire_in_seconds: + type: required + example: + existing_token_expire_in_seconds: 0 + description: Refreshes the specified recipient's delta sharing authentication + token with the provided token info. The caller must be the owner of the recipient. + /api/2.1/unity-catalog/public/data_sharing_activation/{activation_url}: + get: + operationId: recipient-activation-token-retrievetoken + externalDocs: + url: https://docs.databricks.com/api/workspace/recipientactivation/retrievetoken + x-stackQL-resource: recipient_activation_token + x-stackQL-method: retrievetoken + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: activation_url + required: true + description: string + in: path + responses: + '200': + description: The access token was successfully retrieved. + content: + application/json: + schema: + type: object + properties: + shareCredentialsVersion: + type: integer + bearerToken: + type: string + endpoint: + type: string + expirationTime: + type: string + description: Retrieve access token with an activation url. This is a public + API without any authentication. + /api/2.1/unity-catalog/public/data_sharing_activation_info/{activation_url}: + get: + operationId: recipient-activation-url-getactivationurlinfo + externalDocs: + url: https://docs.databricks.com/api/workspace/recipientactivation/getactivationurlinfo + x-stackQL-resource: recipient_activation_url + x-stackQL-method: getactivationurlinfo + x-stackQL-verb: exec + x-numReqParams: 1 + parameters: + - name: activation_url + required: true + description: string + in: path + responses: + '200': + description: The activation URL fetch was successful. + content: + application/json: + schema: + type: object + properties: {} + description: Gets an activation URL for a share. + /api/2.1/unity-catalog/recipients/{name}/share-permissions: + get: + operationId: recipient-share-permissions-sharepermissions + externalDocs: + url: https://docs.databricks.com/api/workspace/recipients/sharepermissions + x-stackQL-resource: recipient_share_permissions + x-stackQL-method: sharepermissions + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: name + required: true + description: string + in: path + - name: max_results + in: query + - name: page_token + in: query + responses: + '200': + description: The recipient share permissions list was successfully retrieved. + content: + application/json: + schema: + type: object + properties: + permissions_out: + type: array + items: + type: object + properties: + share_name: + type: string + privilege_assignments: + type: array + items: + type: object + properties: + principal: + type: string + privileges: + type: array + items: + type: string + next_page_token: + type: string + x-stackQL-objectKey: $.permissions_out + description: Gets the share permissions for the specified Recipient. The caller + must be a metastore admin or the owner of the Recipient. + /api/2.1/unity-catalog/shares: + post: + operationId: shares-create + externalDocs: + url: https://docs.databricks.com/api/workspace/shares/create + x-stackQL-resource: shares + x-stackQL-method: create + x-stackQL-verb: insert + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: The new share was successfully created. + content: + application/json: + schema: + type: object + properties: + name: + type: string + owner: + type: string + comment: + type: string + storage_root: + type: string + objects: + type: array + items: + type: object + properties: + name: + type: string + comment: + type: string + shared_as: + type: string + string_shared_as: + type: string + content: + type: string + history_data_sharing_status: + type: string + partitions: + type: array + items: + type: object + properties: + values: + type: array + items: + type: object + properties: + name: + type: string + value: + type: string + recipient_property_key: + type: string + op: + type: string + cdf_enabled: + type: boolean + start_version: + type: integer + data_object_type: + type: string + added_at: + type: integer + added_by: + type: string + status: + type: string + created_at: + type: integer + created_by: + type: string + updated_at: + type: integer + updated_by: + type: string + storage_location: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: required + comment: + type: string + storage_root: + type: string + example: + name: string + comment: string + storage_root: string + description: Creates a new share for data objects. Data objects can be added + after creation with + get: + operationId: shares-list + externalDocs: + url: https://docs.databricks.com/api/workspace/shares/list + x-stackQL-resource: shares + x-stackQL-method: list + x-stackQL-verb: select + x-numReqParams: 0 + parameters: + - name: max_results + in: query + - name: page_token + in: query + responses: + '200': + description: The shares list was successfully retrieved. + content: + application/json: + schema: + type: object + properties: + shares: + type: array + items: + type: object + properties: + name: + type: string + owner: + type: string + comment: + type: string + storage_root: + type: string + objects: + type: array + items: + type: object + properties: + name: + type: string + comment: + type: string + shared_as: + type: string + string_shared_as: + type: string + content: + type: string + history_data_sharing_status: + type: string + partitions: + type: array + items: + type: object + properties: + values: + type: array + items: + type: object + properties: + name: + type: string + value: + type: string + recipient_property_key: + type: string + op: + type: string + cdf_enabled: + type: boolean + start_version: + type: integer + data_object_type: + type: string + added_at: + type: integer + added_by: + type: string + status: + type: string + created_at: + type: integer + created_by: + type: string + updated_at: + type: integer + updated_by: + type: string + storage_location: + type: string + next_page_token: + type: string + x-stackQL-objectKey: $.shares + description: Gets an array of data object shares from the metastore. The caller + must be a metastore admin or the owner of the share. There is no guarantee + of a specific ordering of the elements in the array. + /api/2.1/unity-catalog/shares/{name}: + delete: + operationId: shares-delete + externalDocs: + url: https://docs.databricks.com/api/workspace/shares/delete + x-stackQL-resource: shares + x-stackQL-method: delete + x-stackQL-verb: delete + x-numReqParams: 1 + parameters: + - name: name + required: true + description: string + in: path + responses: + '200': + description: The share was successfully deleted. + content: + application/json: + schema: + type: object + properties: {} + description: Deletes a data object share from the metastore. The caller must + be an owner of the share. + get: + operationId: shares-get + externalDocs: + url: https://docs.databricks.com/api/workspace/shares/get + x-stackQL-resource: shares + x-stackQL-method: get + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: name + required: true + description: string + in: path + - name: include_shared_data + in: query + responses: + '200': + description: The share was successfully retrieved. + content: + application/json: + schema: + type: object + properties: + name: + type: string + owner: + type: string + comment: + type: string + storage_root: + type: string + objects: + type: array + items: + type: object + properties: + name: + type: string + comment: + type: string + shared_as: + type: string + string_shared_as: + type: string + content: + type: string + history_data_sharing_status: + type: string + partitions: + type: array + items: + type: object + properties: + values: + type: array + items: + type: object + properties: + name: + type: string + value: + type: string + recipient_property_key: + type: string + op: + type: string + cdf_enabled: + type: boolean + start_version: + type: integer + data_object_type: + type: string + added_at: + type: integer + added_by: + type: string + status: + type: string + created_at: + type: integer + created_by: + type: string + updated_at: + type: integer + updated_by: + type: string + storage_location: + type: string + description: Gets a data object share from the metastore. The caller must be + a metastore admin or the owner of the share. + patch: + operationId: shares-update + externalDocs: + url: https://docs.databricks.com/api/workspace/shares/update + x-stackQL-resource: shares + x-stackQL-method: update + x-stackQL-verb: update + x-numReqParams: 1 + parameters: + - name: name + required: true + description: string + in: path + responses: + '200': + description: The share was successfully updated. + content: + application/json: + schema: + type: object + properties: + name: + type: string + owner: + type: string + comment: + type: string + storage_root: + type: string + objects: + type: array + items: + type: object + properties: + name: + type: string + comment: + type: string + shared_as: + type: string + string_shared_as: + type: string + content: + type: string + history_data_sharing_status: + type: string + partitions: + type: array + items: + type: object + properties: + values: + type: array + items: + type: object + properties: + name: + type: string + value: + type: string + recipient_property_key: + type: string + op: + type: string + cdf_enabled: + type: boolean + start_version: + type: integer + data_object_type: + type: string + added_at: + type: integer + added_by: + type: string + status: + type: string + created_at: + type: integer + created_by: + type: string + updated_at: + type: integer + updated_by: + type: string + storage_location: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + owner: + type: string + comment: + type: string + storage_root: + type: string + new_name: + type: string + updates: + type: Array of object + example: + owner: string + comment: string + storage_root: string + new_name: string + updates: + - action: ADD + data_object: + name: string + comment: string + shared_as: string + string_shared_as: string + content: string + history_data_sharing_status: ENABLED + partitions: + - values: + - name: string + value: string + recipient_property_key: string + op: EQUAL + cdf_enabled: true + start_version: 0 + data_object_type: TABLE + added_at: 0 + added_by: string + status: ACTIVE + description: Updates the share with the changes and data objects in the request. + The caller must be the owner of the share or a metastore admin. + /api/2.1/unity-catalog/shares/{name}/permissions: + get: + operationId: share-permissions-sharepermissions + externalDocs: + url: https://docs.databricks.com/api/workspace/shares/sharepermissions + x-stackQL-resource: share_permissions + x-stackQL-method: sharepermissions + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: name + required: true + description: string + in: path + - name: max_results + in: query + - name: page_token + in: query + responses: + '200': + description: The share permissions list was successfully retrieved. + content: + application/json: + schema: + type: object + properties: + privilege_assignments: + type: array + items: + type: object + properties: + principal: + type: string + privileges: + type: array + items: + type: string + x-stackQL-objectKey: $.privilege_assignments + description: Gets the permissions for a data share from the metastore. The caller + must be a metastore admin or the owner of the share. + patch: + operationId: share-permissions-updatepermissions + externalDocs: + url: https://docs.databricks.com/api/workspace/shares/updatepermissions + x-stackQL-resource: share_permissions + x-stackQL-method: updatepermissions + x-stackQL-verb: update + x-numReqParams: 1 + parameters: + - name: name + required: true + description: string + in: path + - name: max_results + in: query + - name: page_token + in: query + responses: + '200': + description: The share permissions were successfully updated. + content: + application/json: + schema: + type: object + properties: {} + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + changes: + type: Array of object + example: + changes: + - principal: string + add: + - SELECT + remove: + - SELECT + description: Updates the permissions for a data share in the metastore. The + caller must be a metastore admin or an owner of the share. +components: + x-stackQL-resources: + providers: + id: databricks_workspace.deltasharing.providers + name: providers + title: Providers + methods: + create: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1providers/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1providers/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.providers + delete: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1providers~1{name}/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1providers~1{name}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1providers~1{name}/patch' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/providers/methods/get' + - $ref: '#/components/x-stackQL-resources/providers/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/providers/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/providers/methods/update' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/providers/methods/delete' + exec: [] + provider_shares: + id: databricks_workspace.deltasharing.provider_shares + name: provider_shares + title: Provider_shares + methods: + listshares: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1providers~1{name}~1shares/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.shares + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/provider_shares/methods/listshares' + insert: [] + update: [] + replace: [] + delete: [] + exec: [] + recipients: + id: databricks_workspace.deltasharing.recipients + name: recipients + title: Recipients + methods: + create: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1recipients/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1recipients/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.recipients + delete: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1recipients~1{name}/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1recipients~1{name}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1recipients~1{name}/patch' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + rotatetoken: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1recipients~1{name}~1rotate-token/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/recipients/methods/get' + - $ref: '#/components/x-stackQL-resources/recipients/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/recipients/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/recipients/methods/update' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/recipients/methods/delete' + exec: + - $ref: '#/components/x-stackQL-resources/recipients/methods/rotatetoken' + recipient_activation_token: + id: databricks_workspace.deltasharing.recipient_activation_token + name: recipient_activation_token + title: Recipient_activation_token + methods: + retrievetoken: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1public~1data_sharing_activation~1{activation_url}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/recipient_activation_token/methods/retrievetoken' + insert: [] + update: [] + replace: [] + delete: [] + exec: [] + recipient_activation_url: + id: databricks_workspace.deltasharing.recipient_activation_url + name: recipient_activation_url + title: Recipient_activation_url + methods: + getactivationurlinfo: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1public~1data_sharing_activation_info~1{activation_url}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: [] + replace: [] + delete: [] + exec: + - $ref: '#/components/x-stackQL-resources/recipient_activation_url/methods/getactivationurlinfo' + recipient_share_permissions: + id: databricks_workspace.deltasharing.recipient_share_permissions + name: recipient_share_permissions + title: Recipient_share_permissions + methods: + sharepermissions: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1recipients~1{name}~1share-permissions/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.permissions_out + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/recipient_share_permissions/methods/sharepermissions' + insert: [] + update: [] + replace: [] + delete: [] + exec: [] + shares: + id: databricks_workspace.deltasharing.shares + name: shares + title: Shares + methods: + create: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1shares/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1shares/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.shares + delete: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1shares~1{name}/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1shares~1{name}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1shares~1{name}/patch' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/shares/methods/get' + - $ref: '#/components/x-stackQL-resources/shares/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/shares/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/shares/methods/update' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/shares/methods/delete' + exec: [] + share_permissions: + id: databricks_workspace.deltasharing.share_permissions + name: share_permissions + title: Share_permissions + methods: + sharepermissions: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1shares~1{name}~1permissions/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.privilege_assignments + updatepermissions: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1shares~1{name}~1permissions/patch' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/share_permissions/methods/sharepermissions' + insert: [] + update: + - $ref: '#/components/x-stackQL-resources/share_permissions/methods/updatepermissions' + replace: [] + delete: [] + exec: [] diff --git a/providers/src/databricks_workspace/v00.00.00000/services/filemanagement.yaml b/providers/src/databricks_workspace/v00.00.00000/services/filemanagement.yaml new file mode 100644 index 00000000..e3fcf603 --- /dev/null +++ b/providers/src/databricks_workspace/v00.00.00000/services/filemanagement.yaml @@ -0,0 +1,865 @@ +openapi: 3.0.0 +info: + version: 2024-12-19-stackql-generated + contact: + name: StackQL Studios + url: https://stackql.io/ + email: info@stackql.io + title: Databricks Filemanagement API + description: Filemanagement +servers: +- url: https://{deployment_name}.cloud.databricks.com + variables: + deployment_name: + description: The Databricks Workspace Deployment Name + default: dbc-abcd0123-a1bc +paths: + /api/2.0/dbfs/list: + get: + operationId: dbfs-directories-list + externalDocs: + url: https://docs.databricks.com/api/workspace/dbfs/list + x-stackQL-resource: dbfs_directories + x-stackQL-method: list + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: path + required: true + description: string + in: query + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + files: + type: array + items: + type: object + properties: + path: + type: string + is_dir: + type: boolean + file_size: + type: integer + modification_time: + type: integer + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + x-stackQL-objectKey: $.files + description: List the contents of a directory, or details of the file. If the + file or directory does not exist, this call throws an exception with + /api/2.0/dbfs/mkdirs: + post: + operationId: dbfs-directories-mkdirs + externalDocs: + url: https://docs.databricks.com/api/workspace/dbfs/mkdirs + x-stackQL-resource: dbfs_directories + x-stackQL-method: mkdirs + x-stackQL-verb: insert + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + path: + type: required + example: + path: /mnt/foo + description: Creates the given directory and necessary parent directories if + they do not exist. If a file (not a directory) exists at any prefix of the + input path, this call throws an exception with + /api/2.0/dbfs/delete: + post: + operationId: dbfs-objects-delete + externalDocs: + url: https://docs.databricks.com/api/workspace/dbfs/delete + x-stackQL-resource: dbfs_objects + x-stackQL-method: delete + x-stackQL-verb: delete + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + path: + type: required + recursive: + type: string + example: + path: /mnt/foo + recursive: false + description: Delete the file or directory (optionally recursively delete all + files in the directory). This call throws an exception with + /api/2.0/dbfs/move: + post: + operationId: dbfs-files-move + externalDocs: + url: https://docs.databricks.com/api/workspace/dbfs/move + x-stackQL-resource: dbfs_files + x-stackQL-method: move + x-stackQL-verb: exec + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + source_path: + type: required + destination_path: + type: string + example: + source_path: /mnt/foo + destination_path: /mnt/bar + description: Moves a file from one location to another location within DBFS. + If the source file does not exist, this call throws an exception with + /api/2.0/dbfs/put: + post: + operationId: dbfs-files-put + externalDocs: + url: https://docs.databricks.com/api/workspace/dbfs/put + x-stackQL-resource: dbfs_files + x-stackQL-method: put + x-stackQL-verb: exec + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + path: + type: required + contents: + type: string + overwrite: + type: string + example: + path: /mnt/foo + contents: string + overwrite: false + description: Uploads a file through the use of multipart form post. It is mainly + used for streaming uploads, but can also be used as a convenient single call + for data upload. + /api/2.0/dbfs/read: + get: + operationId: dbfs-files-read + externalDocs: + url: https://docs.databricks.com/api/workspace/dbfs/read + x-stackQL-resource: dbfs_files + x-stackQL-method: read + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: path + required: true + description: string + in: query + - name: offset + in: query + - name: length + in: query + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + bytes_read: + type: integer + data: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Returns the contents of a file. If the file does not exist, this + call throws an exception with + /api/2.0/dbfs/get-status: + get: + operationId: dbfs-objects-getstatus + externalDocs: + url: https://docs.databricks.com/api/workspace/dbfs/getstatus + x-stackQL-resource: dbfs_objects + x-stackQL-method: getstatus + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: path + required: true + description: string + in: query + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + path: + type: string + is_dir: + type: boolean + file_size: + type: integer + modification_time: + type: integer + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Gets the file information for a file or directory. If the file + or directory does not exist, this call throws an exception with + /api/2.0/dbfs/add-block: + post: + operationId: dbfs-streams-addblock + externalDocs: + url: https://docs.databricks.com/api/workspace/dbfs/addblock + x-stackQL-resource: dbfs_streams + x-stackQL-method: addblock + x-stackQL-verb: exec + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + handle: + type: required + data: + type: integer + format: int64 + example: + handle: 0 + data: string + description: Appends a block of data to the stream specified by the input handle. + If the handle does not exist, this call will throw an exception with + /api/2.0/dbfs/close: + post: + operationId: dbfs-streams-close + externalDocs: + url: https://docs.databricks.com/api/workspace/dbfs/close + x-stackQL-resource: dbfs_streams + x-stackQL-method: close + x-stackQL-verb: delete + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + handle: + type: required + example: + handle: 0 + description: Closes the stream specified by the input handle. If the handle + does not exist, this call throws an exception with + /api/2.0/dbfs/create: + post: + operationId: dbfs-streams-create + externalDocs: + url: https://docs.databricks.com/api/workspace/dbfs/create + x-stackQL-resource: dbfs_streams + x-stackQL-method: create + x-stackQL-verb: insert + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + handle: + type: integer + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + path: + type: required + overwrite: + type: string + example: + path: /mnt/foo + overwrite: false + description: Opens a stream to write to a file and returns a handle to this + stream. There is a 10 minute idle timeout on this handle. If a file or directory + already exists on the given path and + /api/2.0/fs/directories{directory_path}: + put: + operationId: directories-createdirectory + externalDocs: + url: https://docs.databricks.com/api/workspace/files/createdirectory + x-stackQL-resource: directories + x-stackQL-method: createdirectory + x-stackQL-verb: insert + x-numReqParams: 1 + parameters: + - name: directory_path + required: true + description: string + in: path + responses: + '204': + description: The directory was successfully created or already exists. + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '409': + description: Request was rejected due a conflict with an existing resource. + '500': + description: Internal error. + description: Creates an empty directory. If necessary, also creates any parent + directories of the new, empty directory (like the shell command + delete: + operationId: directories-deletedirectory + externalDocs: + url: https://docs.databricks.com/api/workspace/files/deletedirectory + x-stackQL-resource: directories + x-stackQL-method: deletedirectory + x-stackQL-verb: delete + x-numReqParams: 1 + parameters: + - name: directory_path + required: true + description: string + in: path + responses: + '204': + description: The directory was successfully deleted. + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '409': + description: Request was rejected due a conflict with an existing resource. + '500': + description: Internal error. + description: Deletes an empty directory. + get: + operationId: directory-contents-listdirectorycontents + externalDocs: + url: https://docs.databricks.com/api/workspace/files/listdirectorycontents + x-stackQL-resource: directory_contents + x-stackQL-method: listdirectorycontents + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: directory_path + required: true + description: string + in: path + - name: page_token + in: query + - name: page_size + in: query + responses: + '200': + description: An array of DirectoryEntry for the contents of the directory. + If `next_page_token` is set, there may be more entries in the directory. + content: + application/json: + schema: + type: object + properties: + contents: + type: array + items: + type: object + properties: + path: + type: string + is_directory: + type: boolean + file_size: + type: integer + last_modified: + type: integer + name: + type: string + next_page_token: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '409': + description: Request was rejected due a conflict with an existing resource. + '500': + description: Internal error. + x-stackQL-objectKey: $.contents + description: Returns the contents of a directory. If there is no directory at + the specified path, the API returns a HTTP 404 error. + /api/2.0/fs/files{file_path}: + delete: + operationId: files-delete + externalDocs: + url: https://docs.databricks.com/api/workspace/files/delete + x-stackQL-resource: files + x-stackQL-method: delete + x-stackQL-verb: delete + x-numReqParams: 1 + parameters: + - name: file_path + required: true + description: string + in: path + responses: + '204': + description: The file was successfully deleted. + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Deletes a file. If the request is successful, there is no response + body. + get: + operationId: files-download + externalDocs: + url: https://docs.databricks.com/api/workspace/files/download + x-stackQL-resource: files + x-stackQL-method: download + x-stackQL-verb: exec + x-numReqParams: 1 + parameters: + - name: file_path + required: true + description: string + in: path + responses: + '200': + description: '' + description: Downloads a file. The file contents are the response body. This + is a standard HTTP file download, not a JSON RPC. It supports the Range and + If-Unmodified-Since HTTP headers. + put: + operationId: files-upload + externalDocs: + url: https://docs.databricks.com/api/workspace/files/upload + x-stackQL-resource: files + x-stackQL-method: upload + x-stackQL-verb: exec + x-numReqParams: 1 + parameters: + - name: file_path + required: true + description: string + in: path + - name: overwrite + in: query + responses: + '204': + description: The file was successfully uploaded. + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '500': + description: Internal error. + description: Uploads a file of up to 5 GiB. The file contents should be sent + as the request body as raw bytes (an octet stream); do not encode or otherwise + modify the bytes before sending. The contents of the resulting file will be + exactly the bytes sent in the request body. If the request is successful, + there is no response body. +components: + x-stackQL-resources: + dbfs_directories: + id: databricks_workspace.filemanagement.dbfs_directories + name: dbfs_directories + title: Dbfs_directories + methods: + list: + operation: + $ref: '#/paths/~1api~12.0~1dbfs~1list/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.files + mkdirs: + operation: + $ref: '#/paths/~1api~12.0~1dbfs~1mkdirs/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/dbfs_directories/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/dbfs_directories/methods/mkdirs' + update: [] + replace: [] + delete: [] + exec: [] + dbfs_objects: + id: databricks_workspace.filemanagement.dbfs_objects + name: dbfs_objects + title: Dbfs_objects + methods: + delete: + operation: + $ref: '#/paths/~1api~12.0~1dbfs~1delete/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + getstatus: + operation: + $ref: '#/paths/~1api~12.0~1dbfs~1get-status/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/dbfs_objects/methods/getstatus' + insert: [] + update: [] + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/dbfs_objects/methods/delete' + exec: [] + dbfs_files: + id: databricks_workspace.filemanagement.dbfs_files + name: dbfs_files + title: Dbfs_files + methods: + move: + operation: + $ref: '#/paths/~1api~12.0~1dbfs~1move/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + put: + operation: + $ref: '#/paths/~1api~12.0~1dbfs~1put/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + read: + operation: + $ref: '#/paths/~1api~12.0~1dbfs~1read/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/dbfs_files/methods/read' + insert: [] + update: [] + replace: [] + delete: [] + exec: + - $ref: '#/components/x-stackQL-resources/dbfs_files/methods/put' + - $ref: '#/components/x-stackQL-resources/dbfs_files/methods/move' + dbfs_streams: + id: databricks_workspace.filemanagement.dbfs_streams + name: dbfs_streams + title: Dbfs_streams + methods: + addblock: + operation: + $ref: '#/paths/~1api~12.0~1dbfs~1add-block/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + close: + operation: + $ref: '#/paths/~1api~12.0~1dbfs~1close/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + create: + operation: + $ref: '#/paths/~1api~12.0~1dbfs~1create/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: '#/components/x-stackQL-resources/dbfs_streams/methods/create' + update: [] + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/dbfs_streams/methods/close' + exec: + - $ref: '#/components/x-stackQL-resources/dbfs_streams/methods/addblock' + directories: + id: databricks_workspace.filemanagement.directories + name: directories + title: Directories + methods: + createdirectory: + operation: + $ref: '#/paths/~1api~12.0~1fs~1directories{directory_path}/put' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + deletedirectory: + operation: + $ref: '#/paths/~1api~12.0~1fs~1directories{directory_path}/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: '#/components/x-stackQL-resources/directories/methods/createdirectory' + update: [] + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/directories/methods/deletedirectory' + exec: [] + directory_contents: + id: databricks_workspace.filemanagement.directory_contents + name: directory_contents + title: Directory_contents + methods: + listdirectorycontents: + operation: + $ref: '#/paths/~1api~12.0~1fs~1directories{directory_path}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.contents + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/directory_contents/methods/listdirectorycontents' + insert: [] + update: [] + replace: [] + delete: [] + exec: [] + files: + id: databricks_workspace.filemanagement.files + name: files + title: Files + methods: + delete: + operation: + $ref: '#/paths/~1api~12.0~1fs~1files{file_path}/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + download: + operation: + $ref: '#/paths/~1api~12.0~1fs~1files{file_path}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + upload: + operation: + $ref: '#/paths/~1api~12.0~1fs~1files{file_path}/put' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: [] + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/files/methods/delete' + exec: + - $ref: '#/components/x-stackQL-resources/files/methods/upload' + - $ref: '#/components/x-stackQL-resources/files/methods/download' diff --git a/providers/src/databricks_workspace/v00.00.00000/services/iam.yaml b/providers/src/databricks_workspace/v00.00.00000/services/iam.yaml new file mode 100644 index 00000000..b52ac9ed --- /dev/null +++ b/providers/src/databricks_workspace/v00.00.00000/services/iam.yaml @@ -0,0 +1,2891 @@ +openapi: 3.0.0 +info: + version: 2024-12-19-stackql-generated + contact: + name: StackQL Studios + url: https://stackql.io/ + email: info@stackql.io + title: Databricks Iam API + description: Iam +servers: +- url: https://{deployment_name}.cloud.databricks.com + variables: + deployment_name: + description: The Databricks Workspace Deployment Name + default: dbc-abcd0123-a1bc +paths: + /api/2.0/preview/accounts/access-control/assignable-roles: + get: + operationId: assignable-roles-getassignablerolesforresource + externalDocs: + url: https://docs.databricks.com/api/workspace/accountaccesscontrolproxy/getassignablerolesforresource + x-stackQL-resource: assignable_roles + x-stackQL-method: getassignablerolesforresource + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: resource + required: true + description: string + in: query + responses: + '200': + description: Assignable roles were returned successfully. + content: + application/json: + schema: + type: object + properties: + roles: + type: array + items: + type: object + properties: + name: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '500': + description: Internal error. + x-stackQL-objectKey: $.roles + description: Gets all the roles that can be granted on an account-level resource. + A role is grantable if the rule set on the resource can contain an access + rule of the role. + /api/2.0/preview/scim/v2/Me: + get: + operationId: currentuser-me + externalDocs: + url: https://docs.databricks.com/api/workspace/currentuser/me + x-stackQL-resource: currentuser + x-stackQL-method: me + x-stackQL-verb: select + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: User information was returned successfully. + content: + application/json: + schema: + type: object + properties: + schemas: + type: array + items: + type: string + id: + type: string + userName: + type: string + emails: + type: array + items: + type: object + properties: + $ref: + type: string + value: + type: string + display: + type: string + primary: + type: boolean + type: + type: string + name: + type: object + properties: + givenName: + type: string + familyName: + type: string + displayName: + type: string + groups: + type: array + items: + type: object + properties: + $ref: + type: string + value: + type: string + display: + type: string + primary: + type: boolean + type: + type: string + roles: + type: array + items: + type: object + properties: + $ref: + type: string + value: + type: string + display: + type: string + primary: + type: boolean + type: + type: string + entitlements: + type: array + items: + type: object + properties: + $ref: + type: string + value: + type: string + display: + type: string + primary: + type: boolean + type: + type: string + externalId: + type: string + active: + type: boolean + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Get details about the current method caller's identity. + /api/2.0/preview/scim/v2/Groups: + post: + operationId: groups-create + externalDocs: + url: https://docs.databricks.com/api/workspace/groups/create + x-stackQL-resource: groups + x-stackQL-method: create + x-stackQL-verb: insert + x-numReqParams: 0 + parameters: [] + responses: + '201': + description: The group creation request succeeded. + content: + application/json: + schema: + type: object + properties: + schemas: + type: array + items: + type: string + id: + type: string + displayName: + type: string + members: + type: array + items: + type: object + properties: + $ref: + type: string + value: + type: string + display: + type: string + primary: + type: boolean + type: + type: string + groups: + type: array + items: + type: object + properties: + $ref: + type: string + value: + type: string + display: + type: string + primary: + type: boolean + type: + type: string + roles: + type: array + items: + type: object + properties: + $ref: + type: string + value: + type: string + display: + type: string + primary: + type: boolean + type: + type: string + entitlements: + type: array + items: + type: object + properties: + $ref: + type: string + value: + type: string + display: + type: string + primary: + type: boolean + type: + type: string + externalId: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '409': + description: Request was rejected due a conflict with an existing resource. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + schemas: + type: Array of string + id: + type: integer + format: int64 + displayName: + type: string + externalId: + type: string + members: + type: Array of object + groups: + type: Array of object + roles: + type: Array of object + entitlements: + type: Array of object + example: + schemas: + - urn:ietf:params:scim:schemas:core:2.0:Group + id: string + displayName: string + members: + - $ref: string + value: string + display: string + primary: true + type: string + groups: + - $ref: string + value: string + display: string + primary: true + type: string + roles: + - $ref: string + value: string + display: string + primary: true + type: string + entitlements: + - $ref: string + value: string + display: string + primary: true + type: string + externalId: string + description: Properties of the new group. + description: Creates a group in the Databricks workspace with a unique name, + using the supplied group details. + get: + operationId: groups-list + externalDocs: + url: https://docs.databricks.com/api/workspace/groups/list + x-stackQL-resource: groups + x-stackQL-method: list + x-stackQL-verb: select + x-numReqParams: 0 + parameters: + - name: filter + in: query + - name: attributes + in: query + - name: excludedAttributes + in: query + - name: startIndex + in: query + - name: count + in: query + - name: sortBy + in: query + - name: sortOrder + in: query + responses: + '200': + description: List groups operation was succesful. + content: + application/json: + schema: + type: object + properties: + schemas: + type: array + items: + type: string + totalResults: + type: integer + startIndex: + type: integer + itemsPerPage: + type: integer + Resources: + type: array + items: + type: object + properties: + schemas: + type: array + items: + type: string + id: + type: string + displayName: + type: string + members: + type: array + items: + type: object + properties: + $ref: + type: string + value: + type: string + display: + type: string + primary: + type: boolean + type: + type: string + groups: + type: array + items: + type: object + properties: + $ref: + type: string + value: + type: string + display: + type: string + primary: + type: boolean + type: + type: string + roles: + type: array + items: + type: object + properties: + $ref: + type: string + value: + type: string + display: + type: string + primary: + type: boolean + type: + type: string + entitlements: + type: array + items: + type: object + properties: + $ref: + type: string + value: + type: string + display: + type: string + primary: + type: boolean + type: + type: string + externalId: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + x-stackQL-objectKey: $.Resources + description: Gets all details of the groups associated with the Databricks workspace. + /api/2.0/preview/scim/v2/Groups/{id}: + delete: + operationId: groups-delete + externalDocs: + url: https://docs.databricks.com/api/workspace/groups/delete + x-stackQL-resource: groups + x-stackQL-method: delete + x-stackQL-verb: delete + x-numReqParams: 1 + parameters: + - name: id + required: true + description: int64 + in: path + responses: + '204': + description: Group was deleted successfully. + content: + application/json: + schema: + type: object + properties: {} + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Deletes a group from the Databricks workspace. + get: + operationId: groups-get + externalDocs: + url: https://docs.databricks.com/api/workspace/groups/get + x-stackQL-resource: groups + x-stackQL-method: get + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: id + required: true + description: int64 + in: path + responses: + '200': + description: Group information was returned successfully. + content: + application/json: + schema: + type: object + properties: + schemas: + type: array + items: + type: string + id: + type: string + displayName: + type: string + members: + type: array + items: + type: object + properties: + $ref: + type: string + value: + type: string + display: + type: string + primary: + type: boolean + type: + type: string + groups: + type: array + items: + type: object + properties: + $ref: + type: string + value: + type: string + display: + type: string + primary: + type: boolean + type: + type: string + roles: + type: array + items: + type: object + properties: + $ref: + type: string + value: + type: string + display: + type: string + primary: + type: boolean + type: + type: string + entitlements: + type: array + items: + type: object + properties: + $ref: + type: string + value: + type: string + display: + type: string + primary: + type: boolean + type: + type: string + externalId: + type: string + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Gets the information for a specific group in the Databricks workspace. + patch: + operationId: groups-patch + externalDocs: + url: https://docs.databricks.com/api/workspace/groups/patch + x-stackQL-resource: groups + x-stackQL-method: patch + x-stackQL-verb: update + x-numReqParams: 1 + parameters: + - name: id + required: true + description: int64 + in: path + responses: + '200': + description: Group information was updated successfully. + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + schemas: + type: Array of string + Operations: + type: Array of object + example: + schemas: + - urn:ietf:params:scim:api:messages:2.0:PatchOp + Operations: + - op: add + path: string + value: null + description: Operations to be applied on group information. + description: Partially updates the details of a group. + put: + operationId: groups-update + externalDocs: + url: https://docs.databricks.com/api/workspace/groups/update + x-stackQL-resource: groups + x-stackQL-method: update + x-stackQL-verb: update + x-numReqParams: 1 + parameters: + - name: id + required: true + description: int64 + in: path + responses: + '200': + description: Group information was updated successfully. + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + schemas: + type: Array of string + id: + type: integer + format: int64 + displayName: + type: string + externalId: + type: string + members: + type: Array of object + groups: + type: Array of object + roles: + type: Array of object + entitlements: + type: Array of object + example: + schemas: + - urn:ietf:params:scim:schemas:core:2.0:Group + id: string + displayName: string + members: + - $ref: string + value: string + display: string + primary: true + type: string + groups: + - $ref: string + value: string + display: string + primary: true + type: string + roles: + - $ref: string + value: string + display: string + primary: true + type: string + entitlements: + - $ref: string + value: string + display: string + primary: true + type: string + externalId: string + description: Operations to be applied on group information. + description: Updates the details of a group by replacing the entire group entity. + /api/2.0/permissions/{request_object_type}/{request_object_id}: + get: + operationId: permissions-get + externalDocs: + url: https://docs.databricks.com/api/workspace/permissions/get + x-stackQL-resource: permissions + x-stackQL-method: get + x-stackQL-verb: select + x-numReqParams: 2 + parameters: + - name: request_object_type + required: true + description: string + in: path + - name: request_object_id + required: true + description: string + in: path + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + object_id: + type: string + object_type: + type: string + access_control_list: + type: array + items: + type: object + properties: + user_name: + type: string + group_name: + type: string + service_principal_name: + type: string + display_name: + type: string + all_permissions: + type: array + items: + type: object + properties: + permission_level: + type: string + inherited: + type: boolean + inherited_from_object: + type: array + items: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Gets the permissions of an object. Objects can inherit permissions + from their parent objects or root object. + put: + operationId: permissions-set + externalDocs: + url: https://docs.databricks.com/api/workspace/permissions/set + x-stackQL-resource: permissions + x-stackQL-method: set + x-stackQL-verb: replace + x-numReqParams: 2 + parameters: + - name: request_object_type + required: true + description: string + in: path + - name: request_object_id + required: true + description: string + in: path + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + object_id: + type: string + object_type: + type: string + access_control_list: + type: array + items: + type: object + properties: + user_name: + type: string + group_name: + type: string + service_principal_name: + type: string + display_name: + type: string + all_permissions: + type: array + items: + type: object + properties: + permission_level: + type: string + inherited: + type: boolean + inherited_from_object: + type: array + items: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + access_control_list: + type: Array of object + example: + access_control_list: + - user_name: string + group_name: string + service_principal_name: string + permission_level: CAN_MANAGE + description: Sets permissions on an object, replacing existing permissions if + they exist. Deletes all direct permissions if none are specified. Objects + can inherit permissions from their parent objects or root object. + patch: + operationId: permissions-update + externalDocs: + url: https://docs.databricks.com/api/workspace/permissions/update + x-stackQL-resource: permissions + x-stackQL-method: update + x-stackQL-verb: update + x-numReqParams: 2 + parameters: + - name: request_object_type + required: true + description: string + in: path + - name: request_object_id + required: true + description: string + in: path + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + object_id: + type: string + object_type: + type: string + access_control_list: + type: array + items: + type: object + properties: + user_name: + type: string + group_name: + type: string + service_principal_name: + type: string + display_name: + type: string + all_permissions: + type: array + items: + type: object + properties: + permission_level: + type: string + inherited: + type: boolean + inherited_from_object: + type: array + items: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + access_control_list: + type: Array of object + example: + access_control_list: + - user_name: string + group_name: string + service_principal_name: string + permission_level: CAN_MANAGE + description: Updates the permissions on an object. Objects can inherit permissions + from their parent objects or root object. + /api/2.0/permissions/{request_object_type}/{request_object_id}/permissionLevels: + get: + operationId: permission-levels-getpermissionlevels + externalDocs: + url: https://docs.databricks.com/api/workspace/permissions/getpermissionlevels + x-stackQL-resource: permission_levels + x-stackQL-method: getpermissionlevels + x-stackQL-verb: select + x-numReqParams: 2 + parameters: + - name: request_object_type + required: true + description: string + in: path + - name: request_object_id + required: true + description: string + in: path + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + permission_levels: + type: array + items: + type: object + properties: + permission_level: + type: string + description: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + x-stackQL-objectKey: $.permission_levels + description: Gets the permission levels that a user can have on an object. + /api/2.0/preview/accounts/access-control/rule-sets: + get: + operationId: rule-sets-getruleset + externalDocs: + url: https://docs.databricks.com/api/workspace/accountaccesscontrolproxy/getruleset + x-stackQL-resource: rule_sets + x-stackQL-method: getruleset + x-stackQL-verb: select + x-numReqParams: 2 + parameters: + - name: name + required: true + description: string + in: query + - name: etag + required: true + description: string + in: query + responses: + '200': + description: The rule set was returned successfully. + content: + application/json: + schema: + type: object + properties: + name: + type: string + grant_rules: + type: array + items: + type: object + properties: + principals: + type: array + items: + type: string + role: + type: string + etag: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '500': + description: Internal error. + description: Get a rule set by its name. A rule set is always attached to a + resource and contains a list of access rules on the said resource. Currently + only a default rule set for each resource is supported. + put: + operationId: rule-sets-updateruleset + externalDocs: + url: https://docs.databricks.com/api/workspace/accountaccesscontrolproxy/updateruleset + x-stackQL-resource: rule_sets + x-stackQL-method: updateruleset + x-stackQL-verb: update + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Rule sets on the resource was updated successfully. + content: + application/json: + schema: + type: object + properties: + name: + type: string + grant_rules: + type: array + items: + type: object + properties: + role: + type: string + principals: + type: array + items: + type: string + etag: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: required + rule_set: + type: object + example: + name: string + rule_set: + name: string + grant_rules: + - principals: + - string + role: string + etag: string + description: The rule set to update to. + description: Replace the rules of a rule set. First, use a GET rule set request + to read the current version of the rule set before modifying it. This pattern + helps prevent conflicts between concurrent updates. + /api/2.0/preview/scim/v2/ServicePrincipals: + post: + operationId: service-principals-create + externalDocs: + url: https://docs.databricks.com/api/workspace/serviceprincipals/create + x-stackQL-resource: service_principals + x-stackQL-method: create + x-stackQL-verb: insert + x-numReqParams: 0 + parameters: [] + responses: + '201': + description: The user creation request succeeded. + content: + application/json: + schema: + type: object + properties: + schemas: + type: array + items: + type: string + id: + type: string + applicationId: + type: string + displayName: + type: string + groups: + type: array + items: + type: object + properties: + $ref: + type: string + value: + type: string + display: + type: string + primary: + type: boolean + type: + type: string + roles: + type: array + items: + type: object + properties: + $ref: + type: string + value: + type: string + display: + type: string + primary: + type: boolean + type: + type: string + entitlements: + type: array + items: + type: object + properties: + $ref: + type: string + value: + type: string + display: + type: string + primary: + type: boolean + type: + type: string + externalId: + type: string + active: + type: boolean + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '409': + description: Request was rejected due a conflict with an existing resource. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + schemas: + type: Array of string + id: + type: integer + format: int64 + applicationId: + type: uuid + displayName: + type: string + externalId: + type: string + active: + type: boolean + groups: + type: Array of object + roles: + type: Array of object + entitlements: + type: Array of object + example: + schemas: + - urn:ietf:params:scim:schemas:core:2.0:ServicePrincipal + id: string + applicationId: 97ab27fa-30e2-43e3-92a3-160e80f4c0d5 + displayName: etl-service + groups: + - $ref: string + value: string + display: string + primary: true + type: string + roles: + - $ref: string + value: string + display: string + primary: true + type: string + entitlements: + - $ref: string + value: string + display: string + primary: true + type: string + externalId: string + active: true + description: Properties of the new service principal. + description: Creates a new service principal in the Databricks workspace. + get: + operationId: service-principals-list + externalDocs: + url: https://docs.databricks.com/api/workspace/serviceprincipals/list + x-stackQL-resource: service_principals + x-stackQL-method: list + x-stackQL-verb: select + x-numReqParams: 0 + parameters: + - name: filter + in: query + - name: attributes + in: query + - name: excludedAttributes + in: query + - name: startIndex + in: query + - name: count + in: query + - name: sortBy + in: query + - name: sortOrder + in: query + responses: + '200': + description: List service principals operation was succesful. + content: + application/json: + schema: + type: object + properties: + schemas: + type: array + items: + type: string + totalResults: + type: integer + startIndex: + type: integer + itemsPerPage: + type: integer + Resources: + type: array + items: + type: object + properties: + schemas: + type: array + items: + type: string + id: + type: string + applicationId: + type: string + displayName: + type: string + groups: + type: array + items: + type: object + properties: + $ref: + type: string + value: + type: string + display: + type: string + primary: + type: boolean + type: + type: string + roles: + type: array + items: + type: object + properties: + $ref: + type: string + value: + type: string + display: + type: string + primary: + type: boolean + type: + type: string + entitlements: + type: array + items: + type: object + properties: + $ref: + type: string + value: + type: string + display: + type: string + primary: + type: boolean + type: + type: string + externalId: + type: string + active: + type: boolean + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + x-stackQL-objectKey: $.Resources + description: Gets the set of service principals associated with a Databricks + workspace. + /api/2.0/preview/scim/v2/ServicePrincipals/{id}: + delete: + operationId: service-principals-delete + externalDocs: + url: https://docs.databricks.com/api/workspace/serviceprincipals/delete + x-stackQL-resource: service_principals + x-stackQL-method: delete + x-stackQL-verb: delete + x-numReqParams: 1 + parameters: + - name: id + required: true + description: int64 + in: path + responses: + '204': + description: Service principal was deleted successfully. + content: + application/json: + schema: + type: object + properties: {} + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Delete a single service principal in the Databricks workspace. + get: + operationId: service-principals-get + externalDocs: + url: https://docs.databricks.com/api/workspace/serviceprincipals/get + x-stackQL-resource: service_principals + x-stackQL-method: get + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: id + required: true + description: int64 + in: path + responses: + '200': + description: Service principal information was returned successfully. + content: + application/json: + schema: + type: object + properties: + schemas: + type: array + items: + type: string + id: + type: string + applicationId: + type: string + displayName: + type: string + groups: + type: array + items: + type: object + properties: + $ref: + type: string + value: + type: string + display: + type: string + primary: + type: boolean + type: + type: string + roles: + type: array + items: + type: object + properties: + $ref: + type: string + value: + type: string + display: + type: string + primary: + type: boolean + type: + type: string + entitlements: + type: array + items: + type: object + properties: + $ref: + type: string + value: + type: string + display: + type: string + primary: + type: boolean + type: + type: string + externalId: + type: string + active: + type: boolean + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Gets the details for a single service principal define in the Databricks + workspace. + patch: + operationId: service-principals-patch + externalDocs: + url: https://docs.databricks.com/api/workspace/serviceprincipals/patch + x-stackQL-resource: service_principals + x-stackQL-method: patch + x-stackQL-verb: update + x-numReqParams: 1 + parameters: + - name: id + required: true + description: int64 + in: path + responses: + '200': + description: Service principal information was updated successfully. + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + schemas: + type: Array of string + Operations: + type: Array of object + example: + schemas: + - urn:ietf:params:scim:api:messages:2.0:PatchOp + Operations: + - op: add + path: string + value: null + description: Operations to be applied on service principal information. + description: Partially updates the details of a single service principal in + the Databricks workspace. + put: + operationId: service-principals-update + externalDocs: + url: https://docs.databricks.com/api/workspace/serviceprincipals/update + x-stackQL-resource: service_principals + x-stackQL-method: update + x-stackQL-verb: update + x-numReqParams: 1 + parameters: + - name: id + required: true + description: int64 + in: path + responses: + '200': + description: Service principal information was updated successfully. + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + schemas: + type: Array of string + id: + type: integer + format: int64 + applicationId: + type: uuid + displayName: + type: string + externalId: + type: string + active: + type: boolean + groups: + type: Array of object + roles: + type: Array of object + entitlements: + type: Array of object + example: + schemas: + - urn:ietf:params:scim:schemas:core:2.0:ServicePrincipal + id: string + applicationId: 97ab27fa-30e2-43e3-92a3-160e80f4c0d5 + displayName: etl-service + groups: + - $ref: string + value: string + display: string + primary: true + type: string + roles: + - $ref: string + value: string + display: string + primary: true + type: string + entitlements: + - $ref: string + value: string + display: string + primary: true + type: string + externalId: string + active: true + description: Updates the details of a single service principal. + /api/2.0/preview/scim/v2/Users: + post: + operationId: users-create + externalDocs: + url: https://docs.databricks.com/api/workspace/users/create + x-stackQL-resource: users + x-stackQL-method: create + x-stackQL-verb: insert + x-numReqParams: 0 + parameters: [] + responses: + '201': + description: The user creation request succeeded. + content: + application/json: + schema: + type: object + properties: + schemas: + type: array + items: + type: string + id: + type: string + userName: + type: string + emails: + type: array + items: + type: object + properties: + $ref: + type: string + value: + type: string + display: + type: string + primary: + type: boolean + type: + type: string + name: + type: object + properties: + givenName: + type: string + familyName: + type: string + displayName: + type: string + groups: + type: array + items: + type: object + properties: + $ref: + type: string + value: + type: string + display: + type: string + primary: + type: boolean + type: + type: string + roles: + type: array + items: + type: object + properties: + $ref: + type: string + value: + type: string + display: + type: string + primary: + type: boolean + type: + type: string + entitlements: + type: array + items: + type: object + properties: + $ref: + type: string + value: + type: string + display: + type: string + primary: + type: boolean + type: + type: string + externalId: + type: string + active: + type: boolean + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '409': + description: Request was rejected due a conflict with an existing resource. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + schemas: + type: Array of string + id: + type: integer + format: int64 + userName: + type: email + displayName: + type: string + externalId: + type: string + active: + type: boolean + emails: + type: Array of object + name: + type: object + groups: + type: Array of object + roles: + type: Array of object + entitlements: + type: Array of object + example: + schemas: + - urn:ietf:params:scim:schemas:core:2.0:User + id: string + userName: user@example.com + emails: + - $ref: string + value: string + display: string + primary: true + type: string + name: + givenName: string + familyName: string + displayName: string + groups: + - $ref: string + value: string + display: string + primary: true + type: string + roles: + - $ref: string + value: string + display: string + primary: true + type: string + entitlements: + - $ref: string + value: string + display: string + primary: true + type: string + externalId: string + active: true + description: Properties of the new user. + description: Creates a new user in the Databricks workspace. This new user will + also be added to the Databricks account. + get: + operationId: users-list + externalDocs: + url: https://docs.databricks.com/api/workspace/users/list + x-stackQL-resource: users + x-stackQL-method: list + x-stackQL-verb: select + x-numReqParams: 0 + parameters: + - name: filter + in: query + - name: attributes + in: query + - name: excludedAttributes + in: query + - name: startIndex + in: query + - name: count + in: query + - name: sortBy + in: query + - name: sortOrder + in: query + responses: + '200': + description: List users operation was succesful. + content: + application/json: + schema: + type: object + properties: + schemas: + type: array + items: + type: string + totalResults: + type: integer + startIndex: + type: integer + itemsPerPage: + type: integer + Resources: + type: array + items: + type: object + properties: + schemas: + type: array + items: + type: string + id: + type: string + userName: + type: string + emails: + type: array + items: + type: object + properties: + $ref: + type: string + value: + type: string + display: + type: string + primary: + type: boolean + type: + type: string + name: + type: object + properties: + givenName: + type: string + familyName: + type: string + displayName: + type: string + groups: + type: array + items: + type: object + properties: + $ref: + type: string + value: + type: string + display: + type: string + primary: + type: boolean + type: + type: string + roles: + type: array + items: + type: object + properties: + $ref: + type: string + value: + type: string + display: + type: string + primary: + type: boolean + type: + type: string + entitlements: + type: array + items: + type: object + properties: + $ref: + type: string + value: + type: string + display: + type: string + primary: + type: boolean + type: + type: string + externalId: + type: string + active: + type: boolean + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + x-stackQL-objectKey: $.Resources + description: Gets details for all the users associated with a Databricks workspace. + /api/2.0/preview/scim/v2/Users/{id}: + delete: + operationId: users-delete + externalDocs: + url: https://docs.databricks.com/api/workspace/users/delete + x-stackQL-resource: users + x-stackQL-method: delete + x-stackQL-verb: delete + x-numReqParams: 1 + parameters: + - name: id + required: true + description: int64 + in: path + responses: + '204': + description: User was deleted successfully. + content: + application/json: + schema: + type: object + properties: {} + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Deletes a user. Deleting a user from a Databricks workspace also + removes objects associated with the user. + get: + operationId: users-get + externalDocs: + url: https://docs.databricks.com/api/workspace/users/get + x-stackQL-resource: users + x-stackQL-method: get + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: id + required: true + description: int64 + in: path + - name: filter + in: query + - name: attributes + in: query + - name: excludedAttributes + in: query + - name: startIndex + in: query + - name: count + in: query + - name: sortBy + in: query + - name: sortOrder + in: query + responses: + '200': + description: User information was returned successfully. + content: + application/json: + schema: + type: object + properties: + schemas: + type: array + items: + type: string + id: + type: string + userName: + type: string + emails: + type: array + items: + type: object + properties: + $ref: + type: string + value: + type: string + display: + type: string + primary: + type: boolean + type: + type: string + name: + type: object + properties: + givenName: + type: string + familyName: + type: string + displayName: + type: string + groups: + type: array + items: + type: object + properties: + $ref: + type: string + value: + type: string + display: + type: string + primary: + type: boolean + type: + type: string + roles: + type: array + items: + type: object + properties: + $ref: + type: string + value: + type: string + display: + type: string + primary: + type: boolean + type: + type: string + entitlements: + type: array + items: + type: object + properties: + $ref: + type: string + value: + type: string + display: + type: string + primary: + type: boolean + type: + type: string + externalId: + type: string + active: + type: boolean + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Gets information for a specific user in Databricks workspace. + patch: + operationId: users-patch + externalDocs: + url: https://docs.databricks.com/api/workspace/users/patch + x-stackQL-resource: users + x-stackQL-method: patch + x-stackQL-verb: update + x-numReqParams: 1 + parameters: + - name: id + required: true + description: int64 + in: path + responses: + '200': + description: User information was updated successfully. + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + schemas: + type: Array of string + Operations: + type: Array of object + example: + schemas: + - urn:ietf:params:scim:api:messages:2.0:PatchOp + Operations: + - op: add + path: string + value: null + description: Operations to be applied on user information. + description: Partially updates a user resource by applying the supplied operations + on specific user attributes. + put: + operationId: users-update + externalDocs: + url: https://docs.databricks.com/api/workspace/users/update + x-stackQL-resource: users + x-stackQL-method: update + x-stackQL-verb: update + x-numReqParams: 1 + parameters: + - name: id + required: true + description: int64 + in: path + responses: + '200': + description: User information was updated successfully. + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + schemas: + type: Array of string + id: + type: integer + format: int64 + userName: + type: email + displayName: + type: string + externalId: + type: string + active: + type: boolean + emails: + type: Array of object + name: + type: object + groups: + type: Array of object + roles: + type: Array of object + entitlements: + type: Array of object + example: + schemas: + - urn:ietf:params:scim:schemas:core:2.0:User + id: string + userName: user@example.com + emails: + - $ref: string + value: string + display: string + primary: true + type: string + name: + givenName: string + familyName: string + displayName: string + groups: + - $ref: string + value: string + display: string + primary: true + type: string + roles: + - $ref: string + value: string + display: string + primary: true + type: string + entitlements: + - $ref: string + value: string + display: string + primary: true + type: string + externalId: string + active: true + description: Replaces a user's information with the data supplied in request. + /api/2.0/permissions/authorization/passwords: + get: + operationId: user-permissions-getpermissions + externalDocs: + url: https://docs.databricks.com/api/workspace/users/getpermissions + x-stackQL-resource: user_permissions + x-stackQL-method: getpermissions + x-stackQL-verb: select + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + object_id: + type: string + object_type: + type: string + access_control_list: + type: array + items: + type: object + properties: + user_name: + type: string + group_name: + type: string + service_principal_name: + type: string + display_name: + type: string + all_permissions: + type: array + items: + type: object + properties: + permission_level: + type: string + inherited: + type: boolean + inherited_from_object: + type: array + items: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Gets the permissions of all passwords. Passwords can inherit permissions + from their root object. + put: + operationId: user-permissions-setpermissions + externalDocs: + url: https://docs.databricks.com/api/workspace/users/setpermissions + x-stackQL-resource: user_permissions + x-stackQL-method: setpermissions + x-stackQL-verb: replace + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + object_id: + type: string + object_type: + type: string + access_control_list: + type: array + items: + type: object + properties: + user_name: + type: string + group_name: + type: string + service_principal_name: + type: string + display_name: + type: string + all_permissions: + type: array + items: + type: object + properties: + permission_level: + type: string + inherited: + type: boolean + inherited_from_object: + type: array + items: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + access_control_list: + type: Array of object + example: + access_control_list: + - user_name: string + group_name: string + service_principal_name: string + permission_level: CAN_USE + description: Sets permissions on an object, replacing existing permissions if + they exist. Deletes all direct permissions if none are specified. Objects + can inherit permissions from their root object. + patch: + operationId: user-permissions-updatepermissions + externalDocs: + url: https://docs.databricks.com/api/workspace/users/updatepermissions + x-stackQL-resource: user_permissions + x-stackQL-method: updatepermissions + x-stackQL-verb: update + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + object_id: + type: string + object_type: + type: string + access_control_list: + type: array + items: + type: object + properties: + user_name: + type: string + group_name: + type: string + service_principal_name: + type: string + display_name: + type: string + all_permissions: + type: array + items: + type: object + properties: + permission_level: + type: string + inherited: + type: boolean + inherited_from_object: + type: array + items: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + access_control_list: + type: Array of object + example: + access_control_list: + - user_name: string + group_name: string + service_principal_name: string + permission_level: CAN_USE + description: Updates the permissions on all passwords. Passwords can inherit + permissions from their root object. + /api/2.0/permissions/authorization/passwords/permissionLevels: + get: + operationId: user-permission-levels-getpermissionlevels + externalDocs: + url: https://docs.databricks.com/api/workspace/users/getpermissionlevels + x-stackQL-resource: user_permission_levels + x-stackQL-method: getpermissionlevels + x-stackQL-verb: select + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + permission_levels: + type: array + items: + type: object + properties: + permission_level: + type: string + description: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + x-stackQL-objectKey: $.permission_levels + description: Gets the permission levels that a user can have on an object. +components: + x-stackQL-resources: + assignable_roles: + id: databricks_workspace.iam.assignable_roles + name: assignable_roles + title: Assignable_roles + methods: + getassignablerolesforresource: + operation: + $ref: '#/paths/~1api~12.0~1preview~1accounts~1access-control~1assignable-roles/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.roles + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/assignable_roles/methods/getassignablerolesforresource' + insert: [] + update: [] + replace: [] + delete: [] + exec: [] + currentuser: + id: databricks_workspace.iam.currentuser + name: currentuser + title: Currentuser + methods: + me: + operation: + $ref: '#/paths/~1api~12.0~1preview~1scim~1v2~1Me/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/currentuser/methods/me' + insert: [] + update: [] + replace: [] + delete: [] + exec: [] + groups: + id: databricks_workspace.iam.groups + name: groups + title: Groups + methods: + create: + operation: + $ref: '#/paths/~1api~12.0~1preview~1scim~1v2~1Groups/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1api~12.0~1preview~1scim~1v2~1Groups/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.Resources + delete: + operation: + $ref: '#/paths/~1api~12.0~1preview~1scim~1v2~1Groups~1{id}/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1api~12.0~1preview~1scim~1v2~1Groups~1{id}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: '#/paths/~1api~12.0~1preview~1scim~1v2~1Groups~1{id}/patch' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: '#/paths/~1api~12.0~1preview~1scim~1v2~1Groups~1{id}/put' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/groups/methods/get' + - $ref: '#/components/x-stackQL-resources/groups/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/groups/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/groups/methods/update' + - $ref: '#/components/x-stackQL-resources/groups/methods/patch' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/groups/methods/delete' + exec: [] + permissions: + id: databricks_workspace.iam.permissions + name: permissions + title: Permissions + methods: + get: + operation: + $ref: '#/paths/~1api~12.0~1permissions~1{request_object_type}~1{request_object_id}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + set: + operation: + $ref: '#/paths/~1api~12.0~1permissions~1{request_object_type}~1{request_object_id}/put' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: '#/paths/~1api~12.0~1permissions~1{request_object_type}~1{request_object_id}/patch' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/permissions/methods/get' + insert: [] + update: + - $ref: '#/components/x-stackQL-resources/permissions/methods/update' + replace: + - $ref: '#/components/x-stackQL-resources/permissions/methods/set' + delete: [] + exec: [] + permission_levels: + id: databricks_workspace.iam.permission_levels + name: permission_levels + title: Permission_levels + methods: + getpermissionlevels: + operation: + $ref: '#/paths/~1api~12.0~1permissions~1{request_object_type}~1{request_object_id}~1permissionLevels/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.permission_levels + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/permission_levels/methods/getpermissionlevels' + insert: [] + update: [] + replace: [] + delete: [] + exec: [] + rule_sets: + id: databricks_workspace.iam.rule_sets + name: rule_sets + title: Rule_sets + methods: + getruleset: + operation: + $ref: '#/paths/~1api~12.0~1preview~1accounts~1access-control~1rule-sets/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + updateruleset: + operation: + $ref: '#/paths/~1api~12.0~1preview~1accounts~1access-control~1rule-sets/put' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/rule_sets/methods/getruleset' + insert: [] + update: + - $ref: '#/components/x-stackQL-resources/rule_sets/methods/updateruleset' + replace: [] + delete: [] + exec: [] + service_principals: + id: databricks_workspace.iam.service_principals + name: service_principals + title: Service_principals + methods: + create: + operation: + $ref: '#/paths/~1api~12.0~1preview~1scim~1v2~1ServicePrincipals/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1api~12.0~1preview~1scim~1v2~1ServicePrincipals/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.Resources + delete: + operation: + $ref: '#/paths/~1api~12.0~1preview~1scim~1v2~1ServicePrincipals~1{id}/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1api~12.0~1preview~1scim~1v2~1ServicePrincipals~1{id}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: '#/paths/~1api~12.0~1preview~1scim~1v2~1ServicePrincipals~1{id}/patch' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: '#/paths/~1api~12.0~1preview~1scim~1v2~1ServicePrincipals~1{id}/put' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/service_principals/methods/get' + - $ref: '#/components/x-stackQL-resources/service_principals/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/service_principals/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/service_principals/methods/update' + - $ref: '#/components/x-stackQL-resources/service_principals/methods/patch' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/service_principals/methods/delete' + exec: [] + users: + id: databricks_workspace.iam.users + name: users + title: Users + methods: + create: + operation: + $ref: '#/paths/~1api~12.0~1preview~1scim~1v2~1Users/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1api~12.0~1preview~1scim~1v2~1Users/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.Resources + delete: + operation: + $ref: '#/paths/~1api~12.0~1preview~1scim~1v2~1Users~1{id}/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1api~12.0~1preview~1scim~1v2~1Users~1{id}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: '#/paths/~1api~12.0~1preview~1scim~1v2~1Users~1{id}/patch' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: '#/paths/~1api~12.0~1preview~1scim~1v2~1Users~1{id}/put' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/users/methods/get' + - $ref: '#/components/x-stackQL-resources/users/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/users/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/users/methods/update' + - $ref: '#/components/x-stackQL-resources/users/methods/patch' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/users/methods/delete' + exec: [] + user_permissions: + id: databricks_workspace.iam.user_permissions + name: user_permissions + title: User_permissions + methods: + getpermissions: + operation: + $ref: '#/paths/~1api~12.0~1permissions~1authorization~1passwords/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + setpermissions: + operation: + $ref: '#/paths/~1api~12.0~1permissions~1authorization~1passwords/put' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + updatepermissions: + operation: + $ref: '#/paths/~1api~12.0~1permissions~1authorization~1passwords/patch' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/user_permissions/methods/getpermissions' + insert: [] + update: + - $ref: '#/components/x-stackQL-resources/user_permissions/methods/updatepermissions' + replace: + - $ref: '#/components/x-stackQL-resources/user_permissions/methods/setpermissions' + delete: [] + exec: [] + user_permission_levels: + id: databricks_workspace.iam.user_permission_levels + name: user_permission_levels + title: User_permission_levels + methods: + getpermissionlevels: + operation: + $ref: '#/paths/~1api~12.0~1permissions~1authorization~1passwords~1permissionLevels/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.permission_levels + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/user_permission_levels/methods/getpermissionlevels' + insert: [] + update: [] + replace: [] + delete: [] + exec: [] diff --git a/providers/src/databricks_workspace/v00.00.00000/services/lakeview.yaml b/providers/src/databricks_workspace/v00.00.00000/services/lakeview.yaml new file mode 100644 index 00000000..496d9be8 --- /dev/null +++ b/providers/src/databricks_workspace/v00.00.00000/services/lakeview.yaml @@ -0,0 +1,1270 @@ +openapi: 3.0.0 +info: + version: 2024-12-19-stackql-generated + contact: + name: StackQL Studios + url: https://stackql.io/ + email: info@stackql.io + title: Databricks Lakeview API + description: Lakeview +servers: +- url: https://{deployment_name}.cloud.databricks.com + variables: + deployment_name: + description: The Databricks Workspace Deployment Name + default: dbc-abcd0123-a1bc +paths: + /api/2.0/lakeview/dashboards: + post: + operationId: dashboards-create + externalDocs: + url: https://docs.databricks.com/api/workspace/lakeview/create + x-stackQL-resource: dashboards + x-stackQL-method: create + x-stackQL-verb: insert + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + dashboard_id: + type: string + display_name: + type: string + path: + type: string + create_time: + type: string + update_time: + type: string + warehouse_id: + type: string + etag: + type: string + serialized_dashboard: + type: string + lifecycle_state: + type: string + parent_path: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '409': + description: Request was rejected due a conflict with an existing resource. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + display_name: + type: string + warehouse_id: + type: string + etag: + type: string + serialized_dashboard: + type: string + parent_path: + type: string + example: + display_name: Monthly Traffic Report + warehouse_id: 47bb1c472649e711 + etag: '80611980' + serialized_dashboard: '{"pages":[{"name":"b532570b","displayName":"New + Page"}]}' + parent_path: /path/to/dir + description: Create a draft dashboard. + get: + operationId: dashboards-list + externalDocs: + url: https://docs.databricks.com/api/workspace/lakeview/list + x-stackQL-resource: dashboards + x-stackQL-method: list + x-stackQL-verb: select + x-numReqParams: 0 + parameters: + - name: page_size + in: query + - name: page_token + in: query + - name: show_trashed + in: query + - name: view + in: query + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + dashboards: + type: array + items: + type: object + properties: + dashboard_id: + type: string + display_name: + type: string + lifecycle_state: + type: string + warehouse_id: + type: string + create_time: + type: string + next_page_token: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + x-stackQL-objectKey: $.dashboards + /api/2.0/lakeview/dashboards/{dashboard_id}: + get: + operationId: dashboards-get + externalDocs: + url: https://docs.databricks.com/api/workspace/lakeview/get + x-stackQL-resource: dashboards + x-stackQL-method: get + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: dashboard_id + required: true + description: string + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + dashboard_id: + type: string + display_name: + type: string + path: + type: string + create_time: + type: string + update_time: + type: string + warehouse_id: + type: string + etag: + type: string + serialized_dashboard: + type: string + lifecycle_state: + type: string + parent_path: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Get a draft dashboard. + delete: + operationId: dashboards-trash + externalDocs: + url: https://docs.databricks.com/api/workspace/lakeview/trash + x-stackQL-resource: dashboards + x-stackQL-method: trash + x-stackQL-verb: delete + x-numReqParams: 1 + parameters: + - name: dashboard_id + required: true + description: string + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Trash a dashboard. + patch: + operationId: dashboards-update + externalDocs: + url: https://docs.databricks.com/api/workspace/lakeview/update + x-stackQL-resource: dashboards + x-stackQL-method: update + x-stackQL-verb: update + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + dashboard_id: + type: string + display_name: + type: string + path: + type: string + create_time: + type: string + update_time: + type: string + warehouse_id: + type: string + etag: + type: string + serialized_dashboard: + type: string + lifecycle_state: + type: string + parent_path: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '409': + description: Request was rejected due a conflict with an existing resource. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + display_name: + type: string + warehouse_id: + type: string + etag: + type: string + serialized_dashboard: + type: string + example: + display_name: Monthly Traffic Report + warehouse_id: 47bb1c472649e711 + etag: '80611980' + serialized_dashboard: '{"pages":[{"name":"b532570b","displayName":"New + Page"}]}' + description: Update a draft dashboard. + /api/2.0/lakeview/dashboards/migrate: + post: + operationId: dashboards-migrate + externalDocs: + url: https://docs.databricks.com/api/workspace/lakeview/migrate + x-stackQL-resource: dashboards + x-stackQL-method: migrate + x-stackQL-verb: exec + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + dashboard_id: + type: string + display_name: + type: string + path: + type: string + create_time: + type: string + update_time: + type: string + warehouse_id: + type: string + etag: + type: string + serialized_dashboard: + type: string + lifecycle_state: + type: string + parent_path: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + source_dashboard_id: + type: required + display_name: + type: string + parent_path: + type: string + update_parameter_syntax: + type: string + example: + source_dashboard_id: 4e443c27-9f61-4f2e-a12d-ea5668460bf1 + display_name: Monthly Traffic Report + parent_path: /path/to/dir + update_parameter_syntax: true + description: Migrates a classic SQL dashboard to Lakeview. + /api/2.0/lakeview/dashboards/{dashboard_id}/published: + post: + operationId: dashboards-publish + externalDocs: + url: https://docs.databricks.com/api/workspace/lakeview/publish + x-stackQL-resource: dashboards + x-stackQL-method: publish + x-stackQL-verb: exec + x-numReqParams: 1 + parameters: + - name: dashboard_id + required: true + description: string + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + display_name: + type: string + warehouse_id: + type: string + embed_credentials: + type: boolean + revision_create_time: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + embed_credentials: + type: boolean + warehouse_id: + type: string + example: + embed_credentials: true + warehouse_id: string + description: Publish the current draft dashboard. + delete: + operationId: dashboards-unpublish + externalDocs: + url: https://docs.databricks.com/api/workspace/lakeview/unpublish + x-stackQL-resource: dashboards + x-stackQL-method: unpublish + x-stackQL-verb: exec + x-numReqParams: 1 + parameters: + - name: dashboard_id + required: true + description: string + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Unpublish the dashboard. + get: + operationId: dashboards-published-getpublished + externalDocs: + url: https://docs.databricks.com/api/workspace/lakeview/getpublished + x-stackQL-resource: dashboards_published + x-stackQL-method: getpublished + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: dashboard_id + required: true + description: string + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + display_name: + type: string + warehouse_id: + type: string + embed_credentials: + type: boolean + revision_create_time: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Get the current published dashboard. + /api/2.0/lakeview/dashboards/{dashboard_id}/schedules: + post: + operationId: dashboard-schedules-createschedule + externalDocs: + url: https://docs.databricks.com/api/workspace/lakeview/createschedule + x-stackQL-resource: dashboard_schedules + x-stackQL-method: createschedule + x-stackQL-verb: insert + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + schedule_id: + type: string + dashboard_id: + type: string + cron_schedule: + type: object + properties: + quartz_cron_expression: + type: string + timezone_id: + type: string + pause_status: + type: string + display_name: + type: string + etag: + type: string + create_time: + type: string + update_time: + type: string + warehouse_id: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '429': + description: Operation is rejected due to throttling, e.g. some resource + has been exhausted, per-user quota. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + pause_status: + type: string + display_name: + type: string + etag: + type: string + warehouse_id: + type: string + cron_schedule: + type: object + example: + cron_schedule: + quartz_cron_expression: 0 0 8 * * ? + timezone_id: Europe/London + pause_status: UNPAUSED + display_name: Monthly Traffic Report Snapshot + etag: '80611980' + warehouse_id: 47bb1c472649e711 + get: + operationId: dashboard-schedules-listschedules + externalDocs: + url: https://docs.databricks.com/api/workspace/lakeview/listschedules + x-stackQL-resource: dashboard_schedules + x-stackQL-method: listschedules + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: dashboard_id + required: true + description: string + in: path + - name: page_size + in: query + - name: page_token + in: query + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + schedules: + type: array + items: + type: object + properties: + schedule_id: + type: string + dashboard_id: + type: string + cron_schedule: + type: object + properties: + quartz_cron_expression: + type: string + timezone_id: + type: string + pause_status: + type: string + display_name: + type: string + etag: + type: string + create_time: + type: string + update_time: + type: string + warehouse_id: + type: string + next_page_token: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + x-stackQL-objectKey: $.schedules + /api/2.0/lakeview/dashboards/{dashboard_id}/schedules/{schedule_id}: + delete: + operationId: dashboard-schedules-deleteschedule + externalDocs: + url: https://docs.databricks.com/api/workspace/lakeview/deleteschedule + x-stackQL-resource: dashboard_schedules + x-stackQL-method: deleteschedule + x-stackQL-verb: delete + x-numReqParams: 2 + parameters: + - name: dashboard_id + required: true + description: string + in: path + - name: schedule_id + required: true + description: string + in: path + - name: etag + in: query + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + get: + operationId: dashboard-schedules-getschedule + externalDocs: + url: https://docs.databricks.com/api/workspace/lakeview/getschedule + x-stackQL-resource: dashboard_schedules + x-stackQL-method: getschedule + x-stackQL-verb: select + x-numReqParams: 2 + parameters: + - name: dashboard_id + required: true + description: string + in: path + - name: schedule_id + required: true + description: string + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + schedule_id: + type: string + dashboard_id: + type: string + cron_schedule: + type: object + properties: + quartz_cron_expression: + type: string + timezone_id: + type: string + pause_status: + type: string + display_name: + type: string + etag: + type: string + create_time: + type: string + update_time: + type: string + warehouse_id: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + put: + operationId: dashboard-schedules-updateschedule + externalDocs: + url: https://docs.databricks.com/api/workspace/lakeview/updateschedule + x-stackQL-resource: dashboard_schedules + x-stackQL-method: updateschedule + x-stackQL-verb: update + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + schedule_id: + type: string + dashboard_id: + type: string + cron_schedule: + type: object + properties: + quartz_cron_expression: + type: string + timezone_id: + type: string + pause_status: + type: string + display_name: + type: string + etag: + type: string + create_time: + type: string + update_time: + type: string + warehouse_id: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '409': + description: Request was rejected due a conflict with an existing resource. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + pause_status: + type: string + display_name: + type: string + etag: + type: string + warehouse_id: + type: string + cron_schedule: + type: object + example: + cron_schedule: + quartz_cron_expression: 0 0 8 * * ? + timezone_id: Europe/London + pause_status: UNPAUSED + display_name: Monthly Traffic Report Snapshot + etag: '80611980' + warehouse_id: 47bb1c472649e711 + /api/2.0/lakeview/dashboards/{dashboard_id}/schedules/{schedule_id}/subscriptions: + post: + operationId: dashboard-subscriptions-createsubscription + externalDocs: + url: https://docs.databricks.com/api/workspace/lakeview/createsubscription + x-stackQL-resource: dashboard_subscriptions + x-stackQL-method: createsubscription + x-stackQL-verb: insert + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + subscription_id: + type: string + schedule_id: + type: string + dashboard_id: + type: string + subscriber: + type: object + properties: + user_subscriber: + type: object + properties: + user_id: + type: string + created_by_user_id: + type: string + etag: + type: string + create_time: + type: string + update_time: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '429': + description: Operation is rejected due to throttling, e.g. some resource + has been exhausted, per-user quota. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + etag: + type: string + subscriber: + type: required + example: + subscriber: + user_subscriber: + user_id: '3294322584244938' + etag: '80611980' + get: + operationId: dashboard-subscriptions-listsubscriptions + externalDocs: + url: https://docs.databricks.com/api/workspace/lakeview/listsubscriptions + x-stackQL-resource: dashboard_subscriptions + x-stackQL-method: listsubscriptions + x-stackQL-verb: select + x-numReqParams: 2 + parameters: + - name: dashboard_id + required: true + description: string + in: path + - name: schedule_id + required: true + description: string + in: path + - name: page_size + in: query + - name: page_token + in: query + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + subscriptions: + type: array + items: + type: object + properties: + subscription_id: + type: string + schedule_id: + type: string + dashboard_id: + type: string + subscriber: + type: object + properties: + user_subscriber: + type: object + properties: + user_id: + type: string + created_by_user_id: + type: string + etag: + type: string + create_time: + type: string + update_time: + type: string + next_page_token: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + x-stackQL-objectKey: $.subscriptions + /api/2.0/lakeview/dashboards/{dashboard_id}/schedules/{schedule_id}/subscriptions/{subscription_id}: + delete: + operationId: dashboard-subscriptions-deletesubscription + externalDocs: + url: https://docs.databricks.com/api/workspace/lakeview/deletesubscription + x-stackQL-resource: dashboard_subscriptions + x-stackQL-method: deletesubscription + x-stackQL-verb: delete + x-numReqParams: 3 + parameters: + - name: dashboard_id + required: true + description: string + in: path + - name: schedule_id + required: true + description: string + in: path + - name: subscription_id + required: true + description: string + in: path + - name: etag + in: query + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + get: + operationId: dashboard-subscriptions-getsubscription + externalDocs: + url: https://docs.databricks.com/api/workspace/lakeview/getsubscription + x-stackQL-resource: dashboard_subscriptions + x-stackQL-method: getsubscription + x-stackQL-verb: select + x-numReqParams: 3 + parameters: + - name: dashboard_id + required: true + description: string + in: path + - name: schedule_id + required: true + description: string + in: path + - name: subscription_id + required: true + description: string + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + subscription_id: + type: string + schedule_id: + type: string + dashboard_id: + type: string + subscriber: + type: object + properties: + user_subscriber: + type: object + properties: + user_id: + type: string + created_by_user_id: + type: string + etag: + type: string + create_time: + type: string + update_time: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. +components: + x-stackQL-resources: + dashboards: + id: databricks_workspace.lakeview.dashboards + name: dashboards + title: Dashboards + methods: + create: + operation: + $ref: '#/paths/~1api~12.0~1lakeview~1dashboards/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1api~12.0~1lakeview~1dashboards/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.dashboards + get: + operation: + $ref: '#/paths/~1api~12.0~1lakeview~1dashboards~1{dashboard_id}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + trash: + operation: + $ref: '#/paths/~1api~12.0~1lakeview~1dashboards~1{dashboard_id}/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: '#/paths/~1api~12.0~1lakeview~1dashboards~1{dashboard_id}/patch' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + migrate: + operation: + $ref: '#/paths/~1api~12.0~1lakeview~1dashboards~1migrate/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + publish: + operation: + $ref: '#/paths/~1api~12.0~1lakeview~1dashboards~1{dashboard_id}~1published/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + unpublish: + operation: + $ref: '#/paths/~1api~12.0~1lakeview~1dashboards~1{dashboard_id}~1published/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/dashboards/methods/get' + - $ref: '#/components/x-stackQL-resources/dashboards/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/dashboards/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/dashboards/methods/update' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/dashboards/methods/trash' + exec: + - $ref: '#/components/x-stackQL-resources/dashboards/methods/unpublish' + - $ref: '#/components/x-stackQL-resources/dashboards/methods/publish' + - $ref: '#/components/x-stackQL-resources/dashboards/methods/migrate' + dashboards_published: + id: databricks_workspace.lakeview.dashboards_published + name: dashboards_published + title: Dashboards_published + methods: + getpublished: + operation: + $ref: '#/paths/~1api~12.0~1lakeview~1dashboards~1{dashboard_id}~1published/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/dashboards_published/methods/getpublished' + insert: [] + update: [] + replace: [] + delete: [] + exec: [] + dashboard_schedules: + id: databricks_workspace.lakeview.dashboard_schedules + name: dashboard_schedules + title: Dashboard_schedules + methods: + createschedule: + operation: + $ref: '#/paths/~1api~12.0~1lakeview~1dashboards~1{dashboard_id}~1schedules/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + listschedules: + operation: + $ref: '#/paths/~1api~12.0~1lakeview~1dashboards~1{dashboard_id}~1schedules/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.schedules + deleteschedule: + operation: + $ref: '#/paths/~1api~12.0~1lakeview~1dashboards~1{dashboard_id}~1schedules~1{schedule_id}/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + getschedule: + operation: + $ref: '#/paths/~1api~12.0~1lakeview~1dashboards~1{dashboard_id}~1schedules~1{schedule_id}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + updateschedule: + operation: + $ref: '#/paths/~1api~12.0~1lakeview~1dashboards~1{dashboard_id}~1schedules~1{schedule_id}/put' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/dashboard_schedules/methods/getschedule' + - $ref: '#/components/x-stackQL-resources/dashboard_schedules/methods/listschedules' + insert: + - $ref: '#/components/x-stackQL-resources/dashboard_schedules/methods/createschedule' + update: + - $ref: '#/components/x-stackQL-resources/dashboard_schedules/methods/updateschedule' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/dashboard_schedules/methods/deleteschedule' + exec: [] + dashboard_subscriptions: + id: databricks_workspace.lakeview.dashboard_subscriptions + name: dashboard_subscriptions + title: Dashboard_subscriptions + methods: + createsubscription: + operation: + $ref: '#/paths/~1api~12.0~1lakeview~1dashboards~1{dashboard_id}~1schedules~1{schedule_id}~1subscriptions/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + listsubscriptions: + operation: + $ref: '#/paths/~1api~12.0~1lakeview~1dashboards~1{dashboard_id}~1schedules~1{schedule_id}~1subscriptions/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.subscriptions + deletesubscription: + operation: + $ref: '#/paths/~1api~12.0~1lakeview~1dashboards~1{dashboard_id}~1schedules~1{schedule_id}~1subscriptions~1{subscription_id}/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + getsubscription: + operation: + $ref: '#/paths/~1api~12.0~1lakeview~1dashboards~1{dashboard_id}~1schedules~1{schedule_id}~1subscriptions~1{subscription_id}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/dashboard_subscriptions/methods/getsubscription' + - $ref: '#/components/x-stackQL-resources/dashboard_subscriptions/methods/listsubscriptions' + insert: + - $ref: '#/components/x-stackQL-resources/dashboard_subscriptions/methods/createsubscription' + update: [] + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/dashboard_subscriptions/methods/deletesubscription' + exec: [] diff --git a/providers/src/databricks_workspace/v00.00.00000/services/machinelearning.yaml b/providers/src/databricks_workspace/v00.00.00000/services/machinelearning.yaml new file mode 100644 index 00000000..b80f95ec --- /dev/null +++ b/providers/src/databricks_workspace/v00.00.00000/services/machinelearning.yaml @@ -0,0 +1,4891 @@ +openapi: 3.0.0 +info: + version: 2024-12-19-stackql-generated + contact: + name: StackQL Studios + url: https://stackql.io/ + email: info@stackql.io + title: Databricks Machinelearning API + description: Machinelearning +servers: +- url: https://{deployment_name}.cloud.databricks.com + variables: + deployment_name: + description: The Databricks Workspace Deployment Name + default: dbc-abcd0123-a1bc +paths: + /api/2.0/mlflow/experiments/create: + post: + operationId: experiments-createexperiment + externalDocs: + url: https://docs.databricks.com/api/workspace/experiments/createexperiment + x-stackQL-resource: experiments + x-stackQL-method: createexperiment + x-stackQL-verb: insert + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + experiment_id: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: required + artifact_location: + type: string + tags: + type: Array of object + example: + name: string + artifact_location: string + tags: + - key: string + value: string + description: Creates an experiment with a name. Returns the ID of the newly + created experiment. Validates that another experiment with the same name does + not already exist and fails if another experiment with the same name already + exists. + /api/2.0/mlflow/experiments/delete: + post: + operationId: experiments-deleteexperiment + externalDocs: + url: https://docs.databricks.com/api/workspace/experiments/deleteexperiment + x-stackQL-resource: experiments + x-stackQL-method: deleteexperiment + x-stackQL-verb: delete + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + experiment_id: + type: required + example: + experiment_id: string + description: Marks an experiment and associated metadata, runs, metrics, params, + and tags for deletion. If the experiment uses FileStore, artifacts associated + with experiment are also deleted. + /api/2.0/mlflow/experiments/get-by-name: + get: + operationId: experiments-getbyname + externalDocs: + url: https://docs.databricks.com/api/workspace/experiments/getbyname + x-stackQL-resource: experiments + x-stackQL-method: getbyname + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: experiment_name + required: true + description: string + in: query + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + experiment: + type: object + properties: + experiment_id: + type: string + name: + type: string + artifact_location: + type: string + lifecycle_stage: + type: string + last_update_time: + type: integer + creation_time: + type: integer + tags: + type: array + items: + type: object + properties: + key: + type: string + value: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + x-stackQL-objectKey: $.experiment + description: Gets metadata for an experiment. + /api/2.0/mlflow/experiments/get: + get: + operationId: experiments-getexperiment + externalDocs: + url: https://docs.databricks.com/api/workspace/experiments/getexperiment + x-stackQL-resource: experiments + x-stackQL-method: getexperiment + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: experiment_id + required: true + description: string + in: query + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + experiment: + type: object + properties: + experiment_id: + type: string + name: + type: string + artifact_location: + type: string + lifecycle_stage: + type: string + last_update_time: + type: integer + creation_time: + type: integer + tags: + type: array + items: + type: object + properties: + key: + type: string + value: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + x-stackQL-objectKey: $.experiment + description: Gets metadata for an experiment. This method works on deleted experiments. + /api/2.0/mlflow/experiments/list: + get: + operationId: experiments-listexperiments + externalDocs: + url: https://docs.databricks.com/api/workspace/experiments/listexperiments + x-stackQL-resource: experiments + x-stackQL-method: listexperiments + x-stackQL-verb: select + x-numReqParams: 0 + parameters: + - name: view_type + in: query + - name: max_results + in: query + - name: page_token + in: query + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + experiments: + type: array + items: + type: object + properties: + experiment_id: + type: string + name: + type: string + artifact_location: + type: string + lifecycle_stage: + type: string + last_update_time: + type: integer + creation_time: + type: integer + tags: + type: array + items: + type: object + properties: + key: + type: string + value: + type: string + next_page_token: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + x-stackQL-objectKey: $.experiments + description: Gets a list of all experiments. + /api/2.0/mlflow/experiments/restore: + post: + operationId: experiments-restoreexperiment + externalDocs: + url: https://docs.databricks.com/api/workspace/experiments/restoreexperiment + x-stackQL-resource: experiments + x-stackQL-method: restoreexperiment + x-stackQL-verb: exec + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + experiment_id: + type: required + example: + experiment_id: string + description: Restore an experiment marked for deletion. This also restores associated + metadata, runs, metrics, params, and tags. If experiment uses FileStore, underlying + artifacts associated with experiment are also restored. + /api/2.0/mlflow/experiments/search: + post: + operationId: experiments-searchexperiments + externalDocs: + url: https://docs.databricks.com/api/workspace/experiments/searchexperiments + x-stackQL-resource: experiments + x-stackQL-method: searchexperiments + x-stackQL-verb: select + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + experiments: + type: array + items: + type: object + properties: + experiment_id: + type: string + name: + type: string + artifact_location: + type: string + lifecycle_stage: + type: string + last_update_time: + type: integer + creation_time: + type: integer + tags: + type: array + items: + type: object + properties: + key: + type: string + value: + type: string + next_page_token: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + x-stackQL-objectKey: $.experiments + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + max_results: + type: integer + format: int64 + page_token: + type: string + filter: + type: string + order_by: + type: Array of string + view_type: + type: string + example: + max_results: 0 + page_token: string + filter: string + order_by: + - string + view_type: ACTIVE_ONLY + description: Searches for experiments that satisfy specified search criteria. + /api/2.0/mlflow/experiments/update: + post: + operationId: experiments-updateexperiment + externalDocs: + url: https://docs.databricks.com/api/workspace/experiments/updateexperiment + x-stackQL-resource: experiments + x-stackQL-method: updateexperiment + x-stackQL-verb: update + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + experiment_id: + type: required + new_name: + type: string + example: + experiment_id: string + new_name: string + description: Updates experiment metadata. + /api/2.0/mlflow/metrics/get-history: + get: + operationId: experiments-history-gethistory + externalDocs: + url: https://docs.databricks.com/api/workspace/experiments/gethistory + x-stackQL-resource: experiments_history + x-stackQL-method: gethistory + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: run_id + in: query + - name: run_uuid + in: query + - name: metric_key + required: true + description: string + in: query + - name: page_token + in: query + - name: max_results + in: query + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + metrics: + type: array + items: + type: object + properties: + key: + type: string + value: + type: number + timestamp: + type: integer + step: + type: string + next_page_token: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '429': + description: Operation is rejected due to throttling, e.g. some resource + has been exhausted, per-user quota. + '500': + description: Internal error. + x-stackQL-objectKey: $.metrics + description: Gets a list of all values for the specified metric for a given + run. + /api/2.0/mlflow/artifacts/list: + get: + operationId: experiment-artifacts-listartifacts + externalDocs: + url: https://docs.databricks.com/api/workspace/experiments/listartifacts + x-stackQL-resource: experiment_artifacts + x-stackQL-method: listartifacts + x-stackQL-verb: select + x-numReqParams: 0 + parameters: + - name: run_id + in: query + - name: run_uuid + in: query + - name: path + in: query + - name: page_token + in: query + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + root_uri: + type: string + files: + type: array + items: + type: object + properties: + path: + type: string + is_dir: + type: boolean + file_size: + type: integer + next_page_token: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: List artifacts for a run. Takes an optional + /api/2.0/permissions/experiments/{experiment_id}: + get: + operationId: experiment-permissions-getpermissions + externalDocs: + url: https://docs.databricks.com/api/workspace/experiments/getpermissions + x-stackQL-resource: experiment_permissions + x-stackQL-method: getpermissions + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: experiment_id + required: true + description: string + in: path + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + object_id: + type: string + object_type: + type: string + access_control_list: + type: array + items: + type: object + properties: + user_name: + type: string + group_name: + type: string + service_principal_name: + type: string + display_name: + type: string + all_permissions: + type: array + items: + type: object + properties: + permission_level: + type: string + inherited: + type: boolean + inherited_from_object: + type: array + items: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Gets the permissions of an experiment. Experiments can inherit + permissions from their root object. + put: + operationId: experiment-permissions-setpermissions + externalDocs: + url: https://docs.databricks.com/api/workspace/experiments/setpermissions + x-stackQL-resource: experiment_permissions + x-stackQL-method: setpermissions + x-stackQL-verb: replace + x-numReqParams: 1 + parameters: + - name: experiment_id + required: true + description: string + in: path + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + object_id: + type: string + object_type: + type: string + access_control_list: + type: array + items: + type: object + properties: + user_name: + type: string + group_name: + type: string + service_principal_name: + type: string + display_name: + type: string + all_permissions: + type: array + items: + type: object + properties: + permission_level: + type: string + inherited: + type: boolean + inherited_from_object: + type: array + items: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + access_control_list: + type: Array of object + example: + access_control_list: + - user_name: string + group_name: string + service_principal_name: string + permission_level: CAN_MANAGE + description: Sets permissions on an object, replacing existing permissions if + they exist. Deletes all direct permissions if none are specified. Objects + can inherit permissions from their root object. + patch: + operationId: experiment-permissions-updatepermissions + externalDocs: + url: https://docs.databricks.com/api/workspace/experiments/updatepermissions + x-stackQL-resource: experiment_permissions + x-stackQL-method: updatepermissions + x-stackQL-verb: update + x-numReqParams: 1 + parameters: + - name: experiment_id + required: true + description: string + in: path + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + object_id: + type: string + object_type: + type: string + access_control_list: + type: array + items: + type: object + properties: + user_name: + type: string + group_name: + type: string + service_principal_name: + type: string + display_name: + type: string + all_permissions: + type: array + items: + type: object + properties: + permission_level: + type: string + inherited: + type: boolean + inherited_from_object: + type: array + items: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + access_control_list: + type: Array of object + example: + access_control_list: + - user_name: string + group_name: string + service_principal_name: string + permission_level: CAN_MANAGE + description: Updates the permissions on an experiment. Experiments can inherit + permissions from their root object. + /api/2.0/permissions/experiments/{experiment_id}/permissionLevels: + get: + operationId: experiment-permission-levels-getpermissionlevels + externalDocs: + url: https://docs.databricks.com/api/workspace/experiments/getpermissionlevels + x-stackQL-resource: experiment_permission_levels + x-stackQL-method: getpermissionlevels + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: experiment_id + required: true + description: string + in: path + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + permission_levels: + type: array + items: + type: object + properties: + permission_level: + type: string + description: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + x-stackQL-objectKey: $.permission_levels + description: Gets the permission levels that a user can have on an object. + /api/2.0/mlflow/runs/create: + post: + operationId: experiment-runs-createrun + externalDocs: + url: https://docs.databricks.com/api/workspace/experiments/createrun + x-stackQL-resource: experiment_runs + x-stackQL-method: createrun + x-stackQL-verb: insert + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + run: + type: object + properties: + info: + type: object + properties: + run_id: + type: string + run_uuid: + type: string + experiment_id: + type: string + user_id: + type: string + status: + type: string + start_time: + type: integer + end_time: + type: integer + artifact_uri: + type: string + lifecycle_stage: + type: string + data: + type: object + properties: + metrics: + type: array + items: + type: object + properties: + key: + type: string + value: + type: number + timestamp: + type: integer + step: + type: string + params: + type: array + items: + type: object + properties: + key: + type: string + value: + type: string + tags: + type: array + items: + type: object + properties: + key: + type: string + value: + type: string + inputs: + type: object + properties: + dataset_inputs: + type: array + items: + type: object + properties: + tags: + type: array + items: + type: object + properties: + key: + type: string + value: + type: string + dataset: + type: object + properties: + name: + type: string + digest: + type: string + source_type: + type: string + source: + type: string + schema: + type: string + profile: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + experiment_id: + type: string + user_id: + type: string + start_time: + type: integer + format: int64 + tags: + type: Array of object + example: + experiment_id: string + user_id: string + start_time: 0 + tags: + - key: string + value: string + description: Creates a new run within an experiment. A run is usually a single + execution of a machine learning or data ETL pipeline. MLflow uses runs to + track the + /api/2.0/mlflow/runs/delete: + post: + operationId: experiment-runs-deleterun + externalDocs: + url: https://docs.databricks.com/api/workspace/experiments/deleterun + x-stackQL-resource: experiment_runs + x-stackQL-method: deleterun + x-stackQL-verb: delete + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + run_id: + type: required + example: + run_id: string + description: Marks a run for deletion. + /api/2.0/mlflow/databricks/runs/delete-runs: + post: + operationId: experiment-runs-deleteruns + externalDocs: + url: https://docs.databricks.com/api/workspace/experiments/deleteruns + x-stackQL-resource: experiment_runs + x-stackQL-method: deleteruns + x-stackQL-verb: delete + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + runs_deleted: + type: integer + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + experiment_id: + type: required + max_timestamp_millis: + type: string + max_runs: + type: required + example: + experiment_id: string + max_timestamp_millis: 0 + max_runs: '10000' + description: Bulk delete runs in an experiment that were created prior to or + at the specified timestamp. Deletes at most max_runs per request. To call + this API from a Databricks Notebook in Python, you can use the client code + snippet on + /api/2.0/mlflow/runs/get: + get: + operationId: experiment-runs-getrun + externalDocs: + url: https://docs.databricks.com/api/workspace/experiments/getrun + x-stackQL-resource: experiment_runs + x-stackQL-method: getrun + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: run_id + required: true + description: string + in: query + - name: run_uuid + in: query + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + run: + type: object + properties: + info: + type: object + properties: + run_id: + type: string + run_uuid: + type: string + experiment_id: + type: string + user_id: + type: string + status: + type: string + start_time: + type: integer + end_time: + type: integer + artifact_uri: + type: string + lifecycle_stage: + type: string + data: + type: object + properties: + metrics: + type: array + items: + type: object + properties: + key: + type: string + value: + type: number + timestamp: + type: integer + step: + type: string + params: + type: array + items: + type: object + properties: + key: + type: string + value: + type: string + tags: + type: array + items: + type: object + properties: + key: + type: string + value: + type: string + inputs: + type: object + properties: + dataset_inputs: + type: array + items: + type: object + properties: + tags: + type: array + items: + type: object + properties: + key: + type: string + value: + type: string + dataset: + type: object + properties: + name: + type: string + digest: + type: string + source_type: + type: string + source: + type: string + schema: + type: string + profile: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + x-stackQL-objectKey: $.run + description: Gets the metadata, metrics, params, and tags for a run. In the + case where multiple metrics with the same key are logged for a run, return + only the value with the latest timestamp. + /api/2.0/mlflow/runs/log-batch: + post: + operationId: experiment-runs-logbatch + externalDocs: + url: https://docs.databricks.com/api/workspace/experiments/logbatch + x-stackQL-resource: experiment_runs + x-stackQL-method: logbatch + x-stackQL-verb: exec + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + run_id: + type: string + metrics: + type: Array of object + params: + type: Array of object + tags: + type: Array of object + example: + run_id: 2a14ed5c6a87499199e0106c3501eab8 + metrics: + - key: mae + value: 2.5 + timestamp: 1552550804 + - key: rmse + value: 2.7 + timestamp: 1552550804 + params: + - key: model_class + value: LogisticRegression + description: Logs a batch of metrics, params, and tags for a run. If any data + failed to be persisted, the server will respond with an error (non-200 status + code). + /api/2.0/mlflow/runs/log-inputs: + post: + operationId: experiment-runs-loginputs + externalDocs: + url: https://docs.databricks.com/api/workspace/experiments/loginputs + x-stackQL-resource: experiment_runs + x-stackQL-method: loginputs + x-stackQL-verb: exec + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + run_id: + type: string + datasets: + type: Array of object + example: + run_id: string + datasets: + - tags: + - key: string + value: string + dataset: + name: string + digest: string + source_type: string + source: string + schema: string + profile: string + description: 'Experimental: This API may change or be removed in a future release + without warning.' + /api/2.0/mlflow/runs/log-metric: + post: + operationId: experiment-runs-logmetric + externalDocs: + url: https://docs.databricks.com/api/workspace/experiments/logmetric + x-stackQL-resource: experiment_runs + x-stackQL-method: logmetric + x-stackQL-verb: exec + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + run_id: + type: string + run_uuid: + type: string + key: + type: required + value: + type: string + timestamp: + type: required + step: + type: double + example: + run_id: string + run_uuid: string + key: string + value: 0.1 + timestamp: 0 + step: '0' + description: Logs a metric for a run. A metric is a key-value pair (string key, + float value) with an associated timestamp. Examples include the various metrics + that represent ML model accuracy. A metric can be logged multiple times. + /api/2.0/mlflow/runs/log-model: + post: + operationId: experiment-runs-logmodel + externalDocs: + url: https://docs.databricks.com/api/workspace/experiments/logmodel + x-stackQL-resource: experiment_runs + x-stackQL-method: logmodel + x-stackQL-verb: exec + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '429': + description: Operation is rejected due to throttling, e.g. some resource + has been exhausted, per-user quota. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + run_id: + type: string + model_json: + type: string + example: + run_id: string + model_json: string + description: 'Experimental: This API may change or be removed in a future release + without warning.' + /api/2.0/mlflow/runs/log-parameter: + post: + operationId: experiment-runs-logparam + externalDocs: + url: https://docs.databricks.com/api/workspace/experiments/logparam + x-stackQL-resource: experiment_runs + x-stackQL-method: logparam + x-stackQL-verb: exec + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + run_id: + type: string + run_uuid: + type: string + key: + type: required + value: + type: string + example: + run_id: string + run_uuid: string + key: string + value: string + description: Logs a param used for a run. A param is a key-value pair (string + key, string value). Examples include hyperparameters used for ML model training + and constant dates and values used in an ETL pipeline. A param can be logged + only once for a run. + /api/2.0/mlflow/runs/restore: + post: + operationId: experiment-runs-restorerun + externalDocs: + url: https://docs.databricks.com/api/workspace/experiments/restorerun + x-stackQL-resource: experiment_runs + x-stackQL-method: restorerun + x-stackQL-verb: exec + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + run_id: + type: required + example: + run_id: string + description: Restores a deleted run. + /api/2.0/mlflow/databricks/runs/restore-runs: + post: + operationId: experiment-runs-restoreruns + externalDocs: + url: https://docs.databricks.com/api/workspace/experiments/restoreruns + x-stackQL-resource: experiment_runs + x-stackQL-method: restoreruns + x-stackQL-verb: exec + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + runs_restored: + type: integer + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + experiment_id: + type: required + min_timestamp_millis: + type: string + max_runs: + type: required + example: + experiment_id: string + min_timestamp_millis: 0 + max_runs: '10000' + description: Bulk restore runs in an experiment that were deleted no earlier + than the specified timestamp. Restores at most max_runs per request. To call + this API from a Databricks Notebook in Python, you can use the client code + snippet on + /api/2.0/mlflow/runs/search: + post: + operationId: experiment-runs-searchruns + externalDocs: + url: https://docs.databricks.com/api/workspace/experiments/searchruns + x-stackQL-resource: experiment_runs + x-stackQL-method: searchruns + x-stackQL-verb: select + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + runs: + type: array + items: + type: object + properties: + info: + type: object + properties: + run_id: + type: string + run_uuid: + type: string + experiment_id: + type: string + user_id: + type: string + status: + type: string + start_time: + type: integer + end_time: + type: integer + artifact_uri: + type: string + lifecycle_stage: + type: string + data: + type: object + properties: + metrics: + type: array + items: + type: object + properties: + key: + type: string + value: + type: number + timestamp: + type: integer + step: + type: string + params: + type: array + items: + type: object + properties: + key: + type: string + value: + type: string + tags: + type: array + items: + type: object + properties: + key: + type: string + value: + type: string + inputs: + type: object + properties: + dataset_inputs: + type: array + items: + type: object + properties: + tags: + type: array + items: + type: object + properties: + key: + type: string + value: + type: string + dataset: + type: object + properties: + name: + type: string + digest: + type: string + source_type: + type: string + source: + type: string + schema: + type: string + profile: + type: string + next_page_token: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + x-stackQL-objectKey: $.runs + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + experiment_ids: + type: Array of string + filter: + type: string + run_view_type: + type: string + max_results: + type: int32 + order_by: + type: Array of string + page_token: + type: string + example: + experiment_ids: + - string + filter: string + run_view_type: ACTIVE_ONLY + max_results: '1000' + order_by: + - string + page_token: string + description: Searches for runs that satisfy expressions. + /api/2.0/mlflow/runs/update: + post: + operationId: experiment-runs-updaterun + externalDocs: + url: https://docs.databricks.com/api/workspace/experiments/updaterun + x-stackQL-resource: experiment_runs + x-stackQL-method: updaterun + x-stackQL-verb: update + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + run_info: + type: object + properties: + run_id: + type: string + run_uuid: + type: string + experiment_id: + type: string + user_id: + type: string + status: + type: string + start_time: + type: integer + end_time: + type: integer + artifact_uri: + type: string + lifecycle_stage: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + run_id: + type: string + run_uuid: + type: string + status: + type: string + end_time: + type: integer + format: int64 + example: + run_id: string + run_uuid: string + status: RUNNING + end_time: 0 + description: Updates run metadata. + /api/2.0/mlflow/runs/set-tag: + post: + operationId: experiment-run-tags-settag + externalDocs: + url: https://docs.databricks.com/api/workspace/experiments/settag + x-stackQL-resource: experiment_run_tags + x-stackQL-method: settag + x-stackQL-verb: replace + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + run_id: + type: string + run_uuid: + type: string + key: + type: required + value: + type: string + example: + run_id: string + run_uuid: string + key: string + value: string + description: Sets a tag on a run. Tags are run metadata that can be updated + during a run and after a run completes. + /api/2.0/mlflow/runs/delete-tag: + post: + operationId: experiment-tags-deletetag + externalDocs: + url: https://docs.databricks.com/api/workspace/experiments/deletetag + x-stackQL-resource: experiment_tags + x-stackQL-method: deletetag + x-stackQL-verb: delete + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + run_id: + type: required + key: + type: string + example: + run_id: string + key: string + description: Deletes a tag on a run. Tags are run metadata that can be updated + during a run and after a run completes. + /api/2.0/mlflow/experiments/set-experiment-tag: + post: + operationId: experiment-tags-setexperimenttag + externalDocs: + url: https://docs.databricks.com/api/workspace/experiments/setexperimenttag + x-stackQL-resource: experiment_tags + x-stackQL-method: setexperimenttag + x-stackQL-verb: replace + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + experiment_id: + type: required + key: + type: string + value: + type: required + example: + experiment_id: string + key: string + value: string + description: Sets a tag on an experiment. Experiment tags are metadata that + can be updated. + /api/2.0/mlflow/registered-models/create: + post: + operationId: models-createmodel + externalDocs: + url: https://docs.databricks.com/api/workspace/modelregistry/createmodel + x-stackQL-resource: models + x-stackQL-method: createmodel + x-stackQL-verb: insert + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + registered_model: + type: object + properties: + name: + type: string + creation_timestamp: + type: integer + last_updated_timestamp: + type: integer + user_id: + type: string + description: + type: string + latest_versions: + type: array + items: + type: object + properties: + name: + type: string + version: + type: string + creation_timestamp: + type: integer + last_updated_timestamp: + type: integer + user_id: + type: string + current_stage: + type: string + description: + type: string + source: + type: string + run_id: + type: string + status: + type: string + status_message: + type: string + tags: + type: array + items: + type: object + properties: + key: + type: string + value: + type: string + run_link: + type: string + tags: + type: array + items: + type: object + properties: + key: + type: string + value: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: required + description: + type: string + tags: + type: Array of object + example: + name: string + tags: + - key: string + value: string + description: string + description: Creates a new registered model with the name specified in the request + body. + /api/2.0/mlflow/registered-models/delete: + delete: + operationId: models-deletemodel + externalDocs: + url: https://docs.databricks.com/api/workspace/modelregistry/deletemodel + x-stackQL-resource: models + x-stackQL-method: deletemodel + x-stackQL-verb: delete + x-numReqParams: 1 + parameters: + - name: name + required: true + description: string + in: query + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: {} + description: Deletes a registered model. + /api/2.0/mlflow/databricks/registered-models/get: + get: + operationId: models-getmodel + externalDocs: + url: https://docs.databricks.com/api/workspace/modelregistry/getmodel + x-stackQL-resource: models + x-stackQL-method: getmodel + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: name + required: true + description: string + in: query + responses: + '200': + description: Model details were returned successfully. + content: + application/json: + schema: + type: object + properties: + registered_model_databricks: + type: object + properties: + name: + type: string + creation_timestamp: + type: integer + last_updated_timestamp: + type: integer + user_id: + type: string + description: + type: string + latest_versions: + type: array + items: + type: object + properties: + name: + type: string + version: + type: string + creation_timestamp: + type: integer + last_updated_timestamp: + type: integer + user_id: + type: string + current_stage: + type: string + description: + type: string + source: + type: string + run_id: + type: string + status: + type: string + status_message: + type: string + tags: + type: array + items: + type: object + properties: + key: + type: string + value: + type: string + run_link: + type: string + id: + type: string + permission_level: + type: string + tags: + type: array + items: + type: object + properties: + key: + type: string + value: + type: string + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Get the details of a model. This is a Databricks workspace version + of the + /api/2.0/mlflow/registered-models/list: + get: + operationId: models-listmodels + externalDocs: + url: https://docs.databricks.com/api/workspace/modelregistry/listmodels + x-stackQL-resource: models + x-stackQL-method: listmodels + x-stackQL-verb: select + x-numReqParams: 0 + parameters: + - name: max_results + in: query + - name: page_token + in: query + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + registered_models: + type: array + items: + type: object + properties: + name: + type: string + creation_timestamp: + type: integer + last_updated_timestamp: + type: integer + user_id: + type: string + description: + type: string + latest_versions: + type: array + items: + type: object + properties: + name: + type: string + version: + type: string + creation_timestamp: + type: integer + last_updated_timestamp: + type: integer + user_id: + type: string + current_stage: + type: string + description: + type: string + source: + type: string + run_id: + type: string + status: + type: string + status_message: + type: string + tags: + type: array + items: + type: object + properties: + key: + type: string + value: + type: string + run_link: + type: string + tags: + type: array + items: + type: object + properties: + key: + type: string + value: + type: string + next_page_token: + type: string + x-stackQL-objectKey: $.registered_models + description: Lists all available registered models, up to the limit specified + in + /api/2.0/mlflow/registered-models/rename: + post: + operationId: models-renamemodel + externalDocs: + url: https://docs.databricks.com/api/workspace/modelregistry/renamemodel + x-stackQL-resource: models + x-stackQL-method: renamemodel + x-stackQL-verb: exec + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + registered_model: + type: object + properties: + name: + type: string + creation_timestamp: + type: integer + last_updated_timestamp: + type: integer + user_id: + type: string + description: + type: string + latest_versions: + type: array + items: + type: object + properties: + name: + type: string + version: + type: string + creation_timestamp: + type: integer + last_updated_timestamp: + type: integer + user_id: + type: string + current_stage: + type: string + description: + type: string + source: + type: string + run_id: + type: string + status: + type: string + status_message: + type: string + tags: + type: array + items: + type: object + properties: + key: + type: string + value: + type: string + run_link: + type: string + tags: + type: array + items: + type: object + properties: + key: + type: string + value: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: required + new_name: + type: string + example: + name: string + new_name: string + description: Renames a registered model. + /api/2.0/mlflow/registered-models/search: + get: + operationId: models-searchmodels + externalDocs: + url: https://docs.databricks.com/api/workspace/modelregistry/searchmodels + x-stackQL-resource: models + x-stackQL-method: searchmodels + x-stackQL-verb: select + x-numReqParams: 0 + parameters: + - name: filter + in: query + - name: max_results + in: query + - name: order_by + in: query + - name: page_token + in: query + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + registered_models: + type: array + items: + type: object + properties: + name: + type: string + creation_timestamp: + type: integer + last_updated_timestamp: + type: integer + user_id: + type: string + description: + type: string + latest_versions: + type: array + items: + type: object + properties: + name: + type: string + version: + type: string + creation_timestamp: + type: integer + last_updated_timestamp: + type: integer + user_id: + type: string + current_stage: + type: string + description: + type: string + source: + type: string + run_id: + type: string + status: + type: string + status_message: + type: string + tags: + type: array + items: + type: object + properties: + key: + type: string + value: + type: string + run_link: + type: string + tags: + type: array + items: + type: object + properties: + key: + type: string + value: + type: string + next_page_token: + type: string + x-stackQL-objectKey: $.registered_models + description: Search for registered models based on the specified + /api/2.0/mlflow/registered-models/update: + patch: + operationId: models-updatemodel + externalDocs: + url: https://docs.databricks.com/api/workspace/modelregistry/updatemodel + x-stackQL-resource: models + x-stackQL-method: updatemodel + x-stackQL-verb: update + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: {} + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: required + description: + type: string + example: + name: string + description: string + description: Updates a registered model. + /api/2.0/mlflow/registered-models/get-latest-versions: + post: + operationId: model-latest-versions-getlatestversions + externalDocs: + url: https://docs.databricks.com/api/workspace/modelregistry/getlatestversions + x-stackQL-resource: model_latest_versions + x-stackQL-method: getlatestversions + x-stackQL-verb: select + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + model_versions: + type: array + items: + type: object + properties: + name: + type: string + version: + type: string + creation_timestamp: + type: integer + last_updated_timestamp: + type: integer + user_id: + type: string + current_stage: + type: string + description: + type: string + source: + type: string + run_id: + type: string + status: + type: string + status_message: + type: string + tags: + type: array + items: + type: object + properties: + key: + type: string + value: + type: string + run_link: + type: string + x-stackQL-objectKey: $.model_versions + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: required + stages: + type: string + example: + name: string + stages: + - string + description: Gets the latest version of a registered model. + /api/2.0/permissions/registered-models/{registered_model_id}: + get: + operationId: model-permissions-getpermissions + externalDocs: + url: https://docs.databricks.com/api/workspace/modelregistry/getpermissions + x-stackQL-resource: model_permissions + x-stackQL-method: getpermissions + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: registered_model_id + required: true + description: string + in: path + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + object_id: + type: string + object_type: + type: string + access_control_list: + type: array + items: + type: object + properties: + user_name: + type: string + group_name: + type: string + service_principal_name: + type: string + display_name: + type: string + all_permissions: + type: array + items: + type: object + properties: + permission_level: + type: string + inherited: + type: boolean + inherited_from_object: + type: array + items: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Gets the permissions of a registered model. Registered models can + inherit permissions from their root object. + put: + operationId: model-permissions-setpermissions + externalDocs: + url: https://docs.databricks.com/api/workspace/modelregistry/setpermissions + x-stackQL-resource: model_permissions + x-stackQL-method: setpermissions + x-stackQL-verb: replace + x-numReqParams: 1 + parameters: + - name: registered_model_id + required: true + description: string + in: path + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + object_id: + type: string + object_type: + type: string + access_control_list: + type: array + items: + type: object + properties: + user_name: + type: string + group_name: + type: string + service_principal_name: + type: string + display_name: + type: string + all_permissions: + type: array + items: + type: object + properties: + permission_level: + type: string + inherited: + type: boolean + inherited_from_object: + type: array + items: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + access_control_list: + type: Array of object + example: + access_control_list: + - user_name: string + group_name: string + service_principal_name: string + permission_level: CAN_MANAGE + description: Sets permissions on an object, replacing existing permissions if + they exist. Deletes all direct permissions if none are specified. Objects + can inherit permissions from their root object. + patch: + operationId: model-permissions-updatepermissions + externalDocs: + url: https://docs.databricks.com/api/workspace/modelregistry/updatepermissions + x-stackQL-resource: model_permissions + x-stackQL-method: updatepermissions + x-stackQL-verb: update + x-numReqParams: 1 + parameters: + - name: registered_model_id + required: true + description: string + in: path + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + object_id: + type: string + object_type: + type: string + access_control_list: + type: array + items: + type: object + properties: + user_name: + type: string + group_name: + type: string + service_principal_name: + type: string + display_name: + type: string + all_permissions: + type: array + items: + type: object + properties: + permission_level: + type: string + inherited: + type: boolean + inherited_from_object: + type: array + items: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + access_control_list: + type: Array of object + example: + access_control_list: + - user_name: string + group_name: string + service_principal_name: string + permission_level: CAN_MANAGE + description: Updates the permissions on a registered model. Registered models + can inherit permissions from their root object. + /api/2.0/permissions/registered-models/{registered_model_id}/permissionLevels: + get: + operationId: model-permission-levels-getpermissionlevels + externalDocs: + url: https://docs.databricks.com/api/workspace/modelregistry/getpermissionlevels + x-stackQL-resource: model_permission_levels + x-stackQL-method: getpermissionlevels + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: registered_model_id + required: true + description: string + in: path + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + permission_levels: + type: array + items: + type: object + properties: + permission_level: + type: string + description: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + x-stackQL-objectKey: $.permission_levels + description: Gets the permission levels that a user can have on an object. + /api/2.0/mlflow/registered-models/delete-tag: + delete: + operationId: model-tags-deletemodeltag + externalDocs: + url: https://docs.databricks.com/api/workspace/modelregistry/deletemodeltag + x-stackQL-resource: model_tags + x-stackQL-method: deletemodeltag + x-stackQL-verb: delete + x-numReqParams: 2 + parameters: + - name: name + required: true + description: string + in: query + - name: key + required: true + description: string + in: query + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: {} + description: Deletes the tag for a registered model. + /api/2.0/mlflow/registered-models/set-tag: + post: + operationId: model-tags-setmodeltag + externalDocs: + url: https://docs.databricks.com/api/workspace/modelregistry/setmodeltag + x-stackQL-resource: model_tags + x-stackQL-method: setmodeltag + x-stackQL-verb: replace + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: {} + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: required + key: + type: string + value: + type: required + example: + name: string + key: string + value: string + description: Sets a tag on a registered model. + /api/2.0/mlflow/transition-requests/approve: + post: + operationId: model-transition-requests-approvetransitionrequest + externalDocs: + url: https://docs.databricks.com/api/workspace/modelregistry/approvetransitionrequest + x-stackQL-resource: model_transition_requests + x-stackQL-method: approvetransitionrequest + x-stackQL-verb: exec + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Model version's stage was updated successfully. + content: + application/json: + schema: + type: object + properties: + activity: + type: object + properties: + id: + type: string + creation_timestamp: + type: integer + last_updated_timestamp: + type: integer + user_id: + type: string + activity_type: + type: string + from_stage: + type: string + to_stage: + type: string + comment: + type: string + system_comment: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: required + version: + type: string + stage: + type: required + archive_existing_versions: + type: string + comment: + type: required + example: + name: search_ads_model + version: '1' + stage: Staging + archive_existing_versions: true + comment: This version is great! + description: Details required to identify and approve a model version stage + transition request. + description: Approves a model version stage transition request. + /api/2.0/mlflow/transition-requests/create: + post: + operationId: model-transition-requests-createtransitionrequest + externalDocs: + url: https://docs.databricks.com/api/workspace/modelregistry/createtransitionrequest + x-stackQL-resource: model_transition_requests + x-stackQL-method: createtransitionrequest + x-stackQL-verb: insert + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Transition request was made successfully. + content: + application/json: + schema: + type: object + properties: + request: + type: object + properties: + creation_timestamp: + type: integer + to_stage: + type: string + user_id: + type: string + comment: + type: string + available_actions: + type: array + items: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '409': + description: Request was rejected due a conflict with an existing resource. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: required + version: + type: string + stage: + type: required + comment: + type: string + example: + name: search_ads_model + version: '1' + stage: Staging + comment: This version is great! + description: Details required to create a model version stage transition request. + description: Creates a model version stage transition request. + /api/2.0/mlflow/transition-requests/delete: + delete: + operationId: model-transition-requests-deletetransitionrequest + externalDocs: + url: https://docs.databricks.com/api/workspace/modelregistry/deletetransitionrequest + x-stackQL-resource: model_transition_requests + x-stackQL-method: deletetransitionrequest + x-stackQL-verb: delete + x-numReqParams: 4 + parameters: + - name: name + required: true + description: string + in: query + - name: version + required: true + description: string + in: query + - name: stage + required: true + description: string + in: query + - name: creator + required: true + description: email + in: query + - name: comment + in: query + responses: + '200': + description: Transition request was deleted successfully. + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Cancels a model version stage transition request. + /api/2.0/mlflow/transition-requests/list: + get: + operationId: model-transition-requests-listtransitionrequests + externalDocs: + url: https://docs.databricks.com/api/workspace/modelregistry/listtransitionrequests + x-stackQL-resource: model_transition_requests + x-stackQL-method: listtransitionrequests + x-stackQL-verb: select + x-numReqParams: 2 + parameters: + - name: name + required: true + description: string + in: query + - name: version + required: true + description: string + in: query + responses: + '200': + description: Fetched all open requests successfully. + content: + application/json: + schema: + type: object + properties: + requests: + type: array + items: + type: object + properties: + id: + type: string + creation_timestamp: + type: integer + last_updated_timestamp: + type: integer + user_id: + type: string + activity_type: + type: string + from_stage: + type: string + to_stage: + type: string + comment: + type: string + system_comment: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + x-stackQL-objectKey: $.requests + description: Gets a list of all open stage transition requests for the model + version. + /api/2.0/mlflow/transition-requests/reject: + post: + operationId: model-transition-requests-rejecttransitionrequest + externalDocs: + url: https://docs.databricks.com/api/workspace/modelregistry/rejecttransitionrequest + x-stackQL-resource: model_transition_requests + x-stackQL-method: rejecttransitionrequest + x-stackQL-verb: exec + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Transition request was rejected successfully. + content: + application/json: + schema: + type: object + properties: + activity: + type: object + properties: + id: + type: string + creation_timestamp: + type: integer + last_updated_timestamp: + type: integer + user_id: + type: string + activity_type: + type: string + from_stage: + type: string + to_stage: + type: string + comment: + type: string + system_comment: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: required + version: + type: string + stage: + type: required + comment: + type: string + example: + name: search_ads_model + version: '1' + stage: Staging + comment: This version is great! + description: Details required to identify and reject a model version stage + transition request. + description: Rejects a model version stage transition request. + /api/2.0/mlflow/databricks/model-versions/transition-stage: + post: + operationId: model-transition-requests-transitionstage + externalDocs: + url: https://docs.databricks.com/api/workspace/modelregistry/transitionstage + x-stackQL-resource: model_transition_requests + x-stackQL-method: transitionstage + x-stackQL-verb: exec + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Model version's stage was updated successfully. + content: + application/json: + schema: + type: object + properties: + model_version: + type: object + properties: + name: + type: string + version: + type: string + creation_timestamp: + type: integer + last_updated_timestamp: + type: integer + user_id: + type: string + current_stage: + type: string + description: + type: string + source: + type: string + run_id: + type: string + status: + type: string + status_message: + type: string + permission_level: + type: string + tags: + type: array + items: + type: object + properties: + key: + type: string + value: + type: string + run_link: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '409': + description: Request was rejected due a conflict with an existing resource. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: required + version: + type: string + stage: + type: required + archive_existing_versions: + type: string + comment: + type: required + example: + name: search_ads_model + version: '1' + stage: Staging + archive_existing_versions: true + comment: This version is great! + description: Details required to transition a model version's stage. + description: Transition a model version's stage. This is a Databricks workspace + version of the + /api/2.0/mlflow/model-versions/create: + post: + operationId: model-versions-createmodelversion + externalDocs: + url: https://docs.databricks.com/api/workspace/modelregistry/createmodelversion + x-stackQL-resource: model_versions + x-stackQL-method: createmodelversion + x-stackQL-verb: insert + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + model_version: + type: object + properties: + name: + type: string + version: + type: string + creation_timestamp: + type: integer + last_updated_timestamp: + type: integer + user_id: + type: string + current_stage: + type: string + description: + type: string + source: + type: string + run_id: + type: string + status: + type: string + status_message: + type: string + tags: + type: array + items: + type: object + properties: + key: + type: string + value: + type: string + run_link: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: required + source: + type: string + run_id: + type: required + run_link: + type: string + description: + type: string + tags: + type: Array of object + example: + name: string + source: string + run_id: string + tags: + - key: string + value: string + run_link: string + description: string + description: Creates a model version. + /api/2.0/mlflow/model-versions/delete: + delete: + operationId: model-versions-deletemodelversion + externalDocs: + url: https://docs.databricks.com/api/workspace/modelregistry/deletemodelversion + x-stackQL-resource: model_versions + x-stackQL-method: deletemodelversion + x-stackQL-verb: delete + x-numReqParams: 2 + parameters: + - name: name + required: true + description: string + in: query + - name: version + required: true + description: string + in: query + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: {} + description: Deletes a model version. + /api/2.0/mlflow/model-versions/get: + get: + operationId: model-versions-getmodelversion + externalDocs: + url: https://docs.databricks.com/api/workspace/modelregistry/getmodelversion + x-stackQL-resource: model_versions + x-stackQL-method: getmodelversion + x-stackQL-verb: select + x-numReqParams: 2 + parameters: + - name: name + required: true + description: string + in: query + - name: version + required: true + description: string + in: query + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + model_version: + type: object + properties: + name: + type: string + version: + type: string + creation_timestamp: + type: integer + last_updated_timestamp: + type: integer + user_id: + type: string + current_stage: + type: string + description: + type: string + source: + type: string + run_id: + type: string + status: + type: string + status_message: + type: string + tags: + type: array + items: + type: object + properties: + key: + type: string + value: + type: string + run_link: + type: string + x-stackQL-objectKey: $.model_version + description: Get a model version. + /api/2.0/mlflow/model-versions/search: + get: + operationId: model-versions-searchmodelversions + externalDocs: + url: https://docs.databricks.com/api/workspace/modelregistry/searchmodelversions + x-stackQL-resource: model_versions + x-stackQL-method: searchmodelversions + x-stackQL-verb: select + x-numReqParams: 0 + parameters: + - name: filter + in: query + - name: max_results + in: query + - name: order_by + in: query + - name: page_token + in: query + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + model_versions: + type: array + items: + type: object + properties: + name: + type: string + version: + type: string + creation_timestamp: + type: integer + last_updated_timestamp: + type: integer + user_id: + type: string + current_stage: + type: string + description: + type: string + source: + type: string + run_id: + type: string + status: + type: string + status_message: + type: string + tags: + type: array + items: + type: object + properties: + key: + type: string + value: + type: string + run_link: + type: string + next_page_token: + type: string + x-stackQL-objectKey: $.model_versions + description: Searches for specific model versions based on the supplied + /api/2.0/mlflow/model-versions/update: + patch: + operationId: model-versions-updatemodelversion + externalDocs: + url: https://docs.databricks.com/api/workspace/modelregistry/updatemodelversion + x-stackQL-resource: model_versions + x-stackQL-method: updatemodelversion + x-stackQL-verb: update + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: {} + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: required + version: + type: string + description: + type: required + example: + name: string + version: string + description: string + description: Updates the model version. + /api/2.0/mlflow/comments/create: + post: + operationId: model-version-comments-createcomment + externalDocs: + url: https://docs.databricks.com/api/workspace/modelregistry/createcomment + x-stackQL-resource: model_version_comments + x-stackQL-method: createcomment + x-stackQL-verb: insert + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Comment was made successfully. + content: + application/json: + schema: + type: object + properties: + comment: + type: object + properties: + id: + type: string + creation_timestamp: + type: integer + last_updated_timestamp: + type: integer + user_id: + type: string + comment: + type: string + available_actions: + type: array + items: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '409': + description: Request was rejected due a conflict with an existing resource. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: required + version: + type: string + comment: + type: required + example: + name: search_ads_model + version: '1' + comment: This version is great! + description: Details required to create a comment on a model version. + description: Posts a comment on a model version. A comment can be submitted + either by a user or programmatically to display relevant information about + the model. For example, test results or deployment errors. + /api/2.0/mlflow/comments/delete: + delete: + operationId: model-version-comments-deletecomment + externalDocs: + url: https://docs.databricks.com/api/workspace/modelregistry/deletecomment + x-stackQL-resource: model_version_comments + x-stackQL-method: deletecomment + x-stackQL-verb: delete + x-numReqParams: 1 + parameters: + - name: id + required: true + description: uuid + in: query + responses: + '200': + description: Comment was deleted successfully. + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Deletes a comment on a model version. + /api/2.0/mlflow/comments/update: + patch: + operationId: model-version-comments-updatecomment + externalDocs: + url: https://docs.databricks.com/api/workspace/modelregistry/updatecomment + x-stackQL-resource: model_version_comments + x-stackQL-method: updatecomment + x-stackQL-verb: update + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Comment was updated successfully. + content: + application/json: + schema: + type: object + properties: + comment: + type: object + properties: + id: + type: string + creation_timestamp: + type: integer + last_updated_timestamp: + type: integer + user_id: + type: string + comment: + type: string + available_actions: + type: array + items: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + id: + type: required + comment: + type: uuid + example: + id: 6fc74c92704341aaa49e74dcc6031057 + comment: This version is great! + description: Details required to edit a comment on a model version. + description: Post an edit to a comment on a model version. + /api/2.0/mlflow/model-versions/get-download-uri: + get: + operationId: model-version-download-urls-getmodelversiondownloaduri + externalDocs: + url: https://docs.databricks.com/api/workspace/modelregistry/getmodelversiondownloaduri + x-stackQL-resource: model_version_download_urls + x-stackQL-method: getmodelversiondownloaduri + x-stackQL-verb: select + x-numReqParams: 2 + parameters: + - name: name + required: true + description: string + in: query + - name: version + required: true + description: string + in: query + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + artifact_uri: + type: string + description: Gets a URI to download the model version. + /api/2.0/mlflow/model-versions/delete-tag: + delete: + operationId: model-version-tags-deletemodelversiontag + externalDocs: + url: https://docs.databricks.com/api/workspace/modelregistry/deletemodelversiontag + x-stackQL-resource: model_version_tags + x-stackQL-method: deletemodelversiontag + x-stackQL-verb: delete + x-numReqParams: 3 + parameters: + - name: name + required: true + description: string + in: query + - name: version + required: true + description: string + in: query + - name: key + required: true + description: string + in: query + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: {} + description: Deletes a model version tag. + /api/2.0/mlflow/model-versions/set-tag: + post: + operationId: model-version-tags-setmodelversiontag + externalDocs: + url: https://docs.databricks.com/api/workspace/modelregistry/setmodelversiontag + x-stackQL-resource: model_version_tags + x-stackQL-method: setmodelversiontag + x-stackQL-verb: replace + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: {} + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: required + version: + type: string + key: + type: required + value: + type: string + example: + name: string + version: string + key: string + value: string + description: Sets a model version tag. + /api/2.0/mlflow/registry-webhooks/create: + post: + operationId: model-web-hooks-createwebhook + externalDocs: + url: https://docs.databricks.com/api/workspace/modelregistry/createwebhook + x-stackQL-resource: model_web_hooks + x-stackQL-method: createwebhook + x-stackQL-verb: insert + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Registry webhook was created successfully. + content: + application/json: + schema: + type: object + properties: + webhook: + type: object + properties: + id: + type: string + events: + type: array + items: + type: string + creation_timestamp: + type: integer + last_updated_timestamp: + type: integer + description: + type: string + status: + type: string + http_url_spec: + type: object + properties: + url: + type: string + enable_ssl_verification: + type: boolean + model_name: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + events: + type: required + model_name: + type: Array of string + description: + type: string + status: + type: string + job_spec: + type: object + http_url_spec: + type: object + example: + job_spec: + job_id: '1' + access_token: dapi12345678935845824 + workspace_url: string + http_url_spec: + url: https://hooks.slack.com/services/... + secret: anyRandomString + enable_ssl_verification: true + authorization: Bearer + events: + - MODEL_VERSION_CREATED + - MODEL_VERSION_TRANSITIONED_TO_STAGING + - COMMENT_CREATED + model_name: registered-model-1 + description: Webhook for comment creation + status: ACTIVE + description: Details required to create a registry webhook. + description: ': This endpoint is in Public Preview.' + /api/2.0/mlflow/registry-webhooks/delete: + delete: + operationId: model-web-hooks-deletewebhook + externalDocs: + url: https://docs.databricks.com/api/workspace/modelregistry/deletewebhook + x-stackQL-resource: model_web_hooks + x-stackQL-method: deletewebhook + x-stackQL-verb: delete + x-numReqParams: 0 + parameters: + - name: id + in: query + responses: + '200': + description: Registry webhook was deleted successfully. + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: This endpoint is in Public Preview. + /api/2.0/mlflow/registry-webhooks/list: + get: + operationId: model-web-hooks-listwebhooks + externalDocs: + url: https://docs.databricks.com/api/workspace/modelregistry/listwebhooks + x-stackQL-resource: model_web_hooks + x-stackQL-method: listwebhooks + x-stackQL-verb: select + x-numReqParams: 0 + parameters: + - name: model_name + in: query + - name: events + in: query + - name: page_token + in: query + responses: + '200': + description: Registry webhooks listed successfully. + content: + application/json: + schema: + type: object + properties: + webhooks: + type: array + items: + type: object + properties: + id: + type: string + events: + type: array + items: + type: string + creation_timestamp: + type: integer + last_updated_timestamp: + type: integer + description: + type: string + status: + type: string + http_url_spec: + type: object + properties: + url: + type: string + enable_ssl_verification: + type: boolean + model_name: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + x-stackQL-objectKey: $.webhooks + description: This endpoint is in Public Preview. + /api/2.0/mlflow/registry-webhooks/test: + post: + operationId: model-web-hooks-testregistrywebhook + externalDocs: + url: https://docs.databricks.com/api/workspace/modelregistry/testregistrywebhook + x-stackQL-resource: model_web_hooks + x-stackQL-method: testregistrywebhook + x-stackQL-verb: exec + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Registry webhook was tested successfully. + content: + application/json: + schema: + type: object + properties: + webhook: + type: object + properties: + status_code: + type: integer + body: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + id: + type: required + event: + type: string + example: + id: '124323' + event: MODEL_VERSION_CREATED + description: Details required to test a registry webhook. + description: This endpoint is in Public Preview. + /api/2.0/mlflow/registry-webhooks/update: + patch: + operationId: model-web-hooks-updatewebhook + externalDocs: + url: https://docs.databricks.com/api/workspace/modelregistry/updatewebhook + x-stackQL-resource: model_web_hooks + x-stackQL-method: updatewebhook + x-stackQL-verb: update + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Registry webhook was updated successfully. + content: + application/json: + schema: + type: object + properties: + webhook: + type: object + properties: + id: + type: string + events: + type: array + items: + type: string + creation_timestamp: + type: integer + last_updated_timestamp: + type: integer + description: + type: string + status: + type: string + http_url_spec: + type: object + properties: + url: + type: string + enable_ssl_verification: + type: boolean + model_name: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + id: + type: required + events: + type: string + description: + type: Array of string + status: + type: string + http_url_spec: + type: object + job_spec: + type: object + example: + id: '124323' + status: DISABLED + description: Details required to update a registry webhook. Only the fields + that need to be updated should be specified, and both + description: This endpoint is in Public Preview. +components: + x-stackQL-resources: + experiments: + id: databricks_workspace.machinelearning.experiments + name: experiments + title: Experiments + methods: + createexperiment: + operation: + $ref: '#/paths/~1api~12.0~1mlflow~1experiments~1create/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + deleteexperiment: + operation: + $ref: '#/paths/~1api~12.0~1mlflow~1experiments~1delete/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + getbyname: + operation: + $ref: '#/paths/~1api~12.0~1mlflow~1experiments~1get-by-name/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.experiment + getexperiment: + operation: + $ref: '#/paths/~1api~12.0~1mlflow~1experiments~1get/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.experiment + listexperiments: + operation: + $ref: '#/paths/~1api~12.0~1mlflow~1experiments~1list/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.experiments + restoreexperiment: + operation: + $ref: '#/paths/~1api~12.0~1mlflow~1experiments~1restore/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + searchexperiments: + operation: + $ref: '#/paths/~1api~12.0~1mlflow~1experiments~1search/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.experiments + updateexperiment: + operation: + $ref: '#/paths/~1api~12.0~1mlflow~1experiments~1update/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/experiments/methods/searchexperiments' + - $ref: '#/components/x-stackQL-resources/experiments/methods/listexperiments' + - $ref: '#/components/x-stackQL-resources/experiments/methods/getexperiment' + - $ref: '#/components/x-stackQL-resources/experiments/methods/getbyname' + insert: + - $ref: '#/components/x-stackQL-resources/experiments/methods/createexperiment' + update: + - $ref: '#/components/x-stackQL-resources/experiments/methods/updateexperiment' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/experiments/methods/deleteexperiment' + exec: + - $ref: '#/components/x-stackQL-resources/experiments/methods/restoreexperiment' + experiments_history: + id: databricks_workspace.machinelearning.experiments_history + name: experiments_history + title: Experiments_history + methods: + gethistory: + operation: + $ref: '#/paths/~1api~12.0~1mlflow~1metrics~1get-history/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.metrics + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/experiments_history/methods/gethistory' + insert: [] + update: [] + replace: [] + delete: [] + exec: [] + experiment_artifacts: + id: databricks_workspace.machinelearning.experiment_artifacts + name: experiment_artifacts + title: Experiment_artifacts + methods: + listartifacts: + operation: + $ref: '#/paths/~1api~12.0~1mlflow~1artifacts~1list/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/experiment_artifacts/methods/listartifacts' + insert: [] + update: [] + replace: [] + delete: [] + exec: [] + experiment_permissions: + id: databricks_workspace.machinelearning.experiment_permissions + name: experiment_permissions + title: Experiment_permissions + methods: + getpermissions: + operation: + $ref: '#/paths/~1api~12.0~1permissions~1experiments~1{experiment_id}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + setpermissions: + operation: + $ref: '#/paths/~1api~12.0~1permissions~1experiments~1{experiment_id}/put' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + updatepermissions: + operation: + $ref: '#/paths/~1api~12.0~1permissions~1experiments~1{experiment_id}/patch' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/experiment_permissions/methods/getpermissions' + insert: [] + update: + - $ref: '#/components/x-stackQL-resources/experiment_permissions/methods/updatepermissions' + replace: + - $ref: '#/components/x-stackQL-resources/experiment_permissions/methods/setpermissions' + delete: [] + exec: [] + experiment_permission_levels: + id: databricks_workspace.machinelearning.experiment_permission_levels + name: experiment_permission_levels + title: Experiment_permission_levels + methods: + getpermissionlevels: + operation: + $ref: '#/paths/~1api~12.0~1permissions~1experiments~1{experiment_id}~1permissionLevels/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.permission_levels + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/experiment_permission_levels/methods/getpermissionlevels' + insert: [] + update: [] + replace: [] + delete: [] + exec: [] + experiment_runs: + id: databricks_workspace.machinelearning.experiment_runs + name: experiment_runs + title: Experiment_runs + methods: + createrun: + operation: + $ref: '#/paths/~1api~12.0~1mlflow~1runs~1create/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + deleterun: + operation: + $ref: '#/paths/~1api~12.0~1mlflow~1runs~1delete/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + deleteruns: + operation: + $ref: '#/paths/~1api~12.0~1mlflow~1databricks~1runs~1delete-runs/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + getrun: + operation: + $ref: '#/paths/~1api~12.0~1mlflow~1runs~1get/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.run + logbatch: + operation: + $ref: '#/paths/~1api~12.0~1mlflow~1runs~1log-batch/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + loginputs: + operation: + $ref: '#/paths/~1api~12.0~1mlflow~1runs~1log-inputs/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + logmetric: + operation: + $ref: '#/paths/~1api~12.0~1mlflow~1runs~1log-metric/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + logmodel: + operation: + $ref: '#/paths/~1api~12.0~1mlflow~1runs~1log-model/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + logparam: + operation: + $ref: '#/paths/~1api~12.0~1mlflow~1runs~1log-parameter/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + restorerun: + operation: + $ref: '#/paths/~1api~12.0~1mlflow~1runs~1restore/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + restoreruns: + operation: + $ref: '#/paths/~1api~12.0~1mlflow~1databricks~1runs~1restore-runs/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + searchruns: + operation: + $ref: '#/paths/~1api~12.0~1mlflow~1runs~1search/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.runs + updaterun: + operation: + $ref: '#/paths/~1api~12.0~1mlflow~1runs~1update/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/experiment_runs/methods/searchruns' + - $ref: '#/components/x-stackQL-resources/experiment_runs/methods/getrun' + insert: + - $ref: '#/components/x-stackQL-resources/experiment_runs/methods/createrun' + update: + - $ref: '#/components/x-stackQL-resources/experiment_runs/methods/updaterun' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/experiment_runs/methods/deleteruns' + - $ref: '#/components/x-stackQL-resources/experiment_runs/methods/deleterun' + exec: + - $ref: '#/components/x-stackQL-resources/experiment_runs/methods/restoreruns' + - $ref: '#/components/x-stackQL-resources/experiment_runs/methods/restorerun' + - $ref: '#/components/x-stackQL-resources/experiment_runs/methods/logparam' + - $ref: '#/components/x-stackQL-resources/experiment_runs/methods/logmodel' + - $ref: '#/components/x-stackQL-resources/experiment_runs/methods/logmetric' + - $ref: '#/components/x-stackQL-resources/experiment_runs/methods/loginputs' + - $ref: '#/components/x-stackQL-resources/experiment_runs/methods/logbatch' + experiment_run_tags: + id: databricks_workspace.machinelearning.experiment_run_tags + name: experiment_run_tags + title: Experiment_run_tags + methods: + settag: + operation: + $ref: '#/paths/~1api~12.0~1mlflow~1runs~1set-tag/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: [] + replace: + - $ref: '#/components/x-stackQL-resources/experiment_run_tags/methods/settag' + delete: [] + exec: [] + experiment_tags: + id: databricks_workspace.machinelearning.experiment_tags + name: experiment_tags + title: Experiment_tags + methods: + deletetag: + operation: + $ref: '#/paths/~1api~12.0~1mlflow~1runs~1delete-tag/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + setexperimenttag: + operation: + $ref: '#/paths/~1api~12.0~1mlflow~1experiments~1set-experiment-tag/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: [] + replace: + - $ref: '#/components/x-stackQL-resources/experiment_tags/methods/setexperimenttag' + delete: + - $ref: '#/components/x-stackQL-resources/experiment_tags/methods/deletetag' + exec: [] + models: + id: databricks_workspace.machinelearning.models + name: models + title: Models + methods: + createmodel: + operation: + $ref: '#/paths/~1api~12.0~1mlflow~1registered-models~1create/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + deletemodel: + operation: + $ref: '#/paths/~1api~12.0~1mlflow~1registered-models~1delete/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + getmodel: + operation: + $ref: '#/paths/~1api~12.0~1mlflow~1databricks~1registered-models~1get/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + listmodels: + operation: + $ref: '#/paths/~1api~12.0~1mlflow~1registered-models~1list/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.registered_models + renamemodel: + operation: + $ref: '#/paths/~1api~12.0~1mlflow~1registered-models~1rename/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + searchmodels: + operation: + $ref: '#/paths/~1api~12.0~1mlflow~1registered-models~1search/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.registered_models + updatemodel: + operation: + $ref: '#/paths/~1api~12.0~1mlflow~1registered-models~1update/patch' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/models/methods/searchmodels' + - $ref: '#/components/x-stackQL-resources/models/methods/listmodels' + - $ref: '#/components/x-stackQL-resources/models/methods/getmodel' + insert: + - $ref: '#/components/x-stackQL-resources/models/methods/createmodel' + update: + - $ref: '#/components/x-stackQL-resources/models/methods/updatemodel' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/models/methods/deletemodel' + exec: + - $ref: '#/components/x-stackQL-resources/models/methods/renamemodel' + model_latest_versions: + id: databricks_workspace.machinelearning.model_latest_versions + name: model_latest_versions + title: Model_latest_versions + methods: + getlatestversions: + operation: + $ref: '#/paths/~1api~12.0~1mlflow~1registered-models~1get-latest-versions/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.model_versions + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/model_latest_versions/methods/getlatestversions' + insert: [] + update: [] + replace: [] + delete: [] + exec: [] + model_permissions: + id: databricks_workspace.machinelearning.model_permissions + name: model_permissions + title: Model_permissions + methods: + getpermissions: + operation: + $ref: '#/paths/~1api~12.0~1permissions~1registered-models~1{registered_model_id}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + setpermissions: + operation: + $ref: '#/paths/~1api~12.0~1permissions~1registered-models~1{registered_model_id}/put' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + updatepermissions: + operation: + $ref: '#/paths/~1api~12.0~1permissions~1registered-models~1{registered_model_id}/patch' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/model_permissions/methods/getpermissions' + insert: [] + update: + - $ref: '#/components/x-stackQL-resources/model_permissions/methods/updatepermissions' + replace: + - $ref: '#/components/x-stackQL-resources/model_permissions/methods/setpermissions' + delete: [] + exec: [] + model_permission_levels: + id: databricks_workspace.machinelearning.model_permission_levels + name: model_permission_levels + title: Model_permission_levels + methods: + getpermissionlevels: + operation: + $ref: '#/paths/~1api~12.0~1permissions~1registered-models~1{registered_model_id}~1permissionLevels/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.permission_levels + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/model_permission_levels/methods/getpermissionlevels' + insert: [] + update: [] + replace: [] + delete: [] + exec: [] + model_tags: + id: databricks_workspace.machinelearning.model_tags + name: model_tags + title: Model_tags + methods: + deletemodeltag: + operation: + $ref: '#/paths/~1api~12.0~1mlflow~1registered-models~1delete-tag/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + setmodeltag: + operation: + $ref: '#/paths/~1api~12.0~1mlflow~1registered-models~1set-tag/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: [] + replace: + - $ref: '#/components/x-stackQL-resources/model_tags/methods/setmodeltag' + delete: + - $ref: '#/components/x-stackQL-resources/model_tags/methods/deletemodeltag' + exec: [] + model_transition_requests: + id: databricks_workspace.machinelearning.model_transition_requests + name: model_transition_requests + title: Model_transition_requests + methods: + approvetransitionrequest: + operation: + $ref: '#/paths/~1api~12.0~1mlflow~1transition-requests~1approve/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + createtransitionrequest: + operation: + $ref: '#/paths/~1api~12.0~1mlflow~1transition-requests~1create/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + deletetransitionrequest: + operation: + $ref: '#/paths/~1api~12.0~1mlflow~1transition-requests~1delete/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + listtransitionrequests: + operation: + $ref: '#/paths/~1api~12.0~1mlflow~1transition-requests~1list/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.requests + rejecttransitionrequest: + operation: + $ref: '#/paths/~1api~12.0~1mlflow~1transition-requests~1reject/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + transitionstage: + operation: + $ref: '#/paths/~1api~12.0~1mlflow~1databricks~1model-versions~1transition-stage/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/model_transition_requests/methods/listtransitionrequests' + insert: + - $ref: '#/components/x-stackQL-resources/model_transition_requests/methods/createtransitionrequest' + update: [] + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/model_transition_requests/methods/deletetransitionrequest' + exec: + - $ref: '#/components/x-stackQL-resources/model_transition_requests/methods/transitionstage' + - $ref: '#/components/x-stackQL-resources/model_transition_requests/methods/rejecttransitionrequest' + - $ref: '#/components/x-stackQL-resources/model_transition_requests/methods/approvetransitionrequest' + model_versions: + id: databricks_workspace.machinelearning.model_versions + name: model_versions + title: Model_versions + methods: + createmodelversion: + operation: + $ref: '#/paths/~1api~12.0~1mlflow~1model-versions~1create/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + deletemodelversion: + operation: + $ref: '#/paths/~1api~12.0~1mlflow~1model-versions~1delete/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + getmodelversion: + operation: + $ref: '#/paths/~1api~12.0~1mlflow~1model-versions~1get/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.model_version + searchmodelversions: + operation: + $ref: '#/paths/~1api~12.0~1mlflow~1model-versions~1search/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.model_versions + updatemodelversion: + operation: + $ref: '#/paths/~1api~12.0~1mlflow~1model-versions~1update/patch' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/model_versions/methods/searchmodelversions' + - $ref: '#/components/x-stackQL-resources/model_versions/methods/getmodelversion' + insert: + - $ref: '#/components/x-stackQL-resources/model_versions/methods/createmodelversion' + update: + - $ref: '#/components/x-stackQL-resources/model_versions/methods/updatemodelversion' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/model_versions/methods/deletemodelversion' + exec: [] + model_version_comments: + id: databricks_workspace.machinelearning.model_version_comments + name: model_version_comments + title: Model_version_comments + methods: + createcomment: + operation: + $ref: '#/paths/~1api~12.0~1mlflow~1comments~1create/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + deletecomment: + operation: + $ref: '#/paths/~1api~12.0~1mlflow~1comments~1delete/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + updatecomment: + operation: + $ref: '#/paths/~1api~12.0~1mlflow~1comments~1update/patch' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: '#/components/x-stackQL-resources/model_version_comments/methods/createcomment' + update: + - $ref: '#/components/x-stackQL-resources/model_version_comments/methods/updatecomment' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/model_version_comments/methods/deletecomment' + exec: [] + model_version_download_urls: + id: databricks_workspace.machinelearning.model_version_download_urls + name: model_version_download_urls + title: Model_version_download_urls + methods: + getmodelversiondownloaduri: + operation: + $ref: '#/paths/~1api~12.0~1mlflow~1model-versions~1get-download-uri/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/model_version_download_urls/methods/getmodelversiondownloaduri' + insert: [] + update: [] + replace: [] + delete: [] + exec: [] + model_version_tags: + id: databricks_workspace.machinelearning.model_version_tags + name: model_version_tags + title: Model_version_tags + methods: + deletemodelversiontag: + operation: + $ref: '#/paths/~1api~12.0~1mlflow~1model-versions~1delete-tag/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + setmodelversiontag: + operation: + $ref: '#/paths/~1api~12.0~1mlflow~1model-versions~1set-tag/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: [] + replace: + - $ref: '#/components/x-stackQL-resources/model_version_tags/methods/setmodelversiontag' + delete: + - $ref: '#/components/x-stackQL-resources/model_version_tags/methods/deletemodelversiontag' + exec: [] + model_web_hooks: + id: databricks_workspace.machinelearning.model_web_hooks + name: model_web_hooks + title: Model_web_hooks + methods: + createwebhook: + operation: + $ref: '#/paths/~1api~12.0~1mlflow~1registry-webhooks~1create/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + deletewebhook: + operation: + $ref: '#/paths/~1api~12.0~1mlflow~1registry-webhooks~1delete/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + listwebhooks: + operation: + $ref: '#/paths/~1api~12.0~1mlflow~1registry-webhooks~1list/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.webhooks + testregistrywebhook: + operation: + $ref: '#/paths/~1api~12.0~1mlflow~1registry-webhooks~1test/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + updatewebhook: + operation: + $ref: '#/paths/~1api~12.0~1mlflow~1registry-webhooks~1update/patch' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/model_web_hooks/methods/listwebhooks' + insert: + - $ref: '#/components/x-stackQL-resources/model_web_hooks/methods/createwebhook' + update: + - $ref: '#/components/x-stackQL-resources/model_web_hooks/methods/updatewebhook' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/model_web_hooks/methods/deletewebhook' + exec: + - $ref: '#/components/x-stackQL-resources/model_web_hooks/methods/testregistrywebhook' diff --git a/providers/src/databricks_workspace/v00.00.00000/services/marketplace.yaml b/providers/src/databricks_workspace/v00.00.00000/services/marketplace.yaml new file mode 100644 index 00000000..9ddf0000 --- /dev/null +++ b/providers/src/databricks_workspace/v00.00.00000/services/marketplace.yaml @@ -0,0 +1,4531 @@ +openapi: 3.0.0 +info: + version: 2024-12-19-stackql-generated + contact: + name: StackQL Studios + url: https://stackql.io/ + email: info@stackql.io + title: Databricks Marketplace API + description: Marketplace +servers: +- url: https://{deployment_name}.cloud.databricks.com + variables: + deployment_name: + description: The Databricks Workspace Deployment Name + default: dbc-abcd0123-a1bc +paths: + /api/2.1/marketplace-consumer/listings/{listing_id}/fulfillments: + get: + operationId: consumer-fulfillments-list + externalDocs: + url: https://docs.databricks.com/api/workspace/consumerfulfillments/list + x-stackQL-resource: consumer_fulfillments + x-stackQL-method: list + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: listing_id + required: true + description: string + in: path + - name: page_token + in: query + - name: page_size + in: query + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + fulfillments: + type: array + items: + type: object + properties: + listing_id: + type: string + fulfillment_type: + type: string + share_info: + type: object + properties: + name: + type: string + type: + type: string + repo_info: + type: object + properties: + git_repo_url: + type: string + recipient_type: + type: string + next_page_token: + type: string + x-stackQL-objectKey: $.fulfillments + description: Get all listings fulfillments associated with a listing. A + /api/2.1/marketplace-consumer/listings/{listing_id}/installations: + post: + operationId: consumer-installations-create + externalDocs: + url: https://docs.databricks.com/api/workspace/consumerinstallations/create + x-stackQL-resource: consumer_installations + x-stackQL-method: create + x-stackQL-verb: insert + x-numReqParams: 1 + parameters: + - name: listing_id + required: true + description: string + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + installation: + type: object + properties: + id: + type: string + listing_id: + type: string + share_name: + type: string + catalog_name: + type: string + installed_on: + type: integer + status: + type: string + error_message: + type: string + listing_name: + type: string + repo_name: + type: string + repo_path: + type: string + recipient_type: + type: string + tokens: + type: array + items: + type: object + properties: + id: + type: string + created_at: + type: integer + created_by: + type: string + activation_url: + type: string + expiration_time: + type: integer + updated_at: + type: integer + updated_by: + type: string + token_detail: + type: object + properties: + shareCredentialsVersion: + type: integer + bearerToken: + type: string + endpoint: + type: string + expirationTime: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + share_name: + type: string + catalog_name: + type: string + recipient_type: + type: string + repo_detail: + type: object + accepted_consumer_terms: + type: object + example: + share_name: string + catalog_name: string + repo_detail: + repo_name: string + repo_path: string + recipient_type: DELTA_SHARING_RECIPIENT_TYPE_DATABRICKS + accepted_consumer_terms: + version: string + description: Install payload associated with a Databricks Marketplace listing. + get: + operationId: listing-installations-listlistinginstallations + externalDocs: + url: https://docs.databricks.com/api/workspace/consumerinstallations/listlistinginstallations + x-stackQL-resource: listing_installations + x-stackQL-method: listlistinginstallations + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: listing_id + required: true + description: string + in: path + - name: page_token + in: query + - name: page_size + in: query + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + installations: + type: array + items: + type: object + properties: + id: + type: string + listing_id: + type: string + share_name: + type: string + catalog_name: + type: string + installed_on: + type: integer + status: + type: string + error_message: + type: string + listing_name: + type: string + repo_name: + type: string + repo_path: + type: string + recipient_type: + type: string + tokens: + type: array + items: + type: object + properties: + id: + type: string + created_at: + type: integer + created_by: + type: string + activation_url: + type: string + expiration_time: + type: integer + updated_at: + type: integer + updated_by: + type: string + token_detail: + type: object + properties: + shareCredentialsVersion: + type: integer + bearerToken: + type: string + endpoint: + type: string + expirationTime: + type: string + next_page_token: + type: string + x-stackQL-objectKey: $.installations + description: List all installations for a particular listing. + /api/2.1/marketplace-consumer/listings/{listing_id}/installations/{installation_id}: + delete: + operationId: consumer-installations-delete + externalDocs: + url: https://docs.databricks.com/api/workspace/consumerinstallations/delete + x-stackQL-resource: consumer_installations + x-stackQL-method: delete + x-stackQL-verb: delete + x-numReqParams: 2 + parameters: + - name: listing_id + required: true + description: string + in: path + - name: installation_id + required: true + description: string + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: {} + description: Uninstall an installation associated with a Databricks Marketplace + listing. + put: + operationId: consumer-installations-update + externalDocs: + url: https://docs.databricks.com/api/workspace/consumerinstallations/update + x-stackQL-resource: consumer_installations + x-stackQL-method: update + x-stackQL-verb: update + x-numReqParams: 2 + parameters: + - name: listing_id + required: true + description: string + in: path + - name: installation_id + required: true + description: string + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + installation: + type: object + properties: + id: + type: string + listing_id: + type: string + share_name: + type: string + catalog_name: + type: string + installed_on: + type: integer + status: + type: string + error_message: + type: string + listing_name: + type: string + repo_name: + type: string + repo_path: + type: string + recipient_type: + type: string + tokens: + type: array + items: + type: object + properties: + id: + type: string + created_at: + type: integer + created_by: + type: string + activation_url: + type: string + expiration_time: + type: integer + updated_at: + type: integer + updated_by: + type: string + token_detail: + type: object + properties: + shareCredentialsVersion: + type: integer + bearerToken: + type: string + endpoint: + type: string + expirationTime: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + rotate_token: + type: boolean + installation: + type: required + example: + installation: + id: string + listing_id: string + share_name: string + catalog_name: string + installed_on: 0 + status: INSTALLED + error_message: string + listing_name: string + repo_name: string + repo_path: string + recipient_type: DELTA_SHARING_RECIPIENT_TYPE_DATABRICKS + tokens: + - id: string + created_at: 0 + created_by: string + activation_url: string + expiration_time: 0 + updated_at: 0 + updated_by: string + token_detail: + shareCredentialsVersion: 0 + bearerToken: string + endpoint: string + expirationTime: string + rotate_token: true + description: This is a update API that will update the part of the fields defined + in the installation table as well as interact with external services according + to the fields not included in the installation table + /api/2.1/marketplace-consumer/installations: + get: + operationId: consumer-installations-list + externalDocs: + url: https://docs.databricks.com/api/workspace/consumerinstallations/list + x-stackQL-resource: consumer_installations + x-stackQL-method: list + x-stackQL-verb: select + x-numReqParams: 0 + parameters: + - name: page_token + in: query + - name: page_size + in: query + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + installations: + type: array + items: + type: object + properties: + id: + type: string + listing_id: + type: string + share_name: + type: string + catalog_name: + type: string + installed_on: + type: integer + status: + type: string + error_message: + type: string + listing_name: + type: string + repo_name: + type: string + repo_path: + type: string + recipient_type: + type: string + tokens: + type: array + items: + type: object + properties: + id: + type: string + created_at: + type: integer + created_by: + type: string + activation_url: + type: string + expiration_time: + type: integer + updated_at: + type: integer + updated_by: + type: string + token_detail: + type: object + properties: + shareCredentialsVersion: + type: integer + bearerToken: + type: string + endpoint: + type: string + expirationTime: + type: string + next_page_token: + type: string + x-stackQL-objectKey: $.installations + description: List all installations across all listings. + /api/2.1/marketplace-consumer/listings:batchGet: + get: + operationId: consumer-listings-batchget + externalDocs: + url: https://docs.databricks.com/api/workspace/consumerlistings/batchget + x-stackQL-resource: consumer_listings + x-stackQL-method: batchget + x-stackQL-verb: exec + x-numReqParams: 0 + parameters: + - name: ids + in: query + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + listings: + type: array + items: + type: object + properties: + id: + type: string + summary: + type: object + properties: + name: + type: string + subtitle: + type: string + status: + type: string + share: + type: object + properties: + name: + type: string + type: + type: string + provider_region: + type: object + properties: + cloud: + type: string + region: + type: string + setting: + type: object + properties: + visibility: + type: string + created_at: + type: integer + created_by: + type: string + updated_at: + type: integer + updated_by: + type: string + published_at: + type: integer + published_by: + type: string + categories: + type: array + items: + type: string + listingType: + type: string + created_by_id: + type: integer + updated_by_id: + type: integer + provider_id: + type: string + exchange_ids: + type: array + items: + type: string + git_repo: + type: object + properties: + git_repo_url: + type: string + detail: + type: object + properties: + description: + type: string + terms_of_service: + type: string + documentation_link: + type: string + support_link: + type: string + file_ids: + type: array + items: + type: string + privacy_policy_link: + type: string + embedded_notebook_file_infos: + type: array + items: + type: object + properties: + id: + type: string + marketplace_file_type: + type: string + file_parent: + type: object + properties: + parent_id: + type: string + file_parent_type: + type: string + mime_type: + type: string + download_link: + type: string + created_at: + type: integer + updated_at: + type: integer + display_name: + type: string + status: + type: string + status_message: + type: string + geographical_coverage: + type: string + cost: + type: string + pricing_model: + type: string + update_frequency: + type: object + properties: + interval: + type: integer + unit: + type: string + collection_granularity: + type: object + properties: + interval: + type: integer + unit: + type: string + collection_date_start: + type: integer + collection_date_end: + type: integer + data_source: + type: string + size: + type: number + assets: + type: array + items: + type: string + license: + type: string + tags: + type: array + items: + type: object + properties: + tag_name: + type: string + tag_values: + type: array + items: + type: string + description: Batch get a published listing in the Databricks Marketplace that + the consumer has access to. + /api/2.1/marketplace-consumer/listings/{id}: + get: + operationId: consumer-listings-get + externalDocs: + url: https://docs.databricks.com/api/workspace/consumerlistings/get + x-stackQL-resource: consumer_listings + x-stackQL-method: get + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: id + required: true + description: string + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + listing: + type: object + properties: + id: + type: string + summary: + type: object + properties: + name: + type: string + subtitle: + type: string + status: + type: string + share: + type: object + properties: + name: + type: string + type: + type: string + provider_region: + type: object + properties: + cloud: + type: string + region: + type: string + setting: + type: object + properties: + visibility: + type: string + created_at: + type: integer + created_by: + type: string + updated_at: + type: integer + updated_by: + type: string + published_at: + type: integer + published_by: + type: string + categories: + type: array + items: + type: string + listingType: + type: string + created_by_id: + type: integer + updated_by_id: + type: integer + provider_id: + type: string + exchange_ids: + type: array + items: + type: string + git_repo: + type: object + properties: + git_repo_url: + type: string + detail: + type: object + properties: + description: + type: string + terms_of_service: + type: string + documentation_link: + type: string + support_link: + type: string + file_ids: + type: array + items: + type: string + privacy_policy_link: + type: string + embedded_notebook_file_infos: + type: array + items: + type: object + properties: + id: + type: string + marketplace_file_type: + type: string + file_parent: + type: object + properties: + parent_id: + type: string + file_parent_type: + type: string + mime_type: + type: string + download_link: + type: string + created_at: + type: integer + updated_at: + type: integer + display_name: + type: string + status: + type: string + status_message: + type: string + geographical_coverage: + type: string + cost: + type: string + pricing_model: + type: string + update_frequency: + type: object + properties: + interval: + type: integer + unit: + type: string + collection_granularity: + type: object + properties: + interval: + type: integer + unit: + type: string + collection_date_start: + type: integer + collection_date_end: + type: integer + data_source: + type: string + size: + type: number + assets: + type: array + items: + type: string + license: + type: string + tags: + type: array + items: + type: object + properties: + tag_name: + type: string + tag_values: + type: array + items: + type: string + x-stackQL-objectKey: $.listing + description: Get a published listing in the Databricks Marketplace that the + consumer has access to. + /api/2.1/marketplace-consumer/listings: + get: + operationId: consumer-listings-list + externalDocs: + url: https://docs.databricks.com/api/workspace/consumerlistings/list + x-stackQL-resource: consumer_listings + x-stackQL-method: list + x-stackQL-verb: select + x-numReqParams: 0 + parameters: + - name: page_token + in: query + - name: page_size + in: query + - name: assets + in: query + - name: categories + in: query + - name: null + in: query + - name: is_free + in: query + - name: is_private_exchange + in: query + - name: is_staff_pick + in: query + - name: provider_ids + in: query + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + listings: + type: array + items: + type: object + properties: + id: + type: string + summary: + type: object + properties: + name: + type: string + subtitle: + type: string + status: + type: string + share: + type: object + properties: + name: + type: string + type: + type: string + provider_region: + type: object + properties: + cloud: + type: string + region: + type: string + setting: + type: object + properties: + visibility: + type: string + created_at: + type: integer + created_by: + type: string + updated_at: + type: integer + updated_by: + type: string + published_at: + type: integer + published_by: + type: string + categories: + type: array + items: + type: string + listingType: + type: string + created_by_id: + type: integer + updated_by_id: + type: integer + provider_id: + type: string + exchange_ids: + type: array + items: + type: string + git_repo: + type: object + properties: + git_repo_url: + type: string + detail: + type: object + properties: + description: + type: string + terms_of_service: + type: string + documentation_link: + type: string + support_link: + type: string + file_ids: + type: array + items: + type: string + privacy_policy_link: + type: string + embedded_notebook_file_infos: + type: array + items: + type: object + properties: + id: + type: string + marketplace_file_type: + type: string + file_parent: + type: object + properties: + parent_id: + type: string + file_parent_type: + type: string + mime_type: + type: string + download_link: + type: string + created_at: + type: integer + updated_at: + type: integer + display_name: + type: string + status: + type: string + status_message: + type: string + geographical_coverage: + type: string + cost: + type: string + pricing_model: + type: string + update_frequency: + type: object + properties: + interval: + type: integer + unit: + type: string + collection_granularity: + type: object + properties: + interval: + type: integer + unit: + type: string + collection_date_start: + type: integer + collection_date_end: + type: integer + data_source: + type: string + size: + type: number + assets: + type: array + items: + type: string + license: + type: string + tags: + type: array + items: + type: object + properties: + tag_name: + type: string + tag_values: + type: array + items: + type: string + next_page_token: + type: string + x-stackQL-objectKey: $.listings + description: List all published listings in the Databricks Marketplace that + the consumer has access to. + /api/2.1/marketplace-consumer/search-listings: + get: + operationId: consumer-listings-search + externalDocs: + url: https://docs.databricks.com/api/workspace/consumerlistings/search + x-stackQL-resource: consumer_listings + x-stackQL-method: search + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: query + required: true + description: string + in: query + - name: is_free + in: query + - name: is_private_exchange + in: query + - name: provider_ids + in: query + - name: categories + in: query + - name: assets + in: query + - name: page_token + in: query + - name: page_size + in: query + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + listings: + type: array + items: + type: object + properties: + id: + type: string + summary: + type: object + properties: + name: + type: string + subtitle: + type: string + status: + type: string + share: + type: object + properties: + name: + type: string + type: + type: string + provider_region: + type: object + properties: + cloud: + type: string + region: + type: string + setting: + type: object + properties: + visibility: + type: string + created_at: + type: integer + created_by: + type: string + updated_at: + type: integer + updated_by: + type: string + published_at: + type: integer + published_by: + type: string + categories: + type: array + items: + type: string + listingType: + type: string + created_by_id: + type: integer + updated_by_id: + type: integer + provider_id: + type: string + exchange_ids: + type: array + items: + type: string + git_repo: + type: object + properties: + git_repo_url: + type: string + detail: + type: object + properties: + description: + type: string + terms_of_service: + type: string + documentation_link: + type: string + support_link: + type: string + file_ids: + type: array + items: + type: string + privacy_policy_link: + type: string + embedded_notebook_file_infos: + type: array + items: + type: object + properties: + id: + type: string + marketplace_file_type: + type: string + file_parent: + type: object + properties: + parent_id: + type: string + file_parent_type: + type: string + mime_type: + type: string + download_link: + type: string + created_at: + type: integer + updated_at: + type: integer + display_name: + type: string + status: + type: string + status_message: + type: string + geographical_coverage: + type: string + cost: + type: string + pricing_model: + type: string + update_frequency: + type: object + properties: + interval: + type: integer + unit: + type: string + collection_granularity: + type: object + properties: + interval: + type: integer + unit: + type: string + collection_date_start: + type: integer + collection_date_end: + type: integer + data_source: + type: string + size: + type: number + assets: + type: array + items: + type: string + license: + type: string + tags: + type: array + items: + type: object + properties: + tag_name: + type: string + tag_values: + type: array + items: + type: string + next_page_token: + type: string + x-stackQL-objectKey: $.listings + description: Search published listings in the Databricks Marketplace that the + consumer has access to. This query supports a variety of different search + parameters and performs fuzzy matching. + /api/2.1/marketplace-consumer/listings/{listing_id}/content: + get: + operationId: consumer-listing-content-get + externalDocs: + url: https://docs.databricks.com/api/workspace/consumerfulfillments/get + x-stackQL-resource: consumer_listing_content + x-stackQL-method: get + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: listing_id + required: true + description: string + in: path + - name: page_token + in: query + - name: page_size + in: query + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + shared_data_objects: + type: array + items: + type: object + properties: + name: + type: string + data_object_type: + type: string + next_page_token: + type: string + x-stackQL-objectKey: $.shared_data_objects + description: Get a high level preview of the metadata of listing installable + content. + /api/2.1/marketplace-consumer/listings/{listing_id}/personalization-requests: + post: + operationId: consumer-personalization-requests-create + externalDocs: + url: https://docs.databricks.com/api/workspace/consumerpersonalizationrequests/create + x-stackQL-resource: consumer_personalization_requests + x-stackQL-method: create + x-stackQL-verb: insert + x-numReqParams: 1 + parameters: + - name: listing_id + required: true + description: string + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + id: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + comment: + type: string + intended_use: + type: required + first_name: + type: string + last_name: + type: string + company: + type: string + is_from_lighthouse: + type: string + recipient_type: + type: boolean + accepted_consumer_terms: + type: object + example: + comment: string + intended_use: string + first_name: string + last_name: string + company: string + is_from_lighthouse: true + recipient_type: DELTA_SHARING_RECIPIENT_TYPE_DATABRICKS + accepted_consumer_terms: + version: string + description: Data request messages also creates a lead (maybe) + description: Create a personalization request for a listing. + get: + operationId: consumer-personalization-requests-get + externalDocs: + url: https://docs.databricks.com/api/workspace/consumerpersonalizationrequests/get + x-stackQL-resource: consumer_personalization_requests + x-stackQL-method: get + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: listing_id + required: true + description: string + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + personalization_requests: + type: array + items: + type: object + properties: + id: + type: string + consumer_region: + type: object + properties: + cloud: + type: string + region: + type: string + contact_info: + type: object + properties: + first_name: + type: string + last_name: + type: string + email: + type: string + company: + type: string + comment: + type: string + intended_use: + type: string + status: + type: string + status_message: + type: string + share: + type: object + properties: + name: + type: string + type: + type: string + created_at: + type: integer + listing_id: + type: string + updated_at: + type: integer + metastore_id: + type: string + listing_name: + type: string + is_from_lighthouse: + type: boolean + provider_id: + type: string + recipient_type: + type: string + x-stackQL-objectKey: $.personalization_requests + description: Get the personalization request for a listing. Each consumer can + make at + /api/2.1/marketplace-consumer/personalization-requests: + get: + operationId: consumer-personalization-requests-list + externalDocs: + url: https://docs.databricks.com/api/workspace/consumerpersonalizationrequests/list + x-stackQL-resource: consumer_personalization_requests + x-stackQL-method: list + x-stackQL-verb: select + x-numReqParams: 0 + parameters: + - name: page_token + in: query + - name: page_size + in: query + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + personalization_requests: + type: array + items: + type: object + properties: + id: + type: string + consumer_region: + type: object + properties: + cloud: + type: string + region: + type: string + contact_info: + type: object + properties: + first_name: + type: string + last_name: + type: string + email: + type: string + company: + type: string + comment: + type: string + intended_use: + type: string + status: + type: string + status_message: + type: string + share: + type: object + properties: + name: + type: string + type: + type: string + created_at: + type: integer + listing_id: + type: string + updated_at: + type: integer + metastore_id: + type: string + listing_name: + type: string + is_from_lighthouse: + type: boolean + provider_id: + type: string + recipient_type: + type: string + next_page_token: + type: string + x-stackQL-objectKey: $.personalization_requests + description: List personalization requests for a consumer across all listings. + /api/2.1/marketplace-consumer/providers:batchGet: + get: + operationId: consumer-providers-batchget + externalDocs: + url: https://docs.databricks.com/api/workspace/consumerproviders/batchget + x-stackQL-resource: consumer_providers + x-stackQL-method: batchget + x-stackQL-verb: exec + x-numReqParams: 0 + parameters: + - name: ids + in: query + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + providers: + type: array + items: + type: object + properties: + id: + type: string + name: + type: string + description: + type: string + icon_file_path: + type: string + business_contact_email: + type: string + support_contact_email: + type: string + is_featured: + type: boolean + published_by: + type: string + company_website_link: + type: string + icon_file_id: + type: string + term_of_service_link: + type: string + privacy_policy_link: + type: string + dark_mode_icon_file_id: + type: string + dark_mode_icon_file_path: + type: string + description: Batch get a provider in the Databricks Marketplace with at least + one visible listing. + /api/2.1/marketplace-consumer/providers/{id}: + get: + operationId: consumer-providers-get + externalDocs: + url: https://docs.databricks.com/api/workspace/consumerproviders/get + x-stackQL-resource: consumer_providers + x-stackQL-method: get + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: id + required: true + description: string + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + provider: + type: object + properties: + id: + type: string + name: + type: string + description: + type: string + icon_file_path: + type: string + business_contact_email: + type: string + support_contact_email: + type: string + is_featured: + type: boolean + published_by: + type: string + company_website_link: + type: string + icon_file_id: + type: string + term_of_service_link: + type: string + privacy_policy_link: + type: string + dark_mode_icon_file_id: + type: string + dark_mode_icon_file_path: + type: string + x-stackQL-objectKey: $.provider + description: Get a provider in the Databricks Marketplace with at least one + visible listing. + /api/2.1/marketplace-consumer/providers: + get: + operationId: consumer-providers-list + externalDocs: + url: https://docs.databricks.com/api/workspace/consumerproviders/list + x-stackQL-resource: consumer_providers + x-stackQL-method: list + x-stackQL-verb: select + x-numReqParams: 0 + parameters: + - name: page_token + in: query + - name: page_size + in: query + - name: is_featured + in: query + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + providers: + type: array + items: + type: object + properties: + id: + type: string + name: + type: string + description: + type: string + icon_file_path: + type: string + business_contact_email: + type: string + support_contact_email: + type: string + is_featured: + type: boolean + published_by: + type: string + company_website_link: + type: string + icon_file_id: + type: string + term_of_service_link: + type: string + privacy_policy_link: + type: string + dark_mode_icon_file_id: + type: string + dark_mode_icon_file_path: + type: string + next_page_token: + type: string + x-stackQL-objectKey: $.providers + description: List all providers in the Databricks Marketplace with at least + one visible listing. + /api/2.0/marketplace-provider/provider: + post: + operationId: providers-create + externalDocs: + url: https://docs.databricks.com/api/workspace/providerproviders/create + x-stackQL-resource: providers + x-stackQL-method: create + x-stackQL-verb: insert + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + id: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + provider: + type: object + example: + provider: + id: string + name: string + description: string + icon_file_path: string + business_contact_email: string + support_contact_email: string + is_featured: true + published_by: string + company_website_link: string + icon_file_id: string + term_of_service_link: string + privacy_policy_link: string + dark_mode_icon_file_id: string + dark_mode_icon_file_path: string + description: Create a provider + /api/2.0/marketplace-provider/providers/{id}: + delete: + operationId: providers-delete + externalDocs: + url: https://docs.databricks.com/api/workspace/providerproviders/delete + x-stackQL-resource: providers + x-stackQL-method: delete + x-stackQL-verb: delete + x-numReqParams: 1 + parameters: + - name: id + required: true + description: string + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: {} + description: Delete provider + get: + operationId: providers-get + externalDocs: + url: https://docs.databricks.com/api/workspace/providerproviders/get + x-stackQL-resource: providers + x-stackQL-method: get + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: id + required: true + description: string + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + provider: + type: object + properties: + id: + type: string + name: + type: string + description: + type: string + icon_file_path: + type: string + business_contact_email: + type: string + support_contact_email: + type: string + is_featured: + type: boolean + published_by: + type: string + company_website_link: + type: string + icon_file_id: + type: string + term_of_service_link: + type: string + privacy_policy_link: + type: string + dark_mode_icon_file_id: + type: string + dark_mode_icon_file_path: + type: string + x-stackQL-objectKey: $.provider + description: Get provider profile + put: + operationId: providers-update + externalDocs: + url: https://docs.databricks.com/api/workspace/providerproviders/update + x-stackQL-resource: providers + x-stackQL-method: update + x-stackQL-verb: update + x-numReqParams: 1 + parameters: + - name: id + required: true + description: string + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + provider: + type: object + properties: + id: + type: string + name: + type: string + description: + type: string + icon_file_path: + type: string + business_contact_email: + type: string + support_contact_email: + type: string + is_featured: + type: boolean + published_by: + type: string + company_website_link: + type: string + icon_file_id: + type: string + term_of_service_link: + type: string + privacy_policy_link: + type: string + dark_mode_icon_file_id: + type: string + dark_mode_icon_file_path: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + provider: + type: object + example: + provider: + id: string + name: string + description: string + icon_file_path: string + business_contact_email: string + support_contact_email: string + is_featured: true + published_by: string + company_website_link: string + icon_file_id: string + term_of_service_link: string + privacy_policy_link: string + dark_mode_icon_file_id: string + dark_mode_icon_file_path: string + description: Update provider profile + /api/2.0/marketplace-provider/providers: + get: + operationId: providers-list + externalDocs: + url: https://docs.databricks.com/api/workspace/providerproviders/list + x-stackQL-resource: providers + x-stackQL-method: list + x-stackQL-verb: select + x-numReqParams: 0 + parameters: + - name: page_token + in: query + - name: page_size + in: query + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + providers: + type: array + items: + type: object + properties: + id: + type: string + name: + type: string + description: + type: string + icon_file_path: + type: string + business_contact_email: + type: string + support_contact_email: + type: string + is_featured: + type: boolean + published_by: + type: string + company_website_link: + type: string + icon_file_id: + type: string + term_of_service_link: + type: string + privacy_policy_link: + type: string + dark_mode_icon_file_id: + type: string + dark_mode_icon_file_path: + type: string + next_page_token: + type: string + x-stackQL-objectKey: $.providers + description: List provider profiles for account. + /api/2.0/marketplace-provider/analytics_dashboard: + post: + operationId: provider-analytics-dashboards-create + externalDocs: + url: https://docs.databricks.com/api/workspace/providerprovideranalyticsdashboards/create + x-stackQL-resource: provider_analytics_dashboards + x-stackQL-method: create + x-stackQL-verb: insert + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + id: + type: string + description: Create provider analytics dashboard. Returns Marketplace specific + get: + operationId: provider-analytics-dashboards-get + externalDocs: + url: https://docs.databricks.com/api/workspace/providerprovideranalyticsdashboards/get + x-stackQL-resource: provider_analytics_dashboards + x-stackQL-method: get + x-stackQL-verb: select + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + id: + type: string + version: + type: integer + dashboard_id: + type: string + description: Get provider analytics dashboard. + /api/2.0/marketplace-provider/analytics_dashboard/{id}: + put: + operationId: provider-analytics-dashboards-update + externalDocs: + url: https://docs.databricks.com/api/workspace/providerprovideranalyticsdashboards/update + x-stackQL-resource: provider_analytics_dashboards + x-stackQL-method: update + x-stackQL-verb: update + x-numReqParams: 1 + parameters: + - name: id + required: true + description: string + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + id: + type: string + version: + type: integer + dashboard_id: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + version: + type: integer + format: int64 + example: + version: 0 + description: Update provider analytics dashboard. + /api/2.0/marketplace-provider/analytics_dashboard/latest: + get: + operationId: provider-analytics-dashboards-latest-getlatestversion + externalDocs: + url: https://docs.databricks.com/api/workspace/providerprovideranalyticsdashboards/getlatestversion + x-stackQL-resource: provider_analytics_dashboards_latest + x-stackQL-method: getlatestversion + x-stackQL-verb: select + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + version: + type: integer + description: Get latest version of provider analytics dashboard. + /api/2.0/marketplace-exchange/exchanges: + post: + operationId: provider-exchanges-create + externalDocs: + url: https://docs.databricks.com/api/workspace/providerexchanges/create + x-stackQL-resource: provider_exchanges + x-stackQL-method: create + x-stackQL-verb: insert + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + exchange_id: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + exchange: + type: object + example: + exchange: + id: string + name: string + comment: string + filters: + - id: string + exchange_id: string + filter_value: string + name: string + created_at: 0 + created_by: string + updated_at: 0 + updated_by: string + filter_type: GLOBAL_METASTORE_ID + created_at: 0 + created_by: string + updated_at: 0 + updated_by: string + linked_listings: + - id: string + exchange_id: string + exchange_name: string + listing_id: string + listing_name: string + created_at: 0 + created_by: string + description: Create an exchange + get: + operationId: provider-exchanges-list + externalDocs: + url: https://docs.databricks.com/api/workspace/providerexchanges/list + x-stackQL-resource: provider_exchanges + x-stackQL-method: list + x-stackQL-verb: select + x-numReqParams: 0 + parameters: + - name: page_token + in: query + - name: page_size + in: query + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + exchanges: + type: array + items: + type: object + properties: + id: + type: string + name: + type: string + comment: + type: string + filters: + type: array + items: + type: object + properties: + id: + type: string + exchange_id: + type: string + filter_value: + type: string + name: + type: string + created_at: + type: integer + created_by: + type: string + updated_at: + type: integer + updated_by: + type: string + filter_type: + type: string + created_at: + type: integer + created_by: + type: string + updated_at: + type: integer + updated_by: + type: string + linked_listings: + type: array + items: + type: object + properties: + id: + type: string + exchange_id: + type: string + exchange_name: + type: string + listing_id: + type: string + listing_name: + type: string + created_at: + type: integer + created_by: + type: string + next_page_token: + type: string + x-stackQL-objectKey: $.exchanges + description: List exchanges visible to provider + /api/2.0/marketplace-exchange/exchanges/{id}: + delete: + operationId: provider-exchanges-delete + externalDocs: + url: https://docs.databricks.com/api/workspace/providerexchanges/delete + x-stackQL-resource: provider_exchanges + x-stackQL-method: delete + x-stackQL-verb: delete + x-numReqParams: 1 + parameters: + - name: id + required: true + description: string + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: {} + description: This removes a listing from marketplace. + get: + operationId: provider-exchanges-get + externalDocs: + url: https://docs.databricks.com/api/workspace/providerexchanges/get + x-stackQL-resource: provider_exchanges + x-stackQL-method: get + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: id + required: true + description: string + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + exchange: + type: object + properties: + id: + type: string + name: + type: string + comment: + type: string + filters: + type: array + items: + type: object + properties: + id: + type: string + exchange_id: + type: string + filter_value: + type: string + name: + type: string + created_at: + type: integer + created_by: + type: string + updated_at: + type: integer + updated_by: + type: string + filter_type: + type: string + created_at: + type: integer + created_by: + type: string + updated_at: + type: integer + updated_by: + type: string + linked_listings: + type: array + items: + type: object + properties: + id: + type: string + exchange_id: + type: string + exchange_name: + type: string + listing_id: + type: string + listing_name: + type: string + created_at: + type: integer + created_by: + type: string + x-stackQL-objectKey: $.exchange + description: Get an exchange. + put: + operationId: provider-exchanges-update + externalDocs: + url: https://docs.databricks.com/api/workspace/providerexchanges/update + x-stackQL-resource: provider_exchanges + x-stackQL-method: update + x-stackQL-verb: update + x-numReqParams: 1 + parameters: + - name: id + required: true + description: string + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + exchange: + type: object + properties: + id: + type: string + name: + type: string + comment: + type: string + filters: + type: array + items: + type: object + properties: + id: + type: string + exchange_id: + type: string + filter_value: + type: string + name: + type: string + created_at: + type: integer + created_by: + type: string + updated_at: + type: integer + updated_by: + type: string + filter_type: + type: string + created_at: + type: integer + created_by: + type: string + updated_at: + type: integer + updated_by: + type: string + linked_listings: + type: array + items: + type: object + properties: + id: + type: string + exchange_id: + type: string + exchange_name: + type: string + listing_id: + type: string + listing_name: + type: string + created_at: + type: integer + created_by: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + exchange: + type: object + example: + exchange: + id: string + name: string + comment: string + filters: + - id: string + exchange_id: string + filter_value: string + name: string + created_at: 0 + created_by: string + updated_at: 0 + updated_by: string + filter_type: GLOBAL_METASTORE_ID + created_at: 0 + created_by: string + updated_at: 0 + updated_by: string + linked_listings: + - id: string + exchange_id: string + exchange_name: string + listing_id: string + listing_name: string + created_at: 0 + created_by: string + description: Update an exchange + /api/2.0/marketplace-exchange/filters: + post: + operationId: provider-exchange-filters-create + externalDocs: + url: https://docs.databricks.com/api/workspace/providerexchangefilters/create + x-stackQL-resource: provider_exchange_filters + x-stackQL-method: create + x-stackQL-verb: insert + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + filter_id: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + filter: + type: object + example: + filter: + id: string + exchange_id: string + filter_value: string + name: string + created_at: 0 + created_by: string + updated_at: 0 + updated_by: string + filter_type: GLOBAL_METASTORE_ID + description: Add an exchange filter. + get: + operationId: provider-exchange-filters-list + externalDocs: + url: https://docs.databricks.com/api/workspace/providerexchangefilters/list + x-stackQL-resource: provider_exchange_filters + x-stackQL-method: list + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: exchange_id + required: true + description: string + in: query + - name: page_token + in: query + - name: page_size + in: query + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + filters: + type: array + items: + type: object + properties: + id: + type: string + exchange_id: + type: string + filter_value: + type: string + name: + type: string + created_at: + type: integer + created_by: + type: string + updated_at: + type: integer + updated_by: + type: string + filter_type: + type: string + next_page_token: + type: string + x-stackQL-objectKey: $.filters + description: List exchange filter + /api/2.0/marketplace-exchange/filters/{id}: + delete: + operationId: provider-exchange-filters-delete + externalDocs: + url: https://docs.databricks.com/api/workspace/providerexchangefilters/delete + x-stackQL-resource: provider_exchange_filters + x-stackQL-method: delete + x-stackQL-verb: delete + x-numReqParams: 1 + parameters: + - name: id + required: true + description: string + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: {} + description: Delete an exchange filter + put: + operationId: provider-exchange-filters-update + externalDocs: + url: https://docs.databricks.com/api/workspace/providerexchangefilters/update + x-stackQL-resource: provider_exchange_filters + x-stackQL-method: update + x-stackQL-verb: update + x-numReqParams: 1 + parameters: + - name: id + required: true + description: string + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + filter: + type: object + properties: + id: + type: string + exchange_id: + type: string + filter_value: + type: string + name: + type: string + created_at: + type: integer + created_by: + type: string + updated_at: + type: integer + updated_by: + type: string + filter_type: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + filter: + type: object + example: + filter: + id: string + exchange_id: string + filter_value: string + name: string + created_at: 0 + created_by: string + updated_at: 0 + updated_by: string + filter_type: GLOBAL_METASTORE_ID + description: Update an exchange filter. + /api/2.0/marketplace-exchange/exchanges-for-listing: + post: + operationId: provider-exchange-listings-addlistingtoexchange + externalDocs: + url: https://docs.databricks.com/api/workspace/providerexchanges/addlistingtoexchange + x-stackQL-resource: provider_exchange_listings + x-stackQL-method: addlistingtoexchange + x-stackQL-verb: insert + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + exchange_for_listing: + type: object + properties: + id: + type: string + exchange_id: + type: string + exchange_name: + type: string + listing_id: + type: string + listing_name: + type: string + created_at: + type: integer + created_by: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + listing_id: + type: required + exchange_id: + type: string + example: + listing_id: string + exchange_id: string + description: Associate an exchange with a listing + get: + operationId: provider-exchange-listings-listexchangesforlisting + externalDocs: + url: https://docs.databricks.com/api/workspace/providerexchanges/listexchangesforlisting + x-stackQL-resource: provider_exchange_listings + x-stackQL-method: listexchangesforlisting + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: listing_id + required: true + description: string + in: query + - name: page_token + in: query + - name: page_size + in: query + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + exchange_listing: + type: array + items: + type: object + properties: + id: + type: string + exchange_id: + type: string + exchange_name: + type: string + listing_id: + type: string + listing_name: + type: string + created_at: + type: integer + created_by: + type: string + next_page_token: + type: string + x-stackQL-objectKey: $.exchange_listing + description: List exchanges associated with a listing + /api/2.0/marketplace-exchange/exchanges-for-listing/{id}: + delete: + operationId: provider-exchange-listings-deletelistingfromexchange + externalDocs: + url: https://docs.databricks.com/api/workspace/providerexchanges/deletelistingfromexchange + x-stackQL-resource: provider_exchange_listings + x-stackQL-method: deletelistingfromexchange + x-stackQL-verb: delete + x-numReqParams: 1 + parameters: + - name: id + required: true + description: string + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: {} + description: Disassociate an exchange with a listing + /api/2.0/marketplace-exchange/listings-for-exchange: + get: + operationId: provider-exchange-listings-listlistingsforexchange + externalDocs: + url: https://docs.databricks.com/api/workspace/providerexchanges/listlistingsforexchange + x-stackQL-resource: provider_exchange_listings + x-stackQL-method: listlistingsforexchange + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: exchange_id + required: true + description: string + in: query + - name: page_token + in: query + - name: page_size + in: query + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + exchange_listings: + type: array + items: + type: object + properties: + id: + type: string + exchange_id: + type: string + exchange_name: + type: string + listing_id: + type: string + listing_name: + type: string + created_at: + type: integer + created_by: + type: string + next_page_token: + type: string + x-stackQL-objectKey: $.exchange_listings + description: List listings associated with an exchange + /api/2.0/marketplace-provider/files: + post: + operationId: provider-files-create + externalDocs: + url: https://docs.databricks.com/api/workspace/providerfiles/create + x-stackQL-resource: provider_files + x-stackQL-method: create + x-stackQL-verb: insert + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + upload_url: + type: string + file_info: + type: object + properties: + id: + type: string + marketplace_file_type: + type: string + file_parent: + type: object + properties: + parent_id: + type: string + file_parent_type: + type: string + mime_type: + type: string + download_link: + type: string + created_at: + type: integer + updated_at: + type: integer + display_name: + type: string + status: + type: string + status_message: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + marketplace_file_type: + type: required + mime_type: + type: string + display_name: + type: required + file_parent: + type: required + example: + file_parent: + parent_id: string + file_parent_type: PROVIDER + marketplace_file_type: PROVIDER_ICON + mime_type: string + display_name: string + description: Create a file. Currently, only provider icons and attached notebooks + are supported. + get: + operationId: provider-files-list + externalDocs: + url: https://docs.databricks.com/api/workspace/providerfiles/list + x-stackQL-resource: provider_files + x-stackQL-method: list + x-stackQL-verb: select + x-numReqParams: 0 + parameters: + - name: null + in: query + - name: page_token + in: query + - name: page_size + in: query + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + file_infos: + type: array + items: + type: object + properties: + id: + type: string + marketplace_file_type: + type: string + file_parent: + type: object + properties: + parent_id: + type: string + file_parent_type: + type: string + mime_type: + type: string + download_link: + type: string + created_at: + type: integer + updated_at: + type: integer + display_name: + type: string + status: + type: string + status_message: + type: string + next_page_token: + type: string + x-stackQL-objectKey: $.file_infos + description: List files attached to a parent entity. + /api/2.0/marketplace-provider/files/{file_id}: + delete: + operationId: provider-files-delete + externalDocs: + url: https://docs.databricks.com/api/workspace/providerfiles/delete + x-stackQL-resource: provider_files + x-stackQL-method: delete + x-stackQL-verb: delete + x-numReqParams: 1 + parameters: + - name: file_id + required: true + description: string + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: {} + description: Delete a file + get: + operationId: provider-files-get + externalDocs: + url: https://docs.databricks.com/api/workspace/providerfiles/get + x-stackQL-resource: provider_files + x-stackQL-method: get + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: file_id + required: true + description: string + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + file_info: + type: object + properties: + id: + type: string + marketplace_file_type: + type: string + file_parent: + type: object + properties: + parent_id: + type: string + file_parent_type: + type: string + mime_type: + type: string + download_link: + type: string + created_at: + type: integer + updated_at: + type: integer + display_name: + type: string + status: + type: string + status_message: + type: string + x-stackQL-objectKey: $.file_info + description: Get a file + /api/2.0/marketplace-provider/listing: + post: + operationId: provider-listings-create + externalDocs: + url: https://docs.databricks.com/api/workspace/providerlistings/create + x-stackQL-resource: provider_listings + x-stackQL-method: create + x-stackQL-verb: insert + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + listing_id: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + listing: + type: object + example: + listing: + id: string + summary: + name: string + subtitle: string + status: DRAFT + share: + name: string + type: SAMPLE + provider_region: + cloud: string + region: string + setting: + visibility: PUBLIC + created_at: 0 + created_by: string + updated_at: 0 + updated_by: string + published_at: 0 + published_by: string + categories: + - ADVERTISING_AND_MARKETING + listingType: STANDARD + created_by_id: 0 + updated_by_id: 0 + provider_id: string + exchange_ids: + - string + git_repo: + git_repo_url: string + detail: + description: string + terms_of_service: string + documentation_link: string + support_link: string + file_ids: + - string + privacy_policy_link: string + embedded_notebook_file_infos: + - id: string + marketplace_file_type: PROVIDER_ICON + file_parent: + parent_id: string + file_parent_type: PROVIDER + mime_type: string + download_link: string + created_at: 0 + updated_at: 0 + display_name: string + status: FILE_STATUS_PUBLISHED + status_message: string + geographical_coverage: string + cost: FREE + pricing_model: string + update_frequency: + interval: 0 + unit: NONE + collection_granularity: + interval: 0 + unit: NONE + collection_date_start: 0 + collection_date_end: 0 + data_source: string + size: 0.1 + assets: + - ASSET_TYPE_GIT_REPO + license: string + tags: + - tag_name: LISTING_TAG_TYPE_LANGUAGE + tag_values: + - string + description: Create a new listing + /api/2.0/marketplace-provider/listings/{id}: + delete: + operationId: provider-listings-delete + externalDocs: + url: https://docs.databricks.com/api/workspace/providerlistings/delete + x-stackQL-resource: provider_listings + x-stackQL-method: delete + x-stackQL-verb: delete + x-numReqParams: 1 + parameters: + - name: id + required: true + description: string + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: {} + description: Delete a listing + get: + operationId: provider-listings-get + externalDocs: + url: https://docs.databricks.com/api/workspace/providerlistings/get + x-stackQL-resource: provider_listings + x-stackQL-method: get + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: id + required: true + description: string + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + listing: + type: object + properties: + id: + type: string + summary: + type: object + properties: + name: + type: string + subtitle: + type: string + status: + type: string + share: + type: object + properties: + name: + type: string + type: + type: string + provider_region: + type: object + properties: + cloud: + type: string + region: + type: string + setting: + type: object + properties: + visibility: + type: string + created_at: + type: integer + created_by: + type: string + updated_at: + type: integer + updated_by: + type: string + published_at: + type: integer + published_by: + type: string + categories: + type: array + items: + type: string + listingType: + type: string + created_by_id: + type: integer + updated_by_id: + type: integer + provider_id: + type: string + exchange_ids: + type: array + items: + type: string + git_repo: + type: object + properties: + git_repo_url: + type: string + detail: + type: object + properties: + description: + type: string + terms_of_service: + type: string + documentation_link: + type: string + support_link: + type: string + file_ids: + type: array + items: + type: string + privacy_policy_link: + type: string + embedded_notebook_file_infos: + type: array + items: + type: object + properties: + id: + type: string + marketplace_file_type: + type: string + file_parent: + type: object + properties: + parent_id: + type: string + file_parent_type: + type: string + mime_type: + type: string + download_link: + type: string + created_at: + type: integer + updated_at: + type: integer + display_name: + type: string + status: + type: string + status_message: + type: string + geographical_coverage: + type: string + cost: + type: string + pricing_model: + type: string + update_frequency: + type: object + properties: + interval: + type: integer + unit: + type: string + collection_granularity: + type: object + properties: + interval: + type: integer + unit: + type: string + collection_date_start: + type: integer + collection_date_end: + type: integer + data_source: + type: string + size: + type: number + assets: + type: array + items: + type: string + license: + type: string + tags: + type: array + items: + type: object + properties: + tag_name: + type: string + tag_values: + type: array + items: + type: string + x-stackQL-objectKey: $.listing + description: Get a listing + put: + operationId: provider-listings-update + externalDocs: + url: https://docs.databricks.com/api/workspace/providerlistings/update + x-stackQL-resource: provider_listings + x-stackQL-method: update + x-stackQL-verb: update + x-numReqParams: 1 + parameters: + - name: id + required: true + description: string + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + listing: + type: object + properties: + id: + type: string + summary: + type: object + properties: + name: + type: string + subtitle: + type: string + status: + type: string + share: + type: object + properties: + name: + type: string + type: + type: string + provider_region: + type: object + properties: + cloud: + type: string + region: + type: string + setting: + type: object + properties: + visibility: + type: string + created_at: + type: integer + created_by: + type: string + updated_at: + type: integer + updated_by: + type: string + published_at: + type: integer + published_by: + type: string + categories: + type: array + items: + type: string + listingType: + type: string + created_by_id: + type: integer + updated_by_id: + type: integer + provider_id: + type: string + exchange_ids: + type: array + items: + type: string + git_repo: + type: object + properties: + git_repo_url: + type: string + detail: + type: object + properties: + description: + type: string + terms_of_service: + type: string + documentation_link: + type: string + support_link: + type: string + file_ids: + type: array + items: + type: string + privacy_policy_link: + type: string + embedded_notebook_file_infos: + type: array + items: + type: object + properties: + id: + type: string + marketplace_file_type: + type: string + file_parent: + type: object + properties: + parent_id: + type: string + file_parent_type: + type: string + mime_type: + type: string + download_link: + type: string + created_at: + type: integer + updated_at: + type: integer + display_name: + type: string + status: + type: string + status_message: + type: string + geographical_coverage: + type: string + cost: + type: string + pricing_model: + type: string + update_frequency: + type: object + properties: + interval: + type: integer + unit: + type: string + collection_granularity: + type: object + properties: + interval: + type: integer + unit: + type: string + collection_date_start: + type: integer + collection_date_end: + type: integer + data_source: + type: string + size: + type: number + assets: + type: array + items: + type: string + license: + type: string + tags: + type: array + items: + type: object + properties: + tag_name: + type: string + tag_values: + type: array + items: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + listing: + type: object + example: + listing: + id: string + summary: + name: string + subtitle: string + status: DRAFT + share: + name: string + type: SAMPLE + provider_region: + cloud: string + region: string + setting: + visibility: PUBLIC + created_at: 0 + created_by: string + updated_at: 0 + updated_by: string + published_at: 0 + published_by: string + categories: + - ADVERTISING_AND_MARKETING + listingType: STANDARD + created_by_id: 0 + updated_by_id: 0 + provider_id: string + exchange_ids: + - string + git_repo: + git_repo_url: string + detail: + description: string + terms_of_service: string + documentation_link: string + support_link: string + file_ids: + - string + privacy_policy_link: string + embedded_notebook_file_infos: + - id: string + marketplace_file_type: PROVIDER_ICON + file_parent: + parent_id: string + file_parent_type: PROVIDER + mime_type: string + download_link: string + created_at: 0 + updated_at: 0 + display_name: string + status: FILE_STATUS_PUBLISHED + status_message: string + geographical_coverage: string + cost: FREE + pricing_model: string + update_frequency: + interval: 0 + unit: NONE + collection_granularity: + interval: 0 + unit: NONE + collection_date_start: 0 + collection_date_end: 0 + data_source: string + size: 0.1 + assets: + - ASSET_TYPE_GIT_REPO + license: string + tags: + - tag_name: LISTING_TAG_TYPE_LANGUAGE + tag_values: + - string + description: Update a listing + /api/2.0/marketplace-provider/listings: + get: + operationId: provider-listings-list + externalDocs: + url: https://docs.databricks.com/api/workspace/providerlistings/list + x-stackQL-resource: provider_listings + x-stackQL-method: list + x-stackQL-verb: select + x-numReqParams: 0 + parameters: + - name: page_token + in: query + - name: page_size + in: query + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + listings: + type: array + items: + type: object + properties: + id: + type: string + summary: + type: object + properties: + name: + type: string + subtitle: + type: string + status: + type: string + share: + type: object + properties: + name: + type: string + type: + type: string + provider_region: + type: object + properties: + cloud: + type: string + region: + type: string + setting: + type: object + properties: + visibility: + type: string + created_at: + type: integer + created_by: + type: string + updated_at: + type: integer + updated_by: + type: string + published_at: + type: integer + published_by: + type: string + categories: + type: array + items: + type: string + listingType: + type: string + created_by_id: + type: integer + updated_by_id: + type: integer + provider_id: + type: string + exchange_ids: + type: array + items: + type: string + git_repo: + type: object + properties: + git_repo_url: + type: string + detail: + type: object + properties: + description: + type: string + terms_of_service: + type: string + documentation_link: + type: string + support_link: + type: string + file_ids: + type: array + items: + type: string + privacy_policy_link: + type: string + embedded_notebook_file_infos: + type: array + items: + type: object + properties: + id: + type: string + marketplace_file_type: + type: string + file_parent: + type: object + properties: + parent_id: + type: string + file_parent_type: + type: string + mime_type: + type: string + download_link: + type: string + created_at: + type: integer + updated_at: + type: integer + display_name: + type: string + status: + type: string + status_message: + type: string + geographical_coverage: + type: string + cost: + type: string + pricing_model: + type: string + update_frequency: + type: object + properties: + interval: + type: integer + unit: + type: string + collection_granularity: + type: object + properties: + interval: + type: integer + unit: + type: string + collection_date_start: + type: integer + collection_date_end: + type: integer + data_source: + type: string + size: + type: number + assets: + type: array + items: + type: string + license: + type: string + tags: + type: array + items: + type: object + properties: + tag_name: + type: string + tag_values: + type: array + items: + type: string + next_page_token: + type: string + x-stackQL-objectKey: $.listings + description: List listings owned by this provider + /api/2.0/marketplace-provider/personalization-requests: + get: + operationId: provider-personalization-requests-list + externalDocs: + url: https://docs.databricks.com/api/workspace/providerpersonalizationrequests/list + x-stackQL-resource: provider_personalization_requests + x-stackQL-method: list + x-stackQL-verb: select + x-numReqParams: 0 + parameters: + - name: page_token + in: query + - name: page_size + in: query + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + personalization_requests: + type: array + items: + type: object + properties: + id: + type: string + consumer_region: + type: object + properties: + cloud: + type: string + region: + type: string + contact_info: + type: object + properties: + first_name: + type: string + last_name: + type: string + email: + type: string + company: + type: string + comment: + type: string + intended_use: + type: string + status: + type: string + status_message: + type: string + share: + type: object + properties: + name: + type: string + type: + type: string + created_at: + type: integer + listing_id: + type: string + updated_at: + type: integer + metastore_id: + type: string + listing_name: + type: string + is_from_lighthouse: + type: boolean + provider_id: + type: string + recipient_type: + type: string + next_page_token: + type: string + x-stackQL-objectKey: $.personalization_requests + description: List personalization requests to this provider. This will return + all personalization requests, regardless of which listing they are for. + /api/2.0/marketplace-provider/listings/{listing_id}/personalization-requests/{request_id}/request-status: + put: + operationId: provider-personalization-requests-update + externalDocs: + url: https://docs.databricks.com/api/workspace/providerpersonalizationrequests/update + x-stackQL-resource: provider_personalization_requests + x-stackQL-method: update + x-stackQL-verb: update + x-numReqParams: 2 + parameters: + - name: listing_id + required: true + description: string + in: path + - name: request_id + required: true + description: string + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + request: + type: object + properties: + id: + type: string + consumer_region: + type: object + properties: + cloud: + type: string + region: + type: string + contact_info: + type: object + properties: + first_name: + type: string + last_name: + type: string + email: + type: string + company: + type: string + comment: + type: string + intended_use: + type: string + status: + type: string + status_message: + type: string + share: + type: object + properties: + name: + type: string + type: + type: string + created_at: + type: integer + listing_id: + type: string + updated_at: + type: integer + metastore_id: + type: string + listing_name: + type: string + is_from_lighthouse: + type: boolean + provider_id: + type: string + recipient_type: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + status: + type: required + reason: + type: string + share: + type: object + example: + status: NEW + reason: string + share: + name: string + type: SAMPLE + description: Update personalization request. This method only permits updating + the status of the request. +components: + x-stackQL-resources: + consumer_fulfillments: + id: databricks_workspace.marketplace.consumer_fulfillments + name: consumer_fulfillments + title: Consumer_fulfillments + methods: + list: + operation: + $ref: '#/paths/~1api~12.1~1marketplace-consumer~1listings~1{listing_id}~1fulfillments/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.fulfillments + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/consumer_fulfillments/methods/list' + insert: [] + update: [] + replace: [] + delete: [] + exec: [] + consumer_installations: + id: databricks_workspace.marketplace.consumer_installations + name: consumer_installations + title: Consumer_installations + methods: + create: + operation: + $ref: '#/paths/~1api~12.1~1marketplace-consumer~1listings~1{listing_id}~1installations/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: '#/paths/~1api~12.1~1marketplace-consumer~1listings~1{listing_id}~1installations~1{installation_id}/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: '#/paths/~1api~12.1~1marketplace-consumer~1listings~1{listing_id}~1installations~1{installation_id}/put' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1api~12.1~1marketplace-consumer~1installations/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.installations + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/consumer_installations/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/consumer_installations/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/consumer_installations/methods/update' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/consumer_installations/methods/delete' + exec: [] + listing_installations: + id: databricks_workspace.marketplace.listing_installations + name: listing_installations + title: Listing_installations + methods: + listlistinginstallations: + operation: + $ref: '#/paths/~1api~12.1~1marketplace-consumer~1listings~1{listing_id}~1installations/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.installations + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/listing_installations/methods/listlistinginstallations' + insert: [] + update: [] + replace: [] + delete: [] + exec: [] + consumer_listings: + id: databricks_workspace.marketplace.consumer_listings + name: consumer_listings + title: Consumer_listings + methods: + batchget: + operation: + $ref: '#/paths/~1api~12.1~1marketplace-consumer~1listings:batchGet/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1api~12.1~1marketplace-consumer~1listings~1{id}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.listing + list: + operation: + $ref: '#/paths/~1api~12.1~1marketplace-consumer~1listings/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.listings + search: + operation: + $ref: '#/paths/~1api~12.1~1marketplace-consumer~1search-listings/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.listings + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/consumer_listings/methods/search' + - $ref: '#/components/x-stackQL-resources/consumer_listings/methods/list' + - $ref: '#/components/x-stackQL-resources/consumer_listings/methods/get' + insert: [] + update: [] + replace: [] + delete: [] + exec: + - $ref: '#/components/x-stackQL-resources/consumer_listings/methods/batchget' + consumer_listing_content: + id: databricks_workspace.marketplace.consumer_listing_content + name: consumer_listing_content + title: Consumer_listing_content + methods: + get: + operation: + $ref: '#/paths/~1api~12.1~1marketplace-consumer~1listings~1{listing_id}~1content/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.shared_data_objects + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/consumer_listing_content/methods/get' + insert: [] + update: [] + replace: [] + delete: [] + exec: [] + consumer_personalization_requests: + id: databricks_workspace.marketplace.consumer_personalization_requests + name: consumer_personalization_requests + title: Consumer_personalization_requests + methods: + create: + operation: + $ref: '#/paths/~1api~12.1~1marketplace-consumer~1listings~1{listing_id}~1personalization-requests/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1api~12.1~1marketplace-consumer~1listings~1{listing_id}~1personalization-requests/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.personalization_requests + list: + operation: + $ref: '#/paths/~1api~12.1~1marketplace-consumer~1personalization-requests/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.personalization_requests + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/consumer_personalization_requests/methods/list' + - $ref: '#/components/x-stackQL-resources/consumer_personalization_requests/methods/get' + insert: + - $ref: '#/components/x-stackQL-resources/consumer_personalization_requests/methods/create' + update: [] + replace: [] + delete: [] + exec: [] + consumer_providers: + id: databricks_workspace.marketplace.consumer_providers + name: consumer_providers + title: Consumer_providers + methods: + batchget: + operation: + $ref: '#/paths/~1api~12.1~1marketplace-consumer~1providers:batchGet/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1api~12.1~1marketplace-consumer~1providers~1{id}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.provider + list: + operation: + $ref: '#/paths/~1api~12.1~1marketplace-consumer~1providers/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.providers + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/consumer_providers/methods/list' + - $ref: '#/components/x-stackQL-resources/consumer_providers/methods/get' + insert: [] + update: [] + replace: [] + delete: [] + exec: + - $ref: '#/components/x-stackQL-resources/consumer_providers/methods/batchget' + providers: + id: databricks_workspace.marketplace.providers + name: providers + title: Providers + methods: + create: + operation: + $ref: '#/paths/~1api~12.0~1marketplace-provider~1provider/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: '#/paths/~1api~12.0~1marketplace-provider~1providers~1{id}/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1api~12.0~1marketplace-provider~1providers~1{id}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.provider + update: + operation: + $ref: '#/paths/~1api~12.0~1marketplace-provider~1providers~1{id}/put' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1api~12.0~1marketplace-provider~1providers/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.providers + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/providers/methods/list' + - $ref: '#/components/x-stackQL-resources/providers/methods/get' + insert: + - $ref: '#/components/x-stackQL-resources/providers/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/providers/methods/update' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/providers/methods/delete' + exec: [] + provider_analytics_dashboards: + id: databricks_workspace.marketplace.provider_analytics_dashboards + name: provider_analytics_dashboards + title: Provider_analytics_dashboards + methods: + create: + operation: + $ref: '#/paths/~1api~12.0~1marketplace-provider~1analytics_dashboard/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1api~12.0~1marketplace-provider~1analytics_dashboard/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: '#/paths/~1api~12.0~1marketplace-provider~1analytics_dashboard~1{id}/put' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/provider_analytics_dashboards/methods/get' + insert: + - $ref: '#/components/x-stackQL-resources/provider_analytics_dashboards/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/provider_analytics_dashboards/methods/update' + replace: [] + delete: [] + exec: [] + provider_analytics_dashboards_latest: + id: databricks_workspace.marketplace.provider_analytics_dashboards_latest + name: provider_analytics_dashboards_latest + title: Provider_analytics_dashboards_latest + methods: + getlatestversion: + operation: + $ref: '#/paths/~1api~12.0~1marketplace-provider~1analytics_dashboard~1latest/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/provider_analytics_dashboards_latest/methods/getlatestversion' + insert: [] + update: [] + replace: [] + delete: [] + exec: [] + provider_exchanges: + id: databricks_workspace.marketplace.provider_exchanges + name: provider_exchanges + title: Provider_exchanges + methods: + create: + operation: + $ref: '#/paths/~1api~12.0~1marketplace-exchange~1exchanges/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1api~12.0~1marketplace-exchange~1exchanges/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.exchanges + delete: + operation: + $ref: '#/paths/~1api~12.0~1marketplace-exchange~1exchanges~1{id}/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1api~12.0~1marketplace-exchange~1exchanges~1{id}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.exchange + update: + operation: + $ref: '#/paths/~1api~12.0~1marketplace-exchange~1exchanges~1{id}/put' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/provider_exchanges/methods/get' + - $ref: '#/components/x-stackQL-resources/provider_exchanges/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/provider_exchanges/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/provider_exchanges/methods/update' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/provider_exchanges/methods/delete' + exec: [] + provider_exchange_filters: + id: databricks_workspace.marketplace.provider_exchange_filters + name: provider_exchange_filters + title: Provider_exchange_filters + methods: + create: + operation: + $ref: '#/paths/~1api~12.0~1marketplace-exchange~1filters/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1api~12.0~1marketplace-exchange~1filters/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.filters + delete: + operation: + $ref: '#/paths/~1api~12.0~1marketplace-exchange~1filters~1{id}/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: '#/paths/~1api~12.0~1marketplace-exchange~1filters~1{id}/put' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/provider_exchange_filters/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/provider_exchange_filters/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/provider_exchange_filters/methods/update' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/provider_exchange_filters/methods/delete' + exec: [] + provider_exchange_listings: + id: databricks_workspace.marketplace.provider_exchange_listings + name: provider_exchange_listings + title: Provider_exchange_listings + methods: + addlistingtoexchange: + operation: + $ref: '#/paths/~1api~12.0~1marketplace-exchange~1exchanges-for-listing/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + listexchangesforlisting: + operation: + $ref: '#/paths/~1api~12.0~1marketplace-exchange~1exchanges-for-listing/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.exchange_listing + deletelistingfromexchange: + operation: + $ref: '#/paths/~1api~12.0~1marketplace-exchange~1exchanges-for-listing~1{id}/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + listlistingsforexchange: + operation: + $ref: '#/paths/~1api~12.0~1marketplace-exchange~1listings-for-exchange/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.exchange_listings + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/provider_exchange_listings/methods/listlistingsforexchange' + - $ref: '#/components/x-stackQL-resources/provider_exchange_listings/methods/listexchangesforlisting' + insert: + - $ref: '#/components/x-stackQL-resources/provider_exchange_listings/methods/addlistingtoexchange' + update: [] + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/provider_exchange_listings/methods/deletelistingfromexchange' + exec: [] + provider_files: + id: databricks_workspace.marketplace.provider_files + name: provider_files + title: Provider_files + methods: + create: + operation: + $ref: '#/paths/~1api~12.0~1marketplace-provider~1files/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1api~12.0~1marketplace-provider~1files/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.file_infos + delete: + operation: + $ref: '#/paths/~1api~12.0~1marketplace-provider~1files~1{file_id}/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1api~12.0~1marketplace-provider~1files~1{file_id}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.file_info + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/provider_files/methods/get' + - $ref: '#/components/x-stackQL-resources/provider_files/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/provider_files/methods/create' + update: [] + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/provider_files/methods/delete' + exec: [] + provider_listings: + id: databricks_workspace.marketplace.provider_listings + name: provider_listings + title: Provider_listings + methods: + create: + operation: + $ref: '#/paths/~1api~12.0~1marketplace-provider~1listing/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: '#/paths/~1api~12.0~1marketplace-provider~1listings~1{id}/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1api~12.0~1marketplace-provider~1listings~1{id}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.listing + update: + operation: + $ref: '#/paths/~1api~12.0~1marketplace-provider~1listings~1{id}/put' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1api~12.0~1marketplace-provider~1listings/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.listings + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/provider_listings/methods/list' + - $ref: '#/components/x-stackQL-resources/provider_listings/methods/get' + insert: + - $ref: '#/components/x-stackQL-resources/provider_listings/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/provider_listings/methods/update' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/provider_listings/methods/delete' + exec: [] + provider_personalization_requests: + id: databricks_workspace.marketplace.provider_personalization_requests + name: provider_personalization_requests + title: Provider_personalization_requests + methods: + list: + operation: + $ref: '#/paths/~1api~12.0~1marketplace-provider~1personalization-requests/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.personalization_requests + update: + operation: + $ref: '#/paths/~1api~12.0~1marketplace-provider~1listings~1{listing_id}~1personalization-requests~1{request_id}~1request-status/put' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/provider_personalization_requests/methods/list' + insert: [] + update: + - $ref: '#/components/x-stackQL-resources/provider_personalization_requests/methods/update' + replace: [] + delete: [] + exec: [] diff --git a/providers/src/databricks_workspace/v00.00.00000/services/realtimeserving.yaml b/providers/src/databricks_workspace/v00.00.00000/services/realtimeserving.yaml new file mode 100644 index 00000000..779fca1e --- /dev/null +++ b/providers/src/databricks_workspace/v00.00.00000/services/realtimeserving.yaml @@ -0,0 +1,1882 @@ +openapi: 3.0.0 +info: + version: 2024-12-19-stackql-generated + contact: + name: StackQL Studios + url: https://stackql.io/ + email: info@stackql.io + title: Databricks Realtimeserving API + description: Realtimeserving +servers: +- url: https://{deployment_name}.cloud.databricks.com + variables: + deployment_name: + description: The Databricks Workspace Deployment Name + default: dbc-abcd0123-a1bc +paths: + /api/2.0/serving-endpoints/{name}/ai-gateway: + put: + operationId: ai-gateways-putaigateway + externalDocs: + url: https://docs.databricks.com/api/workspace/servingendpoints/putaigateway + x-stackQL-resource: ai_gateways + x-stackQL-method: putaigateway + x-stackQL-verb: exec + x-numReqParams: 1 + parameters: + - name: name + required: true + description: string + in: path + responses: + '200': + description: Serving endpoint AI Gateway was updated successfully. + content: + application/json: + schema: + type: object + properties: + usage_tracking_config: + type: object + properties: + enabled: + type: boolean + inference_table_config: + type: object + properties: + catalog_name: + type: string + schema_name: + type: string + table_name_prefix: + type: string + enabled: + type: boolean + rate_limits: + type: array + items: + type: object + properties: + calls: + type: integer + key: + type: string + renewal_period: + type: string + guardrails: + type: object + properties: + input: + type: object + properties: + safety: + type: boolean + pii: + type: object + properties: + behavior: + type: string + valid_topics: + type: array + items: + type: string + invalid_keywords: + type: array + items: + type: string + output: + type: object + properties: + safety: + type: boolean + pii: + type: object + properties: + behavior: + type: string + valid_topics: + type: array + items: + type: string + invalid_keywords: + type: array + items: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + usage_tracking_config: + type: object + inference_table_config: + type: object + rate_limits: + type: Array of object + guardrails: + type: object + example: + usage_tracking_config: + enabled: true + inference_table_config: + catalog_name: my-catalog + schema_name: my-schema + table_name_prefix: my-prefix + enabled: true + rate_limits: + - calls: 15 + key: user + renewal_period: minute + guardrails: + input: + safety: true + pii: + behavior: BLOCK + valid_topics: + - topic1 + invalid_keywords: + - keyword1 + output: + safety: true + pii: + behavior: BLOCK + valid_topics: + - topic1 + invalid_keywords: + - keyword1 + description: 'Used to update the AI Gateway of a serving endpoint. NOTE: Only + external model endpoints are currently supported.' + /api/2.0/serving-endpoints/{name}/served-models/{served_model_name}/build-logs: + get: + operationId: build-logs-buildlogs + externalDocs: + url: https://docs.databricks.com/api/workspace/servingendpoints/buildlogs + x-stackQL-resource: build_logs + x-stackQL-method: buildlogs + x-stackQL-verb: select + x-numReqParams: 2 + parameters: + - name: name + required: true + description: string + in: path + - name: served_model_name + required: true + description: string + in: path + responses: + '200': + description: Build logs were fetched successfully. + content: + application/json: + schema: + type: object + properties: + logs: + type: string + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Retrieves the build logs associated with the provided served model. + /api/2.0/serving-endpoints/{name}/served-models/{served_model_name}/logs: + get: + operationId: logs-logs + externalDocs: + url: https://docs.databricks.com/api/workspace/servingendpoints/logs + x-stackQL-resource: logs + x-stackQL-method: logs + x-stackQL-verb: select + x-numReqParams: 2 + parameters: + - name: name + required: true + description: string + in: path + - name: served_model_name + required: true + description: string + in: path + responses: + '200': + description: Logs were fetched successfully. + content: + application/json: + schema: + type: object + properties: + logs: + type: string + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Retrieves the service logs associated with the provided served + model. + /api/2.0/serving-endpoints/{name}/metrics: + get: + operationId: metrics-exportmetrics + externalDocs: + url: https://docs.databricks.com/api/workspace/servingendpoints/exportmetrics + x-stackQL-resource: metrics + x-stackQL-method: exportmetrics + x-stackQL-verb: exec + x-numReqParams: 1 + parameters: + - name: name + required: true + description: string + in: path + responses: + '200': + description: Metrics for the serving endpoint in Prometheus exposition or + OpenMetrics exposition format were fetched successfully. + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Retrieves the metrics associated with the provided serving endpoint + in either Prometheus or OpenMetrics exposition format. + /api/2.0/serving-endpoints/{name}/openapi: + get: + operationId: schemas-getopenapi + externalDocs: + url: https://docs.databricks.com/api/workspace/servingendpoints/getopenapi + x-stackQL-resource: schemas + x-stackQL-method: getopenapi + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: name + required: true + description: string + in: path + responses: + '200': + description: The OpenAPI spec for the invocation schema was fetched successfully + content: + application/json: + schema: + type: object + properties: + openapi: + type: string + info: + type: object + properties: + title: + type: string + version: + type: string + servers: + type: array + items: + type: object + properties: + url: + type: string + paths: + type: object + properties: + /served-models/model1/invocations: + type: object + properties: + post: + type: object + properties: + requestBody: + type: object + properties: + content: + type: object + properties: + application/json: + type: object + properties: + schema: + type: object + properties: + oneOf: + type: array + items: + type: object + properties: + properties: + type: object + properties: + dataframe_split: + type: object + properties: + properties: + type: object + properties: + columns: + type: object + properties: + type: + type: string + description: + type: string + items: + type: object + properties: + type: + type: string + enum: + type: array + items: + type: string + data: + type: object + properties: + type: + type: string + items: + type: object + properties: + type: + type: string + prefixItems: + type: array + items: + type: object + properties: + type: + type: string + format: + type: string + responses: + type: object + properties: + '200': + type: object + properties: + description: + type: string + content: + type: object + properties: + application/json: + type: object + properties: + schema: + type: object + properties: + properties: + type: object + properties: + predictions: + type: object + properties: + type: + type: string + items: + type: object + properties: + type: + type: string + format: + type: string + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Get the query schema of the serving endpoint in OpenAPI format. + The schema contains information for the supported paths, input and output + format and datatypes. + /api/2.0/serving-endpoints: + post: + operationId: serving-endpoints-create + externalDocs: + url: https://docs.databricks.com/api/workspace/servingendpoints/create + x-stackQL-resource: serving_endpoints + x-stackQL-method: create + x-stackQL-verb: insert + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Serving endpoint was created successfully + content: + application/json: + schema: + type: object + properties: + name: + type: string + creator: + type: string + creation_timestamp: + type: integer + last_updated_timestamp: + type: integer + state: + type: object + properties: + ready: + type: string + config: + type: object + properties: + served_entities: + type: array + items: + type: object + properties: + name: + type: string + external_model: + type: object + properties: + provider: + type: string + name: + type: string + task: + type: string + openai_config: + type: object + properties: + openai_api_key: + type: string + state: + type: object + properties: + deployment: + type: string + deployment_state_message: + type: string + creator: + type: string + creation_timestamp: + type: integer + traffic_config: + type: object + properties: + routes: + type: array + items: + type: object + properties: + served_model_name: + type: string + traffic_percentage: + type: integer + config_version: + type: integer + ai_gateway: + type: object + properties: + usage_tracking_config: + type: object + properties: + enabled: + type: boolean + inference_table_config: + type: object + properties: + catalog_name: + type: string + schema_name: + type: string + table_name_prefix: + type: string + enabled: + type: boolean + rate_limits: + type: array + items: + type: object + properties: + calls: + type: integer + key: + type: string + renewal_period: + type: string + guardrails: + type: object + properties: + input: + type: object + properties: + safety: + type: boolean + pii: + type: object + properties: + behavior: + type: string + valid_topics: + type: array + items: + type: string + invalid_keywords: + type: array + items: + type: string + output: + type: object + properties: + safety: + type: boolean + pii: + type: object + properties: + behavior: + type: string + valid_topics: + type: array + items: + type: string + invalid_keywords: + type: array + items: + type: string + tags: + type: array + items: + type: object + properties: + key: + type: string + value: + type: string + id: + type: string + permission_level: + type: string + route_optimized: + type: boolean + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: required + route_optimized: + type: string + config: + type: required + tags: + type: object + rate_limits: + type: Array of object + ai_gateway: + type: Array of object + example: + name: openai_endpoint + config: + served_entities: + - name: openai_embeddings + external_model: + name: text-embedding-ada-002 + provider: openai + task: llm/v1/embeddings + openai_config: + openai_api_key: '{{secrets/my_scope/my_openai_api_key}}' + ai_gateway: + usage_tracking_config: + enabled: true + inference_table_config: + catalog_name: my-catalog + schema_name: my-schema + table_name_prefix: my-prefix + enabled: true + rate_limits: + - calls: 100 + key: user + renewal_period: minute + guardrails: + input: + safety: true + pii: + behavior: BLOCK + valid_topics: + - topic1 + - topic2 + invalid_keywords: + - keyword1 + - keyword2 + output: + safety: true + pii: + behavior: BLOCK + valid_topics: + - topic1 + - topic2 + invalid_keywords: + - keyword1 + - keyword2 + tags: + - key: team + value: gen-ai + get: + operationId: serving-endpoints-list + externalDocs: + url: https://docs.databricks.com/api/workspace/servingendpoints/list + x-stackQL-resource: serving_endpoints + x-stackQL-method: list + x-stackQL-verb: select + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: List of serving endpoints was retrieved successfully. + content: + application/json: + schema: + type: object + properties: + endpoints: + type: array + items: + type: object + properties: + name: + type: string + creator: + type: string + creation_timestamp: + type: integer + last_updated_timestamp: + type: integer + state: + type: object + properties: + ready: + type: string + config_update: + type: string + config: + type: object + properties: + served_entities: + type: array + items: + type: object + properties: + name: + type: string + external_model: + type: object + properties: + provider: + type: string + name: + type: string + task: + type: string + ai21labs_config: + type: object + properties: + ai21labs_api_key: + type: string + ai21labs_api_key_plaintext: + type: string + anthropic_config: + type: object + properties: + anthropic_api_key: + type: string + anthropic_api_key_plaintext: + type: string + amazon_bedrock_config: + type: object + properties: + aws_region: + type: string + aws_access_key_id: + type: string + aws_access_key_id_plaintext: + type: string + aws_secret_access_key: + type: string + aws_secret_access_key_plaintext: + type: string + bedrock_provider: + type: string + cohere_config: + type: object + properties: + cohere_api_key: + type: string + cohere_api_key_plaintext: + type: string + cohere_api_base: + type: string + google_cloud_vertex_ai_config: + type: object + properties: + private_key: + type: string + private_key_plaintext: + type: string + region: + type: string + project_id: + type: string + databricks_model_serving_config: + type: object + properties: + databricks_api_token: + type: string + databricks_api_token_plaintext: + type: string + databricks_workspace_url: + type: string + openai_config: + type: object + properties: + openai_api_key: + type: string + openai_api_key_plaintext: + type: string + openai_api_type: + type: string + openai_api_base: + type: string + openai_api_version: + type: string + openai_organization: + type: string + openai_deployment_name: + type: string + microsoft_entra_tenant_id: + type: string + microsoft_entra_client_id: + type: string + microsoft_entra_client_secret: + type: string + microsoft_entra_client_secret_plaintext: + type: string + palm_config: + type: object + properties: + palm_api_key: + type: string + palm_api_key_plaintext: + type: string + foundation_model: + type: object + properties: + name: + type: string + display_name: + type: string + docs: + type: string + description: + type: string + entity_name: + type: string + entity_version: + type: string + served_models: + type: array + items: + type: object + properties: + name: + type: string + model_name: + type: string + model_version: + type: string + tags: + type: array + items: + type: object + properties: + key: + type: string + value: + type: string + id: + type: string + task: + type: string + ai_gateway: + type: object + properties: + usage_tracking_config: + type: object + properties: + enabled: + type: boolean + inference_table_config: + type: object + properties: + catalog_name: + type: string + schema_name: + type: string + table_name_prefix: + type: string + enabled: + type: boolean + rate_limits: + type: array + items: + type: object + properties: + calls: + type: integer + key: + type: string + renewal_period: + type: string + guardrails: + type: object + properties: + input: + type: object + properties: + safety: + type: boolean + pii: + type: object + properties: + behavior: + type: string + valid_topics: + type: array + items: + type: string + invalid_keywords: + type: array + items: + type: string + output: + type: object + properties: + safety: + type: boolean + pii: + type: object + properties: + behavior: + type: string + valid_topics: + type: array + items: + type: string + invalid_keywords: + type: array + items: + type: string + '401': + description: The request does not have valid authentication credentials + for the operation. + '500': + description: Internal error. + x-stackQL-objectKey: $.endpoints + /api/2.0/serving-endpoints/{name}: + delete: + operationId: serving-endpoints-delete + externalDocs: + url: https://docs.databricks.com/api/workspace/servingendpoints/delete + x-stackQL-resource: serving_endpoints + x-stackQL-method: delete + x-stackQL-verb: delete + x-numReqParams: 1 + parameters: + - name: name + required: true + description: string + in: path + responses: + '200': + description: Serving endpoint was deleted successfully. + content: + application/json: + schema: + type: object + properties: {} + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + get: + operationId: serving-endpoints-get + externalDocs: + url: https://docs.databricks.com/api/workspace/servingendpoints/get + x-stackQL-resource: serving_endpoints + x-stackQL-method: get + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: name + required: true + description: string + in: path + responses: + '200': + description: Serving endpoint was retrieved successfully. + content: + application/json: + schema: + type: object + properties: + name: + type: string + creator: + type: string + creation_timestamp: + type: integer + last_updated_timestamp: + type: integer + state: + type: object + properties: + ready: + type: string + config_update: + type: string + config: + type: object + properties: + served_entities: + type: array + items: + type: object + properties: + name: + type: string + entity_name: + type: string + workload_size: + type: string + scale_to_zero_enabled: + type: boolean + workload_type: + type: string + state: + type: object + properties: + deployment: + type: string + deployment_state_message: + type: string + creator: + type: string + creation_timestamp: + type: integer + traffic_config: + type: object + properties: + routes: + type: array + items: + type: object + properties: + traffic_percentage: + type: integer + served_model_name: + type: string + config_version: + type: integer + tags: + type: array + items: + type: object + properties: + key: + type: string + value: + type: string + id: + type: string + permission_level: + type: string + route_optimized: + type: boolean + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Retrieves the details for a single serving endpoint. + /api/2.0/serving-endpoints/{name}/tags: + patch: + operationId: serving-endpoints-patch + externalDocs: + url: https://docs.databricks.com/api/workspace/servingendpoints/patch + x-stackQL-resource: serving_endpoints + x-stackQL-method: patch + x-stackQL-verb: update + x-numReqParams: 1 + parameters: + - name: name + required: true + description: string + in: path + responses: + '200': + description: Serving endpoint tags were patched successfully. + content: + application/json: + schema: + type: array + items: + type: object + properties: + key: + type: string + value: + type: string + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + delete_tags: + type: Array of string + add_tags: + type: Array of object + example: + add_tags: + - key: team + value: data science + delete_tags: + - string + description: Used to batch add and delete tags from a serving endpoint with + a single API call. + /api/2.0/serving-endpoints/{name}/rate-limits: + put: + operationId: serving-endpoints-put + externalDocs: + url: https://docs.databricks.com/api/workspace/servingendpoints/put + x-stackQL-resource: serving_endpoints + x-stackQL-method: put + x-stackQL-verb: replace + x-numReqParams: 1 + parameters: + - name: name + required: true + description: string + in: path + responses: + '200': + description: Serving endpoint rate limits were updated successfully. + content: + application/json: + schema: + type: object + properties: + rate_limits: + type: array + items: + type: object + properties: + calls: + type: integer + key: + type: string + renewal_period: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + rate_limits: + type: Array of object + example: + rate_limits: + - calls: 15 + key: user + renewal_period: minute + description: 'Used to update the rate limits of a serving endpoint. NOTE: Only + foundation model endpoints are currently supported. For external models, use + AI Gateway to manage rate limits.' + /serving-endpoints/{name}/invocations: + post: + operationId: serving-endpoints-query + externalDocs: + url: https://docs.databricks.com/api/workspace/servingendpoints/query + x-stackQL-resource: serving_endpoints + x-stackQL-method: query + x-stackQL-verb: exec + x-numReqParams: 1 + parameters: + - name: name + required: true + description: string + in: path + responses: + '200': + description: Serving endpoint was queried successfully and returned predictions. + content: + application/json: + schema: + type: object + properties: + id: + type: string + object: + type: string + created: + type: integer + model: + type: string + choices: + type: array + items: + type: object + properties: + text: + type: string + index: + type: integer + logprobs: + type: 'null' + finish_reason: + type: string + usage: + type: object + properties: + prompt_tokens: + type: integer + completion_tokens: + type: integer + total_tokens: + type: integer + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + prompt: + type: object + input: + type: object + temperature: + type: double + stop: + type: Array of string + max_tokens: + type: integer + n: + type: integer + stream: + type: boolean + dataframe_records: + type: Array of object + instances: + type: Array of object + inputs: + type: object + messages: + type: Array of object + extra_params: + type: object + dataframe_split: + type: object + example: + dataframe_records: + - user_latitude: 37 + user_longitude: 122.4 + destination_id: 10 + /api/2.0/serving-endpoints/{name}/config: + put: + operationId: serving-endpoints-updateconfig + externalDocs: + url: https://docs.databricks.com/api/workspace/servingendpoints/updateconfig + x-stackQL-resource: serving_endpoints + x-stackQL-method: updateconfig + x-stackQL-verb: update + x-numReqParams: 1 + parameters: + - name: name + required: true + description: string + in: path + responses: + '200': + description: Serving endpoint update was issued successfully. + content: + application/json: + schema: + type: object + properties: + name: + type: string + creator: + type: string + creation_timestamp: + type: integer + last_updated_timestamp: + type: integer + state: + type: object + properties: + ready: + type: string + config: + type: object + properties: + served_entities: + type: array + items: + type: object + properties: + name: + type: string + external_model: + type: object + properties: + provider: + type: string + name: + type: string + task: + type: string + openai_config: + type: object + properties: + openai_api_key: + type: string + state: + type: object + properties: + deployment: + type: string + deployment_state_message: + type: string + creator: + type: string + creation_timestamp: + type: integer + traffic_config: + type: object + properties: + routes: + type: array + items: + type: object + properties: + served_model_name: + type: string + traffic_percentage: + type: integer + config_version: + type: integer + id: + type: string + permission_level: + type: string + route_optimized: + type: boolean + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '409': + description: Request was rejected due a conflict with an existing resource. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + served_entities: + type: Array of object + served_models: + type: Array of object + traffic_config: + type: object + auto_capture_config: + type: object + example: + served_entities: + - name: openai_chat + external_model: + name: gpt-4 + provider: openai + task: llm/v1/chat + openai_config: + openai_api_key: '{{secrets/my_scope/my_openai_api_key}}' + description: Updates any combination of the serving endpoint's served entities, + the compute configuration of those served entities, and the endpoint's traffic + config. An endpoint that already has an update in progress can not be updated + until the current update completes or fails. + /api/2.0/permissions/serving-endpoints/{serving_endpoint_id}: + get: + operationId: serving-endpoints-permissions-getpermissions + externalDocs: + url: https://docs.databricks.com/api/workspace/servingendpoints/getpermissions + x-stackQL-resource: serving_endpoints_permissions + x-stackQL-method: getpermissions + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: serving_endpoint_id + required: true + description: string + in: path + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + object_id: + type: string + object_type: + type: string + access_control_list: + type: array + items: + type: object + properties: + user_name: + type: string + group_name: + type: string + service_principal_name: + type: string + display_name: + type: string + all_permissions: + type: array + items: + type: object + properties: + permission_level: + type: string + inherited: + type: boolean + inherited_from_object: + type: array + items: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Gets the permissions of a serving endpoint. Serving endpoints can + inherit permissions from their root object. + put: + operationId: serving-endpoints-permissions-setpermissions + externalDocs: + url: https://docs.databricks.com/api/workspace/servingendpoints/setpermissions + x-stackQL-resource: serving_endpoints_permissions + x-stackQL-method: setpermissions + x-stackQL-verb: replace + x-numReqParams: 1 + parameters: + - name: serving_endpoint_id + required: true + description: string + in: path + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + object_id: + type: string + object_type: + type: string + access_control_list: + type: array + items: + type: object + properties: + user_name: + type: string + group_name: + type: string + service_principal_name: + type: string + display_name: + type: string + all_permissions: + type: array + items: + type: object + properties: + permission_level: + type: string + inherited: + type: boolean + inherited_from_object: + type: array + items: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + access_control_list: + type: Array of object + example: + access_control_list: + - user_name: string + group_name: string + service_principal_name: string + permission_level: CAN_MANAGE + description: Sets permissions on an object, replacing existing permissions if + they exist. Deletes all direct permissions if none are specified. Objects + can inherit permissions from their root object. + patch: + operationId: serving-endpoints-permissions-updatepermissions + externalDocs: + url: https://docs.databricks.com/api/workspace/servingendpoints/updatepermissions + x-stackQL-resource: serving_endpoints_permissions + x-stackQL-method: updatepermissions + x-stackQL-verb: update + x-numReqParams: 1 + parameters: + - name: serving_endpoint_id + required: true + description: string + in: path + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + object_id: + type: string + object_type: + type: string + access_control_list: + type: array + items: + type: object + properties: + user_name: + type: string + group_name: + type: string + service_principal_name: + type: string + display_name: + type: string + all_permissions: + type: array + items: + type: object + properties: + permission_level: + type: string + inherited: + type: boolean + inherited_from_object: + type: array + items: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + access_control_list: + type: Array of object + example: + access_control_list: + - user_name: string + group_name: string + service_principal_name: string + permission_level: CAN_MANAGE + description: Updates the permissions on a serving endpoint. Serving endpoints + can inherit permissions from their root object. + /api/2.0/permissions/serving-endpoints/{serving_endpoint_id}/permissionLevels: + get: + operationId: serving-endpoints-permission-levels-getpermissionlevels + externalDocs: + url: https://docs.databricks.com/api/workspace/servingendpoints/getpermissionlevels + x-stackQL-resource: serving_endpoints_permission_levels + x-stackQL-method: getpermissionlevels + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: serving_endpoint_id + required: true + description: string + in: path + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + permission_levels: + type: array + items: + type: object + properties: + permission_level: + type: string + description: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + x-stackQL-objectKey: $.permission_levels + description: Gets the permission levels that a user can have on an object. +components: + x-stackQL-resources: + ai_gateways: + id: databricks_workspace.realtimeserving.ai_gateways + name: ai_gateways + title: Ai_gateways + methods: + putaigateway: + operation: + $ref: '#/paths/~1api~12.0~1serving-endpoints~1{name}~1ai-gateway/put' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: [] + replace: [] + delete: [] + exec: + - $ref: '#/components/x-stackQL-resources/ai_gateways/methods/putaigateway' + build_logs: + id: databricks_workspace.realtimeserving.build_logs + name: build_logs + title: Build_logs + methods: + buildlogs: + operation: + $ref: '#/paths/~1api~12.0~1serving-endpoints~1{name}~1served-models~1{served_model_name}~1build-logs/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/build_logs/methods/buildlogs' + insert: [] + update: [] + replace: [] + delete: [] + exec: [] + logs: + id: databricks_workspace.realtimeserving.logs + name: logs + title: Logs + methods: + logs: + operation: + $ref: '#/paths/~1api~12.0~1serving-endpoints~1{name}~1served-models~1{served_model_name}~1logs/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/logs/methods/logs' + insert: [] + update: [] + replace: [] + delete: [] + exec: [] + metrics: + id: databricks_workspace.realtimeserving.metrics + name: metrics + title: Metrics + methods: + exportmetrics: + operation: + $ref: '#/paths/~1api~12.0~1serving-endpoints~1{name}~1metrics/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: [] + replace: [] + delete: [] + exec: + - $ref: '#/components/x-stackQL-resources/metrics/methods/exportmetrics' + schemas: + id: databricks_workspace.realtimeserving.schemas + name: schemas + title: Schemas + methods: + getopenapi: + operation: + $ref: '#/paths/~1api~12.0~1serving-endpoints~1{name}~1openapi/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/schemas/methods/getopenapi' + insert: [] + update: [] + replace: [] + delete: [] + exec: [] + serving_endpoints: + id: databricks_workspace.realtimeserving.serving_endpoints + name: serving_endpoints + title: Serving_endpoints + methods: + create: + operation: + $ref: '#/paths/~1api~12.0~1serving-endpoints/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1api~12.0~1serving-endpoints/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.endpoints + delete: + operation: + $ref: '#/paths/~1api~12.0~1serving-endpoints~1{name}/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1api~12.0~1serving-endpoints~1{name}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: '#/paths/~1api~12.0~1serving-endpoints~1{name}~1tags/patch' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + put: + operation: + $ref: '#/paths/~1api~12.0~1serving-endpoints~1{name}~1rate-limits/put' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + query: + operation: + $ref: '#/paths/~1serving-endpoints~1{name}~1invocations/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + updateconfig: + operation: + $ref: '#/paths/~1api~12.0~1serving-endpoints~1{name}~1config/put' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/serving_endpoints/methods/get' + - $ref: '#/components/x-stackQL-resources/serving_endpoints/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/serving_endpoints/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/serving_endpoints/methods/updateconfig' + - $ref: '#/components/x-stackQL-resources/serving_endpoints/methods/patch' + replace: + - $ref: '#/components/x-stackQL-resources/serving_endpoints/methods/put' + delete: + - $ref: '#/components/x-stackQL-resources/serving_endpoints/methods/delete' + exec: + - $ref: '#/components/x-stackQL-resources/serving_endpoints/methods/query' + serving_endpoints_permissions: + id: databricks_workspace.realtimeserving.serving_endpoints_permissions + name: serving_endpoints_permissions + title: Serving_endpoints_permissions + methods: + getpermissions: + operation: + $ref: '#/paths/~1api~12.0~1permissions~1serving-endpoints~1{serving_endpoint_id}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + setpermissions: + operation: + $ref: '#/paths/~1api~12.0~1permissions~1serving-endpoints~1{serving_endpoint_id}/put' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + updatepermissions: + operation: + $ref: '#/paths/~1api~12.0~1permissions~1serving-endpoints~1{serving_endpoint_id}/patch' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/serving_endpoints_permissions/methods/getpermissions' + insert: [] + update: + - $ref: '#/components/x-stackQL-resources/serving_endpoints_permissions/methods/updatepermissions' + replace: + - $ref: '#/components/x-stackQL-resources/serving_endpoints_permissions/methods/setpermissions' + delete: [] + exec: [] + serving_endpoints_permission_levels: + id: databricks_workspace.realtimeserving.serving_endpoints_permission_levels + name: serving_endpoints_permission_levels + title: Serving_endpoints_permission_levels + methods: + getpermissionlevels: + operation: + $ref: '#/paths/~1api~12.0~1permissions~1serving-endpoints~1{serving_endpoint_id}~1permissionLevels/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.permission_levels + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/serving_endpoints_permission_levels/methods/getpermissionlevels' + insert: [] + update: [] + replace: [] + delete: [] + exec: [] diff --git a/providers/src/databricks_workspace/v00.00.00000/services/repos.yaml b/providers/src/databricks_workspace/v00.00.00000/services/repos.yaml new file mode 100644 index 00000000..f7b97e10 --- /dev/null +++ b/providers/src/databricks_workspace/v00.00.00000/services/repos.yaml @@ -0,0 +1,907 @@ +openapi: 3.0.0 +info: + version: 2024-12-19-stackql-generated + contact: + name: StackQL Studios + url: https://stackql.io/ + email: info@stackql.io + title: Databricks Repos API + description: Repos +servers: +- url: https://{deployment_name}.cloud.databricks.com + variables: + deployment_name: + description: The Databricks Workspace Deployment Name + default: dbc-abcd0123-a1bc +paths: + /api/2.0/git-credentials: + post: + operationId: git-credentials-create + externalDocs: + url: https://docs.databricks.com/api/workspace/gitcredentials/create + x-stackQL-resource: git_credentials + x-stackQL-method: create + x-stackQL-verb: insert + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + credential_id: + type: string + git_provider: + type: string + git_username: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + git_provider: + type: required + git_username: + type: string + personal_access_token: + type: string + example: + git_provider: gitHub + git_username: testuser + personal_access_token: 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 + description: Creates a Git credential entry for the user. Only one Git credential + per user is supported, so any attempts to create credentials if an entry already + exists will fail. Use the PATCH endpoint to update existing credentials, or + the DELETE endpoint to delete existing credentials. + get: + operationId: git-credentials-list + externalDocs: + url: https://docs.databricks.com/api/workspace/gitcredentials/list + x-stackQL-resource: git_credentials + x-stackQL-method: list + x-stackQL-verb: select + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + credentials: + type: array + items: + type: object + properties: + credential_id: + type: string + git_provider: + type: string + git_username: + type: string + '401': + description: The request does not have valid authentication credentials + for the operation. + '500': + description: Internal error. + x-stackQL-objectKey: $.credentials + description: Lists the calling user's Git credentials. One credential per user + is supported. + /api/2.0/git-credentials/{credential_id}: + delete: + operationId: git-credentials-delete + externalDocs: + url: https://docs.databricks.com/api/workspace/gitcredentials/delete + x-stackQL-resource: git_credentials + x-stackQL-method: delete + x-stackQL-verb: delete + x-numReqParams: 1 + parameters: + - name: credential_id + required: true + description: int64 + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: {} + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Deletes the specified Git credential. + get: + operationId: git-credentials-get + externalDocs: + url: https://docs.databricks.com/api/workspace/gitcredentials/get + x-stackQL-resource: git_credentials + x-stackQL-method: get + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: credential_id + required: true + description: int64 + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + credential_id: + type: string + git_provider: + type: string + git_username: + type: string + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Gets the Git credential with the specified credential ID. + patch: + operationId: git-credentials-update + externalDocs: + url: https://docs.databricks.com/api/workspace/gitcredentials/update + x-stackQL-resource: git_credentials + x-stackQL-method: update + x-stackQL-verb: update + x-numReqParams: 1 + parameters: + - name: credential_id + required: true + description: int64 + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + personal_access_token: + type: string + git_provider: + type: required + git_username: + type: string + example: + git_provider: gitHub + git_username: testuser + id: '93488329053511' + personal_access_token: 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 + description: Updates the specified Git credential. + /api/2.0/permissions/repos/{repo_id}: + get: + operationId: permissions-getpermissions + externalDocs: + url: https://docs.databricks.com/api/workspace/repos/getpermissions + x-stackQL-resource: permissions + x-stackQL-method: getpermissions + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: repo_id + required: true + description: string + in: path + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + object_id: + type: string + object_type: + type: string + access_control_list: + type: array + items: + type: object + properties: + user_name: + type: string + group_name: + type: string + service_principal_name: + type: string + display_name: + type: string + all_permissions: + type: array + items: + type: object + properties: + permission_level: + type: string + inherited: + type: boolean + inherited_from_object: + type: array + items: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Gets the permissions of a repo. Repos can inherit permissions from + their root object. + put: + operationId: permissions-setpermissions + externalDocs: + url: https://docs.databricks.com/api/workspace/repos/setpermissions + x-stackQL-resource: permissions + x-stackQL-method: setpermissions + x-stackQL-verb: replace + x-numReqParams: 1 + parameters: + - name: repo_id + required: true + description: string + in: path + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + object_id: + type: string + object_type: + type: string + access_control_list: + type: array + items: + type: object + properties: + user_name: + type: string + group_name: + type: string + service_principal_name: + type: string + display_name: + type: string + all_permissions: + type: array + items: + type: object + properties: + permission_level: + type: string + inherited: + type: boolean + inherited_from_object: + type: array + items: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + access_control_list: + type: Array of object + example: + access_control_list: + - user_name: string + group_name: string + service_principal_name: string + permission_level: CAN_MANAGE + description: Sets permissions on an object, replacing existing permissions if + they exist. Deletes all direct permissions if none are specified. Objects + can inherit permissions from their root object. + patch: + operationId: permissions-updatepermissions + externalDocs: + url: https://docs.databricks.com/api/workspace/repos/updatepermissions + x-stackQL-resource: permissions + x-stackQL-method: updatepermissions + x-stackQL-verb: update + x-numReqParams: 1 + parameters: + - name: repo_id + required: true + description: string + in: path + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + object_id: + type: string + object_type: + type: string + access_control_list: + type: array + items: + type: object + properties: + user_name: + type: string + group_name: + type: string + service_principal_name: + type: string + display_name: + type: string + all_permissions: + type: array + items: + type: object + properties: + permission_level: + type: string + inherited: + type: boolean + inherited_from_object: + type: array + items: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + access_control_list: + type: Array of object + example: + access_control_list: + - user_name: string + group_name: string + service_principal_name: string + permission_level: CAN_MANAGE + description: Updates the permissions on a repo. Repos can inherit permissions + from their root object. + /api/2.0/permissions/repos/{repo_id}/permissionLevels: + get: + operationId: permission-levels-getpermissionlevels + externalDocs: + url: https://docs.databricks.com/api/workspace/repos/getpermissionlevels + x-stackQL-resource: permission_levels + x-stackQL-method: getpermissionlevels + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: repo_id + required: true + description: string + in: path + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + permission_levels: + type: array + items: + type: object + properties: + permission_level: + type: string + description: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + x-stackQL-objectKey: $.permission_levels + description: Gets the permission levels that a user can have on an object. + /api/2.0/repos: + post: + operationId: repos-create + externalDocs: + url: https://docs.databricks.com/api/workspace/repos/create + x-stackQL-resource: repos + x-stackQL-method: create + x-stackQL-verb: insert + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + branch: + type: string + head_commit_id: + type: string + id: + type: string + path: + type: string + provider: + type: string + sparse_checkout: + type: object + properties: + patterns: + type: array + items: + type: string + url: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + url: + type: required + provider: + type: string + path: + type: required + sparse_checkout: + type: object + example: + branch: main + path: /Users/user@company.com/clitest + provider: gitHub + sparse_checkout: + patterns: + - parent-folder/child-folder + - src + - test + url: https://github.com/databricks/cli.git + description: Creates a repo in the workspace and links it to the remote Git + repo specified. Note that repos created programmatically must be linked to + a remote Git repo, unlike repos created in the browser. + get: + operationId: repos-list + externalDocs: + url: https://docs.databricks.com/api/workspace/repos/list + x-stackQL-resource: repos + x-stackQL-method: list + x-stackQL-verb: select + x-numReqParams: 0 + parameters: + - name: path_prefix + in: query + - name: next_page_token + in: query + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + next_page_token: + type: string + repos: + type: array + items: + type: object + properties: + branch: + type: string + path: + type: string + provider: + type: string + sparse_checkout: + type: object + properties: + patterns: + type: array + items: + type: string + url: + type: string + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + x-stackQL-objectKey: $.repos + description: Returns repos that the calling user has Manage permissions on. + Use + /api/2.0/repos/{repo_id}: + delete: + operationId: repos-delete + externalDocs: + url: https://docs.databricks.com/api/workspace/repos/delete + x-stackQL-resource: repos + x-stackQL-method: delete + x-stackQL-verb: delete + x-numReqParams: 1 + parameters: + - name: repo_id + required: true + description: int64 + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: {} + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Deletes the specified repo. + get: + operationId: repos-get + externalDocs: + url: https://docs.databricks.com/api/workspace/repos/get + x-stackQL-resource: repos + x-stackQL-method: get + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: repo_id + required: true + description: int64 + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + branch: + type: string + head_commit_id: + type: string + id: + type: string + path: + type: string + provider: + type: string + url: + type: string + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Returns the repo with the given repo ID. + patch: + operationId: repos-update + externalDocs: + url: https://docs.databricks.com/api/workspace/repos/update + x-stackQL-resource: repos + x-stackQL-method: update + x-stackQL-verb: update + x-numReqParams: 1 + parameters: + - name: repo_id + required: true + description: int64 + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + branch: + type: string + tag: + type: string + sparse_checkout: + type: object + example: + branch: main + sparse_checkout: + patterns: + - parent-folder/child-folder + - src + - test + description: Updates the repo to a different branch or tag, or updates the repo + to the latest commit on the same branch. +components: + x-stackQL-resources: + git_credentials: + id: databricks_workspace.repos.git_credentials + name: git_credentials + title: Git_credentials + methods: + create: + operation: + $ref: '#/paths/~1api~12.0~1git-credentials/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1api~12.0~1git-credentials/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.credentials + delete: + operation: + $ref: '#/paths/~1api~12.0~1git-credentials~1{credential_id}/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1api~12.0~1git-credentials~1{credential_id}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: '#/paths/~1api~12.0~1git-credentials~1{credential_id}/patch' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/git_credentials/methods/get' + - $ref: '#/components/x-stackQL-resources/git_credentials/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/git_credentials/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/git_credentials/methods/update' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/git_credentials/methods/delete' + exec: [] + permissions: + id: databricks_workspace.repos.permissions + name: permissions + title: Permissions + methods: + getpermissions: + operation: + $ref: '#/paths/~1api~12.0~1permissions~1repos~1{repo_id}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + setpermissions: + operation: + $ref: '#/paths/~1api~12.0~1permissions~1repos~1{repo_id}/put' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + updatepermissions: + operation: + $ref: '#/paths/~1api~12.0~1permissions~1repos~1{repo_id}/patch' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/permissions/methods/getpermissions' + insert: [] + update: + - $ref: '#/components/x-stackQL-resources/permissions/methods/updatepermissions' + replace: + - $ref: '#/components/x-stackQL-resources/permissions/methods/setpermissions' + delete: [] + exec: [] + permission_levels: + id: databricks_workspace.repos.permission_levels + name: permission_levels + title: Permission_levels + methods: + getpermissionlevels: + operation: + $ref: '#/paths/~1api~12.0~1permissions~1repos~1{repo_id}~1permissionLevels/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.permission_levels + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/permission_levels/methods/getpermissionlevels' + insert: [] + update: [] + replace: [] + delete: [] + exec: [] + repos: + id: databricks_workspace.repos.repos + name: repos + title: Repos + methods: + create: + operation: + $ref: '#/paths/~1api~12.0~1repos/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1api~12.0~1repos/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.repos + delete: + operation: + $ref: '#/paths/~1api~12.0~1repos~1{repo_id}/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1api~12.0~1repos~1{repo_id}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: '#/paths/~1api~12.0~1repos~1{repo_id}/patch' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/repos/methods/get' + - $ref: '#/components/x-stackQL-resources/repos/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/repos/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/repos/methods/update' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/repos/methods/delete' + exec: [] diff --git a/providers/src/databricks_workspace/v00.00.00000/services/secrets.yaml b/providers/src/databricks_workspace/v00.00.00000/services/secrets.yaml new file mode 100644 index 00000000..c0f5bfdd --- /dev/null +++ b/providers/src/databricks_workspace/v00.00.00000/services/secrets.yaml @@ -0,0 +1,618 @@ +openapi: 3.0.0 +info: + version: 2024-12-19-stackql-generated + contact: + name: StackQL Studios + url: https://stackql.io/ + email: info@stackql.io + title: Databricks Secrets API + description: Secrets +servers: +- url: https://{deployment_name}.cloud.databricks.com + variables: + deployment_name: + description: The Databricks Workspace Deployment Name + default: dbc-abcd0123-a1bc +paths: + /api/2.0/secrets/acls/delete: + post: + operationId: acls-deleteacl + externalDocs: + url: https://docs.databricks.com/api/workspace/secrets/deleteacl + x-stackQL-resource: acls + x-stackQL-method: deleteacl + x-stackQL-verb: delete + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: {} + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + scope: + type: required + principal: + type: string + example: + scope: my-secret-scope + principal: data-scientists + description: Deletes the given ACL on the given scope. + /api/2.0/secrets/acls/get: + get: + operationId: acls-getacl + externalDocs: + url: https://docs.databricks.com/api/workspace/secrets/getacl + x-stackQL-resource: acls + x-stackQL-method: getacl + x-stackQL-verb: select + x-numReqParams: 2 + parameters: + - name: scope + required: true + description: string + in: query + - name: principal + required: true + description: string + in: query + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + principal: + type: string + permission: + type: string + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Gets the details about the given ACL, such as the group and permission. + Users must have the + /api/2.0/secrets/acls/list: + get: + operationId: acls-listacls + externalDocs: + url: https://docs.databricks.com/api/workspace/secrets/listacls + x-stackQL-resource: acls + x-stackQL-method: listacls + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: scope + required: true + description: string + in: query + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + acls: + type: array + items: + type: object + properties: + principal: + type: string + permission: + type: string + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + x-stackQL-objectKey: $.acls + description: List the ACLs for a given secret scope. Users must have the + /api/2.0/secrets/acls/put: + post: + operationId: acls-putacl + externalDocs: + url: https://docs.databricks.com/api/workspace/secrets/putacl + x-stackQL-resource: acls + x-stackQL-method: putacl + x-stackQL-verb: replace + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + scope: + type: required + principal: + type: string + permission: + type: required + example: + scope: my-secret-scope + principal: data-scientists + permission: READ + description: Creates or overwrites the Access Control List (ACL) associated + with the given principal (user or group) on the specified scope point. + /api/2.0/secrets/scopes/create: + post: + operationId: scopes-createscope + externalDocs: + url: https://docs.databricks.com/api/workspace/secrets/createscope + x-stackQL-resource: scopes + x-stackQL-method: createscope + x-stackQL-verb: insert + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + scope: + type: required + initial_manage_principal: + type: string + scope_backend_type: + type: string + example: + scope: string + initial_manage_principal: string + scope_backend_type: DATABRICKS + description: The scope name must consist of alphanumeric characters, dashes, + underscores, and periods, and may not exceed 128 characters. + /api/2.0/secrets/scopes/delete: + post: + operationId: scopes-deletescope + externalDocs: + url: https://docs.databricks.com/api/workspace/secrets/deletescope + x-stackQL-resource: scopes + x-stackQL-method: deletescope + x-stackQL-verb: delete + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: {} + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + scope: + type: required + example: + scope: my-secret-scope + description: Deletes a secret scope. + /api/2.0/secrets/scopes/list: + get: + operationId: scopes-listscopes + externalDocs: + url: https://docs.databricks.com/api/workspace/secrets/listscopes + x-stackQL-resource: scopes + x-stackQL-method: listscopes + x-stackQL-verb: select + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + scopes: + type: array + items: + type: object + properties: + name: + type: string + backend_type: + type: string + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '500': + description: Internal error. + x-stackQL-objectKey: $.scopes + description: Lists all secret scopes available in the workspace. + /api/2.0/secrets/delete: + post: + operationId: secrets-deletesecret + externalDocs: + url: https://docs.databricks.com/api/workspace/secrets/deletesecret + x-stackQL-resource: secrets + x-stackQL-method: deletesecret + x-stackQL-verb: delete + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: {} + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + scope: + type: required + key: + type: string + example: + scope: my-secret-scope + key: my-secret-key + description: Deletes the secret stored in this secret scope. You must have + /api/2.0/secrets/get: + get: + operationId: secrets-getsecret + externalDocs: + url: https://docs.databricks.com/api/workspace/secrets/getsecret + x-stackQL-resource: secrets + x-stackQL-method: getsecret + x-stackQL-verb: select + x-numReqParams: 2 + parameters: + - name: scope + required: true + description: string + in: query + - name: key + required: true + description: string + in: query + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + key: + type: string + value: + type: string + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Gets the bytes representation of a secret value for the specified + scope and key. + /api/2.0/secrets/list: + get: + operationId: secrets-listsecrets + externalDocs: + url: https://docs.databricks.com/api/workspace/secrets/listsecrets + x-stackQL-resource: secrets + x-stackQL-method: listsecrets + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: scope + required: true + description: string + in: query + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + secrets: + type: array + items: + type: object + properties: + key: + type: string + last_updated_timestamp: + type: string + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + x-stackQL-objectKey: $.secrets + description: Lists the secret keys that are stored at this scope. This is a + metadata-only operation; secret data cannot be retrieved using this API. Users + need the READ permission to make this call. + /api/2.0/secrets/put: + post: + operationId: secrets-putsecret + externalDocs: + url: https://docs.databricks.com/api/workspace/secrets/putsecret + x-stackQL-resource: secrets + x-stackQL-method: putsecret + x-stackQL-verb: replace + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + scope: + type: required + key: + type: string + string_value: + type: required + bytes_value: + type: string + example: + scope: my-databricks-scope + key: my-string-key + string_value: foobar + description: Inserts a secret under the provided scope with the given name. If + a secret already exists with the same name, this command overwrites the existing + secret's value. The server encrypts the secret using the secret scope's encryption + settings before storing it. +components: + x-stackQL-resources: + acls: + id: databricks_workspace.secrets.acls + name: acls + title: Acls + methods: + deleteacl: + operation: + $ref: '#/paths/~1api~12.0~1secrets~1acls~1delete/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + getacl: + operation: + $ref: '#/paths/~1api~12.0~1secrets~1acls~1get/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + listacls: + operation: + $ref: '#/paths/~1api~12.0~1secrets~1acls~1list/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.acls + putacl: + operation: + $ref: '#/paths/~1api~12.0~1secrets~1acls~1put/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/acls/methods/listacls' + - $ref: '#/components/x-stackQL-resources/acls/methods/getacl' + insert: [] + update: [] + replace: + - $ref: '#/components/x-stackQL-resources/acls/methods/putacl' + delete: + - $ref: '#/components/x-stackQL-resources/acls/methods/deleteacl' + exec: [] + scopes: + id: databricks_workspace.secrets.scopes + name: scopes + title: Scopes + methods: + createscope: + operation: + $ref: '#/paths/~1api~12.0~1secrets~1scopes~1create/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + deletescope: + operation: + $ref: '#/paths/~1api~12.0~1secrets~1scopes~1delete/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + listscopes: + operation: + $ref: '#/paths/~1api~12.0~1secrets~1scopes~1list/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.scopes + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/scopes/methods/listscopes' + insert: + - $ref: '#/components/x-stackQL-resources/scopes/methods/createscope' + update: [] + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/scopes/methods/deletescope' + exec: [] + secrets: + id: databricks_workspace.secrets.secrets + name: secrets + title: Secrets + methods: + deletesecret: + operation: + $ref: '#/paths/~1api~12.0~1secrets~1delete/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + getsecret: + operation: + $ref: '#/paths/~1api~12.0~1secrets~1get/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + listsecrets: + operation: + $ref: '#/paths/~1api~12.0~1secrets~1list/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.secrets + putsecret: + operation: + $ref: '#/paths/~1api~12.0~1secrets~1put/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/secrets/methods/listsecrets' + - $ref: '#/components/x-stackQL-resources/secrets/methods/getsecret' + insert: [] + update: [] + replace: + - $ref: '#/components/x-stackQL-resources/secrets/methods/putsecret' + delete: + - $ref: '#/components/x-stackQL-resources/secrets/methods/deletesecret' + exec: [] diff --git a/providers/src/databricks_workspace/v00.00.00000/services/unitycatalog.yaml b/providers/src/databricks_workspace/v00.00.00000/services/unitycatalog.yaml new file mode 100644 index 00000000..4d3d6ef2 --- /dev/null +++ b/providers/src/databricks_workspace/v00.00.00000/services/unitycatalog.yaml @@ -0,0 +1,7945 @@ +openapi: 3.0.0 +info: + version: 2024-12-19-stackql-generated + contact: + name: StackQL Studios + url: https://stackql.io/ + email: info@stackql.io + title: Databricks Unitycatalog API + description: Unitycatalog +servers: +- url: https://{deployment_name}.cloud.databricks.com + variables: + deployment_name: + description: The Databricks Workspace Deployment Name + default: dbc-abcd0123-a1bc +paths: + /api/2.1/unity-catalog/artifact-allowlists/{artifact_type}: + get: + operationId: artifact-allow-lists-get + externalDocs: + url: https://docs.databricks.com/api/workspace/artifactallowlists/get + x-stackQL-resource: artifact_allow_lists + x-stackQL-method: get + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: artifact_type + required: true + description: string + in: path + responses: + '200': + description: The artifact allowlist was successfully retrieved. + content: + application/json: + schema: + type: object + properties: + artifact_matchers: + type: array + items: + type: object + properties: + artifact: + type: string + match_type: + type: string + metastore_id: + type: string + created_by: + type: string + created_at: + type: integer + description: Get the artifact allowlist of a certain artifact type. The caller + must be a metastore admin or have the + put: + operationId: artifact-allow-lists-update + externalDocs: + url: https://docs.databricks.com/api/workspace/artifactallowlists/update + x-stackQL-resource: artifact_allow_lists + x-stackQL-method: update + x-stackQL-verb: update + x-numReqParams: 1 + parameters: + - name: artifact_type + required: true + description: string + in: path + responses: + '200': + description: The artifact allowlist of a certain artifact type was updated + content: + application/json: + schema: + type: object + properties: + artifact_matchers: + type: array + items: + type: object + properties: + artifact: + type: string + match_type: + type: string + metastore_id: + type: string + created_by: + type: string + created_at: + type: integer + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + artifact_matchers: + type: required + example: + artifact_matchers: + - artifact: string + match_type: PREFIX_MATCH + description: Set the artifact allowlist of a certain artifact type. The whole + artifact allowlist is replaced with the new allowlist. The caller must be + a metastore admin or have the + /api/2.1/unity-catalog/catalogs: + post: + operationId: catalogs-create + externalDocs: + url: https://docs.databricks.com/api/workspace/catalogs/create + x-stackQL-resource: catalogs + x-stackQL-method: create + x-stackQL-verb: insert + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: The new catalog was successfully created. + content: + application/json: + schema: + type: object + properties: + name: + type: string + owner: + type: string + comment: + type: string + properties: + type: object + properties: + property1: + type: string + property2: + type: string + storage_root: + type: string + provider_name: + type: string + share_name: + type: string + enable_predictive_optimization: + type: string + metastore_id: + type: string + created_at: + type: integer + created_by: + type: string + updated_at: + type: integer + updated_by: + type: string + catalog_type: + type: string + storage_location: + type: string + effective_predictive_optimization_flag: + type: object + properties: + value: + type: string + inherited_from_type: + type: string + inherited_from_name: + type: string + isolation_mode: + type: string + connection_name: + type: string + options: + type: object + properties: + property1: + type: string + property2: + type: string + full_name: + type: string + securable_kind: + type: string + securable_type: + type: string + provisioning_info: + type: object + properties: + state: + type: string + browse_only: + type: boolean + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: required + comment: + type: string + storage_root: + type: string + provider_name: + type: string + share_name: + type: string + connection_name: + type: string + properties: + type: object + options: + type: object + example: + name: string + comment: string + properties: + property1: string + property2: string + storage_root: string + provider_name: string + share_name: string + connection_name: string + options: + property1: string + property2: string + description: Creates a new catalog instance in the parent metastore if the caller + is a metastore admin or has the + get: + operationId: catalogs-list + externalDocs: + url: https://docs.databricks.com/api/workspace/catalogs/list + x-stackQL-resource: catalogs + x-stackQL-method: list + x-stackQL-verb: select + x-numReqParams: 0 + parameters: + - name: include_browse + in: query + - name: max_results + in: query + - name: page_token + in: query + responses: + '200': + description: The catalog list was successfully retrieved. + content: + application/json: + schema: + type: object + properties: + catalogs: + type: array + items: + type: object + properties: + name: + type: string + owner: + type: string + comment: + type: string + properties: + type: object + properties: + property1: + type: string + property2: + type: string + storage_root: + type: string + provider_name: + type: string + share_name: + type: string + enable_predictive_optimization: + type: string + metastore_id: + type: string + created_at: + type: integer + created_by: + type: string + updated_at: + type: integer + updated_by: + type: string + catalog_type: + type: string + storage_location: + type: string + effective_predictive_optimization_flag: + type: object + properties: + value: + type: string + inherited_from_type: + type: string + inherited_from_name: + type: string + isolation_mode: + type: string + connection_name: + type: string + options: + type: object + properties: + property1: + type: string + property2: + type: string + full_name: + type: string + securable_kind: + type: string + securable_type: + type: string + provisioning_info: + type: object + properties: + state: + type: string + browse_only: + type: boolean + next_page_token: + type: string + x-stackQL-objectKey: $.catalogs + description: Gets an array of catalogs in the metastore. If the caller is the + metastore admin, all catalogs will be retrieved. Otherwise, only catalogs + owned by the caller (or for which the caller has the + /api/2.1/unity-catalog/catalogs/{name}: + delete: + operationId: catalogs-delete + externalDocs: + url: https://docs.databricks.com/api/workspace/catalogs/delete + x-stackQL-resource: catalogs + x-stackQL-method: delete + x-stackQL-verb: delete + x-numReqParams: 1 + parameters: + - name: name + required: true + description: string + in: path + - name: force + in: query + responses: + '200': + description: The catalog was successfully deleted. + content: + application/json: + schema: + type: object + properties: {} + description: Deletes the catalog that matches the supplied name. The caller + must be a metastore admin or the owner of the catalog. + get: + operationId: catalogs-get + externalDocs: + url: https://docs.databricks.com/api/workspace/catalogs/get + x-stackQL-resource: catalogs + x-stackQL-method: get + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: name + required: true + description: string + in: path + - name: include_browse + in: query + responses: + '200': + description: The catalog was successfully retrieved. + content: + application/json: + schema: + type: object + properties: + name: + type: string + owner: + type: string + comment: + type: string + properties: + type: object + properties: + property1: + type: string + property2: + type: string + storage_root: + type: string + provider_name: + type: string + share_name: + type: string + enable_predictive_optimization: + type: string + metastore_id: + type: string + created_at: + type: integer + created_by: + type: string + updated_at: + type: integer + updated_by: + type: string + catalog_type: + type: string + storage_location: + type: string + effective_predictive_optimization_flag: + type: object + properties: + value: + type: string + inherited_from_type: + type: string + inherited_from_name: + type: string + isolation_mode: + type: string + connection_name: + type: string + options: + type: object + properties: + property1: + type: string + property2: + type: string + full_name: + type: string + securable_kind: + type: string + securable_type: + type: string + provisioning_info: + type: object + properties: + state: + type: string + browse_only: + type: boolean + description: Gets the specified catalog in a metastore. The caller must be a + metastore admin, the owner of the catalog, or a user that has the + patch: + operationId: catalogs-update + externalDocs: + url: https://docs.databricks.com/api/workspace/catalogs/update + x-stackQL-resource: catalogs + x-stackQL-method: update + x-stackQL-verb: update + x-numReqParams: 1 + parameters: + - name: name + required: true + description: string + in: path + responses: + '200': + description: The catalog was successfully updated. + content: + application/json: + schema: + type: object + properties: + name: + type: string + owner: + type: string + comment: + type: string + properties: + type: object + properties: + property1: + type: string + property2: + type: string + storage_root: + type: string + provider_name: + type: string + share_name: + type: string + enable_predictive_optimization: + type: string + metastore_id: + type: string + created_at: + type: integer + created_by: + type: string + updated_at: + type: integer + updated_by: + type: string + catalog_type: + type: string + storage_location: + type: string + effective_predictive_optimization_flag: + type: object + properties: + value: + type: string + inherited_from_type: + type: string + inherited_from_name: + type: string + isolation_mode: + type: string + connection_name: + type: string + options: + type: object + properties: + property1: + type: string + property2: + type: string + full_name: + type: string + securable_kind: + type: string + securable_type: + type: string + provisioning_info: + type: object + properties: + state: + type: string + browse_only: + type: boolean + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + owner: + type: string + comment: + type: string + isolation_mode: + type: string + enable_predictive_optimization: + type: string + new_name: + type: string + properties: + type: object + example: + owner: string + comment: string + properties: + property1: string + property2: string + isolation_mode: OPEN + enable_predictive_optimization: DISABLE + new_name: string + description: Updates the catalog that matches the supplied name. The caller + must be either the owner of the catalog, or a metastore admin (when changing + the owner field of the catalog). + /api/2.1/unity-catalog/connections: + post: + operationId: connections-create + externalDocs: + url: https://docs.databricks.com/api/workspace/connections/create + x-stackQL-resource: connections + x-stackQL-method: create + x-stackQL-verb: insert + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: The connection was successfully created. + content: + application/json: + schema: + type: object + properties: + name: + type: string + connection_type: + type: string + options: + type: object + properties: + property1: + type: string + property2: + type: string + owner: + type: string + read_only: + type: boolean + comment: + type: string + properties: + type: object + properties: + property1: + type: string + property2: + type: string + full_name: + type: string + url: + type: string + credential_type: + type: string + connection_id: + type: string + metastore_id: + type: string + created_at: + type: integer + created_by: + type: string + updated_at: + type: integer + updated_by: + type: string + securable_kind: + type: string + securable_type: + type: string + provisioning_info: + type: object + properties: + state: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: required + connection_type: + type: string + read_only: + type: required + comment: + type: string + options: + type: required + properties: + type: object + example: + name: string + connection_type: MYSQL + options: + property1: string + property2: string + read_only: true + comment: string + properties: + property1: string + property2: string + description: Creates a new connection + get: + operationId: connections-list + externalDocs: + url: https://docs.databricks.com/api/workspace/connections/list + x-stackQL-resource: connections + x-stackQL-method: list + x-stackQL-verb: select + x-numReqParams: 0 + parameters: + - name: max_results + in: query + - name: page_token + in: query + responses: + '200': + description: The connection list was successfully retrieved. + content: + application/json: + schema: + type: object + properties: + connections: + type: array + items: + type: object + properties: + name: + type: string + connection_type: + type: string + options: + type: object + properties: + property1: + type: string + property2: + type: string + owner: + type: string + read_only: + type: boolean + comment: + type: string + properties: + type: object + properties: + property1: + type: string + property2: + type: string + full_name: + type: string + url: + type: string + credential_type: + type: string + connection_id: + type: string + metastore_id: + type: string + created_at: + type: integer + created_by: + type: string + updated_at: + type: integer + updated_by: + type: string + securable_kind: + type: string + securable_type: + type: string + provisioning_info: + type: object + properties: + state: + type: string + next_page_token: + type: string + x-stackQL-objectKey: $.connections + description: List all connections. + /api/2.1/unity-catalog/connections/{name}: + delete: + operationId: connections-delete + externalDocs: + url: https://docs.databricks.com/api/workspace/connections/delete + x-stackQL-resource: connections + x-stackQL-method: delete + x-stackQL-verb: delete + x-numReqParams: 1 + parameters: + - name: name + required: true + description: string + in: path + responses: + '200': + description: The connection was successfully deleted. + content: + application/json: + schema: + type: object + properties: {} + description: Deletes the connection that matches the supplied name. + get: + operationId: connections-get + externalDocs: + url: https://docs.databricks.com/api/workspace/connections/get + x-stackQL-resource: connections + x-stackQL-method: get + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: name + required: true + description: string + in: path + responses: + '200': + description: The connection was successfully retrieved. + content: + application/json: + schema: + type: object + properties: + name: + type: string + connection_type: + type: string + options: + type: object + properties: + property1: + type: string + property2: + type: string + owner: + type: string + read_only: + type: boolean + comment: + type: string + properties: + type: object + properties: + property1: + type: string + property2: + type: string + full_name: + type: string + url: + type: string + credential_type: + type: string + connection_id: + type: string + metastore_id: + type: string + created_at: + type: integer + created_by: + type: string + updated_at: + type: integer + updated_by: + type: string + securable_kind: + type: string + securable_type: + type: string + provisioning_info: + type: object + properties: + state: + type: string + description: Gets a connection from it's name. + patch: + operationId: connections-update + externalDocs: + url: https://docs.databricks.com/api/workspace/connections/update + x-stackQL-resource: connections + x-stackQL-method: update + x-stackQL-verb: update + x-numReqParams: 1 + parameters: + - name: name + required: true + description: string + in: path + responses: + '200': + description: The connection was successfully updated. + content: + application/json: + schema: + type: object + properties: + name: + type: string + connection_type: + type: string + options: + type: object + properties: + property1: + type: string + property2: + type: string + owner: + type: string + read_only: + type: boolean + comment: + type: string + properties: + type: object + properties: + property1: + type: string + property2: + type: string + full_name: + type: string + url: + type: string + credential_type: + type: string + connection_id: + type: string + metastore_id: + type: string + created_at: + type: integer + created_by: + type: string + updated_at: + type: integer + updated_by: + type: string + securable_kind: + type: string + securable_type: + type: string + provisioning_info: + type: object + properties: + state: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + owner: + type: string + new_name: + type: string + options: + type: required + example: + options: + property1: string + property2: string + owner: string + new_name: string + description: Updates the connection that matches the supplied name. + /api/2.1/unity-catalog/credentials: + post: + operationId: credentials-createcredential + externalDocs: + url: https://docs.databricks.com/api/workspace/credentials/createcredential + x-stackQL-resource: credentials + x-stackQL-method: createcredential + x-stackQL-verb: insert + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + name: + type: string + aws_iam_role: + type: object + properties: + role_arn: + type: string + unity_catalog_iam_arn: + type: string + external_id: + type: string + comment: + type: string + read_only: + type: boolean + purpose: + type: string + owner: + type: string + id: + type: string + metastore_id: + type: string + created_at: + type: integer + created_by: + type: string + updated_at: + type: integer + updated_by: + type: string + used_for_managed_storage: + type: boolean + full_name: + type: string + isolation_mode: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: required + comment: + type: string + read_only: + type: string + purpose: + type: boolean + skip_validation: + type: string + aws_iam_role: + type: object + example: + name: string + aws_iam_role: + role_arn: string + unity_catalog_iam_arn: string + external_id: string + comment: string + read_only: true + purpose: STORAGE + skip_validation: false + description: Creates a new credential. The type of credential to be created + is determined by the + get: + operationId: credentials-listcredentials + externalDocs: + url: https://docs.databricks.com/api/workspace/credentials/listcredentials + x-stackQL-resource: credentials + x-stackQL-method: listcredentials + x-stackQL-verb: select + x-numReqParams: 0 + parameters: + - name: max_results + in: query + - name: page_token + in: query + - name: purpose + in: query + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + credentials: + type: array + items: + type: object + properties: + name: + type: string + aws_iam_role: + type: object + properties: + role_arn: + type: string + unity_catalog_iam_arn: + type: string + external_id: + type: string + comment: + type: string + read_only: + type: boolean + purpose: + type: string + owner: + type: string + id: + type: string + metastore_id: + type: string + created_at: + type: integer + created_by: + type: string + updated_at: + type: integer + updated_by: + type: string + used_for_managed_storage: + type: boolean + full_name: + type: string + isolation_mode: + type: string + next_page_token: + type: string + x-stackQL-objectKey: $.credentials + description: Gets an array of credentials (as + /api/2.1/unity-catalog/credentials/{name_arg}: + delete: + operationId: credentials-deletecredential + externalDocs: + url: https://docs.databricks.com/api/workspace/credentials/deletecredential + x-stackQL-resource: credentials + x-stackQL-method: deletecredential + x-stackQL-verb: delete + x-numReqParams: 1 + parameters: + - name: name_arg + required: true + description: string + in: path + - name: force + in: query + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: {} + description: Deletes a service or storage credential from the metastore. The + caller must be an owner of the credential. + get: + operationId: credentials-getcredential + externalDocs: + url: https://docs.databricks.com/api/workspace/credentials/getcredential + x-stackQL-resource: credentials + x-stackQL-method: getcredential + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: name_arg + required: true + description: string + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + name: + type: string + aws_iam_role: + type: object + properties: + role_arn: + type: string + unity_catalog_iam_arn: + type: string + external_id: + type: string + comment: + type: string + read_only: + type: boolean + purpose: + type: string + owner: + type: string + id: + type: string + metastore_id: + type: string + created_at: + type: integer + created_by: + type: string + updated_at: + type: integer + updated_by: + type: string + used_for_managed_storage: + type: boolean + full_name: + type: string + isolation_mode: + type: string + description: Gets a service or storage credential from the metastore. The caller + must be a metastore admin, the owner of the credential, or have any permission + on the credential. + patch: + operationId: credentials-updatecredential + externalDocs: + url: https://docs.databricks.com/api/workspace/credentials/updatecredential + x-stackQL-resource: credentials + x-stackQL-method: updatecredential + x-stackQL-verb: update + x-numReqParams: 1 + parameters: + - name: name_arg + required: true + description: string + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + name: + type: string + aws_iam_role: + type: object + properties: + role_arn: + type: string + unity_catalog_iam_arn: + type: string + external_id: + type: string + comment: + type: string + read_only: + type: boolean + purpose: + type: string + owner: + type: string + id: + type: string + metastore_id: + type: string + created_at: + type: integer + created_by: + type: string + updated_at: + type: integer + updated_by: + type: string + used_for_managed_storage: + type: boolean + full_name: + type: string + isolation_mode: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + new_name: + type: string + comment: + type: string + read_only: + type: boolean + owner: + type: string + isolation_mode: + type: string + skip_validation: + type: boolean + force: + type: boolean + aws_iam_role: + type: object + example: + new_name: string + aws_iam_role: + role_arn: string + unity_catalog_iam_arn: string + external_id: string + comment: string + read_only: true + owner: string + isolation_mode: ISOLATION_MODE_OPEN + skip_validation: true + force: true + description: Updates a service or storage credential on the metastore. + /api/2.1/unity-catalog/temporary-service-credentials: + post: + operationId: credentials-generatetemporaryservicecredential + externalDocs: + url: https://docs.databricks.com/api/workspace/credentials/generatetemporaryservicecredential + x-stackQL-resource: credentials + x-stackQL-method: generatetemporaryservicecredential + x-stackQL-verb: select + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + aws_temp_credentials: + type: object + properties: + access_key_id: + type: string + secret_access_key: + type: string + session_token: + type: string + access_point: + type: string + expiration_time: + type: integer + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + credential_name: + type: required + example: + credential_name: string + description: Returns a set of temporary credentials generated using the specified + service credential. The caller must be a metastore admin or have the metastore + privilege + /api/2.1/unity-catalog/validate-credentials: + post: + operationId: credential-validation-validatecredential + externalDocs: + url: https://docs.databricks.com/api/workspace/credentials/validatecredential + x-stackQL-resource: credential_validation + x-stackQL-method: validatecredential + x-stackQL-verb: select + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + results: + type: array + items: + type: object + properties: + result: + type: string + message: + type: string + isDir: + type: boolean + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + credential_name: + type: string + purpose: + type: string + external_location_name: + type: string + url: + type: string + read_only: + type: boolean + aws_iam_role: + type: object + example: + credential_name: string + aws_iam_role: + role_arn: string + unity_catalog_iam_arn: string + external_id: string + purpose: STORAGE + external_location_name: string + url: string + read_only: true + description: Validates a credential. + /api/2.1/unity-catalog/effective-permissions/{securable_type}/{full_name}: + get: + operationId: effective-grants-geteffective + externalDocs: + url: https://docs.databricks.com/api/workspace/grants/geteffective + x-stackQL-resource: effective_grants + x-stackQL-method: geteffective + x-stackQL-verb: select + x-numReqParams: 2 + parameters: + - name: securable_type + required: true + description: string + in: path + - name: full_name + required: true + description: string + in: path + - name: principal + in: query + responses: + '200': + description: The effective permissions list for securable was successfully + retrieved. + content: + application/json: + schema: + type: object + properties: + privilege_assignments: + type: array + items: + type: object + properties: + principal: + type: string + privileges: + type: array + items: + type: object + properties: + privilege: + type: string + inherited_from_type: + type: string + inherited_from_name: + type: string + x-stackQL-objectKey: $.privilege_assignments + description: Gets the effective permissions for a securable. + /api/2.1/unity-catalog/external-locations: + post: + operationId: external-locations-create + externalDocs: + url: https://docs.databricks.com/api/workspace/externallocations/create + x-stackQL-resource: external_locations + x-stackQL-method: create + x-stackQL-verb: insert + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: The new external location was successfully created. + content: + application/json: + schema: + type: object + properties: + name: + type: string + url: + type: string + credential_name: + type: string + read_only: + type: boolean + comment: + type: string + owner: + type: string + access_point: + type: string + metastore_id: + type: string + credential_id: + type: string + created_at: + type: integer + created_by: + type: string + updated_at: + type: integer + updated_by: + type: string + browse_only: + type: boolean + isolation_mode: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: required + url: + type: string + credential_name: + type: required + read_only: + type: string + comment: + type: required + access_point: + type: string + skip_validation: + type: boolean + example: + name: string + url: string + credential_name: string + read_only: true + comment: string + access_point: string + skip_validation: true + description: Creates a new external location entry in the metastore. The caller + must be a metastore admin or have the + get: + operationId: external-locations-list + externalDocs: + url: https://docs.databricks.com/api/workspace/externallocations/list + x-stackQL-resource: external_locations + x-stackQL-method: list + x-stackQL-verb: select + x-numReqParams: 0 + parameters: + - name: max_results + in: query + - name: page_token + in: query + - name: include_browse + in: query + responses: + '200': + description: The external location list was successfully retrieved. + content: + application/json: + schema: + type: object + properties: + external_locations: + type: array + items: + type: object + properties: + name: + type: string + url: + type: string + credential_name: + type: string + read_only: + type: boolean + comment: + type: string + owner: + type: string + access_point: + type: string + metastore_id: + type: string + credential_id: + type: string + created_at: + type: integer + created_by: + type: string + updated_at: + type: integer + updated_by: + type: string + browse_only: + type: boolean + isolation_mode: + type: string + next_page_token: + type: string + x-stackQL-objectKey: $.external_locations + description: Gets an array of external locations ( + /api/2.1/unity-catalog/external-locations/{name}: + delete: + operationId: external-locations-delete + externalDocs: + url: https://docs.databricks.com/api/workspace/externallocations/delete + x-stackQL-resource: external_locations + x-stackQL-method: delete + x-stackQL-verb: delete + x-numReqParams: 1 + parameters: + - name: name + required: true + description: string + in: path + - name: force + in: query + responses: + '200': + description: The external location was successfully deleted. + content: + application/json: + schema: + type: object + properties: {} + description: Deletes the specified external location from the metastore. The + caller must be the owner of the external location. + get: + operationId: external-locations-get + externalDocs: + url: https://docs.databricks.com/api/workspace/externallocations/get + x-stackQL-resource: external_locations + x-stackQL-method: get + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: name + required: true + description: string + in: path + - name: include_browse + in: query + responses: + '200': + description: The external location was successfully retrieved. + content: + application/json: + schema: + type: object + properties: + name: + type: string + url: + type: string + credential_name: + type: string + read_only: + type: boolean + comment: + type: string + owner: + type: string + access_point: + type: string + metastore_id: + type: string + credential_id: + type: string + created_at: + type: integer + created_by: + type: string + updated_at: + type: integer + updated_by: + type: string + browse_only: + type: boolean + isolation_mode: + type: string + description: Gets an external location from the metastore. The caller must be + either a metastore admin, the owner of the external location, or a user that + has some privilege on the external location. + patch: + operationId: external-locations-update + externalDocs: + url: https://docs.databricks.com/api/workspace/externallocations/update + x-stackQL-resource: external_locations + x-stackQL-method: update + x-stackQL-verb: update + x-numReqParams: 1 + parameters: + - name: name + required: true + description: string + in: path + responses: + '200': + description: The external location was successfully updated. + content: + application/json: + schema: + type: object + properties: + name: + type: string + url: + type: string + credential_name: + type: string + read_only: + type: boolean + comment: + type: string + owner: + type: string + access_point: + type: string + metastore_id: + type: string + credential_id: + type: string + created_at: + type: integer + created_by: + type: string + updated_at: + type: integer + updated_by: + type: string + browse_only: + type: boolean + isolation_mode: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + url: + type: string + credential_name: + type: string + read_only: + type: boolean + comment: + type: string + owner: + type: string + access_point: + type: string + isolation_mode: + type: string + new_name: + type: string + force: + type: boolean + skip_validation: + type: boolean + example: + url: string + credential_name: string + read_only: true + comment: string + owner: string + access_point: string + isolation_mode: ISOLATION_MODE_OPEN + new_name: string + force: true + skip_validation: true + description: Updates an external location in the metastore. The caller must + be the owner of the external location, or be a metastore admin. In the second + case, the admin can only update the name of the external location. + /api/2.1/unity-catalog/functions: + post: + operationId: functions-create + externalDocs: + url: https://docs.databricks.com/api/workspace/functions/create + x-stackQL-resource: functions + x-stackQL-method: create + x-stackQL-verb: insert + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: The new function was successfully created. + content: + application/json: + schema: + type: object + properties: + name: + type: string + catalog_name: + type: string + schema_name: + type: string + input_params: + type: object + properties: + parameters: + type: array + items: + type: object + properties: + name: + type: string + type_text: + type: string + type_json: + type: string + type_name: + type: string + type_precision: + type: integer + type_scale: + type: integer + type_interval_type: + type: string + position: + type: integer + parameter_mode: + type: string + parameter_type: + type: string + parameter_default: + type: string + comment: + type: string + data_type: + type: string + full_data_type: + type: string + return_params: + type: object + properties: + parameters: + type: array + items: + type: object + properties: + name: + type: string + type_text: + type: string + type_json: + type: string + type_name: + type: string + type_precision: + type: integer + type_scale: + type: integer + type_interval_type: + type: string + position: + type: integer + parameter_mode: + type: string + parameter_type: + type: string + parameter_default: + type: string + comment: + type: string + routine_body: + type: string + routine_definition: + type: string + routine_dependencies: + type: object + properties: + dependencies: + type: array + items: + type: object + properties: + table: + type: object + properties: + table_full_name: + type: string + function: + type: object + properties: + function_full_name: + type: string + parameter_style: + type: string + is_deterministic: + type: boolean + sql_data_access: + type: string + is_null_call: + type: boolean + security_type: + type: string + specific_name: + type: string + external_name: + type: string + external_language: + type: string + sql_path: + type: string + owner: + type: string + comment: + type: string + properties: + type: string + metastore_id: + type: string + full_name: + type: string + created_at: + type: integer + created_by: + type: string + updated_at: + type: integer + updated_by: + type: string + function_id: + type: string + browse_only: + type: boolean + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + function_info: + type: object + example: + function_info: + name: string + catalog_name: string + schema_name: string + input_params: + parameters: + - name: string + type_text: string + type_json: string + type_name: BOOLEAN + type_precision: 0 + type_scale: 0 + type_interval_type: string + position: 0 + parameter_mode: IN + parameter_type: PARAM + parameter_default: string + comment: string + data_type: BOOLEAN + full_data_type: string + return_params: + parameters: + - name: string + type_text: string + type_json: string + type_name: BOOLEAN + type_precision: 0 + type_scale: 0 + type_interval_type: string + position: 0 + parameter_mode: IN + parameter_type: PARAM + parameter_default: string + comment: string + routine_definition: string + routine_dependencies: + dependencies: + - table: + table_full_name: string + function: + function_full_name: string + is_deterministic: true + is_null_call: true + specific_name: string + external_name: string + external_language: string + sql_path: string + comment: string + properties: string + routine_body: SQL + security_type: DEFINER + sql_data_access: CONTAINS_SQL + parameter_style: S + get: + operationId: functions-list + externalDocs: + url: https://docs.databricks.com/api/workspace/functions/list + x-stackQL-resource: functions + x-stackQL-method: list + x-stackQL-verb: select + x-numReqParams: 2 + parameters: + - name: catalog_name + required: true + description: string + in: query + - name: schema_name + required: true + description: string + in: query + - name: max_results + in: query + - name: page_token + in: query + - name: include_browse + in: query + responses: + '200': + description: The function list was successfully retrieved. + content: + application/json: + schema: + type: object + properties: + functions: + type: array + items: + type: object + properties: + name: + type: string + catalog_name: + type: string + schema_name: + type: string + input_params: + type: object + properties: + parameters: + type: array + items: + type: object + properties: + name: + type: string + type_text: + type: string + type_json: + type: string + type_name: + type: string + type_precision: + type: integer + type_scale: + type: integer + type_interval_type: + type: string + position: + type: integer + parameter_mode: + type: string + parameter_type: + type: string + parameter_default: + type: string + comment: + type: string + data_type: + type: string + full_data_type: + type: string + return_params: + type: object + properties: + parameters: + type: array + items: + type: object + properties: + name: + type: string + type_text: + type: string + type_json: + type: string + type_name: + type: string + type_precision: + type: integer + type_scale: + type: integer + type_interval_type: + type: string + position: + type: integer + parameter_mode: + type: string + parameter_type: + type: string + parameter_default: + type: string + comment: + type: string + routine_body: + type: string + routine_definition: + type: string + routine_dependencies: + type: object + properties: + dependencies: + type: array + items: + type: object + properties: + table: + type: object + properties: + table_full_name: + type: string + function: + type: object + properties: + function_full_name: + type: string + parameter_style: + type: string + is_deterministic: + type: boolean + sql_data_access: + type: string + is_null_call: + type: boolean + security_type: + type: string + specific_name: + type: string + external_name: + type: string + external_language: + type: string + sql_path: + type: string + owner: + type: string + comment: + type: string + properties: + type: string + metastore_id: + type: string + full_name: + type: string + created_at: + type: integer + created_by: + type: string + updated_at: + type: integer + updated_by: + type: string + function_id: + type: string + browse_only: + type: boolean + next_page_token: + type: string + x-stackQL-objectKey: $.functions + description: List functions within the specified parent catalog and schema. + If the user is a metastore admin, all functions are returned in the output + list. Otherwise, the user must have the + /api/2.1/unity-catalog/functions/{name}: + delete: + operationId: functions-delete + externalDocs: + url: https://docs.databricks.com/api/workspace/functions/delete + x-stackQL-resource: functions + x-stackQL-method: delete + x-stackQL-verb: delete + x-numReqParams: 1 + parameters: + - name: name + required: true + description: string + in: path + - name: force + in: query + responses: + '200': + description: The function was successfully deleted. + content: + application/json: + schema: + type: object + properties: {} + description: 'Deletes the function that matches the supplied name. For the deletion + to succeed, the user must satisfy one of the following conditions:' + get: + operationId: functions-get + externalDocs: + url: https://docs.databricks.com/api/workspace/functions/get + x-stackQL-resource: functions + x-stackQL-method: get + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: name + required: true + description: string + in: path + - name: include_browse + in: query + responses: + '200': + description: The function was successfully retrieved. + content: + application/json: + schema: + type: object + properties: + name: + type: string + catalog_name: + type: string + schema_name: + type: string + input_params: + type: object + properties: + parameters: + type: array + items: + type: object + properties: + name: + type: string + type_text: + type: string + type_json: + type: string + type_name: + type: string + type_precision: + type: integer + type_scale: + type: integer + type_interval_type: + type: string + position: + type: integer + parameter_mode: + type: string + parameter_type: + type: string + parameter_default: + type: string + comment: + type: string + data_type: + type: string + full_data_type: + type: string + return_params: + type: object + properties: + parameters: + type: array + items: + type: object + properties: + name: + type: string + type_text: + type: string + type_json: + type: string + type_name: + type: string + type_precision: + type: integer + type_scale: + type: integer + type_interval_type: + type: string + position: + type: integer + parameter_mode: + type: string + parameter_type: + type: string + parameter_default: + type: string + comment: + type: string + routine_body: + type: string + routine_definition: + type: string + routine_dependencies: + type: object + properties: + dependencies: + type: array + items: + type: object + properties: + table: + type: object + properties: + table_full_name: + type: string + function: + type: object + properties: + function_full_name: + type: string + parameter_style: + type: string + is_deterministic: + type: boolean + sql_data_access: + type: string + is_null_call: + type: boolean + security_type: + type: string + specific_name: + type: string + external_name: + type: string + external_language: + type: string + sql_path: + type: string + owner: + type: string + comment: + type: string + properties: + type: string + metastore_id: + type: string + full_name: + type: string + created_at: + type: integer + created_by: + type: string + updated_at: + type: integer + updated_by: + type: string + function_id: + type: string + browse_only: + type: boolean + description: 'Gets a function from within a parent catalog and schema. For the + fetch to succeed, the user must satisfy one of the following requirements:' + patch: + operationId: functions-update + externalDocs: + url: https://docs.databricks.com/api/workspace/functions/update + x-stackQL-resource: functions + x-stackQL-method: update + x-stackQL-verb: update + x-numReqParams: 1 + parameters: + - name: name + required: true + description: string + in: path + responses: + '200': + description: The function was successfully updated. + content: + application/json: + schema: + type: object + properties: + name: + type: string + catalog_name: + type: string + schema_name: + type: string + input_params: + type: object + properties: + parameters: + type: array + items: + type: object + properties: + name: + type: string + type_text: + type: string + type_json: + type: string + type_name: + type: string + type_precision: + type: integer + type_scale: + type: integer + type_interval_type: + type: string + position: + type: integer + parameter_mode: + type: string + parameter_type: + type: string + parameter_default: + type: string + comment: + type: string + data_type: + type: string + full_data_type: + type: string + return_params: + type: object + properties: + parameters: + type: array + items: + type: object + properties: + name: + type: string + type_text: + type: string + type_json: + type: string + type_name: + type: string + type_precision: + type: integer + type_scale: + type: integer + type_interval_type: + type: string + position: + type: integer + parameter_mode: + type: string + parameter_type: + type: string + parameter_default: + type: string + comment: + type: string + routine_body: + type: string + routine_definition: + type: string + routine_dependencies: + type: object + properties: + dependencies: + type: array + items: + type: object + properties: + table: + type: object + properties: + table_full_name: + type: string + function: + type: object + properties: + function_full_name: + type: string + parameter_style: + type: string + is_deterministic: + type: boolean + sql_data_access: + type: string + is_null_call: + type: boolean + security_type: + type: string + specific_name: + type: string + external_name: + type: string + external_language: + type: string + sql_path: + type: string + owner: + type: string + comment: + type: string + properties: + type: string + metastore_id: + type: string + full_name: + type: string + created_at: + type: integer + created_by: + type: string + updated_at: + type: integer + updated_by: + type: string + function_id: + type: string + browse_only: + type: boolean + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + owner: + type: string + example: + owner: string + description: Updates the function that matches the supplied name. Only the owner + of the function can be updated. If the user is not a metastore admin, the + user must be a member of the group that is the new function owner. + /api/2.1/unity-catalog/permissions/{securable_type}/{full_name}: + get: + operationId: grants-get + externalDocs: + url: https://docs.databricks.com/api/workspace/grants/get + x-stackQL-resource: grants + x-stackQL-method: get + x-stackQL-verb: select + x-numReqParams: 2 + parameters: + - name: securable_type + required: true + description: string + in: path + - name: full_name + required: true + description: string + in: path + - name: principal + in: query + responses: + '200': + description: The permissions list for securable was successfully retrieved. + content: + application/json: + schema: + type: object + properties: + privilege_assignments: + type: array + items: + type: object + properties: + principal: + type: string + privileges: + type: array + items: + type: string + x-stackQL-objectKey: $.privilege_assignments + description: Gets the permissions for a securable. + patch: + operationId: grants-update + externalDocs: + url: https://docs.databricks.com/api/workspace/grants/update + x-stackQL-resource: grants + x-stackQL-method: update + x-stackQL-verb: update + x-numReqParams: 2 + parameters: + - name: securable_type + required: true + description: string + in: path + - name: full_name + required: true + description: string + in: path + responses: + '200': + description: The permissions list for securable was successfully updated. + content: + application/json: + schema: + type: object + properties: + privilege_assignments: + type: array + items: + type: object + properties: + principal: + type: string + privileges: + type: array + items: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + changes: + type: Array of object + example: + changes: + - principal: string + add: + - SELECT + remove: + - SELECT + description: Updates the permissions for a securable. + /api/2.1/unity-catalog/metastores: + post: + operationId: metastores-create + externalDocs: + url: https://docs.databricks.com/api/workspace/metastores/create + x-stackQL-resource: metastores + x-stackQL-method: create + x-stackQL-verb: insert + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: The new metastore was successfully created. + content: + application/json: + schema: + type: object + properties: + name: + type: string + storage_root: + type: string + default_data_access_config_id: + type: string + storage_root_credential_id: + type: string + delta_sharing_scope: + type: string + delta_sharing_recipient_token_lifetime_in_seconds: + type: integer + delta_sharing_organization_name: + type: string + owner: + type: string + privilege_model_version: + type: string + region: + type: string + metastore_id: + type: string + created_at: + type: integer + created_by: + type: string + updated_at: + type: integer + updated_by: + type: string + storage_root_credential_name: + type: string + cloud: + type: string + global_metastore_id: + type: string + external_access_enabled: + type: boolean + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: required + storage_root: + type: string + region: + type: string + example: + name: string + storage_root: string + region: string + description: Creates a new metastore based on a provided name and optional storage + root path. By default (if the + get: + operationId: metastores-list + externalDocs: + url: https://docs.databricks.com/api/workspace/metastores/list + x-stackQL-resource: metastores + x-stackQL-method: list + x-stackQL-verb: select + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: The metastore list was successfully retrieved. + content: + application/json: + schema: + type: object + properties: + metastores: + type: array + items: + type: object + properties: + name: + type: string + storage_root: + type: string + default_data_access_config_id: + type: string + storage_root_credential_id: + type: string + delta_sharing_scope: + type: string + delta_sharing_recipient_token_lifetime_in_seconds: + type: integer + delta_sharing_organization_name: + type: string + owner: + type: string + privilege_model_version: + type: string + region: + type: string + metastore_id: + type: string + created_at: + type: integer + created_by: + type: string + updated_at: + type: integer + updated_by: + type: string + storage_root_credential_name: + type: string + cloud: + type: string + global_metastore_id: + type: string + external_access_enabled: + type: boolean + x-stackQL-objectKey: $.metastores + description: Gets an array of the available metastores (as + /api/2.1/unity-catalog/metastores/{id}: + delete: + operationId: metastores-delete + externalDocs: + url: https://docs.databricks.com/api/workspace/metastores/delete + x-stackQL-resource: metastores + x-stackQL-method: delete + x-stackQL-verb: delete + x-numReqParams: 1 + parameters: + - name: id + required: true + description: string + in: path + - name: force + in: query + responses: + '200': + description: The metastore was successfully deleted. + content: + application/json: + schema: + type: object + properties: {} + description: Deletes a metastore. The caller must be a metastore admin. + get: + operationId: metastores-get + externalDocs: + url: https://docs.databricks.com/api/workspace/metastores/get + x-stackQL-resource: metastores + x-stackQL-method: get + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: id + required: true + description: string + in: path + responses: + '200': + description: The metastore was successfully retrieved. + content: + application/json: + schema: + type: object + properties: + name: + type: string + storage_root: + type: string + default_data_access_config_id: + type: string + storage_root_credential_id: + type: string + delta_sharing_scope: + type: string + delta_sharing_recipient_token_lifetime_in_seconds: + type: integer + delta_sharing_organization_name: + type: string + owner: + type: string + privilege_model_version: + type: string + region: + type: string + metastore_id: + type: string + created_at: + type: integer + created_by: + type: string + updated_at: + type: integer + updated_by: + type: string + storage_root_credential_name: + type: string + cloud: + type: string + global_metastore_id: + type: string + external_access_enabled: + type: boolean + description: Gets a metastore that matches the supplied ID. The caller must + be a metastore admin to retrieve this info. + patch: + operationId: metastores-update + externalDocs: + url: https://docs.databricks.com/api/workspace/metastores/update + x-stackQL-resource: metastores + x-stackQL-method: update + x-stackQL-verb: update + x-numReqParams: 1 + parameters: + - name: id + required: true + description: string + in: path + responses: + '200': + description: The metastore was successfully updated. + content: + application/json: + schema: + type: object + properties: + name: + type: string + storage_root: + type: string + default_data_access_config_id: + type: string + storage_root_credential_id: + type: string + delta_sharing_scope: + type: string + delta_sharing_recipient_token_lifetime_in_seconds: + type: integer + delta_sharing_organization_name: + type: string + owner: + type: string + privilege_model_version: + type: string + region: + type: string + metastore_id: + type: string + created_at: + type: integer + created_by: + type: string + updated_at: + type: integer + updated_by: + type: string + storage_root_credential_name: + type: string + cloud: + type: string + global_metastore_id: + type: string + external_access_enabled: + type: boolean + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + storage_root_credential_id: + type: string + delta_sharing_recipient_token_lifetime_in_seconds: + type: integer + format: int64 + delta_sharing_organization_name: + type: string + owner: + type: string + privilege_model_version: + type: string + new_name: + type: string + delta_sharing_scope: + type: string + example: + storage_root_credential_id: string + delta_sharing_recipient_token_lifetime_in_seconds: 0 + delta_sharing_organization_name: string + owner: string + privilege_model_version: string + new_name: string + delta_sharing_scope: INTERNAL + description: Updates information for a specific metastore. The caller must be + a metastore admin. If the + /api/2.1/unity-catalog/workspaces/{workspace_id}/metastore: + put: + operationId: metastore-assignments-assign + externalDocs: + url: https://docs.databricks.com/api/workspace/metastores/assign + x-stackQL-resource: metastore_assignments + x-stackQL-method: assign + x-stackQL-verb: insert + x-numReqParams: 1 + parameters: + - name: workspace_id + required: true + description: int64 + in: path + responses: + '200': + description: The metastore was successfully assigned. + content: + application/json: + schema: + type: object + properties: {} + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + metastore_id: + type: required + default_catalog_name: + type: string + example: + metastore_id: string + default_catalog_name: string + description: Creates a new metastore assignment. If an assignment for the same + delete: + operationId: metastore-assignments-unassign + externalDocs: + url: https://docs.databricks.com/api/workspace/metastores/unassign + x-stackQL-resource: metastore_assignments + x-stackQL-method: unassign + x-stackQL-verb: delete + x-numReqParams: 2 + parameters: + - name: workspace_id + required: true + description: int64 + in: path + - name: metastore_id + required: true + description: string + in: query + responses: + '200': + description: The metastore assignment was successfully deleted. + content: + application/json: + schema: + type: object + properties: {} + description: Deletes a metastore assignment. The caller must be an account administrator. + patch: + operationId: metastore-assignments-updateassignment + externalDocs: + url: https://docs.databricks.com/api/workspace/metastores/updateassignment + x-stackQL-resource: metastore_assignments + x-stackQL-method: updateassignment + x-stackQL-verb: update + x-numReqParams: 1 + parameters: + - name: workspace_id + required: true + description: int64 + in: path + responses: + '200': + description: The metastore assignment was successfully updated. + content: + application/json: + schema: + type: object + properties: {} + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + metastore_id: + type: string + default_catalog_name: + type: string + example: + metastore_id: string + default_catalog_name: string + description: Updates a metastore assignment. This operation can be used to update + /api/2.1/unity-catalog/current-metastore-assignment: + get: + operationId: metastore-assignments-current + externalDocs: + url: https://docs.databricks.com/api/workspace/metastores/current + x-stackQL-resource: metastore_assignments + x-stackQL-method: current + x-stackQL-verb: select + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: The metastore assignment was successfully retrieved. + content: + application/json: + schema: + type: object + properties: + metastore_id: + type: string + workspace_id: + type: integer + default_catalog_name: + type: string + description: Gets the metastore assignment for the workspace being accessed. + /api/2.1/unity-catalog/metastore_summary: + get: + operationId: metastore-summary-summary + externalDocs: + url: https://docs.databricks.com/api/workspace/metastores/summary + x-stackQL-resource: metastore_summary + x-stackQL-method: summary + x-stackQL-verb: select + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: The metastore summary was successfully retrieved. + content: + application/json: + schema: + type: object + properties: + metastore_id: + type: string + name: + type: string + default_data_access_config_id: + type: string + storage_root_credential_id: + type: string + cloud: + type: string + region: + type: string + global_metastore_id: + type: string + storage_root_credential_name: + type: string + privilege_model_version: + type: string + delta_sharing_recipient_token_lifetime_in_seconds: + type: integer + delta_sharing_organization_name: + type: string + storage_root: + type: string + owner: + type: string + created_at: + type: integer + created_by: + type: string + updated_at: + type: integer + updated_by: + type: string + external_access_enabled: + type: boolean + delta_sharing_scope: + type: string + description: Gets information about a metastore. This summary includes the storage + credential, the cloud vendor, the cloud region, and the global metastore ID. + /api/2.1/unity-catalog/models/{full_name}/versions/{version}: + delete: + operationId: model-versions-delete + externalDocs: + url: https://docs.databricks.com/api/workspace/modelversions/delete + x-stackQL-resource: model_versions + x-stackQL-method: delete + x-stackQL-verb: delete + x-numReqParams: 2 + parameters: + - name: full_name + required: true + description: string + in: path + - name: version + required: true + description: integer + in: path + responses: + '200': + description: Successfully deleted the model version + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Deletes a model version from the specified registered model. Any + aliases assigned to the model version will also be deleted. + get: + operationId: model-versions-get + externalDocs: + url: https://docs.databricks.com/api/workspace/modelversions/get + x-stackQL-resource: model_versions + x-stackQL-method: get + x-stackQL-verb: select + x-numReqParams: 2 + parameters: + - name: full_name + required: true + description: string + in: path + - name: version + required: true + description: integer + in: path + - name: include_browse + in: query + - name: include_aliases + in: query + responses: + '200': + description: Successfully retrieved the properties of the model version + content: + application/json: + schema: + type: object + properties: + model_name: + type: string + catalog_name: + type: string + schema_name: + type: string + comment: + type: string + source: + type: string + run_id: + type: string + run_workspace_id: + type: string + version: + type: integer + status: + type: string + id: + type: string + metastore_id: + type: string + created_at: + type: integer + created_by: + type: string + updated_at: + type: integer + updated_by: + type: string + storage_location: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Get a model version. + patch: + operationId: model-versions-update + externalDocs: + url: https://docs.databricks.com/api/workspace/modelversions/update + x-stackQL-resource: model_versions + x-stackQL-method: update + x-stackQL-verb: update + x-numReqParams: 2 + parameters: + - name: full_name + required: true + description: string + in: path + - name: version + required: true + description: integer + in: path + responses: + '200': + description: Successfully updated the properties of the model version + content: + application/json: + schema: + type: object + properties: + model_name: + type: string + catalog_name: + type: string + schema_name: + type: string + comment: + type: string + source: + type: string + run_id: + type: string + run_workspace_id: + type: string + version: + type: integer + status: + type: string + id: + type: string + metastore_id: + type: string + created_at: + type: integer + created_by: + type: string + updated_at: + type: integer + updated_by: + type: string + storage_location: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + comment: + type: string + example: + comment: This is my new model version comment + description: Updates the specified model version. + /api/2.1/unity-catalog/models/{full_name}/aliases/{alias}: + get: + operationId: model-versions-getbyalias + externalDocs: + url: https://docs.databricks.com/api/workspace/modelversions/getbyalias + x-stackQL-resource: model_versions + x-stackQL-method: getbyalias + x-stackQL-verb: select + x-numReqParams: 2 + parameters: + - name: full_name + required: true + description: string + in: path + - name: alias + required: true + description: string + in: path + - name: include_aliases + in: query + responses: + '200': + description: Successfully retrieved the properties of the model version + content: + application/json: + schema: + type: object + properties: + model_name: + type: string + catalog_name: + type: string + schema_name: + type: string + comment: + type: string + source: + type: string + run_id: + type: string + run_workspace_id: + type: string + version: + type: integer + status: + type: string + id: + type: string + metastore_id: + type: string + created_at: + type: integer + created_by: + type: string + updated_at: + type: integer + updated_by: + type: string + storage_location: + type: string + aliases: + type: array + items: + type: object + properties: + alias_name: + type: string + version_num: + type: integer + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Get a model version by alias. + delete: + operationId: registered-model-aliases-deletealias + externalDocs: + url: https://docs.databricks.com/api/workspace/registeredmodels/deletealias + x-stackQL-resource: registered_model_aliases + x-stackQL-method: deletealias + x-stackQL-verb: delete + x-numReqParams: 2 + parameters: + - name: full_name + required: true + description: string + in: path + - name: alias + required: true + description: string + in: path + responses: + '200': + description: Successfully deleted the registered model alias + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Deletes a registered model alias. + put: + operationId: registered-model-aliases-setalias + externalDocs: + url: https://docs.databricks.com/api/workspace/registeredmodels/setalias + x-stackQL-resource: registered_model_aliases + x-stackQL-method: setalias + x-stackQL-verb: replace + x-numReqParams: 2 + parameters: + - name: full_name + required: true + description: string + in: path + - name: alias + required: true + description: string + in: path + responses: + '200': + description: Successfully set the specified alias on the registered model + content: + application/json: + schema: + type: object + properties: + alias_name: + type: string + version_num: + type: integer + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + full_name: + type: required + alias: + type: string + version_num: + type: required + example: + version_num: 2 + description: Set an alias on the specified registered model. + /api/2.1/unity-catalog/models/{full_name}/versions: + get: + operationId: model-versions-list + externalDocs: + url: https://docs.databricks.com/api/workspace/modelversions/list + x-stackQL-resource: model_versions + x-stackQL-method: list + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: full_name + required: true + description: string + in: path + - name: max_results + in: query + - name: page_token + in: query + - name: include_browse + in: query + responses: + '200': + description: The model version list was successfully retrieved + content: + application/json: + schema: + type: object + properties: + model_versions: + type: array + items: + type: object + properties: + model_name: + type: string + catalog_name: + type: string + schema_name: + type: string + comment: + type: string + source: + type: string + run_id: + type: string + run_workspace_id: + type: string + version: + type: integer + status: + type: string + id: + type: string + metastore_id: + type: string + created_at: + type: integer + created_by: + type: string + updated_at: + type: integer + updated_by: + type: string + storage_location: + type: string + next_page_token: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + x-stackQL-objectKey: $.model_versions + description: List model versions. You can list model versions under a particular + schema, or list all model versions in the current metastore. + /api/2.0/online-tables: + post: + operationId: online-tables-create + externalDocs: + url: https://docs.databricks.com/api/workspace/onlinetables/create + x-stackQL-resource: online_tables + x-stackQL-method: create + x-stackQL-verb: insert + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + name: + type: string + spec: + type: object + properties: + run_continuously: + type: object + properties: {} + run_triggered: + type: object + properties: {} + source_table_full_name: + type: string + primary_key_columns: + type: array + items: + type: string + timeseries_key: + type: string + perform_full_copy: + type: boolean + pipeline_id: + type: string + status: + type: object + properties: + detailed_state: + type: string + message: + type: string + provisioning_status: + type: object + properties: + initial_pipeline_sync_progress: + type: object + properties: + latest_version_currently_processing: + type: integer + synced_row_count: + type: integer + total_row_count: + type: integer + sync_progress_completion: + type: number + estimated_completion_time_seconds: + type: number + continuous_update_status: + type: object + properties: + last_processed_commit_version: + type: integer + timestamp: + type: string + initial_pipeline_sync_progress: + type: object + properties: + latest_version_currently_processing: + type: integer + synced_row_count: + type: integer + total_row_count: + type: integer + sync_progress_completion: + type: number + estimated_completion_time_seconds: + type: number + triggered_update_status: + type: object + properties: + last_processed_commit_version: + type: integer + timestamp: + type: string + triggered_update_progress: + type: object + properties: + latest_version_currently_processing: + type: integer + synced_row_count: + type: integer + total_row_count: + type: integer + sync_progress_completion: + type: number + estimated_completion_time_seconds: + type: number + failed_status: + type: object + properties: + last_processed_commit_version: + type: integer + timestamp: + type: string + table_serving_url: + type: string + unity_catalog_provisioning_state: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: string + spec: + type: object + example: + name: string + spec: + run_continuously: {} + run_triggered: {} + source_table_full_name: string + primary_key_columns: + - string + timeseries_key: string + perform_full_copy: false + pipeline_id: string + description: Online Table information. + description: Create a new Online Table. + /api/2.0/online-tables/{name}: + delete: + operationId: online-tables-delete + externalDocs: + url: https://docs.databricks.com/api/workspace/onlinetables/delete + x-stackQL-resource: online_tables + x-stackQL-method: delete + x-stackQL-verb: delete + x-numReqParams: 1 + parameters: + - name: name + required: true + description: string + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: {} + description: 'Delete an online table. Warning: This will delete all the data + in the online table. If the source Delta table was deleted or modified since + this Online Table was created, this will lose the data forever!' + get: + operationId: online-tables-get + externalDocs: + url: https://docs.databricks.com/api/workspace/onlinetables/get + x-stackQL-resource: online_tables + x-stackQL-method: get + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: name + required: true + description: string + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + name: + type: string + spec: + type: object + properties: + run_continuously: + type: object + properties: {} + run_triggered: + type: object + properties: {} + source_table_full_name: + type: string + primary_key_columns: + type: array + items: + type: string + timeseries_key: + type: string + perform_full_copy: + type: boolean + pipeline_id: + type: string + status: + type: object + properties: + detailed_state: + type: string + message: + type: string + provisioning_status: + type: object + properties: + initial_pipeline_sync_progress: + type: object + properties: + latest_version_currently_processing: + type: integer + synced_row_count: + type: integer + total_row_count: + type: integer + sync_progress_completion: + type: number + estimated_completion_time_seconds: + type: number + continuous_update_status: + type: object + properties: + last_processed_commit_version: + type: integer + timestamp: + type: string + initial_pipeline_sync_progress: + type: object + properties: + latest_version_currently_processing: + type: integer + synced_row_count: + type: integer + total_row_count: + type: integer + sync_progress_completion: + type: number + estimated_completion_time_seconds: + type: number + triggered_update_status: + type: object + properties: + last_processed_commit_version: + type: integer + timestamp: + type: string + triggered_update_progress: + type: object + properties: + latest_version_currently_processing: + type: integer + synced_row_count: + type: integer + total_row_count: + type: integer + sync_progress_completion: + type: number + estimated_completion_time_seconds: + type: number + failed_status: + type: object + properties: + last_processed_commit_version: + type: integer + timestamp: + type: string + table_serving_url: + type: string + unity_catalog_provisioning_state: + type: string + description: Get information about an existing online table and its status. + /api/2.1/unity-catalog/tables/{table_name}/monitor: + post: + operationId: quality-monitors-create + externalDocs: + url: https://docs.databricks.com/api/workspace/qualitymonitors/create + x-stackQL-resource: quality_monitors + x-stackQL-method: create + x-stackQL-verb: insert + x-numReqParams: 1 + parameters: + - name: table_name + required: true + description: string + in: path + responses: + '200': + description: The new monitor was successfully created. + content: + application/json: + schema: + type: object + properties: + assets_dir: + type: string + output_schema_name: + type: string + inference_log: + type: object + properties: + problem_type: + type: string + timestamp_col: + type: string + granularities: + type: array + items: + type: string + prediction_col: + type: string + label_col: + type: string + model_id_col: + type: string + prediction_proba_col: + type: string + time_series: + type: object + properties: + timestamp_col: + type: string + granularities: + type: array + items: + type: string + snapshot: + type: object + properties: {} + slicing_exprs: + type: array + items: + type: string + custom_metrics: + type: array + items: + type: object + properties: + name: + type: string + definition: + type: string + input_columns: + type: array + items: + type: string + output_data_type: + type: string + type: + type: string + baseline_table_name: + type: string + schedule: + type: object + properties: + quartz_cron_expression: + type: string + timezone_id: + type: string + pause_status: + type: string + notifications: + type: object + properties: + on_failure: + type: object + properties: + email_addresses: + type: array + items: + type: string + table_name: + type: string + status: + type: string + latest_monitor_failure_msg: + type: string + profile_metrics_table_name: + type: string + drift_metrics_table_name: + type: string + dashboard_id: + type: string + monitor_version: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + skip_builtin_dashboard: + type: boolean + warehouse_id: + type: string + assets_dir: + type: required + output_schema_name: + type: string + snapshot: + type: required + slicing_exprs: + type: string + baseline_table_name: + type: object + inference_log: + type: object + time_series: + type: object + custom_metrics: + type: Array of object + schedule: + type: object + notifications: + type: object + example: + skip_builtin_dashboard: true + warehouse_id: string + assets_dir: string + output_schema_name: string + inference_log: + problem_type: PROBLEM_TYPE_CLASSIFICATION + timestamp_col: string + granularities: + - string + prediction_col: string + label_col: string + model_id_col: string + prediction_proba_col: string + time_series: + timestamp_col: string + granularities: + - string + snapshot: {} + slicing_exprs: + - string + custom_metrics: + - name: string + definition: string + input_columns: + - string + output_data_type: string + type: CUSTOM_METRIC_TYPE_AGGREGATE + baseline_table_name: string + schedule: + quartz_cron_expression: string + timezone_id: string + pause_status: UNPAUSED + notifications: + on_failure: + email_addresses: + - string + description: Creates a new monitor for the specified table. + delete: + operationId: quality-monitors-delete + externalDocs: + url: https://docs.databricks.com/api/workspace/qualitymonitors/delete + x-stackQL-resource: quality_monitors + x-stackQL-method: delete + x-stackQL-verb: delete + x-numReqParams: 1 + parameters: + - name: table_name + required: true + description: string + in: path + responses: + '200': + description: The monitor was successfully deleted. + description: Deletes a monitor for the specified table. + get: + operationId: quality-monitors-get + externalDocs: + url: https://docs.databricks.com/api/workspace/qualitymonitors/get + x-stackQL-resource: quality_monitors + x-stackQL-method: get + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: table_name + required: true + description: string + in: path + responses: + '200': + description: The monitor was successfully retrieved. + content: + application/json: + schema: + type: object + properties: + assets_dir: + type: string + output_schema_name: + type: string + inference_log: + type: object + properties: + problem_type: + type: string + timestamp_col: + type: string + granularities: + type: array + items: + type: string + prediction_col: + type: string + label_col: + type: string + model_id_col: + type: string + prediction_proba_col: + type: string + time_series: + type: object + properties: + timestamp_col: + type: string + granularities: + type: array + items: + type: string + snapshot: + type: object + properties: {} + slicing_exprs: + type: array + items: + type: string + custom_metrics: + type: array + items: + type: object + properties: + name: + type: string + definition: + type: string + input_columns: + type: array + items: + type: string + output_data_type: + type: string + type: + type: string + baseline_table_name: + type: string + schedule: + type: object + properties: + quartz_cron_expression: + type: string + timezone_id: + type: string + pause_status: + type: string + notifications: + type: object + properties: + on_failure: + type: object + properties: + email_addresses: + type: array + items: + type: string + table_name: + type: string + status: + type: string + latest_monitor_failure_msg: + type: string + profile_metrics_table_name: + type: string + drift_metrics_table_name: + type: string + dashboard_id: + type: string + monitor_version: + type: string + description: Gets a monitor for the specified table. + put: + operationId: quality-monitors-update + externalDocs: + url: https://docs.databricks.com/api/workspace/qualitymonitors/update + x-stackQL-resource: quality_monitors + x-stackQL-method: update + x-stackQL-verb: update + x-numReqParams: 1 + parameters: + - name: table_name + required: true + description: string + in: path + responses: + '200': + description: The monitor was successfully updated. + content: + application/json: + schema: + type: object + properties: + assets_dir: + type: string + output_schema_name: + type: string + inference_log: + type: object + properties: + problem_type: + type: string + timestamp_col: + type: string + granularities: + type: array + items: + type: string + prediction_col: + type: string + label_col: + type: string + model_id_col: + type: string + prediction_proba_col: + type: string + time_series: + type: object + properties: + timestamp_col: + type: string + granularities: + type: array + items: + type: string + snapshot: + type: object + properties: {} + slicing_exprs: + type: array + items: + type: string + custom_metrics: + type: array + items: + type: object + properties: + name: + type: string + definition: + type: string + input_columns: + type: array + items: + type: string + output_data_type: + type: string + type: + type: string + baseline_table_name: + type: string + schedule: + type: object + properties: + quartz_cron_expression: + type: string + timezone_id: + type: string + pause_status: + type: string + notifications: + type: object + properties: + on_failure: + type: object + properties: + email_addresses: + type: array + items: + type: string + table_name: + type: string + status: + type: string + latest_monitor_failure_msg: + type: string + profile_metrics_table_name: + type: string + drift_metrics_table_name: + type: string + dashboard_id: + type: string + monitor_version: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + output_schema_name: + type: required + snapshot: + type: string + slicing_exprs: + type: object + baseline_table_name: + type: Array of string + dashboard_id: + type: string + inference_log: + type: object + time_series: + type: object + custom_metrics: + type: Array of object + schedule: + type: object + notifications: + type: object + example: + output_schema_name: string + inference_log: + problem_type: PROBLEM_TYPE_CLASSIFICATION + timestamp_col: string + granularities: + - string + prediction_col: string + label_col: string + model_id_col: string + prediction_proba_col: string + time_series: + timestamp_col: string + granularities: + - string + snapshot: {} + slicing_exprs: + - string + custom_metrics: + - name: string + definition: string + input_columns: + - string + output_data_type: string + type: CUSTOM_METRIC_TYPE_AGGREGATE + baseline_table_name: string + schedule: + quartz_cron_expression: string + timezone_id: string + pause_status: UNPAUSED + notifications: + on_failure: + email_addresses: + - string + dashboard_id: string + description: Updates a monitor for the specified table. + /api/2.1/unity-catalog/tables/{table_name}/monitor/refreshes/{refresh_id}: + get: + operationId: quality-monitor-refreshes-getrefresh + externalDocs: + url: https://docs.databricks.com/api/workspace/qualitymonitors/getrefresh + x-stackQL-resource: quality_monitor_refreshes + x-stackQL-method: getrefresh + x-stackQL-verb: select + x-numReqParams: 2 + parameters: + - name: table_name + required: true + description: string + in: path + - name: refresh_id + required: true + description: string + in: path + responses: + '200': + description: The refresh info was successfully retrieved. + content: + application/json: + schema: + type: object + properties: + refresh_id: + type: integer + state: + type: string + message: + type: string + start_time_ms: + type: integer + end_time_ms: + type: integer + trigger: + type: string + description: Gets info about a specific monitor refresh using the given refresh + ID. + /api/2.1/unity-catalog/tables/{table_name}/monitor/refreshes: + get: + operationId: quality-monitor-refreshes-listrefreshes + externalDocs: + url: https://docs.databricks.com/api/workspace/qualitymonitors/listrefreshes + x-stackQL-resource: quality_monitor_refreshes + x-stackQL-method: listrefreshes + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: table_name + required: true + description: string + in: path + responses: + '200': + description: The list of refresh info was successfully retrieved. + content: + application/json: + schema: + type: object + properties: + refreshes: + type: array + items: + type: object + properties: + refresh_id: + type: integer + state: + type: string + message: + type: string + start_time_ms: + type: integer + end_time_ms: + type: integer + trigger: + type: string + x-stackQL-objectKey: $.refreshes + description: Gets an array containing the history of the most recent refreshes + (up to 25) for this table. + post: + operationId: quality-monitor-refreshes-runrefresh + externalDocs: + url: https://docs.databricks.com/api/workspace/qualitymonitors/runrefresh + x-stackQL-resource: quality_monitor_refreshes + x-stackQL-method: runrefresh + x-stackQL-verb: exec + x-numReqParams: 1 + parameters: + - name: table_name + required: true + description: string + in: path + responses: + '200': + description: The metric refresh was successfully queued. + content: + application/json: + schema: + type: object + properties: + refresh_id: + type: integer + state: + type: string + message: + type: string + start_time_ms: + type: integer + end_time_ms: + type: integer + trigger: + type: string + description: Queues a metric refresh on the monitor for the specified table. + The refresh will execute in the background. + /api/2.1/unity-catalog/models: + post: + operationId: registered-models-create + externalDocs: + url: https://docs.databricks.com/api/workspace/registeredmodels/create + x-stackQL-resource: registered_models + x-stackQL-method: create + x-stackQL-verb: insert + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Successfully created the registered model + content: + application/json: + schema: + type: object + properties: + name: + type: string + catalog_name: + type: string + schema_name: + type: string + full_name: + type: string + owner: + type: string + id: + type: string + metastore_id: + type: string + created_at: + type: integer + created_by: + type: string + updated_at: + type: integer + updated_by: + type: string + storage_location: + type: string + securable_type: + type: string + securable_kind: + type: string + comment: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + catalog_name: + type: required + schema_name: + type: string + name: + type: required + storage_location: + type: string + comment: + type: required + example: + name: revenue_forecasting_model + catalog_name: main + schema_name: default + comment: This model contains model versions that forecast future revenue, + given historical data + description: Creates a new registered model in Unity Catalog. + get: + operationId: registered-models-list + externalDocs: + url: https://docs.databricks.com/api/workspace/registeredmodels/list + x-stackQL-resource: registered_models + x-stackQL-method: list + x-stackQL-verb: select + x-numReqParams: 0 + parameters: + - name: catalog_name + in: query + - name: schema_name + in: query + - name: max_results + in: query + - name: page_token + in: query + - name: include_browse + in: query + responses: + '200': + description: The registered model list was successfully retrieved + content: + application/json: + schema: + type: object + properties: + registered_models: + type: array + items: + type: object + properties: + name: + type: string + catalog_name: + type: string + schema_name: + type: string + full_name: + type: string + owner: + type: string + id: + type: string + metastore_id: + type: string + created_at: + type: integer + created_by: + type: string + updated_at: + type: integer + updated_by: + type: string + storage_location: + type: string + securable_type: + type: string + securable_kind: + type: string + comment: + type: string + next_page_token: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + x-stackQL-objectKey: $.registered_models + description: List registered models. You can list registered models under a + particular schema, or list all registered models in the current metastore. + /api/2.1/unity-catalog/models/{full_name}: + delete: + operationId: registered-models-delete + externalDocs: + url: https://docs.databricks.com/api/workspace/registeredmodels/delete + x-stackQL-resource: registered_models + x-stackQL-method: delete + x-stackQL-verb: delete + x-numReqParams: 1 + parameters: + - name: full_name + required: true + description: string + in: path + responses: + '200': + description: Successfully deleted the registered model + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Deletes a registered model and all its model versions from the + specified parent catalog and schema. + get: + operationId: registered-models-get + externalDocs: + url: https://docs.databricks.com/api/workspace/registeredmodels/get + x-stackQL-resource: registered_models + x-stackQL-method: get + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: full_name + required: true + description: string + in: path + - name: include_browse + in: query + - name: include_aliases + in: query + responses: + '200': + description: Successfully retrieved the properties of the registered model + content: + application/json: + schema: + type: object + properties: + name: + type: string + catalog_name: + type: string + schema_name: + type: string + full_name: + type: string + owner: + type: string + id: + type: string + metastore_id: + type: string + created_at: + type: integer + created_by: + type: string + updated_at: + type: integer + updated_by: + type: string + storage_location: + type: string + securable_type: + type: string + securable_kind: + type: string + comment: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Get a registered model. + patch: + operationId: registered-models-update + externalDocs: + url: https://docs.databricks.com/api/workspace/registeredmodels/update + x-stackQL-resource: registered_models + x-stackQL-method: update + x-stackQL-verb: update + x-numReqParams: 1 + parameters: + - name: full_name + required: true + description: string + in: path + responses: + '200': + description: Successfully updated the properties of the registered model + content: + application/json: + schema: + type: object + properties: + name: + type: string + catalog_name: + type: string + schema_name: + type: string + full_name: + type: string + owner: + type: string + id: + type: string + metastore_id: + type: string + created_at: + type: integer + created_by: + type: string + updated_at: + type: integer + updated_by: + type: string + storage_location: + type: string + securable_type: + type: string + securable_kind: + type: string + comment: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + owner: + type: string + comment: + type: string + new_name: + type: string + example: + new_name: my_new_model + description: Updates the specified registered model. + /api/2.1/unity-catalog/resource-quotas/{parent_securable_type}/{parent_full_name}/{quota_name}: + get: + operationId: resource-quotas-getquota + externalDocs: + url: https://docs.databricks.com/api/workspace/resourcequotas/getquota + x-stackQL-resource: resource_quotas + x-stackQL-method: getquota + x-stackQL-verb: select + x-numReqParams: 3 + parameters: + - name: parent_securable_type + required: true + description: string + in: path + - name: parent_full_name + required: true + description: string + in: path + - name: quota_name + required: true + description: string + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + quota_info: + type: object + properties: + parent_securable_type: + type: string + parent_full_name: + type: string + quota_name: + type: string + quota_count: + type: integer + quota_limit: + type: integer + last_refreshed_at: + type: integer + x-stackQL-objectKey: $.quota_info + description: The GetQuota API returns usage information for a single resource + quota, defined as a child-parent pair. This API also refreshes the quota count + if it is out of date. Refreshes are triggered asynchronously. The updated + count might not be returned in the first call. + /api/2.1/unity-catalog/resource-quotas/all-resource-quotas: + get: + operationId: resource-quotas-listquotas + externalDocs: + url: https://docs.databricks.com/api/workspace/resourcequotas/listquotas + x-stackQL-resource: resource_quotas + x-stackQL-method: listquotas + x-stackQL-verb: select + x-numReqParams: 0 + parameters: + - name: max_results + in: query + - name: page_token + in: query + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + quotas: + type: array + items: + type: object + properties: + parent_securable_type: + type: string + parent_full_name: + type: string + quota_name: + type: string + quota_count: + type: integer + quota_limit: + type: integer + last_refreshed_at: + type: integer + next_page_token: + type: string + x-stackQL-objectKey: $.quotas + description: ListQuotas returns all quota values under the metastore. There + are no SLAs on the freshness of the counts returned. This API does not trigger + a refresh of quota counts. + /api/2.1/unity-catalog/schemas: + post: + operationId: schemas-create + externalDocs: + url: https://docs.databricks.com/api/workspace/schemas/create + x-stackQL-resource: schemas + x-stackQL-method: create + x-stackQL-verb: insert + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: The new schema was successfully created. + content: + application/json: + schema: + type: object + properties: + name: + type: string + catalog_name: + type: string + owner: + type: string + comment: + type: string + properties: + type: object + properties: + property1: + type: string + property2: + type: string + storage_root: + type: string + enable_predictive_optimization: + type: string + metastore_id: + type: string + full_name: + type: string + storage_location: + type: string + created_at: + type: integer + created_by: + type: string + updated_at: + type: integer + updated_by: + type: string + catalog_type: + type: string + effective_predictive_optimization_flag: + type: object + properties: + value: + type: string + inherited_from_type: + type: string + inherited_from_name: + type: string + browse_only: + type: boolean + schema_id: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: required + catalog_name: + type: string + comment: + type: required + storage_root: + type: string + properties: + type: object + example: + name: string + catalog_name: string + comment: string + properties: + property1: string + property2: string + storage_root: string + description: Creates a new schema for catalog in the Metatastore. The caller + must be a metastore admin, or have the + get: + operationId: schemas-list + externalDocs: + url: https://docs.databricks.com/api/workspace/schemas/list + x-stackQL-resource: schemas + x-stackQL-method: list + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: catalog_name + required: true + description: string + in: query + - name: max_results + in: query + - name: page_token + in: query + - name: include_browse + in: query + responses: + '200': + description: The schemas list was successfully retrieved. + content: + application/json: + schema: + type: object + properties: + schemas: + type: array + items: + type: object + properties: + name: + type: string + catalog_name: + type: string + owner: + type: string + comment: + type: string + properties: + type: object + properties: + property1: + type: string + property2: + type: string + storage_root: + type: string + enable_predictive_optimization: + type: string + metastore_id: + type: string + full_name: + type: string + storage_location: + type: string + created_at: + type: integer + created_by: + type: string + updated_at: + type: integer + updated_by: + type: string + catalog_type: + type: string + effective_predictive_optimization_flag: + type: object + properties: + value: + type: string + inherited_from_type: + type: string + inherited_from_name: + type: string + browse_only: + type: boolean + schema_id: + type: string + next_page_token: + type: string + x-stackQL-objectKey: $.schemas + description: Gets an array of schemas for a catalog in the metastore. If the + caller is the metastore admin or the owner of the parent catalog, all schemas + for the catalog will be retrieved. Otherwise, only schemas owned by the caller + (or for which the caller has the + /api/2.1/unity-catalog/schemas/{full_name}: + delete: + operationId: schemas-delete + externalDocs: + url: https://docs.databricks.com/api/workspace/schemas/delete + x-stackQL-resource: schemas + x-stackQL-method: delete + x-stackQL-verb: delete + x-numReqParams: 1 + parameters: + - name: full_name + required: true + description: string + in: path + - name: force + in: query + responses: + '200': + description: The schema was successfully deleted. + content: + application/json: + schema: + type: object + properties: {} + description: Deletes the specified schema from the parent catalog. The caller + must be the owner of the schema or an owner of the parent catalog. + get: + operationId: schemas-get + externalDocs: + url: https://docs.databricks.com/api/workspace/schemas/get + x-stackQL-resource: schemas + x-stackQL-method: get + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: full_name + required: true + description: string + in: path + - name: include_browse + in: query + responses: + '200': + description: The schema was successfully retrieved. + content: + application/json: + schema: + type: object + properties: + name: + type: string + catalog_name: + type: string + owner: + type: string + comment: + type: string + properties: + type: object + properties: + property1: + type: string + property2: + type: string + storage_root: + type: string + enable_predictive_optimization: + type: string + metastore_id: + type: string + full_name: + type: string + storage_location: + type: string + created_at: + type: integer + created_by: + type: string + updated_at: + type: integer + updated_by: + type: string + catalog_type: + type: string + effective_predictive_optimization_flag: + type: object + properties: + value: + type: string + inherited_from_type: + type: string + inherited_from_name: + type: string + browse_only: + type: boolean + schema_id: + type: string + description: Gets the specified schema within the metastore. The caller must + be a metastore admin, the owner of the schema, or a user that has the + patch: + operationId: schemas-update + externalDocs: + url: https://docs.databricks.com/api/workspace/schemas/update + x-stackQL-resource: schemas + x-stackQL-method: update + x-stackQL-verb: update + x-numReqParams: 1 + parameters: + - name: full_name + required: true + description: string + in: path + responses: + '200': + description: The schema was successfully updated. + content: + application/json: + schema: + type: object + properties: + name: + type: string + catalog_name: + type: string + owner: + type: string + comment: + type: string + properties: + type: object + properties: + property1: + type: string + property2: + type: string + storage_root: + type: string + enable_predictive_optimization: + type: string + metastore_id: + type: string + full_name: + type: string + storage_location: + type: string + created_at: + type: integer + created_by: + type: string + updated_at: + type: integer + updated_by: + type: string + catalog_type: + type: string + effective_predictive_optimization_flag: + type: object + properties: + value: + type: string + inherited_from_type: + type: string + inherited_from_name: + type: string + browse_only: + type: boolean + schema_id: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + owner: + type: string + comment: + type: string + enable_predictive_optimization: + type: string + new_name: + type: string + properties: + type: object + example: + owner: string + comment: string + properties: + property1: string + property2: string + enable_predictive_optimization: DISABLE + new_name: string + description: Updates a schema for a catalog. The caller must be the owner of + the schema or a metastore admin. If the caller is a metastore admin, only + the + /api/2.1/unity-catalog/storage-credentials: + post: + operationId: storage-credentials-create + externalDocs: + url: https://docs.databricks.com/api/workspace/storagecredentials/create + x-stackQL-resource: storage_credentials + x-stackQL-method: create + x-stackQL-verb: insert + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: The new storage credential was successfully created. + content: + application/json: + schema: + type: object + properties: + name: + type: string + aws_iam_role: + type: object + properties: + role_arn: + type: string + unity_catalog_iam_arn: + type: string + external_id: + type: string + comment: + type: string + read_only: + type: boolean + owner: + type: string + full_name: + type: string + id: + type: string + metastore_id: + type: string + created_at: + type: integer + created_by: + type: string + updated_at: + type: integer + updated_by: + type: string + used_for_managed_storage: + type: boolean + isolation_mode: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: required + comment: + type: string + read_only: + type: string + skip_validation: + type: boolean + aws_iam_role: + type: object + example: + name: string + comment: string + read_only: true + aws_iam_role: + role_arn: string + skip_validation: false + description: Creates a new storage credential. + get: + operationId: storage-credentials-list + externalDocs: + url: https://docs.databricks.com/api/workspace/storagecredentials/list + x-stackQL-resource: storage_credentials + x-stackQL-method: list + x-stackQL-verb: select + x-numReqParams: 0 + parameters: + - name: max_results + in: query + - name: page_token + in: query + responses: + '200': + description: The storage credentials list was successfully retrieved. + content: + application/json: + schema: + type: object + properties: + storage_credentials: + type: array + items: + type: object + properties: + name: + type: string + aws_iam_role: + type: object + properties: + role_arn: + type: string + unity_catalog_iam_arn: + type: string + external_id: + type: string + comment: + type: string + read_only: + type: boolean + owner: + type: string + full_name: + type: string + id: + type: string + metastore_id: + type: string + created_at: + type: integer + created_by: + type: string + updated_at: + type: integer + updated_by: + type: string + used_for_managed_storage: + type: boolean + isolation_mode: + type: string + next_page_token: + type: string + x-stackQL-objectKey: $.storage_credentials + description: Gets an array of storage credentials (as + /api/2.1/unity-catalog/storage-credentials/{name}: + delete: + operationId: storage-credentials-delete + externalDocs: + url: https://docs.databricks.com/api/workspace/storagecredentials/delete + x-stackQL-resource: storage_credentials + x-stackQL-method: delete + x-stackQL-verb: delete + x-numReqParams: 1 + parameters: + - name: name + required: true + description: string + in: path + - name: force + in: query + responses: + '200': + description: The storage credential was successfully deleted. + content: + application/json: + schema: + type: object + properties: {} + description: Deletes a storage credential from the metastore. The caller must + be an owner of the storage credential. + get: + operationId: storage-credentials-get + externalDocs: + url: https://docs.databricks.com/api/workspace/storagecredentials/get + x-stackQL-resource: storage_credentials + x-stackQL-method: get + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: name + required: true + description: string + in: path + responses: + '200': + description: The storage credential was successfully retrieved. + content: + application/json: + schema: + type: object + properties: + name: + type: string + aws_iam_role: + type: object + properties: + role_arn: + type: string + unity_catalog_iam_arn: + type: string + external_id: + type: string + comment: + type: string + read_only: + type: boolean + owner: + type: string + full_name: + type: string + id: + type: string + metastore_id: + type: string + created_at: + type: integer + created_by: + type: string + updated_at: + type: integer + updated_by: + type: string + used_for_managed_storage: + type: boolean + isolation_mode: + type: string + description: Gets a storage credential from the metastore. The caller must be + a metastore admin, the owner of the storage credential, or have some permission + on the storage credential. + patch: + operationId: storage-credentials-update + externalDocs: + url: https://docs.databricks.com/api/workspace/storagecredentials/update + x-stackQL-resource: storage_credentials + x-stackQL-method: update + x-stackQL-verb: update + x-numReqParams: 1 + parameters: + - name: name + required: true + description: string + in: path + responses: + '200': + description: The storage credential was successfully updated. + content: + application/json: + schema: + type: object + properties: + name: + type: string + aws_iam_role: + type: object + properties: + role_arn: + type: string + unity_catalog_iam_arn: + type: string + external_id: + type: string + comment: + type: string + read_only: + type: boolean + owner: + type: string + full_name: + type: string + id: + type: string + metastore_id: + type: string + created_at: + type: integer + created_by: + type: string + updated_at: + type: integer + updated_by: + type: string + used_for_managed_storage: + type: boolean + isolation_mode: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + comment: + type: string + read_only: + type: boolean + owner: + type: string + isolation_mode: + type: string + new_name: + type: string + skip_validation: + type: boolean + force: + type: boolean + aws_iam_role: + type: object + example: + comment: string + read_only: true + owner: string + aws_iam_role: + role_arn: string + isolation_mode: ISOLATION_MODE_OPEN + new_name: string + skip_validation: false + force: true + description: Updates a storage credential on the metastore. + /api/2.1/unity-catalog/validate-storage-credentials: + post: + operationId: storage-credential-validation-validate + externalDocs: + url: https://docs.databricks.com/api/workspace/storagecredentials/validate + x-stackQL-resource: storage_credential_validation + x-stackQL-method: validate + x-stackQL-verb: select + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: The storage credential validation operation completed successfully. + content: + application/json: + schema: + type: object + properties: + isDir: + type: boolean + results: + type: array + items: + type: object + properties: + operation: + type: string + result: + type: string + message: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + storage_credential_name: + type: string + external_location_name: + type: string + url: + type: string + read_only: + type: boolean + aws_iam_role: + type: object + example: + storage_credential_name: string + aws_iam_role: + role_arn: string + external_location_name: string + url: string + read_only: true + description: Validates a storage credential. At least one of + /api/2.1/unity-catalog/metastores/{metastore_id}/systemschemas/{schema_name}: + delete: + operationId: system-schemas-disable + externalDocs: + url: https://docs.databricks.com/api/workspace/systemschemas/disable + x-stackQL-resource: system_schemas + x-stackQL-method: disable + x-stackQL-verb: exec + x-numReqParams: 2 + parameters: + - name: metastore_id + required: true + description: string + in: path + - name: schema_name + required: true + description: string + in: path + responses: + '200': + description: The schema was successfully disabled. + description: Disables the system schema and removes it from the system catalog. + The caller must be an account admin or a metastore admin. + put: + operationId: system-schemas-enable + externalDocs: + url: https://docs.databricks.com/api/workspace/systemschemas/enable + x-stackQL-resource: system_schemas + x-stackQL-method: enable + x-stackQL-verb: exec + x-numReqParams: 2 + parameters: + - name: metastore_id + required: true + description: string + in: path + - name: schema_name + required: true + description: string + in: path + responses: + '200': + description: The system schema was successfully enabled. + description: Enables the system schema and adds it to the system catalog. The + caller must be an account admin or a metastore admin. + /api/2.1/unity-catalog/metastores/{metastore_id}/systemschemas: + get: + operationId: system-schemas-list + externalDocs: + url: https://docs.databricks.com/api/workspace/systemschemas/list + x-stackQL-resource: system_schemas + x-stackQL-method: list + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: metastore_id + required: true + description: string + in: path + - name: max_results + in: query + - name: page_token + in: query + responses: + '200': + description: The schemas list was successfully retrieved. + content: + application/json: + schema: + type: object + properties: + schemas: + type: array + items: + type: object + properties: + schema: + type: string + state: + type: string + next_page_token: + type: string + x-stackQL-objectKey: $.schemas + description: Gets an array of system schemas for a metastore. The caller must + be an account admin or a metastore admin. + /api/2.1/unity-catalog/tables/{full_name}: + delete: + operationId: tables-delete + externalDocs: + url: https://docs.databricks.com/api/workspace/tables/delete + x-stackQL-resource: tables + x-stackQL-method: delete + x-stackQL-verb: delete + x-numReqParams: 1 + parameters: + - name: full_name + required: true + description: string + in: path + responses: + '200': + description: The table was successfully deleted. + content: + application/json: + schema: + type: object + properties: {} + description: Deletes a table from the specified parent catalog and schema. The + caller must be the owner of the parent catalog, have the + get: + operationId: tables-get + externalDocs: + url: https://docs.databricks.com/api/workspace/tables/get + x-stackQL-resource: tables + x-stackQL-method: get + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: full_name + required: true + description: string + in: path + - name: include_delta_metadata + in: query + - name: include_browse + in: query + - name: include_manifest_capabilities + in: query + responses: + '200': + description: The table was successfully retrieved. + content: + application/json: + schema: + type: object + properties: + name: + type: string + catalog_name: + type: string + schema_name: + type: string + table_type: + type: string + data_source_format: + type: string + columns: + type: array + items: + type: object + properties: + name: + type: string + type_text: + type: string + type_name: + type: string + position: + type: integer + type_precision: + type: integer + type_scale: + type: integer + type_interval_type: + type: string + type_json: + type: string + comment: + type: string + nullable: + type: boolean + partition_index: + type: integer + mask: + type: object + properties: + function_name: + type: string + using_column_names: + type: array + items: + type: string + storage_location: + type: string + view_definition: + type: string + view_dependencies: + type: object + properties: + dependencies: + type: array + items: + type: object + properties: + table: + type: object + properties: + table_full_name: + type: string + function: + type: object + properties: + function_full_name: + type: string + sql_path: + type: string + owner: + type: string + comment: + type: string + properties: + type: object + properties: + property1: + type: string + property2: + type: string + storage_credential_name: + type: string + table_constraints: + type: array + items: + type: object + properties: + primary_key_constraint: + type: object + properties: + name: + type: string + child_columns: + type: array + items: + type: string + foreign_key_constraint: + type: object + properties: + name: + type: string + child_columns: + type: array + items: + type: string + parent_table: + type: string + parent_columns: + type: array + items: + type: string + named_table_constraint: + type: object + properties: + name: + type: string + row_filter: + type: object + properties: + function_name: + type: string + input_column_names: + type: array + items: + type: string + enable_predictive_optimization: + type: string + metastore_id: + type: string + full_name: + type: string + data_access_configuration_id: + type: string + created_at: + type: integer + created_by: + type: string + updated_at: + type: integer + updated_by: + type: string + deleted_at: + type: integer + table_id: + type: string + delta_runtime_properties_kvpairs: + type: object + properties: + delta_runtime_properties: + type: object + properties: + property1: + type: string + property2: + type: string + effective_predictive_optimization_flag: + type: object + properties: + value: + type: string + inherited_from_type: + type: string + inherited_from_name: + type: string + access_point: + type: string + pipeline_id: + type: string + browse_only: + type: boolean + description: 'Gets a table from the metastore for a specific catalog and schema. + The caller must satisfy one of the following requirements:' + /api/2.1/unity-catalog/tables: + get: + operationId: tables-list + externalDocs: + url: https://docs.databricks.com/api/workspace/tables/list + x-stackQL-resource: tables + x-stackQL-method: list + x-stackQL-verb: select + x-numReqParams: 2 + parameters: + - name: catalog_name + required: true + description: string + in: query + - name: schema_name + required: true + description: string + in: query + - name: max_results + in: query + - name: page_token + in: query + - name: include_delta_metadata + in: query + - name: omit_columns + in: query + - name: omit_properties + in: query + - name: omit_username + in: query + - name: include_browse + in: query + - name: include_manifest_capabilities + in: query + responses: + '200': + description: The tables list was successfully retrieved. + content: + application/json: + schema: + type: object + properties: + tables: + type: array + items: + type: object + properties: + name: + type: string + catalog_name: + type: string + schema_name: + type: string + table_type: + type: string + data_source_format: + type: string + columns: + type: array + items: + type: object + properties: + name: + type: string + type_text: + type: string + type_name: + type: string + position: + type: integer + type_precision: + type: integer + type_scale: + type: integer + type_interval_type: + type: string + type_json: + type: string + comment: + type: string + nullable: + type: boolean + partition_index: + type: integer + mask: + type: object + properties: + function_name: + type: string + using_column_names: + type: array + items: + type: string + storage_location: + type: string + view_definition: + type: string + view_dependencies: + type: object + properties: + dependencies: + type: array + items: + type: object + properties: + table: + type: object + properties: + table_full_name: + type: string + function: + type: object + properties: + function_full_name: + type: string + sql_path: + type: string + owner: + type: string + comment: + type: string + properties: + type: object + properties: + property1: + type: string + property2: + type: string + storage_credential_name: + type: string + table_constraints: + type: array + items: + type: object + properties: + primary_key_constraint: + type: object + properties: + name: + type: string + child_columns: + type: array + items: + type: string + foreign_key_constraint: + type: object + properties: + name: + type: string + child_columns: + type: array + items: + type: string + parent_table: + type: string + parent_columns: + type: array + items: + type: string + named_table_constraint: + type: object + properties: + name: + type: string + row_filter: + type: object + properties: + function_name: + type: string + input_column_names: + type: array + items: + type: string + enable_predictive_optimization: + type: string + metastore_id: + type: string + full_name: + type: string + data_access_configuration_id: + type: string + created_at: + type: integer + created_by: + type: string + updated_at: + type: integer + updated_by: + type: string + deleted_at: + type: integer + table_id: + type: string + delta_runtime_properties_kvpairs: + type: object + properties: + delta_runtime_properties: + type: object + properties: + property1: + type: string + property2: + type: string + effective_predictive_optimization_flag: + type: object + properties: + value: + type: string + inherited_from_type: + type: string + inherited_from_name: + type: string + access_point: + type: string + pipeline_id: + type: string + browse_only: + type: boolean + next_page_token: + type: string + x-stackQL-objectKey: $.tables + description: Gets an array of all tables for the current metastore under the + parent catalog and schema. The caller must be a metastore admin or an owner + of (or have the + /api/2.1/unity-catalog/constraints: + post: + operationId: table-constraints-create + externalDocs: + url: https://docs.databricks.com/api/workspace/tableconstraints/create + x-stackQL-resource: table_constraints + x-stackQL-method: create + x-stackQL-verb: insert + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: The new table constraint was successfully created. + content: + application/json: + schema: + type: object + properties: + primary_key_constraint: + type: object + properties: + name: + type: string + child_columns: + type: array + items: + type: string + foreign_key_constraint: + type: object + properties: + name: + type: string + child_columns: + type: array + items: + type: string + parent_table: + type: string + parent_columns: + type: array + items: + type: string + named_table_constraint: + type: object + properties: + name: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + full_name_arg: + type: required + constraint: + type: required + example: + full_name_arg: string + constraint: + primary_key_constraint: + name: string + child_columns: + - string + foreign_key_constraint: + name: string + child_columns: + - string + parent_table: string + parent_columns: + - string + named_table_constraint: + name: string + description: Creates a new table constraint. + /api/2.1/unity-catalog/constraints/{full_name}: + delete: + operationId: table-constraints-delete + externalDocs: + url: https://docs.databricks.com/api/workspace/tableconstraints/delete + x-stackQL-resource: table_constraints + x-stackQL-method: delete + x-stackQL-verb: delete + x-numReqParams: 3 + parameters: + - name: full_name + required: true + description: string + in: path + - name: constraint_name + required: true + description: string + in: query + - name: cascade + required: true + description: boolean + in: query + responses: + '200': + description: The table constraint was successfully deleted. + content: + application/json: + schema: + type: object + properties: {} + description: Deletes a table constraint. + /api/2.1/unity-catalog/tables/{full_name}/exists: + get: + operationId: table-exists-exists + externalDocs: + url: https://docs.databricks.com/api/workspace/tables/exists + x-stackQL-resource: table_exists + x-stackQL-method: exists + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: full_name + required: true + description: string + in: path + responses: + '200': + description: The boolean reflecting if the table exists was successfully + returned. + content: + application/json: + schema: + type: object + properties: + table_exists: + type: boolean + description: 'Gets if a table exists in the metastore for a specific catalog + and schema. The caller must satisfy one of the following requirements:' + /api/2.1/unity-catalog/table-summaries: + get: + operationId: table-summaries-listsummaries + externalDocs: + url: https://docs.databricks.com/api/workspace/tables/listsummaries + x-stackQL-resource: table_summaries + x-stackQL-method: listsummaries + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: catalog_name + required: true + description: string + in: query + - name: schema_name_pattern + in: query + - name: table_name_pattern + in: query + - name: max_results + in: query + - name: page_token + in: query + - name: include_manifest_capabilities + in: query + responses: + '200': + description: The table summaries list was successfully retrieved. + content: + application/json: + schema: + type: object + properties: + tables: + type: array + items: + type: object + properties: + full_name: + type: string + table_type: + type: string + next_page_token: + type: string + x-stackQL-objectKey: $.tables + description: 'Gets an array of summaries for tables for a schema and catalog + within the metastore. The table summaries returned are either:' + /api/2.0/unity-catalog/temporary-table-credentials: + post: + operationId: temporary-table-credentials-generatetemporarytablecredentials + externalDocs: + url: https://docs.databricks.com/api/workspace/temporarytablecredentials/generatetemporarytablecredentials + x-stackQL-resource: temporary_table_credentials + x-stackQL-method: generatetemporarytablecredentials + x-stackQL-verb: select + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + aws_temp_credentials: + type: object + properties: + access_key_id: + type: string + secret_access_key: + type: string + session_token: + type: string + access_point: + type: string + azure_user_delegation_sas: + type: object + properties: + sas_token: + type: string + gcp_oauth_token: + type: object + properties: + oauth_token: + type: string + r2_temp_credentials: + type: object + properties: + access_key_id: + type: string + secret_access_key: + type: string + session_token: + type: string + expiration_time: + type: integer + url: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + table_id: + type: string + operation: + type: string + example: + table_id: string + operation: READ + description: Get a short-lived credential for directly accessing the table data + on cloud storage. The metastore must have external_access_enabled flag set + to true (default false). The caller must have EXTERNAL_USE_SCHEMA privilege + on the parent schema and this privilege can only be granted by catalog owners. + /api/2.1/unity-catalog/volumes: + post: + operationId: volumes-create + externalDocs: + url: https://docs.databricks.com/api/workspace/volumes/create + x-stackQL-resource: volumes + x-stackQL-method: create + x-stackQL-verb: insert + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Successfully created the volume + content: + application/json: + schema: + type: object + properties: + catalog_name: + type: string + schema_name: + type: string + name: + type: string + full_name: + type: string + volume_type: + type: string + owner: + type: string + volume_id: + type: string + metastore_id: + type: string + created_at: + type: integer + created_by: + type: string + updated_at: + type: integer + updated_by: + type: string + storage_location: + type: string + comment: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + catalog_name: + type: required + schema_name: + type: string + name: + type: required + volume_type: + type: string + storage_location: + type: required + comment: + type: string + example: + catalog_name: main + schema_name: default + name: my_volume + volume_type: EXTERNAL + storage_location: s3://my-bucket/hello/world/my-volume + comment: This is my first volume + description: Creates a new volume. + get: + operationId: volumes-list + externalDocs: + url: https://docs.databricks.com/api/workspace/volumes/list + x-stackQL-resource: volumes + x-stackQL-method: list + x-stackQL-verb: select + x-numReqParams: 2 + parameters: + - name: catalog_name + required: true + description: string + in: query + - name: schema_name + required: true + description: string + in: query + - name: max_results + in: query + - name: page_token + in: query + - name: include_browse + in: query + responses: + '200': + description: The volume list was successfully retrieved + content: + application/json: + schema: + type: object + properties: + volumes: + type: array + items: + type: object + properties: + catalog_name: + type: string + schema_name: + type: string + name: + type: string + full_name: + type: string + volume_type: + type: string + owner: + type: string + volume_id: + type: string + metastore_id: + type: string + created_at: + type: integer + created_by: + type: string + updated_at: + type: integer + updated_by: + type: string + storage_location: + type: string + comment: + type: string + x-stackQL-objectKey: $.volumes + description: Gets an array of volumes for the current metastore under the parent + catalog and schema. + /api/2.1/unity-catalog/volumes/{name}: + delete: + operationId: volumes-delete + externalDocs: + url: https://docs.databricks.com/api/workspace/volumes/delete + x-stackQL-resource: volumes + x-stackQL-method: delete + x-stackQL-verb: delete + x-numReqParams: 1 + parameters: + - name: name + required: true + description: string + in: path + responses: + '200': + description: Successfully deleted the volume + description: Deletes a volume from the specified parent catalog and schema. + get: + operationId: volumes-read + externalDocs: + url: https://docs.databricks.com/api/workspace/volumes/read + x-stackQL-resource: volumes + x-stackQL-method: read + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: name + required: true + description: string + in: path + - name: include_browse + in: query + responses: + '200': + description: Successfully retrieved the properties of the volume + content: + application/json: + schema: + type: object + properties: + catalog_name: + type: string + schema_name: + type: string + name: + type: string + full_name: + type: string + volume_type: + type: string + owner: + type: string + volume_id: + type: string + metastore_id: + type: string + created_at: + type: integer + created_by: + type: string + updated_at: + type: integer + updated_by: + type: string + storage_location: + type: string + comment: + type: string + description: Gets a volume from the metastore for a specific catalog and schema. + patch: + operationId: volumes-update + externalDocs: + url: https://docs.databricks.com/api/workspace/volumes/update + x-stackQL-resource: volumes + x-stackQL-method: update + x-stackQL-verb: update + x-numReqParams: 1 + parameters: + - name: name + required: true + description: string + in: path + responses: + '200': + description: Successfully updated the properties of the volume + content: + application/json: + schema: + type: object + properties: + catalog_name: + type: string + schema_name: + type: string + name: + type: string + full_name: + type: string + volume_type: + type: string + owner: + type: string + volume_id: + type: string + metastore_id: + type: string + created_at: + type: integer + created_by: + type: string + updated_at: + type: integer + updated_by: + type: string + storage_location: + type: string + comment: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + owner: + type: string + comment: + type: string + new_name: + type: string + example: + new_name: my_new_volume + description: Updates the specified volume under the specified parent catalog + and schema. + /api/2.1/unity-catalog/bindings/{securable_type}/{securable_name}: + get: + operationId: workspace-bindings-getbindings + externalDocs: + url: https://docs.databricks.com/api/workspace/workspacebindings/getbindings + x-stackQL-resource: workspace_bindings + x-stackQL-method: getbindings + x-stackQL-verb: select + x-numReqParams: 2 + parameters: + - name: securable_type + required: true + description: string + in: path + - name: securable_name + required: true + description: string + in: path + - name: max_results + in: query + - name: page_token + in: query + responses: + '200': + description: A list of workspace IDs that are bound to the securable + content: + application/json: + schema: + type: object + properties: + bindings: + type: array + items: + type: object + properties: + workspace_id: + type: integer + binding_type: + type: string + next_page_token: + type: string + x-stackQL-objectKey: $.bindings + description: Gets workspace bindings of the securable. The caller must be a + metastore admin or an owner of the securable. + patch: + operationId: workspace-bindings-updatebindings + externalDocs: + url: https://docs.databricks.com/api/workspace/workspacebindings/updatebindings + x-stackQL-resource: workspace_bindings + x-stackQL-method: updatebindings + x-stackQL-verb: update + x-numReqParams: 2 + parameters: + - name: securable_type + required: true + description: string + in: path + - name: securable_name + required: true + description: string + in: path + responses: + '200': + description: A list of workspace bindings that are bound to the securable. + content: + application/json: + schema: + type: object + properties: + bindings: + type: array + items: + type: object + properties: + workspace_id: + type: integer + binding_type: + type: string + next_page_token: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + add: + type: Array of object + remove: + type: Array of object + example: + add: + - workspace_id: 0 + binding_type: BINDING_TYPE_READ_WRITE + remove: + - workspace_id: 0 + binding_type: BINDING_TYPE_READ_WRITE + description: Updates workspace bindings of the securable. The caller must be + a metastore admin or an owner of the securable. + /api/2.1/unity-catalog/workspace-bindings/catalogs/{name}: + patch: + operationId: workspace-bindings-update + externalDocs: + url: https://docs.databricks.com/api/workspace/workspacebindings/update + x-stackQL-resource: workspace_bindings + x-stackQL-method: update + x-stackQL-verb: update + x-numReqParams: 1 + parameters: + - name: name + required: true + description: string + in: path + responses: + '200': + description: A list of workspace IDs that are bound to the catalog. + content: + application/json: + schema: + type: object + properties: + workspaces: + type: array + items: + type: integer + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + assign_workspaces: + type: Array of int64 + unassign_workspaces: + type: Array of int64 + example: + assign_workspaces: + - 0 + unassign_workspaces: + - 0 + description: Updates workspace bindings of the catalog. The caller must be a + metastore admin or an owner of the catalog. +components: + x-stackQL-resources: + artifact_allow_lists: + id: databricks_workspace.unitycatalog.artifact_allow_lists + name: artifact_allow_lists + title: Artifact_allow_lists + methods: + get: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1artifact-allowlists~1{artifact_type}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1artifact-allowlists~1{artifact_type}/put' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/artifact_allow_lists/methods/get' + insert: [] + update: + - $ref: '#/components/x-stackQL-resources/artifact_allow_lists/methods/update' + replace: [] + delete: [] + exec: [] + catalogs: + id: databricks_workspace.unitycatalog.catalogs + name: catalogs + title: Catalogs + methods: + create: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1catalogs/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1catalogs/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.catalogs + delete: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1catalogs~1{name}/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1catalogs~1{name}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1catalogs~1{name}/patch' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/catalogs/methods/get' + - $ref: '#/components/x-stackQL-resources/catalogs/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/catalogs/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/catalogs/methods/update' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/catalogs/methods/delete' + exec: [] + connections: + id: databricks_workspace.unitycatalog.connections + name: connections + title: Connections + methods: + create: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1connections/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1connections/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.connections + delete: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1connections~1{name}/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1connections~1{name}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1connections~1{name}/patch' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/connections/methods/get' + - $ref: '#/components/x-stackQL-resources/connections/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/connections/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/connections/methods/update' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/connections/methods/delete' + exec: [] + credentials: + id: databricks_workspace.unitycatalog.credentials + name: credentials + title: Credentials + methods: + createcredential: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1credentials/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + listcredentials: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1credentials/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.credentials + deletecredential: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1credentials~1{name_arg}/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + getcredential: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1credentials~1{name_arg}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + updatecredential: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1credentials~1{name_arg}/patch' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + generatetemporaryservicecredential: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1temporary-service-credentials/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/credentials/methods/generatetemporaryservicecredential' + - $ref: '#/components/x-stackQL-resources/credentials/methods/getcredential' + - $ref: '#/components/x-stackQL-resources/credentials/methods/listcredentials' + insert: + - $ref: '#/components/x-stackQL-resources/credentials/methods/createcredential' + update: + - $ref: '#/components/x-stackQL-resources/credentials/methods/updatecredential' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/credentials/methods/deletecredential' + exec: [] + credential_validation: + id: databricks_workspace.unitycatalog.credential_validation + name: credential_validation + title: Credential_validation + methods: + validatecredential: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1validate-credentials/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/credential_validation/methods/validatecredential' + insert: [] + update: [] + replace: [] + delete: [] + exec: [] + effective_grants: + id: databricks_workspace.unitycatalog.effective_grants + name: effective_grants + title: Effective_grants + methods: + geteffective: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1effective-permissions~1{securable_type}~1{full_name}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.privilege_assignments + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/effective_grants/methods/geteffective' + insert: [] + update: [] + replace: [] + delete: [] + exec: [] + external_locations: + id: databricks_workspace.unitycatalog.external_locations + name: external_locations + title: External_locations + methods: + create: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1external-locations/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1external-locations/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.external_locations + delete: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1external-locations~1{name}/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1external-locations~1{name}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1external-locations~1{name}/patch' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/external_locations/methods/get' + - $ref: '#/components/x-stackQL-resources/external_locations/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/external_locations/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/external_locations/methods/update' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/external_locations/methods/delete' + exec: [] + functions: + id: databricks_workspace.unitycatalog.functions + name: functions + title: Functions + methods: + create: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1functions/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1functions/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.functions + delete: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1functions~1{name}/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1functions~1{name}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1functions~1{name}/patch' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/functions/methods/get' + - $ref: '#/components/x-stackQL-resources/functions/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/functions/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/functions/methods/update' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/functions/methods/delete' + exec: [] + grants: + id: databricks_workspace.unitycatalog.grants + name: grants + title: Grants + methods: + get: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1permissions~1{securable_type}~1{full_name}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.privilege_assignments + update: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1permissions~1{securable_type}~1{full_name}/patch' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/grants/methods/get' + insert: [] + update: + - $ref: '#/components/x-stackQL-resources/grants/methods/update' + replace: [] + delete: [] + exec: [] + metastores: + id: databricks_workspace.unitycatalog.metastores + name: metastores + title: Metastores + methods: + create: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1metastores/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1metastores/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.metastores + delete: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1metastores~1{id}/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1metastores~1{id}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1metastores~1{id}/patch' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/metastores/methods/get' + - $ref: '#/components/x-stackQL-resources/metastores/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/metastores/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/metastores/methods/update' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/metastores/methods/delete' + exec: [] + metastore_assignments: + id: databricks_workspace.unitycatalog.metastore_assignments + name: metastore_assignments + title: Metastore_assignments + methods: + assign: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1workspaces~1{workspace_id}~1metastore/put' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + unassign: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1workspaces~1{workspace_id}~1metastore/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + updateassignment: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1workspaces~1{workspace_id}~1metastore/patch' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + current: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1current-metastore-assignment/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/metastore_assignments/methods/current' + insert: + - $ref: '#/components/x-stackQL-resources/metastore_assignments/methods/assign' + update: + - $ref: '#/components/x-stackQL-resources/metastore_assignments/methods/updateassignment' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/metastore_assignments/methods/unassign' + exec: [] + metastore_summary: + id: databricks_workspace.unitycatalog.metastore_summary + name: metastore_summary + title: Metastore_summary + methods: + summary: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1metastore_summary/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/metastore_summary/methods/summary' + insert: [] + update: [] + replace: [] + delete: [] + exec: [] + model_versions: + id: databricks_workspace.unitycatalog.model_versions + name: model_versions + title: Model_versions + methods: + delete: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1models~1{full_name}~1versions~1{version}/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1models~1{full_name}~1versions~1{version}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1models~1{full_name}~1versions~1{version}/patch' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + getbyalias: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1models~1{full_name}~1aliases~1{alias}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1models~1{full_name}~1versions/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.model_versions + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/model_versions/methods/list' + - $ref: '#/components/x-stackQL-resources/model_versions/methods/getbyalias' + - $ref: '#/components/x-stackQL-resources/model_versions/methods/get' + insert: [] + update: + - $ref: '#/components/x-stackQL-resources/model_versions/methods/update' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/model_versions/methods/delete' + exec: [] + registered_model_aliases: + id: databricks_workspace.unitycatalog.registered_model_aliases + name: registered_model_aliases + title: Registered_model_aliases + methods: + deletealias: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1models~1{full_name}~1aliases~1{alias}/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + setalias: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1models~1{full_name}~1aliases~1{alias}/put' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: [] + replace: + - $ref: '#/components/x-stackQL-resources/registered_model_aliases/methods/setalias' + delete: + - $ref: '#/components/x-stackQL-resources/registered_model_aliases/methods/deletealias' + exec: [] + online_tables: + id: databricks_workspace.unitycatalog.online_tables + name: online_tables + title: Online_tables + methods: + create: + operation: + $ref: '#/paths/~1api~12.0~1online-tables/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: '#/paths/~1api~12.0~1online-tables~1{name}/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1api~12.0~1online-tables~1{name}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/online_tables/methods/get' + insert: + - $ref: '#/components/x-stackQL-resources/online_tables/methods/create' + update: [] + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/online_tables/methods/delete' + exec: [] + quality_monitors: + id: databricks_workspace.unitycatalog.quality_monitors + name: quality_monitors + title: Quality_monitors + methods: + create: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1tables~1{table_name}~1monitor/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1tables~1{table_name}~1monitor/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1tables~1{table_name}~1monitor/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1tables~1{table_name}~1monitor/put' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/quality_monitors/methods/get' + insert: + - $ref: '#/components/x-stackQL-resources/quality_monitors/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/quality_monitors/methods/update' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/quality_monitors/methods/delete' + exec: [] + quality_monitor_refreshes: + id: databricks_workspace.unitycatalog.quality_monitor_refreshes + name: quality_monitor_refreshes + title: Quality_monitor_refreshes + methods: + getrefresh: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1tables~1{table_name}~1monitor~1refreshes~1{refresh_id}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + listrefreshes: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1tables~1{table_name}~1monitor~1refreshes/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.refreshes + runrefresh: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1tables~1{table_name}~1monitor~1refreshes/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/quality_monitor_refreshes/methods/listrefreshes' + - $ref: '#/components/x-stackQL-resources/quality_monitor_refreshes/methods/getrefresh' + insert: [] + update: [] + replace: [] + delete: [] + exec: + - $ref: '#/components/x-stackQL-resources/quality_monitor_refreshes/methods/runrefresh' + registered_models: + id: databricks_workspace.unitycatalog.registered_models + name: registered_models + title: Registered_models + methods: + create: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1models/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1models/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.registered_models + delete: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1models~1{full_name}/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1models~1{full_name}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1models~1{full_name}/patch' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/registered_models/methods/get' + - $ref: '#/components/x-stackQL-resources/registered_models/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/registered_models/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/registered_models/methods/update' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/registered_models/methods/delete' + exec: [] + resource_quotas: + id: databricks_workspace.unitycatalog.resource_quotas + name: resource_quotas + title: Resource_quotas + methods: + getquota: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1resource-quotas~1{parent_securable_type}~1{parent_full_name}~1{quota_name}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.quota_info + listquotas: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1resource-quotas~1all-resource-quotas/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.quotas + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/resource_quotas/methods/listquotas' + - $ref: '#/components/x-stackQL-resources/resource_quotas/methods/getquota' + insert: [] + update: [] + replace: [] + delete: [] + exec: [] + schemas: + id: databricks_workspace.unitycatalog.schemas + name: schemas + title: Schemas + methods: + create: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1schemas/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1schemas/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.schemas + delete: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1schemas~1{full_name}/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1schemas~1{full_name}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1schemas~1{full_name}/patch' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/schemas/methods/get' + - $ref: '#/components/x-stackQL-resources/schemas/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/schemas/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/schemas/methods/update' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/schemas/methods/delete' + exec: [] + storage_credentials: + id: databricks_workspace.unitycatalog.storage_credentials + name: storage_credentials + title: Storage_credentials + methods: + create: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1storage-credentials/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1storage-credentials/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.storage_credentials + delete: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1storage-credentials~1{name}/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1storage-credentials~1{name}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1storage-credentials~1{name}/patch' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/storage_credentials/methods/get' + - $ref: '#/components/x-stackQL-resources/storage_credentials/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/storage_credentials/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/storage_credentials/methods/update' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/storage_credentials/methods/delete' + exec: [] + storage_credential_validation: + id: databricks_workspace.unitycatalog.storage_credential_validation + name: storage_credential_validation + title: Storage_credential_validation + methods: + validate: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1validate-storage-credentials/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/storage_credential_validation/methods/validate' + insert: [] + update: [] + replace: [] + delete: [] + exec: [] + system_schemas: + id: databricks_workspace.unitycatalog.system_schemas + name: system_schemas + title: System_schemas + methods: + disable: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1metastores~1{metastore_id}~1systemschemas~1{schema_name}/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + enable: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1metastores~1{metastore_id}~1systemschemas~1{schema_name}/put' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1metastores~1{metastore_id}~1systemschemas/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.schemas + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/system_schemas/methods/list' + insert: [] + update: [] + replace: [] + delete: [] + exec: + - $ref: '#/components/x-stackQL-resources/system_schemas/methods/enable' + - $ref: '#/components/x-stackQL-resources/system_schemas/methods/disable' + tables: + id: databricks_workspace.unitycatalog.tables + name: tables + title: Tables + methods: + delete: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1tables~1{full_name}/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1tables~1{full_name}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1tables/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.tables + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/tables/methods/list' + - $ref: '#/components/x-stackQL-resources/tables/methods/get' + insert: [] + update: [] + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/tables/methods/delete' + exec: [] + table_constraints: + id: databricks_workspace.unitycatalog.table_constraints + name: table_constraints + title: Table_constraints + methods: + create: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1constraints/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1constraints~1{full_name}/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: '#/components/x-stackQL-resources/table_constraints/methods/create' + update: [] + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/table_constraints/methods/delete' + exec: [] + table_exists: + id: databricks_workspace.unitycatalog.table_exists + name: table_exists + title: Table_exists + methods: + exists: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1tables~1{full_name}~1exists/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/table_exists/methods/exists' + insert: [] + update: [] + replace: [] + delete: [] + exec: [] + table_summaries: + id: databricks_workspace.unitycatalog.table_summaries + name: table_summaries + title: Table_summaries + methods: + listsummaries: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1table-summaries/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.tables + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/table_summaries/methods/listsummaries' + insert: [] + update: [] + replace: [] + delete: [] + exec: [] + temporary_table_credentials: + id: databricks_workspace.unitycatalog.temporary_table_credentials + name: temporary_table_credentials + title: Temporary_table_credentials + methods: + generatetemporarytablecredentials: + operation: + $ref: '#/paths/~1api~12.0~1unity-catalog~1temporary-table-credentials/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/temporary_table_credentials/methods/generatetemporarytablecredentials' + insert: [] + update: [] + replace: [] + delete: [] + exec: [] + volumes: + id: databricks_workspace.unitycatalog.volumes + name: volumes + title: Volumes + methods: + create: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1volumes/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1volumes/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.volumes + delete: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1volumes~1{name}/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + read: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1volumes~1{name}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1volumes~1{name}/patch' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/volumes/methods/read' + - $ref: '#/components/x-stackQL-resources/volumes/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/volumes/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/volumes/methods/update' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/volumes/methods/delete' + exec: [] + workspace_bindings: + id: databricks_workspace.unitycatalog.workspace_bindings + name: workspace_bindings + title: Workspace_bindings + methods: + getbindings: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1bindings~1{securable_type}~1{securable_name}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.bindings + updatebindings: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1bindings~1{securable_type}~1{securable_name}/patch' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1workspace-bindings~1catalogs~1{name}/patch' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/workspace_bindings/methods/getbindings' + insert: [] + update: + - $ref: '#/components/x-stackQL-resources/workspace_bindings/methods/update' + - $ref: '#/components/x-stackQL-resources/workspace_bindings/methods/updatebindings' + replace: [] + delete: [] + exec: [] diff --git a/providers/src/databricks_workspace/v00.00.00000/services/vectorsearch.yaml b/providers/src/databricks_workspace/v00.00.00000/services/vectorsearch.yaml new file mode 100644 index 00000000..0aa67f26 --- /dev/null +++ b/providers/src/databricks_workspace/v00.00.00000/services/vectorsearch.yaml @@ -0,0 +1,982 @@ +openapi: 3.0.0 +info: + version: 2024-12-19-stackql-generated + contact: + name: StackQL Studios + url: https://stackql.io/ + email: info@stackql.io + title: Databricks Vectorsearch API + description: Vectorsearch +servers: +- url: https://{deployment_name}.cloud.databricks.com + variables: + deployment_name: + description: The Databricks Workspace Deployment Name + default: dbc-abcd0123-a1bc +paths: + /api/2.0/vector-search/indexes/{index_name}/delete-data: + post: + operationId: data-vector-indexes-deletedatavectorindex + externalDocs: + url: https://docs.databricks.com/api/workspace/vectorsearchindexes/deletedatavectorindex + x-stackQL-resource: data_vector_indexes + x-stackQL-method: deletedatavectorindex + x-stackQL-verb: delete + x-numReqParams: 1 + parameters: + - name: index_name + required: true + description: string + in: path + responses: + '200': + description: Response indicating the result of the delete operation. + content: + application/json: + schema: + type: object + properties: + status: + type: string + result: + type: object + properties: + success_row_count: + type: integer + failed_primary_keys: + type: array + items: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + primary_keys: + type: required + example: + primary_keys: + - '1' + description: Data to be deleted from the vector index. + description: Handles the deletion of data from a specified vector index. + /api/2.0/vector-search/indexes/{index_name}/upsert-data: + post: + operationId: data-vector-indexes-upsertdatavectorindex + externalDocs: + url: https://docs.databricks.com/api/workspace/vectorsearchindexes/upsertdatavectorindex + x-stackQL-resource: data_vector_indexes + x-stackQL-method: upsertdatavectorindex + x-stackQL-verb: replace + x-numReqParams: 1 + parameters: + - name: index_name + required: true + description: string + in: path + responses: + '200': + description: Response indicating the result of the upsert operation. + content: + application/json: + schema: + type: object + properties: + status: + type: string + result: + type: object + properties: + success_row_count: + type: integer + failed_primary_keys: + type: array + items: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + inputs_json: + type: required + example: + inputs_json: '[{"id": "1", "text": "hello world", "text_vector": [1.0, + 2.0, 3.0]}]' + description: Data to be upserted into the vector index. + description: Handles the upserting of data into a specified vector index. + /api/2.0/vector-search/endpoints: + post: + operationId: endpoints-createendpoint + externalDocs: + url: https://docs.databricks.com/api/workspace/vectorsearchendpoints/createendpoint + x-stackQL-resource: endpoints + x-stackQL-method: createendpoint + x-stackQL-verb: insert + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Successful response with details of the created endpoint + content: + application/json: + schema: + type: object + properties: + name: + type: string + creator: + type: string + creation_timestamp: + type: integer + last_updated_timestamp: + type: integer + endpoint_type: + type: string + last_updated_user: + type: string + id: + type: string + endpoint_status: + type: object + properties: + state: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: required + endpoint_type: + type: string + example: + name: docs-endpoint + endpoint_type: STANDARD + description: Create a new endpoint. + get: + operationId: endpoints-listendpoints + externalDocs: + url: https://docs.databricks.com/api/workspace/vectorsearchendpoints/listendpoints + x-stackQL-resource: endpoints + x-stackQL-method: listendpoints + x-stackQL-verb: select + x-numReqParams: 0 + parameters: + - name: page_token + in: query + responses: + '200': + description: List of all endpoints + content: + application/json: + schema: + type: object + properties: + endpoints: + type: array + items: + type: object + properties: + name: + type: string + creator: + type: string + creation_timestamp: + type: integer + last_updated_timestamp: + type: integer + endpoint_type: + type: string + last_updated_user: + type: string + id: + type: string + endpoint_status: + type: object + properties: + state: + type: string + message: + type: string + num_indexes: + type: integer + next_page_token: + type: string + x-stackQL-objectKey: $.endpoints + /api/2.0/vector-search/endpoints/{endpoint_name}: + delete: + operationId: endpoints-deleteendpoint + externalDocs: + url: https://docs.databricks.com/api/workspace/vectorsearchendpoints/deleteendpoint + x-stackQL-resource: endpoints + x-stackQL-method: deleteendpoint + x-stackQL-verb: delete + x-numReqParams: 1 + parameters: + - name: endpoint_name + required: true + description: string + in: path + responses: + '200': + description: Endpoint deletion initiated. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + get: + operationId: endpoints-getendpoint + externalDocs: + url: https://docs.databricks.com/api/workspace/vectorsearchendpoints/getendpoint + x-stackQL-resource: endpoints + x-stackQL-method: getendpoint + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: endpoint_name + required: true + description: string + in: path + responses: + '200': + description: Details of the endpoint. + content: + application/json: + schema: + type: object + properties: + name: + type: string + creator: + type: string + creation_timestamp: + type: integer + last_updated_timestamp: + type: integer + endpoint_type: + type: string + last_updated_user: + type: string + id: + type: string + endpoint_status: + type: object + properties: + state: + type: string + message: + type: string + num_indexes: + type: integer + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + /api/2.0/vector-search/indexes: + post: + operationId: indexes-createindex + externalDocs: + url: https://docs.databricks.com/api/workspace/vectorsearchindexes/createindex + x-stackQL-resource: indexes + x-stackQL-method: createindex + x-stackQL-verb: insert + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Successful response with details of the created index + content: + application/json: + schema: + type: object + properties: + name: + type: string + endpoint_name: + type: string + primary_key: + type: string + index_type: + type: string + delta_sync_index_spec: + type: object + properties: + source_table: + type: string + embedding_source_columns: + type: array + items: + type: object + properties: + name: + type: string + embedding_model_endpoint_name: + type: string + columns_to_sync: + type: array + items: + type: string + pipeline_type: + type: string + pipeline_id: + type: string + status: + type: object + properties: + message: + type: string + indexed_row_count: + type: integer + ready: + type: boolean + index_url: + type: string + creator: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: required + endpoint_name: + type: string + primary_key: + type: required + index_type: + type: string + delta_sync_index_spec: + type: object + direct_access_index_spec: + type: object + example: + name: main_catalog.docs.en_wiki_index + primary_key: id + index_type: DELTA_SYNC + delta_sync_index_spec: + source_table: main_catalog.docs.en_wiki + pipeline_type: TRIGGERED + embedding_source_columns: + - name: text + embedding_model_endpoint_name: e5-small-v2 + columns_to_sync: + - id + - text + description: Create a new index. + get: + operationId: indexes-listindexes + externalDocs: + url: https://docs.databricks.com/api/workspace/vectorsearchindexes/listindexes + x-stackQL-resource: indexes + x-stackQL-method: listindexes + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: endpoint_name + required: true + description: string + in: query + - name: page_token + in: query + responses: + '200': + description: Successful response with list of endpoints. + content: + application/json: + schema: + type: object + properties: + vector_indexes: + type: array + items: + type: object + properties: + name: + type: string + endpoint_name: + type: string + primary_key: + type: string + index_type: + type: string + creator: + type: string + next_page_token: + type: string + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + x-stackQL-objectKey: $.vector_indexes + description: List all indexes in the given endpoint. + /api/2.0/vector-search/indexes/{index_name}: + delete: + operationId: indexes-deleteindex + externalDocs: + url: https://docs.databricks.com/api/workspace/vectorsearchindexes/deleteindex + x-stackQL-resource: indexes + x-stackQL-method: deleteindex + x-stackQL-verb: delete + x-numReqParams: 1 + parameters: + - name: index_name + required: true + description: string + in: path + responses: + '200': + description: Index deletion has been initiated. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Delete an index. + get: + operationId: indexes-getindex + externalDocs: + url: https://docs.databricks.com/api/workspace/vectorsearchindexes/getindex + x-stackQL-resource: indexes + x-stackQL-method: getindex + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: index_name + required: true + description: string + in: path + responses: + '200': + description: Successful response with details of the index + content: + application/json: + schema: + type: object + properties: + name: + type: string + endpoint_name: + type: string + primary_key: + type: string + index_type: + type: string + delta_sync_index_spec: + type: object + properties: + source_table: + type: string + embedding_source_columns: + type: array + items: + type: object + properties: + name: + type: string + embedding_model_endpoint_name: + type: string + pipeline_type: + type: string + pipeline_id: + type: string + status: + type: object + properties: + message: + type: string + indexed_row_count: + type: integer + ready: + type: boolean + index_url: + type: string + creator: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Get an index. + /api/2.0/vector-search/indexes/{index_name}/query-next-page: + post: + operationId: indexes-querynextpage + externalDocs: + url: https://docs.databricks.com/api/workspace/vectorsearchindexes/querynextpage + x-stackQL-resource: indexes + x-stackQL-method: querynextpage + x-stackQL-verb: exec + x-numReqParams: 1 + parameters: + - name: index_name + required: true + description: string + in: path + responses: + '200': + description: Successful response with query results. + content: + application/json: + schema: + type: object + properties: + manifest: + type: object + properties: + column_count: + type: integer + columns: + type: array + items: + type: object + properties: + name: + type: string + result: + type: object + properties: + row_count: + type: integer + data_array: + type: array + items: + type: array + items: + type: string + next_page_token: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + endpoint_name: + type: string + page_token: + type: string + example: + endpoint_name: demo-endpoint + page_token: dummy-page-token + description: Use + /api/2.0/vector-search/indexes/{index_name}/sync: + post: + operationId: indexes-syncindex + externalDocs: + url: https://docs.databricks.com/api/workspace/vectorsearchindexes/syncindex + x-stackQL-resource: indexes + x-stackQL-method: syncindex + x-stackQL-verb: exec + x-numReqParams: 1 + parameters: + - name: index_name + required: true + description: string + in: path + responses: + '200': + description: Successful response indicating the sync process has been initiated. + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Triggers a synchronization process for a specified vector index. + /api/2.0/vector-search/indexes/{index_name}/query: + post: + operationId: index-query-queryindex + externalDocs: + url: https://docs.databricks.com/api/workspace/vectorsearchindexes/queryindex + x-stackQL-resource: index_query + x-stackQL-method: queryindex + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: index_name + required: true + description: string + in: path + responses: + '200': + description: Successful response with query results. + content: + application/json: + schema: + type: object + properties: + manifest: + type: object + properties: + column_count: + type: integer + columns: + type: array + items: + type: object + properties: + name: + type: string + result: + type: object + properties: + row_count: + type: integer + data_array: + type: array + items: + type: array + items: + type: string + next_page_token: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + num_results: + type: integer + columns: + type: required + filters_json: + type: Array of string + query_vector: + type: string + query_text: + type: Array of double + score_threshold: + type: string + query_type: + type: double + example: + query_vector: + - 1 + - 2 + - 3 + columns: + - id + - text + num_results: 10 + description: Query the specified vector index. + /api/2.0/vector-search/indexes/{index_name}/scan: + post: + operationId: index-scan-scanindex + externalDocs: + url: https://docs.databricks.com/api/workspace/vectorsearchindexes/scanindex + x-stackQL-resource: index_scan + x-stackQL-method: scanindex + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: index_name + required: true + description: string + in: path + responses: + '200': + description: Successful response with scan results. + content: + application/json: + schema: + type: object + properties: + last_primary_key: + type: string + data: + type: array + items: + type: object + properties: + fields: + type: array + items: + type: object + properties: + key: + type: string + value: + type: object + properties: + number_value: + type: integer + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + num_results: + type: integer + last_primary_key: + type: string + example: + num_results: 2 + description: Scan the specified vector index and return the first +components: + x-stackQL-resources: + data_vector_indexes: + id: databricks_workspace.vectorsearch.data_vector_indexes + name: data_vector_indexes + title: Data_vector_indexes + methods: + deletedatavectorindex: + operation: + $ref: '#/paths/~1api~12.0~1vector-search~1indexes~1{index_name}~1delete-data/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + upsertdatavectorindex: + operation: + $ref: '#/paths/~1api~12.0~1vector-search~1indexes~1{index_name}~1upsert-data/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: [] + replace: + - $ref: '#/components/x-stackQL-resources/data_vector_indexes/methods/upsertdatavectorindex' + delete: + - $ref: '#/components/x-stackQL-resources/data_vector_indexes/methods/deletedatavectorindex' + exec: [] + endpoints: + id: databricks_workspace.vectorsearch.endpoints + name: endpoints + title: Endpoints + methods: + createendpoint: + operation: + $ref: '#/paths/~1api~12.0~1vector-search~1endpoints/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + listendpoints: + operation: + $ref: '#/paths/~1api~12.0~1vector-search~1endpoints/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.endpoints + deleteendpoint: + operation: + $ref: '#/paths/~1api~12.0~1vector-search~1endpoints~1{endpoint_name}/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + getendpoint: + operation: + $ref: '#/paths/~1api~12.0~1vector-search~1endpoints~1{endpoint_name}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/endpoints/methods/getendpoint' + - $ref: '#/components/x-stackQL-resources/endpoints/methods/listendpoints' + insert: + - $ref: '#/components/x-stackQL-resources/endpoints/methods/createendpoint' + update: [] + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/endpoints/methods/deleteendpoint' + exec: [] + indexes: + id: databricks_workspace.vectorsearch.indexes + name: indexes + title: Indexes + methods: + createindex: + operation: + $ref: '#/paths/~1api~12.0~1vector-search~1indexes/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + listindexes: + operation: + $ref: '#/paths/~1api~12.0~1vector-search~1indexes/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.vector_indexes + deleteindex: + operation: + $ref: '#/paths/~1api~12.0~1vector-search~1indexes~1{index_name}/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + getindex: + operation: + $ref: '#/paths/~1api~12.0~1vector-search~1indexes~1{index_name}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + querynextpage: + operation: + $ref: '#/paths/~1api~12.0~1vector-search~1indexes~1{index_name}~1query-next-page/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + syncindex: + operation: + $ref: '#/paths/~1api~12.0~1vector-search~1indexes~1{index_name}~1sync/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/indexes/methods/getindex' + - $ref: '#/components/x-stackQL-resources/indexes/methods/listindexes' + insert: + - $ref: '#/components/x-stackQL-resources/indexes/methods/createindex' + update: [] + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/indexes/methods/deleteindex' + exec: + - $ref: '#/components/x-stackQL-resources/indexes/methods/syncindex' + - $ref: '#/components/x-stackQL-resources/indexes/methods/querynextpage' + index_query: + id: databricks_workspace.vectorsearch.index_query + name: index_query + title: Index_query + methods: + queryindex: + operation: + $ref: '#/paths/~1api~12.0~1vector-search~1indexes~1{index_name}~1query/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/index_query/methods/queryindex' + insert: [] + update: [] + replace: [] + delete: [] + exec: [] + index_scan: + id: databricks_workspace.vectorsearch.index_scan + name: index_scan + title: Index_scan + methods: + scanindex: + operation: + $ref: '#/paths/~1api~12.0~1vector-search~1indexes~1{index_name}~1scan/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/index_scan/methods/scanindex' + insert: [] + update: [] + replace: [] + delete: [] + exec: [] diff --git a/providers/src/databricks_workspace/v00.00.00000/services/workflows.yaml b/providers/src/databricks_workspace/v00.00.00000/services/workflows.yaml new file mode 100644 index 00000000..f9fe6d13 --- /dev/null +++ b/providers/src/databricks_workspace/v00.00.00000/services/workflows.yaml @@ -0,0 +1,4507 @@ +openapi: 3.0.0 +info: + version: 2024-12-19-stackql-generated + contact: + name: StackQL Studios + url: https://stackql.io/ + email: info@stackql.io + title: Databricks Workflows API + description: Workflows +servers: +- url: https://{deployment_name}.cloud.databricks.com + variables: + deployment_name: + description: The Databricks Workspace Deployment Name + default: dbc-abcd0123-a1bc +paths: + /api/2.2/jobs/create: + post: + operationId: jobs-create + externalDocs: + url: https://docs.databricks.com/api/workspace/jobs/create + x-stackQL-resource: jobs + x-stackQL-method: create + x-stackQL-verb: insert + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + job_id: + type: integer + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '429': + description: Operation is rejected due to throttling, e.g. some resource + has been exhausted, per-user quota. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: + type: string + timeout_seconds: + type: int32 + max_concurrent_runs: + type: int32 + format: + type: string + edit_mode: + type: string + email_notifications: + type: object + webhook_notifications: + type: object + notification_settings: + type: object + health: + type: object + schedule: + type: object + trigger: + type: object + continuous: + type: object + tasks: + type: Array of object + job_clusters: + type: Array of object + git_source: + type: object + tags: + type: object + queue: + type: object + parameters: + type: Array of object + run_as: + type: object + deployment: + type: object + environments: + type: Array of object + access_control_list: + type: Array of object + example: + name: A multitask job + description: This job contain multiple tasks that are required to + produce the weekly shark sightings report. + email_notifications: + on_start: + - user.name@databricks.com + on_success: + - user.name@databricks.com + on_failure: + - user.name@databricks.com + on_duration_warning_threshold_exceeded: + - user.name@databricks.com + on_streaming_backlog_exceeded: + - user.name@databricks.com + no_alert_for_skipped_runs: false + webhook_notifications: + on_start: + - - id: 0481e838-0a59-4eff-9541-a4ca6f149574 + on_success: + - - id: 0481e838-0a59-4eff-9541-a4ca6f149574 + on_failure: + - - id: 0481e838-0a59-4eff-9541-a4ca6f149574 + on_duration_warning_threshold_exceeded: + - - id: 0481e838-0a59-4eff-9541-a4ca6f149574 + on_streaming_backlog_exceeded: + - - id: 0481e838-0a59-4eff-9541-a4ca6f149574 + notification_settings: + no_alert_for_skipped_runs: false + no_alert_for_canceled_runs: false + timeout_seconds: 86400 + health: + rules: + - metric: RUN_DURATION_SECONDS + op: GREATER_THAN + value: 10 + schedule: + quartz_cron_expression: 20 30 * * * ? + timezone_id: Europe/London + pause_status: UNPAUSED + trigger: + pause_status: UNPAUSED + file_arrival: + url: string + min_time_between_triggers_seconds: 0 + wait_after_last_change_seconds: 0 + periodic: + interval: 0 + unit: HOURS + continuous: + pause_status: UNPAUSED + max_concurrent_runs: 10 + tasks: + - max_retries: 3 + task_key: Sessionize + description: Extracts session data from events + min_retry_interval_millis: 2000 + depends_on: [] + timeout_seconds: 86400 + spark_jar_task: + main_class_name: com.databricks.Sessionize + parameters: + - --data + - dbfs:/path/to/data.json + libraries: + - jar: dbfs:/mnt/databricks/Sessionize.jar + retry_on_timeout: false + existing_cluster_id: 0923-164208-meows279 + - max_retries: 3 + task_key: Orders_Ingest + description: Ingests order data + job_cluster_key: auto_scaling_cluster + min_retry_interval_millis: 2000 + depends_on: [] + timeout_seconds: 86400 + spark_jar_task: + main_class_name: com.databricks.OrdersIngest + parameters: + - --data + - dbfs:/path/to/order-data.json + libraries: + - jar: dbfs:/mnt/databricks/OrderIngest.jar + retry_on_timeout: false + - max_retries: 3 + task_key: Match + description: Matches orders with user sessions + notebook_task: + base_parameters: + age: '35' + name: John Doe + notebook_path: /Users/user.name@databricks.com/Match + min_retry_interval_millis: 2000 + depends_on: + - task_key: Orders_Ingest + - task_key: Sessionize + new_cluster: + autoscale: + max_workers: 16 + min_workers: 2 + node_type_id: null + spark_conf: + spark.speculation: true + spark_version: 7.3.x-scala2.12 + timeout_seconds: 86400 + retry_on_timeout: false + run_if: ALL_SUCCESS + job_clusters: + - job_cluster_key: auto_scaling_cluster + new_cluster: + autoscale: + max_workers: 16 + min_workers: 2 + node_type_id: null + spark_conf: + spark.speculation: true + spark_version: 7.3.x-scala2.12 + git_source: + git_branch: main + git_provider: gitHub + git_url: https://github.com/databricks/databricks-cli + tags: + cost-center: engineering + team: jobs + format: SINGLE_TASK + queue: + enabled: true + parameters: + - default: users + name: table + run_as: + user_name: user@databricks.com + service_principal_name: 692bc6d0-ffa3-11ed-be56-0242ac120002 + edit_mode: UI_LOCKED + deployment: + kind: BUNDLE + metadata_file_path: string + environments: + - environment_key: string + spec: + client: '1' + dependencies: + - string + access_control_list: + - user_name: string + group_name: string + service_principal_name: string + permission_level: CAN_MANAGE + description: Create a new job. + /api/2.2/jobs/delete: + post: + operationId: jobs-delete + externalDocs: + url: https://docs.databricks.com/api/workspace/jobs/delete + x-stackQL-resource: jobs + x-stackQL-method: delete + x-stackQL-verb: delete + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '429': + description: Operation is rejected due to throttling, e.g. some resource + has been exhausted, per-user quota. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + job_id: + type: required + example: + job_id: 11223344 + description: Deletes a job. + /api/2.2/jobs/get: + get: + operationId: jobs-get + externalDocs: + url: https://docs.databricks.com/api/workspace/jobs/get + x-stackQL-resource: jobs + x-stackQL-method: get + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: job_id + required: true + description: int64 + in: query + - name: page_token + in: query + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + job_id: + type: integer + creator_user_name: + type: string + run_as_user_name: + type: string + settings: + type: object + properties: + name: + type: string + description: + type: string + email_notifications: + type: object + properties: + on_start: + type: array + items: + type: string + on_success: + type: array + items: + type: string + on_failure: + type: array + items: + type: string + on_duration_warning_threshold_exceeded: + type: array + items: + type: string + on_streaming_backlog_exceeded: + type: array + items: + type: string + no_alert_for_skipped_runs: + type: boolean + webhook_notifications: + type: object + properties: + on_start: + type: array + items: + type: array + items: + type: object + properties: + id: + type: string + on_success: + type: array + items: + type: array + items: + type: object + properties: + id: + type: string + on_failure: + type: array + items: + type: array + items: + type: object + properties: + id: + type: string + on_duration_warning_threshold_exceeded: + type: array + items: + type: array + items: + type: object + properties: + id: + type: string + on_streaming_backlog_exceeded: + type: array + items: + type: array + items: + type: object + properties: + id: + type: string + notification_settings: + type: object + properties: + no_alert_for_skipped_runs: + type: boolean + no_alert_for_canceled_runs: + type: boolean + timeout_seconds: + type: integer + health: + type: object + properties: + rules: + type: array + items: + type: object + properties: + metric: + type: string + op: + type: string + value: + type: integer + schedule: + type: object + properties: + quartz_cron_expression: + type: string + timezone_id: + type: string + pause_status: + type: string + trigger: + type: object + properties: + pause_status: + type: string + file_arrival: + type: object + properties: + url: + type: string + min_time_between_triggers_seconds: + type: integer + wait_after_last_change_seconds: + type: integer + periodic: + type: object + properties: + interval: + type: integer + unit: + type: string + continuous: + type: object + properties: + pause_status: + type: string + max_concurrent_runs: + type: integer + tasks: + type: array + items: + type: object + properties: + max_retries: + type: integer + task_key: + type: string + description: + type: string + min_retry_interval_millis: + type: integer + depends_on: + type: array + items: {} + timeout_seconds: + type: integer + spark_jar_task: + type: object + properties: + main_class_name: + type: string + parameters: + type: array + items: + type: string + libraries: + type: array + items: + type: object + properties: + jar: + type: string + retry_on_timeout: + type: boolean + existing_cluster_id: + type: string + job_clusters: + type: array + items: + type: object + properties: + job_cluster_key: + type: string + new_cluster: + type: object + properties: + autoscale: + type: object + properties: + max_workers: + type: integer + min_workers: + type: integer + node_type_id: + type: 'null' + spark_conf: + type: object + properties: + spark.speculation: + type: boolean + spark_version: + type: string + git_source: + type: object + properties: + git_branch: + type: string + git_provider: + type: string + git_url: + type: string + tags: + type: object + properties: + cost-center: + type: string + team: + type: string + format: + type: string + queue: + type: object + properties: + enabled: + type: boolean + parameters: + type: array + items: + type: object + properties: + default: + type: string + name: + type: string + run_as: + type: object + properties: + user_name: + type: string + service_principal_name: + type: string + edit_mode: + type: string + deployment: + type: object + properties: + kind: + type: string + metadata_file_path: + type: string + environments: + type: array + items: + type: object + properties: + environment_key: + type: string + spec: + type: object + properties: + client: + type: string + dependencies: + type: array + items: + type: string + created_time: + type: integer + has_more: + type: boolean + next_page_token: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '429': + description: Operation is rejected due to throttling, e.g. some resource + has been exhausted, per-user quota. + '500': + description: Internal error. + description: Retrieves the details for a single job. + /api/2.2/jobs/list: + get: + operationId: jobs-list + externalDocs: + url: https://docs.databricks.com/api/workspace/jobs/list + x-stackQL-resource: jobs + x-stackQL-method: list + x-stackQL-verb: select + x-numReqParams: 0 + parameters: + - name: offset + in: query + - name: limit + in: query + - name: expand_tasks + in: query + - name: name + in: query + - name: page_token + in: query + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + jobs: + type: array + items: + type: object + properties: + job_id: + type: integer + creator_user_name: + type: string + settings: + type: object + properties: + name: + type: string + description: + type: string + email_notifications: + type: object + properties: + on_start: + type: array + items: + type: string + on_success: + type: array + items: + type: string + on_failure: + type: array + items: + type: string + on_duration_warning_threshold_exceeded: + type: array + items: + type: string + on_streaming_backlog_exceeded: + type: array + items: + type: string + no_alert_for_skipped_runs: + type: boolean + webhook_notifications: + type: object + properties: + on_start: + type: array + items: + type: array + items: + type: object + properties: + id: + type: string + on_success: + type: array + items: + type: array + items: + type: object + properties: + id: + type: string + on_failure: + type: array + items: + type: array + items: + type: object + properties: + id: + type: string + on_duration_warning_threshold_exceeded: + type: array + items: + type: array + items: + type: object + properties: + id: + type: string + on_streaming_backlog_exceeded: + type: array + items: + type: array + items: + type: object + properties: + id: + type: string + notification_settings: + type: object + properties: + no_alert_for_skipped_runs: + type: boolean + no_alert_for_canceled_runs: + type: boolean + timeout_seconds: + type: integer + health: + type: object + properties: + rules: + type: array + items: + type: object + properties: + metric: + type: string + op: + type: string + value: + type: integer + schedule: + type: object + properties: + quartz_cron_expression: + type: string + timezone_id: + type: string + pause_status: + type: string + trigger: + type: object + properties: + pause_status: + type: string + file_arrival: + type: object + properties: + url: + type: string + min_time_between_triggers_seconds: + type: integer + wait_after_last_change_seconds: + type: integer + periodic: + type: object + properties: + interval: + type: integer + unit: + type: string + continuous: + type: object + properties: + pause_status: + type: string + max_concurrent_runs: + type: integer + tasks: + type: array + items: + type: object + properties: + max_retries: + type: integer + task_key: + type: string + description: + type: string + min_retry_interval_millis: + type: integer + depends_on: + type: array + items: {} + timeout_seconds: + type: integer + spark_jar_task: + type: object + properties: + main_class_name: + type: string + parameters: + type: array + items: + type: string + libraries: + type: array + items: + type: object + properties: + jar: + type: string + retry_on_timeout: + type: boolean + existing_cluster_id: + type: string + job_clusters: + type: array + items: + type: object + properties: + job_cluster_key: + type: string + new_cluster: + type: object + properties: + autoscale: + type: object + properties: + max_workers: + type: integer + min_workers: + type: integer + node_type_id: + type: 'null' + spark_conf: + type: object + properties: + spark.speculation: + type: boolean + spark_version: + type: string + git_source: + type: object + properties: + git_branch: + type: string + git_provider: + type: string + git_url: + type: string + tags: + type: object + properties: + cost-center: + type: string + team: + type: string + format: + type: string + queue: + type: object + properties: + enabled: + type: boolean + parameters: + type: array + items: + type: object + properties: + default: + type: string + name: + type: string + run_as: + type: object + properties: + user_name: + type: string + service_principal_name: + type: string + edit_mode: + type: string + deployment: + type: object + properties: + kind: + type: string + metadata_file_path: + type: string + environments: + type: array + items: + type: object + properties: + environment_key: + type: string + spec: + type: object + properties: + client: + type: string + dependencies: + type: array + items: + type: string + created_time: + type: integer + has_more: + type: boolean + next_page_token: + type: string + prev_page_token: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '429': + description: Operation is rejected due to throttling, e.g. some resource + has been exhausted, per-user quota. + '500': + description: Internal error. + x-stackQL-objectKey: $.jobs + description: Retrieves a list of jobs. + /api/2.2/jobs/reset: + post: + operationId: jobs-reset + externalDocs: + url: https://docs.databricks.com/api/workspace/jobs/reset + x-stackQL-resource: jobs + x-stackQL-method: reset + x-stackQL-verb: replace + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '429': + description: Operation is rejected due to throttling, e.g. some resource + has been exhausted, per-user quota. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + job_id: + type: required + new_settings: + type: required + example: + job_id: 11223344 + new_settings: + name: A multitask job + description: This job contain multiple tasks that are required to + produce the weekly shark sightings report. + email_notifications: + on_start: + - user.name@databricks.com + on_success: + - user.name@databricks.com + on_failure: + - user.name@databricks.com + on_duration_warning_threshold_exceeded: + - user.name@databricks.com + on_streaming_backlog_exceeded: + - user.name@databricks.com + no_alert_for_skipped_runs: false + webhook_notifications: + on_start: + - - id: 0481e838-0a59-4eff-9541-a4ca6f149574 + on_success: + - - id: 0481e838-0a59-4eff-9541-a4ca6f149574 + on_failure: + - - id: 0481e838-0a59-4eff-9541-a4ca6f149574 + on_duration_warning_threshold_exceeded: + - - id: 0481e838-0a59-4eff-9541-a4ca6f149574 + on_streaming_backlog_exceeded: + - - id: 0481e838-0a59-4eff-9541-a4ca6f149574 + notification_settings: + no_alert_for_skipped_runs: false + no_alert_for_canceled_runs: false + timeout_seconds: 86400 + health: + rules: + - metric: RUN_DURATION_SECONDS + op: GREATER_THAN + value: 10 + schedule: + quartz_cron_expression: 20 30 * * * ? + timezone_id: Europe/London + pause_status: UNPAUSED + trigger: + pause_status: UNPAUSED + file_arrival: + url: string + min_time_between_triggers_seconds: 0 + wait_after_last_change_seconds: 0 + periodic: + interval: 0 + unit: HOURS + continuous: + pause_status: UNPAUSED + max_concurrent_runs: 10 + tasks: + - max_retries: 3 + task_key: Sessionize + description: Extracts session data from events + min_retry_interval_millis: 2000 + depends_on: [] + timeout_seconds: 86400 + spark_jar_task: + main_class_name: com.databricks.Sessionize + parameters: + - --data + - dbfs:/path/to/data.json + libraries: + - jar: dbfs:/mnt/databricks/Sessionize.jar + retry_on_timeout: false + existing_cluster_id: 0923-164208-meows279 + - max_retries: 3 + task_key: Orders_Ingest + description: Ingests order data + job_cluster_key: auto_scaling_cluster + min_retry_interval_millis: 2000 + depends_on: [] + timeout_seconds: 86400 + spark_jar_task: + main_class_name: com.databricks.OrdersIngest + parameters: + - --data + - dbfs:/path/to/order-data.json + libraries: + - jar: dbfs:/mnt/databricks/OrderIngest.jar + retry_on_timeout: false + - max_retries: 3 + task_key: Match + description: Matches orders with user sessions + notebook_task: + base_parameters: + age: '35' + name: John Doe + notebook_path: /Users/user.name@databricks.com/Match + min_retry_interval_millis: 2000 + depends_on: + - task_key: Orders_Ingest + - task_key: Sessionize + new_cluster: + autoscale: + max_workers: 16 + min_workers: 2 + node_type_id: null + spark_conf: + spark.speculation: true + spark_version: 7.3.x-scala2.12 + timeout_seconds: 86400 + retry_on_timeout: false + run_if: ALL_SUCCESS + job_clusters: + - job_cluster_key: auto_scaling_cluster + new_cluster: + autoscale: + max_workers: 16 + min_workers: 2 + node_type_id: null + spark_conf: + spark.speculation: true + spark_version: 7.3.x-scala2.12 + git_source: + git_branch: main + git_provider: gitHub + git_url: https://github.com/databricks/databricks-cli + tags: + cost-center: engineering + team: jobs + format: SINGLE_TASK + queue: + enabled: true + parameters: + - default: users + name: table + run_as: + user_name: user@databricks.com + service_principal_name: 692bc6d0-ffa3-11ed-be56-0242ac120002 + edit_mode: UI_LOCKED + deployment: + kind: BUNDLE + metadata_file_path: string + environments: + - environment_key: string + spec: + client: '1' + dependencies: + - string + description: Overwrite all settings for the given job. Use the + /api/2.2/jobs/run-now: + post: + operationId: jobs-runnow + externalDocs: + url: https://docs.databricks.com/api/workspace/jobs/runnow + x-stackQL-resource: jobs + x-stackQL-method: runnow + x-stackQL-verb: exec + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + run_id: + type: integer + number_in_job: + type: integer + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '429': + description: Operation is rejected due to throttling, e.g. some resource + has been exhausted, per-user quota. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + job_id: + type: required + idempotency_token: + type: integer + format: int64 + job_parameters: + type: object + pipeline_params: + type: object + queue: + type: object + example: + job_id: 11223344 + job_parameters: + property1: string + property2: string + pipeline_params: + full_refresh: false + idempotency_token: 8f018174-4792-40d5-bcbc-3e6a527352c8 + queue: + enabled: true + description: Run a job and return the + /api/2.2/jobs/runs/submit: + post: + operationId: jobs-submit + externalDocs: + url: https://docs.databricks.com/api/workspace/jobs/submit + x-stackQL-resource: jobs + x-stackQL-method: submit + x-stackQL-verb: exec + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + run_id: + type: integer + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '429': + description: Operation is rejected due to throttling, e.g. some resource + has been exhausted, per-user quota. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + run_name: + type: string + timeout_seconds: + type: int32 + idempotency_token: + type: string + health: + type: object + tasks: + type: Array of object + git_source: + type: object + webhook_notifications: + type: object + email_notifications: + type: object + notification_settings: + type: object + environments: + type: Array of object + access_control_list: + type: Array of object + queue: + type: object + run_as: + type: object + example: + run_name: A multitask job run + timeout_seconds: 86400 + health: + rules: + - metric: RUN_DURATION_SECONDS + op: GREATER_THAN + value: 10 + idempotency_token: 8f018174-4792-40d5-bcbc-3e6a527352c8 + tasks: + - task_key: Sessionize + description: Extracts session data from events + min_retry_interval_millis: 2000 + depends_on: [] + timeout_seconds: 86400 + spark_jar_task: + main_class_name: com.databricks.Sessionize + parameters: + - --data + - dbfs:/path/to/data.json + libraries: + - jar: dbfs:/mnt/databricks/Sessionize.jar + retry_on_timeout: false + existing_cluster_id: 0923-164208-meows279 + - task_key: Orders_Ingest + description: Ingests order data + depends_on: [] + timeout_seconds: 86400 + spark_jar_task: + main_class_name: com.databricks.OrdersIngest + parameters: + - --data + - dbfs:/path/to/order-data.json + libraries: + - jar: dbfs:/mnt/databricks/OrderIngest.jar + existing_cluster_id: 0923-164208-meows279 + - task_key: Match + description: Matches orders with user sessions + notebook_task: + base_parameters: + age: '35' + name: John Doe + notebook_path: /Users/user.name@databricks.com/Match + depends_on: + - task_key: Orders_Ingest + - task_key: Sessionize + new_cluster: + autoscale: + max_workers: 16 + min_workers: 2 + node_type_id: null + spark_conf: + spark.speculation: true + spark_version: 7.3.x-scala2.12 + timeout_seconds: 86400 + retry_on_timeout: false + run_if: ALL_SUCCESS + git_source: + git_branch: main + git_provider: gitHub + git_url: https://github.com/databricks/databricks-cli + webhook_notifications: + on_start: + - - id: 0481e838-0a59-4eff-9541-a4ca6f149574 + on_success: + - - id: 0481e838-0a59-4eff-9541-a4ca6f149574 + on_failure: + - - id: 0481e838-0a59-4eff-9541-a4ca6f149574 + on_duration_warning_threshold_exceeded: + - - id: 0481e838-0a59-4eff-9541-a4ca6f149574 + on_streaming_backlog_exceeded: + - - id: 0481e838-0a59-4eff-9541-a4ca6f149574 + email_notifications: + on_start: + - user.name@databricks.com + on_success: + - user.name@databricks.com + on_failure: + - user.name@databricks.com + on_duration_warning_threshold_exceeded: + - user.name@databricks.com + on_streaming_backlog_exceeded: + - user.name@databricks.com + no_alert_for_skipped_runs: false + notification_settings: + no_alert_for_skipped_runs: false + no_alert_for_canceled_runs: false + environments: + - environment_key: string + spec: + client: '1' + dependencies: + - string + access_control_list: + - user_name: string + group_name: string + service_principal_name: string + permission_level: CAN_MANAGE + queue: + enabled: true + run_as: + user_name: user@databricks.com + service_principal_name: 692bc6d0-ffa3-11ed-be56-0242ac120002 + description: "Submit a one-time run. This endpoint allows you to submit a workload\ + \ directly without creating a job. Runs submitted using this endpoint don\u2019\ + t display in the UI. Use the" + /api/2.2/jobs/update: + post: + operationId: jobs-update + externalDocs: + url: https://docs.databricks.com/api/workspace/jobs/update + x-stackQL-resource: jobs + x-stackQL-method: update + x-stackQL-verb: update + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '429': + description: Operation is rejected due to throttling, e.g. some resource + has been exhausted, per-user quota. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + job_id: + type: required + fields_to_remove: + type: integer + format: int64 + new_settings: + type: object + example: + job_id: 11223344 + new_settings: + name: A multitask job + description: This job contain multiple tasks that are required to + produce the weekly shark sightings report. + email_notifications: + on_start: + - user.name@databricks.com + on_success: + - user.name@databricks.com + on_failure: + - user.name@databricks.com + on_duration_warning_threshold_exceeded: + - user.name@databricks.com + on_streaming_backlog_exceeded: + - user.name@databricks.com + no_alert_for_skipped_runs: false + webhook_notifications: + on_start: + - - id: 0481e838-0a59-4eff-9541-a4ca6f149574 + on_success: + - - id: 0481e838-0a59-4eff-9541-a4ca6f149574 + on_failure: + - - id: 0481e838-0a59-4eff-9541-a4ca6f149574 + on_duration_warning_threshold_exceeded: + - - id: 0481e838-0a59-4eff-9541-a4ca6f149574 + on_streaming_backlog_exceeded: + - - id: 0481e838-0a59-4eff-9541-a4ca6f149574 + notification_settings: + no_alert_for_skipped_runs: false + no_alert_for_canceled_runs: false + timeout_seconds: 86400 + health: + rules: + - metric: RUN_DURATION_SECONDS + op: GREATER_THAN + value: 10 + schedule: + quartz_cron_expression: 20 30 * * * ? + timezone_id: Europe/London + pause_status: UNPAUSED + trigger: + pause_status: UNPAUSED + file_arrival: + url: string + min_time_between_triggers_seconds: 0 + wait_after_last_change_seconds: 0 + periodic: + interval: 0 + unit: HOURS + continuous: + pause_status: UNPAUSED + max_concurrent_runs: 10 + tasks: + - max_retries: 3 + task_key: Sessionize + description: Extracts session data from events + min_retry_interval_millis: 2000 + depends_on: [] + timeout_seconds: 86400 + spark_jar_task: + main_class_name: com.databricks.Sessionize + parameters: + - --data + - dbfs:/path/to/data.json + libraries: + - jar: dbfs:/mnt/databricks/Sessionize.jar + retry_on_timeout: false + existing_cluster_id: 0923-164208-meows279 + - max_retries: 3 + task_key: Orders_Ingest + description: Ingests order data + job_cluster_key: auto_scaling_cluster + min_retry_interval_millis: 2000 + depends_on: [] + timeout_seconds: 86400 + spark_jar_task: + main_class_name: com.databricks.OrdersIngest + parameters: + - --data + - dbfs:/path/to/order-data.json + libraries: + - jar: dbfs:/mnt/databricks/OrderIngest.jar + retry_on_timeout: false + - max_retries: 3 + task_key: Match + description: Matches orders with user sessions + notebook_task: + base_parameters: + age: '35' + name: John Doe + notebook_path: /Users/user.name@databricks.com/Match + min_retry_interval_millis: 2000 + depends_on: + - task_key: Orders_Ingest + - task_key: Sessionize + new_cluster: + autoscale: + max_workers: 16 + min_workers: 2 + node_type_id: null + spark_conf: + spark.speculation: true + spark_version: 7.3.x-scala2.12 + timeout_seconds: 86400 + retry_on_timeout: false + run_if: ALL_SUCCESS + job_clusters: + - job_cluster_key: auto_scaling_cluster + new_cluster: + autoscale: + max_workers: 16 + min_workers: 2 + node_type_id: null + spark_conf: + spark.speculation: true + spark_version: 7.3.x-scala2.12 + git_source: + git_branch: main + git_provider: gitHub + git_url: https://github.com/databricks/databricks-cli + tags: + cost-center: engineering + team: jobs + format: SINGLE_TASK + queue: + enabled: true + parameters: + - default: users + name: table + run_as: + user_name: user@databricks.com + service_principal_name: 692bc6d0-ffa3-11ed-be56-0242ac120002 + edit_mode: UI_LOCKED + deployment: + kind: BUNDLE + metadata_file_path: string + environments: + - environment_key: string + spec: + client: '1' + dependencies: + - string + fields_to_remove: + - libraries + - schedule + - tasks/task_1 + - job_clusters/Default + description: Add, update, or remove specific settings of an existing job. Use + the + /api/2.0/policies/jobs/enforce-compliance: + post: + operationId: job-compliance-enforcecompliance + externalDocs: + url: https://docs.databricks.com/api/workspace/policycomplianceforjobs/enforcecompliance + x-stackQL-resource: job_compliance + x-stackQL-method: enforcecompliance + x-stackQL-verb: replace + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + has_changes: + type: boolean + job_cluster_changes: + type: array + items: + type: object + properties: + field: + type: string + previous_value: + type: string + new_value: + type: string + settings: + type: object + properties: + name: + type: string + description: + type: string + email_notifications: + type: object + properties: + on_start: + type: array + items: + type: string + on_success: + type: array + items: + type: string + on_failure: + type: array + items: + type: string + on_duration_warning_threshold_exceeded: + type: array + items: + type: string + on_streaming_backlog_exceeded: + type: array + items: + type: string + no_alert_for_skipped_runs: + type: boolean + webhook_notifications: + type: object + properties: + on_start: + type: array + items: + type: array + items: + type: object + properties: + id: + type: string + on_success: + type: array + items: + type: array + items: + type: object + properties: + id: + type: string + on_failure: + type: array + items: + type: array + items: + type: object + properties: + id: + type: string + on_duration_warning_threshold_exceeded: + type: array + items: + type: array + items: + type: object + properties: + id: + type: string + on_streaming_backlog_exceeded: + type: array + items: + type: array + items: + type: object + properties: + id: + type: string + notification_settings: + type: object + properties: + no_alert_for_skipped_runs: + type: boolean + no_alert_for_canceled_runs: + type: boolean + timeout_seconds: + type: integer + health: + type: object + properties: + rules: + type: array + items: + type: object + properties: + metric: + type: string + op: + type: string + value: + type: integer + schedule: + type: object + properties: + quartz_cron_expression: + type: string + timezone_id: + type: string + pause_status: + type: string + trigger: + type: object + properties: + pause_status: + type: string + file_arrival: + type: object + properties: + url: + type: string + min_time_between_triggers_seconds: + type: integer + wait_after_last_change_seconds: + type: integer + periodic: + type: object + properties: + interval: + type: integer + unit: + type: string + continuous: + type: object + properties: + pause_status: + type: string + max_concurrent_runs: + type: integer + tasks: + type: array + items: + type: object + properties: + max_retries: + type: integer + task_key: + type: string + description: + type: string + min_retry_interval_millis: + type: integer + depends_on: + type: array + items: {} + timeout_seconds: + type: integer + spark_jar_task: + type: object + properties: + main_class_name: + type: string + parameters: + type: array + items: + type: string + libraries: + type: array + items: + type: object + properties: + jar: + type: string + retry_on_timeout: + type: boolean + existing_cluster_id: + type: string + job_clusters: + type: array + items: + type: object + properties: + job_cluster_key: + type: string + new_cluster: + type: object + properties: + autoscale: + type: object + properties: + max_workers: + type: integer + min_workers: + type: integer + node_type_id: + type: 'null' + spark_conf: + type: object + properties: + spark.speculation: + type: boolean + spark_version: + type: string + git_source: + type: object + properties: + git_branch: + type: string + git_provider: + type: string + git_url: + type: string + tags: + type: object + properties: + cost-center: + type: string + team: + type: string + format: + type: string + queue: + type: object + properties: + enabled: + type: boolean + parameters: + type: array + items: + type: object + properties: + default: + type: string + name: + type: string + run_as: + type: object + properties: + user_name: + type: string + service_principal_name: + type: string + edit_mode: + type: string + deployment: + type: object + properties: + kind: + type: string + metadata_file_path: + type: string + environments: + type: array + items: + type: object + properties: + environment_key: + type: string + spec: + type: object + properties: + client: + type: string + dependencies: + type: array + items: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '429': + description: Operation is rejected due to throttling, e.g. some resource + has been exhausted, per-user quota. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + job_id: + type: required + validate_only: + type: integer + format: int64 + example: + job_id: 0 + validate_only: false + description: Updates a job so the job clusters that are created when running + the job (specified in + /api/2.0/policies/jobs/get-compliance: + get: + operationId: job-compliance-getcompliance + externalDocs: + url: https://docs.databricks.com/api/workspace/policycomplianceforjobs/getcompliance + x-stackQL-resource: job_compliance + x-stackQL-method: getcompliance + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: job_id + required: true + description: int64 + in: query + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + is_compliant: + type: boolean + violations: + type: object + properties: + job_clusters[job_cluster_key].new_cluster.custom_tags.test_tag: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '429': + description: Operation is rejected due to throttling, e.g. some resource + has been exhausted, per-user quota. + '500': + description: Internal error. + description: Returns the policy compliance status of a job. Jobs could be out + of compliance if a cluster policy they use was updated after the job was last + edited and some of its job clusters no longer comply with their updated policies. + /api/2.0/policies/jobs/list-compliance: + get: + operationId: job-compliance-listcompliance + externalDocs: + url: https://docs.databricks.com/api/workspace/policycomplianceforjobs/listcompliance + x-stackQL-resource: job_compliance + x-stackQL-method: listcompliance + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: policy_id + required: true + description: string + in: query + - name: page_token + in: query + - name: page_size + in: query + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + jobs: + type: array + items: + type: object + properties: + job_id: + type: integer + is_compliant: + type: boolean + violations: + type: object + properties: + job_clusters[job_cluster_key].new_cluster.custom_tags.test_tag: + type: string + next_page_token: + type: string + prev_page_token: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '429': + description: Operation is rejected due to throttling, e.g. some resource + has been exhausted, per-user quota. + '500': + description: Internal error. + x-stackQL-objectKey: $.jobs + description: Returns the policy compliance status of all jobs that use a given + policy. Jobs could be out of compliance if a cluster policy they use was updated + after the job was last edited and its job clusters no longer comply with the + updated policy. + /api/2.0/permissions/jobs/{job_id}: + get: + operationId: job-permissions-getpermissions + externalDocs: + url: https://docs.databricks.com/api/workspace/jobs/getpermissions + x-stackQL-resource: job_permissions + x-stackQL-method: getpermissions + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: job_id + required: true + description: string + in: path + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + object_id: + type: string + object_type: + type: string + access_control_list: + type: array + items: + type: object + properties: + user_name: + type: string + group_name: + type: string + service_principal_name: + type: string + display_name: + type: string + all_permissions: + type: array + items: + type: object + properties: + permission_level: + type: string + inherited: + type: boolean + inherited_from_object: + type: array + items: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Gets the permissions of a job. Jobs can inherit permissions from + their root object. + put: + operationId: job-permissions-setpermissions + externalDocs: + url: https://docs.databricks.com/api/workspace/jobs/setpermissions + x-stackQL-resource: job_permissions + x-stackQL-method: setpermissions + x-stackQL-verb: replace + x-numReqParams: 1 + parameters: + - name: job_id + required: true + description: string + in: path + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + object_id: + type: string + object_type: + type: string + access_control_list: + type: array + items: + type: object + properties: + user_name: + type: string + group_name: + type: string + service_principal_name: + type: string + display_name: + type: string + all_permissions: + type: array + items: + type: object + properties: + permission_level: + type: string + inherited: + type: boolean + inherited_from_object: + type: array + items: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + access_control_list: + type: Array of object + example: + access_control_list: + - user_name: string + group_name: string + service_principal_name: string + permission_level: CAN_MANAGE + description: Sets permissions on an object, replacing existing permissions if + they exist. Deletes all direct permissions if none are specified. Objects + can inherit permissions from their root object. + patch: + operationId: job-permissions-updatepermissions + externalDocs: + url: https://docs.databricks.com/api/workspace/jobs/updatepermissions + x-stackQL-resource: job_permissions + x-stackQL-method: updatepermissions + x-stackQL-verb: update + x-numReqParams: 1 + parameters: + - name: job_id + required: true + description: string + in: path + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + object_id: + type: string + object_type: + type: string + access_control_list: + type: array + items: + type: object + properties: + user_name: + type: string + group_name: + type: string + service_principal_name: + type: string + display_name: + type: string + all_permissions: + type: array + items: + type: object + properties: + permission_level: + type: string + inherited: + type: boolean + inherited_from_object: + type: array + items: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + access_control_list: + type: Array of object + example: + access_control_list: + - user_name: string + group_name: string + service_principal_name: string + permission_level: CAN_MANAGE + description: Updates the permissions on a job. Jobs can inherit permissions + from their root object. + /api/2.0/permissions/jobs/{job_id}/permissionLevels: + get: + operationId: job-permission-levels-getpermissionlevels + externalDocs: + url: https://docs.databricks.com/api/workspace/jobs/getpermissionlevels + x-stackQL-resource: job_permission_levels + x-stackQL-method: getpermissionlevels + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: job_id + required: true + description: string + in: path + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + permission_levels: + type: array + items: + type: object + properties: + permission_level: + type: string + description: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + x-stackQL-objectKey: $.permission_levels + description: Gets the permission levels that a user can have on an object. + /api/2.2/jobs/runs/cancel-all: + post: + operationId: job-runs-cancelallruns + externalDocs: + url: https://docs.databricks.com/api/workspace/jobs/cancelallruns + x-stackQL-resource: job_runs + x-stackQL-method: cancelallruns + x-stackQL-verb: exec + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '429': + description: Operation is rejected due to throttling, e.g. some resource + has been exhausted, per-user quota. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + job_id: + type: integer + format: int64 + all_queued_runs: + type: boolean + example: + job_id: 11223344 + all_queued_runs: false + description: Cancels all active runs of a job. The runs are canceled asynchronously, + so it doesn't prevent new runs from being started. + /api/2.2/jobs/runs/cancel: + post: + operationId: job-runs-cancelrun + externalDocs: + url: https://docs.databricks.com/api/workspace/jobs/cancelrun + x-stackQL-resource: job_runs + x-stackQL-method: cancelrun + x-stackQL-verb: exec + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '429': + description: Operation is rejected due to throttling, e.g. some resource + has been exhausted, per-user quota. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + run_id: + type: required + example: + run_id: 455644833 + description: Cancels a job run or a task run. The run is canceled asynchronously, + so it may still be running when this request completes. + /api/2.2/jobs/runs/delete: + post: + operationId: job-runs-deleterun + externalDocs: + url: https://docs.databricks.com/api/workspace/jobs/deleterun + x-stackQL-resource: job_runs + x-stackQL-method: deleterun + x-stackQL-verb: delete + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '429': + description: Operation is rejected due to throttling, e.g. some resource + has been exhausted, per-user quota. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + run_id: + type: required + example: + run_id: 455644833 + description: Deletes a non-active run. Returns an error if the run is active. + /api/2.2/jobs/runs/export: + get: + operationId: job-runs-exportrun + externalDocs: + url: https://docs.databricks.com/api/workspace/jobs/exportrun + x-stackQL-resource: job_runs + x-stackQL-method: exportrun + x-stackQL-verb: exec + x-numReqParams: 1 + parameters: + - name: run_id + required: true + description: int64 + in: query + - name: views_to_export + in: query + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + views: + type: array + items: + type: object + properties: + content: + type: string + name: + type: string + type: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '429': + description: Operation is rejected due to throttling, e.g. some resource + has been exhausted, per-user quota. + '500': + description: Internal error. + description: Export and retrieve the job run task. + /api/2.2/jobs/runs/get: + get: + operationId: job-runs-getrun + externalDocs: + url: https://docs.databricks.com/api/workspace/jobs/getrun + x-stackQL-resource: job_runs + x-stackQL-method: getrun + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: run_id + required: true + description: int64 + in: query + - name: include_history + in: query + - name: include_resolved_values + in: query + - name: page_token + in: query + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + job_id: + type: integer + run_id: + type: integer + creator_user_name: + type: string + number_in_job: + type: integer + original_attempt_run_id: + type: integer + state: + type: object + properties: + life_cycle_state: + type: string + result_state: + type: string + state_message: + type: string + user_cancelled_or_timedout: + type: boolean + queue_reason: + type: string + schedule: + type: object + properties: + quartz_cron_expression: + type: string + timezone_id: + type: string + pause_status: + type: string + cluster_spec: + type: object + properties: + existing_cluster_id: + type: string + new_cluster: + type: object + properties: + num_workers: + type: integer + autoscale: + type: object + properties: + min_workers: + type: integer + max_workers: + type: integer + kind: + type: string + cluster_name: + type: string + spark_version: + type: string + use_ml_runtime: + type: boolean + is_single_node: + type: boolean + spark_conf: + type: object + properties: + property1: + type: string + property2: + type: string + aws_attributes: + type: object + properties: + first_on_demand: + type: string + availability: + type: string + zone_id: + type: string + instance_profile_arn: + type: string + spot_bid_price_percent: + type: string + ebs_volume_type: + type: string + ebs_volume_count: + type: string + ebs_volume_size: + type: integer + ebs_volume_iops: + type: integer + ebs_volume_throughput: + type: integer + node_type_id: + type: string + driver_node_type_id: + type: string + ssh_public_keys: + type: array + items: + type: string + custom_tags: + type: object + properties: + property1: + type: string + property2: + type: string + cluster_log_conf: + type: object + properties: + dbfs: + type: object + properties: + destination: + type: string + s3: + type: object + properties: + destination: + type: string + region: + type: string + endpoint: + type: string + enable_encryption: + type: boolean + encryption_type: + type: string + kms_key: + type: string + canned_acl: + type: string + init_scripts: + type: array + items: + type: object + properties: + workspace: + type: object + properties: + destination: + type: string + volumes: + type: object + properties: + destination: + type: string + s3: + type: object + properties: + destination: + type: string + region: + type: string + endpoint: + type: string + enable_encryption: + type: boolean + encryption_type: + type: string + kms_key: + type: string + canned_acl: + type: string + file: + type: object + properties: + destination: + type: string + dbfs: + type: object + properties: + destination: + type: string + abfss: + type: object + properties: + destination: + type: string + gcs: + type: object + properties: + destination: + type: string + spark_env_vars: + type: object + properties: + property1: + type: string + property2: + type: string + autotermination_minutes: + type: integer + enable_elastic_disk: + type: boolean + instance_pool_id: + type: string + policy_id: + type: string + enable_local_disk_encryption: + type: boolean + driver_instance_pool_id: + type: string + workload_type: + type: object + properties: + clients: + type: object + properties: + notebooks: + type: string + jobs: + type: string + runtime_engine: + type: string + docker_image: + type: object + properties: + url: + type: string + basic_auth: + type: object + properties: + username: + type: string + password: + type: string + data_security_mode: + type: string + single_user_name: + type: string + apply_policy_default_values: + type: boolean + job_cluster_key: + type: string + libraries: + type: array + items: + type: object + properties: + jar: + type: string + egg: + type: string + pypi: + type: object + properties: + package: + type: string + repo: + type: string + maven: + type: object + properties: + coordinates: + type: string + repo: + type: string + exclusions: + type: array + items: + type: string + cran: + type: object + properties: + package: + type: string + repo: + type: string + whl: + type: string + requirements: + type: string + cluster_instance: + type: object + properties: + cluster_id: + type: string + spark_context_id: + type: string + job_parameters: + type: array + items: + type: object + properties: + default: + type: string + name: + type: string + value: + type: string + overriding_parameters: + type: object + properties: + pipeline_params: + type: object + properties: + full_refresh: + type: boolean + start_time: + type: integer + setup_duration: + type: integer + execution_duration: + type: integer + cleanup_duration: + type: integer + end_time: + type: integer + run_duration: + type: integer + queue_duration: + type: integer + trigger: + type: string + trigger_info: + type: object + properties: + run_id: + type: integer + run_name: + type: string + run_page_url: + type: string + run_type: + type: string + tasks: + type: array + items: + type: object + properties: + setup_duration: + type: integer + start_time: + type: integer + task_key: + type: string + state: + type: object + properties: + life_cycle_state: + type: string + result_state: + type: string + state_message: + type: string + user_cancelled_or_timedout: + type: boolean + description: + type: string + job_cluster_key: + type: string + end_time: + type: integer + run_page_url: + type: string + run_id: + type: integer + cluster_instance: + type: object + properties: + cluster_id: + type: string + spark_context_id: + type: string + spark_jar_task: + type: object + properties: + main_class_name: + type: string + libraries: + type: array + items: + type: object + properties: + jar: + type: string + attempt_number: + type: integer + cleanup_duration: + type: integer + execution_duration: + type: integer + run_if: + type: string + description: + type: string + attempt_number: + type: integer + job_clusters: + type: array + items: + type: object + properties: + job_cluster_key: + type: string + new_cluster: + type: object + properties: + autoscale: + type: object + properties: + max_workers: + type: integer + min_workers: + type: integer + node_type_id: + type: 'null' + spark_conf: + type: object + properties: + spark.speculation: + type: boolean + spark_version: + type: string + git_source: + type: object + properties: + git_branch: + type: string + git_provider: + type: string + git_url: + type: string + repair_history: + type: array + items: + type: object + properties: + type: + type: string + start_time: + type: integer + end_time: + type: integer + state: + type: object + properties: + life_cycle_state: + type: string + result_state: + type: string + state_message: + type: string + user_cancelled_or_timedout: + type: boolean + queue_reason: + type: string + id: + type: integer + task_run_ids: + type: array + items: + type: integer + status: + type: object + properties: + state: + type: string + termination_details: + type: object + properties: + code: + type: string + type: + type: string + message: + type: string + queue_details: + type: object + properties: + code: + type: string + message: + type: string + status: + type: object + properties: + state: + type: string + termination_details: + type: object + properties: + code: + type: string + type: + type: string + message: + type: string + queue_details: + type: object + properties: + code: + type: string + message: + type: string + job_run_id: + type: integer + has_more: + type: boolean + next_page_token: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '429': + description: Operation is rejected due to throttling, e.g. some resource + has been exhausted, per-user quota. + '500': + description: Internal error. + description: Retrieves the metadata of a run. + /api/2.2/jobs/runs/list: + get: + operationId: job-runs-listruns + externalDocs: + url: https://docs.databricks.com/api/workspace/jobs/listruns + x-stackQL-resource: job_runs + x-stackQL-method: listruns + x-stackQL-verb: select + x-numReqParams: 0 + parameters: + - name: job_id + in: query + - name: active_only + in: query + - name: completed_only + in: query + - name: offset + in: query + - name: limit + in: query + - name: run_type + in: query + - name: expand_tasks + in: query + - name: start_time_from + in: query + - name: start_time_to + in: query + - name: page_token + in: query + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + runs: + type: array + items: + type: object + properties: + job_id: + type: integer + run_id: + type: integer + creator_user_name: + type: string + number_in_job: + type: integer + original_attempt_run_id: + type: integer + state: + type: object + properties: + life_cycle_state: + type: string + result_state: + type: string + state_message: + type: string + user_cancelled_or_timedout: + type: boolean + queue_reason: + type: string + schedule: + type: object + properties: + quartz_cron_expression: + type: string + timezone_id: + type: string + pause_status: + type: string + cluster_spec: + type: object + properties: + existing_cluster_id: + type: string + new_cluster: + type: object + properties: + num_workers: + type: integer + autoscale: + type: object + properties: + min_workers: + type: integer + max_workers: + type: integer + kind: + type: string + cluster_name: + type: string + spark_version: + type: string + use_ml_runtime: + type: boolean + is_single_node: + type: boolean + spark_conf: + type: object + properties: + property1: + type: string + property2: + type: string + aws_attributes: + type: object + properties: + first_on_demand: + type: string + availability: + type: string + zone_id: + type: string + instance_profile_arn: + type: string + spot_bid_price_percent: + type: string + ebs_volume_type: + type: string + ebs_volume_count: + type: string + ebs_volume_size: + type: integer + ebs_volume_iops: + type: integer + ebs_volume_throughput: + type: integer + node_type_id: + type: string + driver_node_type_id: + type: string + ssh_public_keys: + type: array + items: + type: string + custom_tags: + type: object + properties: + property1: + type: string + property2: + type: string + cluster_log_conf: + type: object + properties: + dbfs: + type: object + properties: + destination: + type: string + s3: + type: object + properties: + destination: + type: string + region: + type: string + endpoint: + type: string + enable_encryption: + type: boolean + encryption_type: + type: string + kms_key: + type: string + canned_acl: + type: string + init_scripts: + type: array + items: + type: object + properties: + workspace: + type: object + properties: + destination: + type: string + volumes: + type: object + properties: + destination: + type: string + s3: + type: object + properties: + destination: + type: string + region: + type: string + endpoint: + type: string + enable_encryption: + type: boolean + encryption_type: + type: string + kms_key: + type: string + canned_acl: + type: string + file: + type: object + properties: + destination: + type: string + dbfs: + type: object + properties: + destination: + type: string + abfss: + type: object + properties: + destination: + type: string + gcs: + type: object + properties: + destination: + type: string + spark_env_vars: + type: object + properties: + property1: + type: string + property2: + type: string + autotermination_minutes: + type: integer + enable_elastic_disk: + type: boolean + instance_pool_id: + type: string + policy_id: + type: string + enable_local_disk_encryption: + type: boolean + driver_instance_pool_id: + type: string + workload_type: + type: object + properties: + clients: + type: object + properties: + notebooks: + type: string + jobs: + type: string + runtime_engine: + type: string + docker_image: + type: object + properties: + url: + type: string + basic_auth: + type: object + properties: + username: + type: string + password: + type: string + data_security_mode: + type: string + single_user_name: + type: string + apply_policy_default_values: + type: boolean + job_cluster_key: + type: string + libraries: + type: array + items: + type: object + properties: + jar: + type: string + egg: + type: string + pypi: + type: object + properties: + package: + type: string + repo: + type: string + maven: + type: object + properties: + coordinates: + type: string + repo: + type: string + exclusions: + type: array + items: + type: string + cran: + type: object + properties: + package: + type: string + repo: + type: string + whl: + type: string + requirements: + type: string + cluster_instance: + type: object + properties: + cluster_id: + type: string + spark_context_id: + type: string + job_parameters: + type: array + items: + type: object + properties: + default: + type: string + name: + type: string + value: + type: string + overriding_parameters: + type: object + properties: + pipeline_params: + type: object + properties: + full_refresh: + type: boolean + start_time: + type: integer + setup_duration: + type: integer + execution_duration: + type: integer + cleanup_duration: + type: integer + end_time: + type: integer + run_duration: + type: integer + queue_duration: + type: integer + trigger: + type: string + trigger_info: + type: object + properties: + run_id: + type: integer + run_name: + type: string + run_page_url: + type: string + run_type: + type: string + tasks: + type: array + items: + type: object + properties: + setup_duration: + type: integer + start_time: + type: integer + task_key: + type: string + state: + type: object + properties: + life_cycle_state: + type: string + result_state: + type: string + state_message: + type: string + user_cancelled_or_timedout: + type: boolean + description: + type: string + job_cluster_key: + type: string + end_time: + type: integer + run_page_url: + type: string + run_id: + type: integer + cluster_instance: + type: object + properties: + cluster_id: + type: string + spark_context_id: + type: string + spark_jar_task: + type: object + properties: + main_class_name: + type: string + libraries: + type: array + items: + type: object + properties: + jar: + type: string + attempt_number: + type: integer + cleanup_duration: + type: integer + execution_duration: + type: integer + run_if: + type: string + description: + type: string + attempt_number: + type: integer + job_clusters: + type: array + items: + type: object + properties: + job_cluster_key: + type: string + new_cluster: + type: object + properties: + autoscale: + type: object + properties: + max_workers: + type: integer + min_workers: + type: integer + node_type_id: + type: 'null' + spark_conf: + type: object + properties: + spark.speculation: + type: boolean + spark_version: + type: string + git_source: + type: object + properties: + git_branch: + type: string + git_provider: + type: string + git_url: + type: string + repair_history: + type: array + items: + type: object + properties: + type: + type: string + start_time: + type: integer + end_time: + type: integer + state: + type: object + properties: + life_cycle_state: + type: string + result_state: + type: string + state_message: + type: string + user_cancelled_or_timedout: + type: boolean + queue_reason: + type: string + id: + type: integer + task_run_ids: + type: array + items: + type: integer + status: + type: object + properties: + state: + type: string + termination_details: + type: object + properties: + code: + type: string + type: + type: string + message: + type: string + queue_details: + type: object + properties: + code: + type: string + message: + type: string + status: + type: object + properties: + state: + type: string + termination_details: + type: object + properties: + code: + type: string + type: + type: string + message: + type: string + queue_details: + type: object + properties: + code: + type: string + message: + type: string + job_run_id: + type: integer + has_more: + type: boolean + next_page_token: + type: string + prev_page_token: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '429': + description: Operation is rejected due to throttling, e.g. some resource + has been exhausted, per-user quota. + '500': + description: Internal error. + x-stackQL-objectKey: $.runs + description: List runs in descending order by start time. + /api/2.2/jobs/runs/repair: + post: + operationId: job-runs-repairrun + externalDocs: + url: https://docs.databricks.com/api/workspace/jobs/repairrun + x-stackQL-resource: job_runs + x-stackQL-method: repairrun + x-stackQL-verb: exec + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + repair_id: + type: integer + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + run_id: + type: required + latest_repair_id: + type: integer + format: int64 + rerun_tasks: + type: integer + format: int64 + rerun_all_failed_tasks: + type: Array of string + rerun_dependent_tasks: + type: boolean + job_parameters: + type: object + pipeline_params: + type: object + example: + run_id: 455644833 + latest_repair_id: 734650698524280 + rerun_tasks: + - task0 + - task1 + job_parameters: + property1: string + property2: string + pipeline_params: + full_refresh: false + rerun_all_failed_tasks: false + rerun_dependent_tasks: false + description: Re-run one or more tasks. Tasks are re-run as part of the original + job run. They use the current job and task settings, and can be viewed in + the history for the original job run. + /api/2.2/jobs/runs/get-output: + get: + operationId: job-run-output-getrunoutput + externalDocs: + url: https://docs.databricks.com/api/workspace/jobs/getrunoutput + x-stackQL-resource: job_run_output + x-stackQL-method: getrunoutput + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: run_id + required: true + description: int64 + in: query + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + metadata: + type: object + properties: + job_id: + type: integer + run_id: + type: integer + creator_user_name: + type: string + number_in_job: + type: integer + original_attempt_run_id: + type: integer + state: + type: object + properties: + life_cycle_state: + type: string + result_state: + type: string + state_message: + type: string + user_cancelled_or_timedout: + type: boolean + queue_reason: + type: string + schedule: + type: object + properties: + quartz_cron_expression: + type: string + timezone_id: + type: string + pause_status: + type: string + cluster_spec: + type: object + properties: + existing_cluster_id: + type: string + new_cluster: + type: object + properties: + num_workers: + type: integer + autoscale: + type: object + properties: + min_workers: + type: integer + max_workers: + type: integer + kind: + type: string + cluster_name: + type: string + spark_version: + type: string + use_ml_runtime: + type: boolean + is_single_node: + type: boolean + spark_conf: + type: object + properties: + property1: + type: string + property2: + type: string + aws_attributes: + type: object + properties: + first_on_demand: + type: string + availability: + type: string + zone_id: + type: string + instance_profile_arn: + type: string + spot_bid_price_percent: + type: string + ebs_volume_type: + type: string + ebs_volume_count: + type: string + ebs_volume_size: + type: integer + ebs_volume_iops: + type: integer + ebs_volume_throughput: + type: integer + node_type_id: + type: string + driver_node_type_id: + type: string + ssh_public_keys: + type: array + items: + type: string + custom_tags: + type: object + properties: + property1: + type: string + property2: + type: string + cluster_log_conf: + type: object + properties: + dbfs: + type: object + properties: + destination: + type: string + s3: + type: object + properties: + destination: + type: string + region: + type: string + endpoint: + type: string + enable_encryption: + type: boolean + encryption_type: + type: string + kms_key: + type: string + canned_acl: + type: string + init_scripts: + type: array + items: + type: object + properties: + workspace: + type: object + properties: + destination: + type: string + volumes: + type: object + properties: + destination: + type: string + s3: + type: object + properties: + destination: + type: string + region: + type: string + endpoint: + type: string + enable_encryption: + type: boolean + encryption_type: + type: string + kms_key: + type: string + canned_acl: + type: string + file: + type: object + properties: + destination: + type: string + dbfs: + type: object + properties: + destination: + type: string + abfss: + type: object + properties: + destination: + type: string + gcs: + type: object + properties: + destination: + type: string + spark_env_vars: + type: object + properties: + property1: + type: string + property2: + type: string + autotermination_minutes: + type: integer + enable_elastic_disk: + type: boolean + instance_pool_id: + type: string + policy_id: + type: string + enable_local_disk_encryption: + type: boolean + driver_instance_pool_id: + type: string + workload_type: + type: object + properties: + clients: + type: object + properties: + notebooks: + type: string + jobs: + type: string + runtime_engine: + type: string + docker_image: + type: object + properties: + url: + type: string + basic_auth: + type: object + properties: + username: + type: string + password: + type: string + data_security_mode: + type: string + single_user_name: + type: string + apply_policy_default_values: + type: boolean + job_cluster_key: + type: string + libraries: + type: array + items: + type: object + properties: + jar: + type: string + egg: + type: string + pypi: + type: object + properties: + package: + type: string + repo: + type: string + maven: + type: object + properties: + coordinates: + type: string + repo: + type: string + exclusions: + type: array + items: + type: string + cran: + type: object + properties: + package: + type: string + repo: + type: string + whl: + type: string + requirements: + type: string + cluster_instance: + type: object + properties: + cluster_id: + type: string + spark_context_id: + type: string + job_parameters: + type: array + items: + type: object + properties: + default: + type: string + name: + type: string + value: + type: string + overriding_parameters: + type: object + properties: + pipeline_params: + type: object + properties: + full_refresh: + type: boolean + start_time: + type: integer + setup_duration: + type: integer + execution_duration: + type: integer + cleanup_duration: + type: integer + end_time: + type: integer + run_duration: + type: integer + queue_duration: + type: integer + trigger: + type: string + trigger_info: + type: object + properties: + run_id: + type: integer + run_name: + type: string + run_page_url: + type: string + run_type: + type: string + tasks: + type: array + items: + type: object + properties: + setup_duration: + type: integer + start_time: + type: integer + task_key: + type: string + state: + type: object + properties: + life_cycle_state: + type: string + result_state: + type: string + state_message: + type: string + user_cancelled_or_timedout: + type: boolean + description: + type: string + job_cluster_key: + type: string + end_time: + type: integer + run_page_url: + type: string + run_id: + type: integer + cluster_instance: + type: object + properties: + cluster_id: + type: string + spark_context_id: + type: string + spark_jar_task: + type: object + properties: + main_class_name: + type: string + libraries: + type: array + items: + type: object + properties: + jar: + type: string + attempt_number: + type: integer + cleanup_duration: + type: integer + execution_duration: + type: integer + run_if: + type: string + description: + type: string + attempt_number: + type: integer + job_clusters: + type: array + items: + type: object + properties: + job_cluster_key: + type: string + new_cluster: + type: object + properties: + autoscale: + type: object + properties: + max_workers: + type: integer + min_workers: + type: integer + node_type_id: + type: 'null' + spark_conf: + type: object + properties: + spark.speculation: + type: boolean + spark_version: + type: string + git_source: + type: object + properties: + git_branch: + type: string + git_provider: + type: string + git_url: + type: string + repair_history: + type: array + items: + type: object + properties: + type: + type: string + start_time: + type: integer + end_time: + type: integer + state: + type: object + properties: + life_cycle_state: + type: string + result_state: + type: string + state_message: + type: string + user_cancelled_or_timedout: + type: boolean + queue_reason: + type: string + id: + type: integer + task_run_ids: + type: array + items: + type: integer + status: + type: object + properties: + state: + type: string + termination_details: + type: object + properties: + code: + type: string + type: + type: string + message: + type: string + queue_details: + type: object + properties: + code: + type: string + message: + type: string + status: + type: object + properties: + state: + type: string + termination_details: + type: object + properties: + code: + type: string + type: + type: string + message: + type: string + queue_details: + type: object + properties: + code: + type: string + message: + type: string + job_run_id: + type: integer + has_more: + type: boolean + next_page_token: + type: string + error: + type: string + logs: + type: string + logs_truncated: + type: boolean + error_trace: + type: string + info: + type: string + notebook_output: + type: object + properties: + result: + type: string + truncated: + type: boolean + sql_output: + type: object + properties: + query_output: + type: object + properties: + query_text: + type: string + endpoint_id: + type: string + sql_statements: + type: array + items: + type: object + properties: + lookup_key: + type: string + output_link: + type: string + warehouse_id: + type: string + dashboard_output: + type: object + properties: + widgets: + type: array + items: + type: object + properties: + widget_id: + type: string + widget_title: + type: string + output_link: + type: string + status: + type: string + error: + type: object + properties: + message: + type: string + start_time: + type: integer + end_time: + type: integer + warehouse_id: + type: string + alert_output: + type: object + properties: + query_text: + type: string + sql_statements: + type: array + items: + type: object + properties: + lookup_key: + type: string + output_link: + type: string + warehouse_id: + type: string + alert_state: + type: string + dbt_output: + type: object + properties: + artifacts_link: + type: string + artifacts_headers: + type: object + properties: + property1: + type: string + property2: + type: string + run_job_output: + type: object + properties: + run_id: + type: integer + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '429': + description: Operation is rejected due to throttling, e.g. some resource + has been exhausted, per-user quota. + '500': + description: Internal error. + description: Retrieve the output and metadata of a single task run. When a notebook + task returns a value through the +components: + x-stackQL-resources: + jobs: + id: databricks_workspace.workflows.jobs + name: jobs + title: Jobs + methods: + create: + operation: + $ref: '#/paths/~1api~12.2~1jobs~1create/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: '#/paths/~1api~12.2~1jobs~1delete/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1api~12.2~1jobs~1get/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1api~12.2~1jobs~1list/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.jobs + reset: + operation: + $ref: '#/paths/~1api~12.2~1jobs~1reset/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + runnow: + operation: + $ref: '#/paths/~1api~12.2~1jobs~1run-now/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + submit: + operation: + $ref: '#/paths/~1api~12.2~1jobs~1runs~1submit/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: '#/paths/~1api~12.2~1jobs~1update/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/jobs/methods/list' + - $ref: '#/components/x-stackQL-resources/jobs/methods/get' + insert: + - $ref: '#/components/x-stackQL-resources/jobs/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/jobs/methods/update' + replace: + - $ref: '#/components/x-stackQL-resources/jobs/methods/reset' + delete: + - $ref: '#/components/x-stackQL-resources/jobs/methods/delete' + exec: + - $ref: '#/components/x-stackQL-resources/jobs/methods/submit' + - $ref: '#/components/x-stackQL-resources/jobs/methods/runnow' + job_compliance: + id: databricks_workspace.workflows.job_compliance + name: job_compliance + title: Job_compliance + methods: + enforcecompliance: + operation: + $ref: '#/paths/~1api~12.0~1policies~1jobs~1enforce-compliance/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + getcompliance: + operation: + $ref: '#/paths/~1api~12.0~1policies~1jobs~1get-compliance/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + listcompliance: + operation: + $ref: '#/paths/~1api~12.0~1policies~1jobs~1list-compliance/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.jobs + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/job_compliance/methods/listcompliance' + - $ref: '#/components/x-stackQL-resources/job_compliance/methods/getcompliance' + insert: [] + update: [] + replace: + - $ref: '#/components/x-stackQL-resources/job_compliance/methods/enforcecompliance' + delete: [] + exec: [] + job_permissions: + id: databricks_workspace.workflows.job_permissions + name: job_permissions + title: Job_permissions + methods: + getpermissions: + operation: + $ref: '#/paths/~1api~12.0~1permissions~1jobs~1{job_id}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + setpermissions: + operation: + $ref: '#/paths/~1api~12.0~1permissions~1jobs~1{job_id}/put' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + updatepermissions: + operation: + $ref: '#/paths/~1api~12.0~1permissions~1jobs~1{job_id}/patch' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/job_permissions/methods/getpermissions' + insert: [] + update: + - $ref: '#/components/x-stackQL-resources/job_permissions/methods/updatepermissions' + replace: + - $ref: '#/components/x-stackQL-resources/job_permissions/methods/setpermissions' + delete: [] + exec: [] + job_permission_levels: + id: databricks_workspace.workflows.job_permission_levels + name: job_permission_levels + title: Job_permission_levels + methods: + getpermissionlevels: + operation: + $ref: '#/paths/~1api~12.0~1permissions~1jobs~1{job_id}~1permissionLevels/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.permission_levels + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/job_permission_levels/methods/getpermissionlevels' + insert: [] + update: [] + replace: [] + delete: [] + exec: [] + job_runs: + id: databricks_workspace.workflows.job_runs + name: job_runs + title: Job_runs + methods: + cancelallruns: + operation: + $ref: '#/paths/~1api~12.2~1jobs~1runs~1cancel-all/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + cancelrun: + operation: + $ref: '#/paths/~1api~12.2~1jobs~1runs~1cancel/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + deleterun: + operation: + $ref: '#/paths/~1api~12.2~1jobs~1runs~1delete/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + exportrun: + operation: + $ref: '#/paths/~1api~12.2~1jobs~1runs~1export/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + getrun: + operation: + $ref: '#/paths/~1api~12.2~1jobs~1runs~1get/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + listruns: + operation: + $ref: '#/paths/~1api~12.2~1jobs~1runs~1list/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.runs + repairrun: + operation: + $ref: '#/paths/~1api~12.2~1jobs~1runs~1repair/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/job_runs/methods/listruns' + - $ref: '#/components/x-stackQL-resources/job_runs/methods/getrun' + insert: [] + update: [] + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/job_runs/methods/deleterun' + exec: + - $ref: '#/components/x-stackQL-resources/job_runs/methods/repairrun' + - $ref: '#/components/x-stackQL-resources/job_runs/methods/exportrun' + - $ref: '#/components/x-stackQL-resources/job_runs/methods/cancelrun' + - $ref: '#/components/x-stackQL-resources/job_runs/methods/cancelallruns' + job_run_output: + id: databricks_workspace.workflows.job_run_output + name: job_run_output + title: Job_run_output + methods: + getrunoutput: + operation: + $ref: '#/paths/~1api~12.2~1jobs~1runs~1get-output/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/job_run_output/methods/getrunoutput' + insert: [] + update: [] + replace: [] + delete: [] + exec: [] diff --git a/providers/src/databricks_workspace/v00.00.00000/services/workspace.yaml b/providers/src/databricks_workspace/v00.00.00000/services/workspace.yaml new file mode 100644 index 00000000..d9c75d98 --- /dev/null +++ b/providers/src/databricks_workspace/v00.00.00000/services/workspace.yaml @@ -0,0 +1,3401 @@ +openapi: 3.0.0 +info: + version: 2024-12-19-stackql-generated + contact: + name: StackQL Studios + url: https://stackql.io/ + email: info@stackql.io + title: Databricks Workspace API + description: Workspace +servers: +- url: https://{deployment_name}.cloud.databricks.com + variables: + deployment_name: + description: The Databricks Workspace Deployment Name + default: dbc-abcd0123-a1bc +paths: + /api/2.0/settings/types/automatic_cluster_update/names/default: + get: + operationId: automatic-cluster-update-get + externalDocs: + url: https://docs.databricks.com/api/workspace/automaticclusterupdate/get + x-stackQL-resource: automatic_cluster_update + x-stackQL-method: get + x-stackQL-verb: select + x-numReqParams: 0 + parameters: + - name: etag + in: query + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + etag: + type: string + setting_name: + type: string + automatic_cluster_update_workspace: + type: object + properties: + enabled: + type: boolean + can_toggle: + type: boolean + maintenance_window: + type: object + properties: + week_day_based_schedule: + type: object + properties: + frequency: + type: string + day_of_week: + type: string + window_start_time: + type: object + properties: + hours: + type: integer + minutes: + type: integer + enablement_details: + type: object + properties: + unavailable_for_non_enterprise_tier: + type: boolean + unavailable_for_disabled_entitlement: + type: boolean + forced_for_compliance_mode: + type: boolean + restart_even_if_no_updates_available: + type: boolean + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Gets the automatic cluster update setting. + patch: + operationId: automatic-cluster-update-update + externalDocs: + url: https://docs.databricks.com/api/workspace/automaticclusterupdate/update + x-stackQL-resource: automatic_cluster_update + x-stackQL-method: update + x-stackQL-verb: update + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + etag: + type: string + setting_name: + type: string + automatic_cluster_update_workspace: + type: object + properties: + enabled: + type: boolean + can_toggle: + type: boolean + maintenance_window: + type: object + properties: + week_day_based_schedule: + type: object + properties: + frequency: + type: string + day_of_week: + type: string + window_start_time: + type: object + properties: + hours: + type: integer + minutes: + type: integer + enablement_details: + type: object + properties: + unavailable_for_non_enterprise_tier: + type: boolean + unavailable_for_disabled_entitlement: + type: boolean + forced_for_compliance_mode: + type: boolean + restart_even_if_no_updates_available: + type: boolean + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '409': + description: Request was rejected due a conflict with an existing resource. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + allow_missing: + type: required + field_mask: + type: boolean + setting: + type: object + example: + allow_missing: true + setting: + etag: string + setting_name: string + automatic_cluster_update_workspace: + enabled: true + can_toggle: true + maintenance_window: + week_day_based_schedule: + frequency: FIRST_OF_MONTH + day_of_week: MONDAY + window_start_time: + hours: 0 + minutes: 0 + enablement_details: + unavailable_for_non_enterprise_tier: true + unavailable_for_disabled_entitlement: true + forced_for_compliance_mode: true + restart_even_if_no_updates_available: true + field_mask: string + description: Details required to update a setting. + description: Updates the automatic cluster update setting for the workspace. + A fresh etag needs to be provided in + /api/2.0/settings/types/shield_csp_enablement_ws_db/names/default: + get: + operationId: compliance-security-profile-get + externalDocs: + url: https://docs.databricks.com/api/workspace/compliancesecurityprofile/get + x-stackQL-resource: compliance_security_profile + x-stackQL-method: get + x-stackQL-verb: select + x-numReqParams: 0 + parameters: + - name: etag + in: query + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + etag: + type: string + setting_name: + type: string + compliance_security_profile_workspace: + type: object + properties: + is_enabled: + type: boolean + compliance_standards: + type: array + items: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Gets the compliance security profile setting. + patch: + operationId: compliance-security-profile-update + externalDocs: + url: https://docs.databricks.com/api/workspace/compliancesecurityprofile/update + x-stackQL-resource: compliance_security_profile + x-stackQL-method: update + x-stackQL-verb: update + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + etag: + type: string + setting_name: + type: string + compliance_security_profile_workspace: + type: object + properties: + is_enabled: + type: boolean + compliance_standards: + type: array + items: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '409': + description: Request was rejected due a conflict with an existing resource. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + allow_missing: + type: required + field_mask: + type: boolean + setting: + type: object + example: + allow_missing: true + setting: + etag: string + setting_name: string + compliance_security_profile_workspace: + is_enabled: true + compliance_standards: + - NONE + field_mask: string + description: Details required to update a setting. + description: Updates the compliance security profile setting for the workspace. + A fresh etag needs to be provided in + /api/2.0/settings/types/aibi_dash_embed_ws_acc_policy/names/default: + delete: + operationId: dashboard-embedding-access-policy-delete + externalDocs: + url: https://docs.databricks.com/api/workspace/aibidashboardembeddingaccesspolicy/delete + x-stackQL-resource: dashboard_embedding_access_policy + x-stackQL-method: delete + x-stackQL-verb: delete + x-numReqParams: 0 + parameters: + - name: etag + in: query + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + etag: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '409': + description: Request was rejected due a conflict with an existing resource. + '500': + description: Internal error. + description: Delete the AI/BI dashboard embedding access policy, reverting back + to the default. + get: + operationId: dashboard-embedding-access-policy-get + externalDocs: + url: https://docs.databricks.com/api/workspace/aibidashboardembeddingaccesspolicy/get + x-stackQL-resource: dashboard_embedding_access_policy + x-stackQL-method: get + x-stackQL-verb: select + x-numReqParams: 0 + parameters: + - name: etag + in: query + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + etag: + type: string + setting_name: + type: string + aibi_dashboard_embedding_access_policy: + type: object + properties: + access_policy_type: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Retrieves the AI/BI dashboard embedding access policy. The default + setting is ALLOW_APPROVED_DOMAINS, permitting AI/BI dashboards to be embedded + on approved domains. + patch: + operationId: dashboard-embedding-access-policy-update + externalDocs: + url: https://docs.databricks.com/api/workspace/aibidashboardembeddingaccesspolicy/update + x-stackQL-resource: dashboard_embedding_access_policy + x-stackQL-method: update + x-stackQL-verb: update + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + etag: + type: string + setting_name: + type: string + aibi_dashboard_embedding_access_policy: + type: object + properties: + access_policy_type: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '409': + description: Request was rejected due a conflict with an existing resource. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + allow_missing: + type: required + field_mask: + type: boolean + setting: + type: object + example: + allow_missing: true + setting: + etag: string + setting_name: string + aibi_dashboard_embedding_access_policy: + access_policy_type: ALLOW_ALL_DOMAINS + field_mask: string + description: Details required to update a setting. + description: Updates the AI/BI dashboard embedding access policy at the workspace + level. + /api/2.0/settings/types/aibi_dash_embed_ws_apprvd_domains/names/default: + delete: + operationId: dashboard-embedding-approved-domains-delete + externalDocs: + url: https://docs.databricks.com/api/workspace/aibidashboardembeddingapproveddomains/delete + x-stackQL-resource: dashboard_embedding_approved_domains + x-stackQL-method: delete + x-stackQL-verb: delete + x-numReqParams: 0 + parameters: + - name: etag + in: query + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + etag: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '409': + description: Request was rejected due a conflict with an existing resource. + '500': + description: Internal error. + description: Delete the list of domains approved to host embedded AI/BI dashboards, + reverting back to the default empty list. + get: + operationId: dashboard-embedding-approved-domains-get + externalDocs: + url: https://docs.databricks.com/api/workspace/aibidashboardembeddingapproveddomains/get + x-stackQL-resource: dashboard_embedding_approved_domains + x-stackQL-method: get + x-stackQL-verb: select + x-numReqParams: 0 + parameters: + - name: etag + in: query + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + etag: + type: string + setting_name: + type: string + aibi_dashboard_embedding_approved_domains: + type: object + properties: + approved_domains: + type: array + items: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Retrieves the list of domains approved to host embedded AI/BI dashboards. + patch: + operationId: dashboard-embedding-approved-domains-update + externalDocs: + url: https://docs.databricks.com/api/workspace/aibidashboardembeddingapproveddomains/update + x-stackQL-resource: dashboard_embedding_approved_domains + x-stackQL-method: update + x-stackQL-verb: update + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + etag: + type: string + setting_name: + type: string + aibi_dashboard_embedding_approved_domains: + type: object + properties: + approved_domains: + type: array + items: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '409': + description: Request was rejected due a conflict with an existing resource. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + allow_missing: + type: required + field_mask: + type: boolean + setting: + type: object + example: + allow_missing: true + setting: + etag: string + setting_name: string + aibi_dashboard_embedding_approved_domains: + approved_domains: + - string + field_mask: string + description: Details required to update a setting. + description: Updates the list of domains approved to host embedded AI/BI dashboards. + This update will fail if the current workspace access policy is not ALLOW_APPROVED_DOMAINS. + /api/2.0/workspace/list: + get: + operationId: directories-list + externalDocs: + url: https://docs.databricks.com/api/workspace/workspace/list + x-stackQL-resource: directories + x-stackQL-method: list + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: path + required: true + description: string + in: query + - name: notebooks_modified_after + in: query + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + objects: + type: array + items: + type: object + properties: + path: + type: string + object_type: + type: string + object_id: + type: integer + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + x-stackQL-objectKey: $.objects + description: Lists the contents of a directory, or the object if it is not a + directory. If the input path does not exist, this call returns an error + /api/2.0/workspace/mkdirs: + post: + operationId: directories-mkdirs + externalDocs: + url: https://docs.databricks.com/api/workspace/workspace/mkdirs + x-stackQL-resource: directories + x-stackQL-method: mkdirs + x-stackQL-verb: insert + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + path: + type: required + example: + path: /Users/user@example.com/project + description: Creates the specified directory (and necessary parent directories + if they do not exist). If there is an object (not a directory) at any prefix + of the input path, this call returns an error + /api/2.0/settings/types/shield_esm_enablement_ws_db/names/default: + get: + operationId: enhanced-security-monitoring-get + externalDocs: + url: https://docs.databricks.com/api/workspace/enhancedsecuritymonitoring/get + x-stackQL-resource: enhanced_security_monitoring + x-stackQL-method: get + x-stackQL-verb: select + x-numReqParams: 0 + parameters: + - name: etag + in: query + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + etag: + type: string + setting_name: + type: string + enhanced_security_monitoring_workspace: + type: object + properties: + is_enabled: + type: boolean + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Gets the enhanced security monitoring setting. + patch: + operationId: enhanced-security-monitoring-update + externalDocs: + url: https://docs.databricks.com/api/workspace/enhancedsecuritymonitoring/update + x-stackQL-resource: enhanced_security_monitoring + x-stackQL-method: update + x-stackQL-verb: update + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + etag: + type: string + setting_name: + type: string + enhanced_security_monitoring_workspace: + type: object + properties: + is_enabled: + type: boolean + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '409': + description: Request was rejected due a conflict with an existing resource. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + allow_missing: + type: required + field_mask: + type: boolean + setting: + type: object + example: + allow_missing: true + setting: + etag: string + setting_name: string + enhanced_security_monitoring_workspace: + is_enabled: true + field_mask: string + description: Details required to update a setting. + description: Updates the enhanced security monitoring setting for the workspace. + A fresh etag needs to be provided in + /api/2.0/workspace-conf: + get: + operationId: feature-status-getstatus + externalDocs: + url: https://docs.databricks.com/api/workspace/workspaceconf/getstatus + x-stackQL-resource: feature_status + x-stackQL-method: getstatus + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: keys + required: true + description: string + in: query + responses: + '200': + description: Status was returned successfully. + content: + application/json: + schema: + type: object + properties: + property1: + type: string + property2: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Enables or disables a specified feature for a workspace. + patch: + operationId: feature-status-setstatus + externalDocs: + url: https://docs.databricks.com/api/workspace/workspaceconf/setstatus + x-stackQL-resource: feature_status + x-stackQL-method: setstatus + x-stackQL-verb: replace + x-numReqParams: 0 + parameters: [] + responses: + '204': + description: Enabling or disabling feature was successful. + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Enables or disables a specified feature for a workspace. + /api/2.0/ip-access-lists: + post: + operationId: ip-access-lists-create + externalDocs: + url: https://docs.databricks.com/api/workspace/ipaccesslists/create + x-stackQL-resource: ip_access_lists + x-stackQL-method: create + x-stackQL-verb: insert + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + ip_access_list: + type: object + properties: + list_id: + type: string + label: + type: string + ip_addresses: + type: array + items: + type: string + address_count: + type: integer + list_type: + type: string + created_at: + type: integer + created_by: + type: integer + updated_at: + type: integer + updated_by: + type: integer + enabled: + type: boolean + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + label: + type: required + list_type: + type: string + ip_addresses: + type: required + example: + label: Office VPN + list_type: ALLOW + ip_addresses: + - 192.168.100.0/22 + description: Details required to configure a block list or allow list. + description: Creates an IP access list for this workspace. + get: + operationId: ip-access-lists-list + externalDocs: + url: https://docs.databricks.com/api/workspace/ipaccesslists/list + x-stackQL-resource: ip_access_lists + x-stackQL-method: list + x-stackQL-verb: select + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + ip_access_lists: + type: array + items: + type: object + properties: + list_id: + type: string + label: + type: string + ip_addresses: + type: array + items: + type: string + address_count: + type: integer + list_type: + type: string + created_at: + type: integer + created_by: + type: integer + updated_at: + type: integer + updated_by: + type: integer + enabled: + type: boolean + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '500': + description: Internal error. + x-stackQL-objectKey: $.ip_access_lists + description: Gets all IP access lists for the specified workspace. + /api/2.0/ip-access-lists/{ip_access_list_id}: + delete: + operationId: ip-access-lists-delete + externalDocs: + url: https://docs.databricks.com/api/workspace/ipaccesslists/delete + x-stackQL-resource: ip_access_lists + x-stackQL-method: delete + x-stackQL-verb: delete + x-numReqParams: 1 + parameters: + - name: ip_access_list_id + required: true + description: string + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: {} + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Deletes an IP access list, specified by its list ID. + get: + operationId: ip-access-lists-get + externalDocs: + url: https://docs.databricks.com/api/workspace/ipaccesslists/get + x-stackQL-resource: ip_access_lists + x-stackQL-method: get + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: ip_access_list_id + required: true + description: string + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + ip_access_list: + type: object + properties: + list_id: + type: string + label: + type: string + ip_addresses: + type: array + items: + type: string + address_count: + type: integer + list_type: + type: string + created_at: + type: integer + created_by: + type: integer + updated_at: + type: integer + updated_by: + type: integer + enabled: + type: boolean + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + x-stackQL-objectKey: $.ip_access_list + description: Gets an IP access list, specified by its list ID. + put: + operationId: ip-access-lists-replace + externalDocs: + url: https://docs.databricks.com/api/workspace/ipaccesslists/replace + x-stackQL-resource: ip_access_lists + x-stackQL-method: replace + x-stackQL-verb: replace + x-numReqParams: 1 + parameters: + - name: ip_access_list_id + required: true + description: string + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + label: + type: required + list_type: + type: string + ip_addresses: + type: required + enabled: + type: string + example: + label: Office VPN + list_type: ALLOW + ip_addresses: + - 192.168.100.0/22 + enabled: true + description: Details required to replace an IP access list. + description: Replaces an IP access list, specified by its ID. + patch: + operationId: ip-access-lists-update + externalDocs: + url: https://docs.databricks.com/api/workspace/ipaccesslists/update + x-stackQL-resource: ip_access_lists + x-stackQL-method: update + x-stackQL-verb: update + x-numReqParams: 1 + parameters: + - name: ip_access_list_id + required: true + description: string + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + label: + type: string + list_type: + type: string + ip_addresses: + type: Array of string + enabled: + type: boolean + example: + label: Office VPN + list_type: ALLOW + ip_addresses: + - 192.168.100.0/22 + enabled: true + description: Details required to update an IP access list. + description: Updates an existing IP access list, specified by its ID. + /api/2.0/notification-destinations: + post: + operationId: notification-destinations-create + externalDocs: + url: https://docs.databricks.com/api/workspace/notificationdestinations/create + x-stackQL-resource: notification_destinations + x-stackQL-method: create + x-stackQL-verb: insert + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + config: + type: object + properties: + generic_webhook: + type: object + properties: + password_set: + type: boolean + url_set: + type: boolean + username_set: + type: boolean + destination_type: + type: string + display_name: + type: string + id: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + display_name: + type: string + config: + type: object + example: + config: + generic_webhook: + password: my-password + url: https://my-webhook.com + username: my-username + display_name: My webhook destination + description: Creates a notification destination. Requires workspace admin permissions. + get: + operationId: notification-destinations-list + externalDocs: + url: https://docs.databricks.com/api/workspace/notificationdestinations/list + x-stackQL-resource: notification_destinations + x-stackQL-method: list + x-stackQL-verb: select + x-numReqParams: 0 + parameters: + - name: page_token + in: query + - name: page_size + in: query + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + next_page_token: + type: string + results: + type: array + items: + type: object + properties: + destination_type: + type: string + display_name: + type: string + id: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + x-stackQL-objectKey: $.results + description: Lists notification destinations. + /api/2.0/notification-destinations/{id}: + delete: + operationId: notification-destinations-delete + externalDocs: + url: https://docs.databricks.com/api/workspace/notificationdestinations/delete + x-stackQL-resource: notification_destinations + x-stackQL-method: delete + x-stackQL-verb: delete + x-numReqParams: 1 + parameters: + - name: id + required: true + description: string + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Deletes a notification destination. Requires workspace admin permissions. + get: + operationId: notification-destinations-get + externalDocs: + url: https://docs.databricks.com/api/workspace/notificationdestinations/get + x-stackQL-resource: notification_destinations + x-stackQL-method: get + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: id + required: true + description: string + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + destination_type: + type: string + display_name: + type: string + id: + type: string + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Gets a notification destination. + patch: + operationId: notification-destinations-update + externalDocs: + url: https://docs.databricks.com/api/workspace/notificationdestinations/update + x-stackQL-resource: notification_destinations + x-stackQL-method: update + x-stackQL-verb: update + x-numReqParams: 1 + parameters: + - name: id + required: true + description: string + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + config: + type: object + properties: + slack: + type: object + properties: + url_set: + type: boolean + destination_type: + type: string + display_name: + type: string + id: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + display_name: + type: string + config: + type: object + example: + config: + slack: + url: https://hooks.slack.com/services/T00000000/B00000000/AAAAAAAAAAAAAAAA + display_name: My slack destination updated + id: fe25e731-92f2-4838-9fb2-1ca364320a3d + description: Updates a notification destination. Requires workspace admin permissions. + At least one field is required in the request body. + /api/2.0/workspace/delete: + post: + operationId: objects-delete + externalDocs: + url: https://docs.databricks.com/api/workspace/workspace/delete + x-stackQL-resource: objects + x-stackQL-method: delete + x-stackQL-verb: delete + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + path: + type: required + recursive: + type: string + example: + path: /Users/me@example.com/MyFolder + recursive: true + description: Deletes an object or a directory (and optionally recursively deletes + all objects in the directory). + /api/2.0/workspace/export: + get: + operationId: objects-export + externalDocs: + url: https://docs.databricks.com/api/workspace/workspace/export + x-stackQL-resource: objects + x-stackQL-method: export + x-stackQL-verb: exec + x-numReqParams: 1 + parameters: + - name: path + required: true + description: string + in: query + - name: format + in: query + - name: direct_download + in: query + responses: + '200': + description: The request field `direct_download` determines whether a JSON + response or binary contents are returned by this endpoint. + content: + application/json: + schema: + type: object + properties: + content: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Exports an object or the contents of an entire directory. + /api/2.0/workspace/import: + post: + operationId: objects-import + externalDocs: + url: https://docs.databricks.com/api/workspace/workspace/import + x-stackQL-resource: objects + x-stackQL-method: import + x-stackQL-verb: exec + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '409': + description: Request was rejected due a conflict with an existing resource. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + path: + type: required + format: + type: string + language: + type: string + content: + type: string + overwrite: + type: string + example: + format: SOURCE + path: /Users/user@example.com/project/ScalaExampleNotebook + language: SCALA + content: MSsx + overwrite: true + description: Imports a workspace object (for example, a notebook or file) or + the contents of an entire directory. If + /api/2.0/permissions/{workspace_object_type}/{workspace_object_id}: + get: + operationId: object-permissions-getpermissions + externalDocs: + url: https://docs.databricks.com/api/workspace/workspace/getpermissions + x-stackQL-resource: object_permissions + x-stackQL-method: getpermissions + x-stackQL-verb: select + x-numReqParams: 2 + parameters: + - name: workspace_object_type + required: true + description: string + in: path + - name: workspace_object_id + required: true + description: string + in: path + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + object_id: + type: string + object_type: + type: string + access_control_list: + type: array + items: + type: object + properties: + user_name: + type: string + group_name: + type: string + service_principal_name: + type: string + display_name: + type: string + all_permissions: + type: array + items: + type: object + properties: + permission_level: + type: string + inherited: + type: boolean + inherited_from_object: + type: array + items: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Gets the permissions of a workspace object. Workspace objects can + inherit permissions from their parent objects or root object. + put: + operationId: object-permissions-setpermissions + externalDocs: + url: https://docs.databricks.com/api/workspace/workspace/setpermissions + x-stackQL-resource: object_permissions + x-stackQL-method: setpermissions + x-stackQL-verb: replace + x-numReqParams: 2 + parameters: + - name: workspace_object_type + required: true + description: string + in: path + - name: workspace_object_id + required: true + description: string + in: path + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + object_id: + type: string + object_type: + type: string + access_control_list: + type: array + items: + type: object + properties: + user_name: + type: string + group_name: + type: string + service_principal_name: + type: string + display_name: + type: string + all_permissions: + type: array + items: + type: object + properties: + permission_level: + type: string + inherited: + type: boolean + inherited_from_object: + type: array + items: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + access_control_list: + type: Array of object + example: + access_control_list: + - user_name: string + group_name: string + service_principal_name: string + permission_level: CAN_MANAGE + description: Sets permissions on an object, replacing existing permissions if + they exist. Deletes all direct permissions if none are specified. Objects + can inherit permissions from their parent objects or root object. + patch: + operationId: object-permissions-updatepermissions + externalDocs: + url: https://docs.databricks.com/api/workspace/workspace/updatepermissions + x-stackQL-resource: object_permissions + x-stackQL-method: updatepermissions + x-stackQL-verb: update + x-numReqParams: 2 + parameters: + - name: workspace_object_type + required: true + description: string + in: path + - name: workspace_object_id + required: true + description: string + in: path + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + object_id: + type: string + object_type: + type: string + access_control_list: + type: array + items: + type: object + properties: + user_name: + type: string + group_name: + type: string + service_principal_name: + type: string + display_name: + type: string + all_permissions: + type: array + items: + type: object + properties: + permission_level: + type: string + inherited: + type: boolean + inherited_from_object: + type: array + items: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + access_control_list: + type: Array of object + example: + access_control_list: + - user_name: string + group_name: string + service_principal_name: string + permission_level: CAN_MANAGE + description: Updates the permissions on a workspace object. Workspace objects + can inherit permissions from their parent objects or root object. + /api/2.0/permissions/{workspace_object_type}/{workspace_object_id}/permissionLevels: + get: + operationId: object-permission-levels-getpermissionlevels + externalDocs: + url: https://docs.databricks.com/api/workspace/workspace/getpermissionlevels + x-stackQL-resource: object_permission_levels + x-stackQL-method: getpermissionlevels + x-stackQL-verb: select + x-numReqParams: 2 + parameters: + - name: workspace_object_type + required: true + description: string + in: path + - name: workspace_object_id + required: true + description: string + in: path + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + permission_levels: + type: array + items: + type: object + properties: + permission_level: + type: string + description: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + x-stackQL-objectKey: $.permission_levels + description: Gets the permission levels that a user can have on an object. + /api/2.0/workspace/get-status: + get: + operationId: object-status-getstatus + externalDocs: + url: https://docs.databricks.com/api/workspace/workspace/getstatus + x-stackQL-resource: object_status + x-stackQL-method: getstatus + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: path + required: true + description: string + in: query + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + path: + type: string + language: + type: string + object_type: + type: string + object_id: + type: integer + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Gets the status of an object or a directory. If + /api/2.0/settings/types/default_namespace_ws/names/default: + delete: + operationId: permissions-delete + externalDocs: + url: https://docs.databricks.com/api/workspace/defaultnamespace/delete + x-stackQL-resource: permissions + x-stackQL-method: delete + x-stackQL-verb: delete + x-numReqParams: 0 + parameters: + - name: etag + in: query + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + etag: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '409': + description: Request was rejected due a conflict with an existing resource. + '500': + description: Internal error. + description: Deletes the default namespace setting for the workspace. A fresh + etag needs to be provided in + get: + operationId: permissions-get + externalDocs: + url: https://docs.databricks.com/api/workspace/defaultnamespace/get + x-stackQL-resource: permissions + x-stackQL-method: get + x-stackQL-verb: select + x-numReqParams: 0 + parameters: + - name: etag + in: query + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + etag: + type: string + setting_name: + type: string + namespace: + type: object + properties: + value: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Gets the default namespace setting. + patch: + operationId: permissions-update + externalDocs: + url: https://docs.databricks.com/api/workspace/defaultnamespace/update + x-stackQL-resource: permissions + x-stackQL-method: update + x-stackQL-verb: update + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + etag: + type: string + setting_name: + type: string + namespace: + type: object + properties: + value: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '409': + description: Request was rejected due a conflict with an existing resource. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + allow_missing: + type: required + field_mask: + type: boolean + setting: + type: object + example: + allow_missing: true + setting: + etag: string + setting_name: string + namespace: + value: string + field_mask: string + description: Details required to update a setting. + description: Updates the default namespace setting for the workspace. A fresh + etag needs to be provided in + /api/2.0/settings/types/restrict_workspace_admins/names/default: + delete: + operationId: restrict-admins-delete + externalDocs: + url: https://docs.databricks.com/api/workspace/restrictworkspaceadmins/delete + x-stackQL-resource: restrict_admins + x-stackQL-method: delete + x-stackQL-verb: delete + x-numReqParams: 0 + parameters: + - name: etag + in: query + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + etag: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '409': + description: Request was rejected due a conflict with an existing resource. + '500': + description: Internal error. + description: Reverts the restrict workspace admins setting status for the workspace. + A fresh etag needs to be provided in + get: + operationId: restrict-admins-get + externalDocs: + url: https://docs.databricks.com/api/workspace/restrictworkspaceadmins/get + x-stackQL-resource: restrict_admins + x-stackQL-method: get + x-stackQL-verb: select + x-numReqParams: 0 + parameters: + - name: etag + in: query + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + etag: + type: string + setting_name: + type: string + restrict_workspace_admins: + type: object + properties: + status: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Gets the restrict workspace admins setting. + patch: + operationId: restrict-admins-update + externalDocs: + url: https://docs.databricks.com/api/workspace/restrictworkspaceadmins/update + x-stackQL-resource: restrict_admins + x-stackQL-method: update + x-stackQL-verb: update + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + etag: + type: string + setting_name: + type: string + restrict_workspace_admins: + type: object + properties: + status: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '409': + description: Request was rejected due a conflict with an existing resource. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + allow_missing: + type: required + field_mask: + type: boolean + setting: + type: object + example: + allow_missing: true + setting: + etag: string + setting_name: string + restrict_workspace_admins: + status: ALLOW_ALL + field_mask: string + description: Details required to update a setting. + description: Updates the restrict workspace admins setting for the workspace. + A fresh etag needs to be provided in + /api/2.0/token-management/on-behalf-of/tokens: + post: + operationId: tokens-createobotoken + externalDocs: + url: https://docs.databricks.com/api/workspace/tokenmanagement/createobotoken + x-stackQL-resource: tokens + x-stackQL-method: createobotoken + x-stackQL-verb: insert + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + token_value: + type: string + token_info: + type: object + properties: + token_id: + type: string + creation_time: + type: integer + expiry_time: + type: integer + comment: + type: string + created_by_id: + type: integer + created_by_username: + type: string + owner_id: + type: integer + workspace_id: + type: integer + last_used_day: + type: integer + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + application_id: + type: required + lifetime_seconds: + type: string + comment: + type: integer + format: int64 + example: + application_id: 6f5ccf28-d83a-4957-9bfb-5bbfac551410 + lifetime_seconds: 3600 + comment: This is for the ABC department automation scripts. + description: Configuration details for creating on-behalf tokens. + description: Creates a token on behalf of a service principal. + /api/2.0/token-management/tokens/{token_id}: + delete: + operationId: tokens-delete + externalDocs: + url: https://docs.databricks.com/api/workspace/tokenmanagement/delete + x-stackQL-resource: tokens + x-stackQL-method: delete + x-stackQL-verb: delete + x-numReqParams: 1 + parameters: + - name: token_id + required: true + description: string + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: {} + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Deletes a token, specified by its ID. + get: + operationId: tokens-get + externalDocs: + url: https://docs.databricks.com/api/workspace/tokenmanagement/get + x-stackQL-resource: tokens + x-stackQL-method: get + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: token_id + required: true + description: string + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + token_info: + type: object + properties: + token_id: + type: string + creation_time: + type: integer + expiry_time: + type: integer + comment: + type: string + created_by_id: + type: integer + created_by_username: + type: string + owner_id: + type: integer + workspace_id: + type: integer + last_used_day: + type: integer + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + x-stackQL-objectKey: $.token_info + description: Gets information about a token, specified by its ID. + /api/2.0/token-management/tokens: + get: + operationId: tokens-list + externalDocs: + url: https://docs.databricks.com/api/workspace/tokenmanagement/list + x-stackQL-resource: tokens + x-stackQL-method: list + x-stackQL-verb: select + x-numReqParams: 0 + parameters: + - name: created_by_id + in: query + - name: created_by_username + in: query + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + token_infos: + type: array + items: + type: object + properties: + token_id: + type: string + creation_time: + type: integer + expiry_time: + type: integer + comment: + type: string + created_by_id: + type: integer + created_by_username: + type: string + owner_id: + type: integer + workspace_id: + type: integer + last_used_day: + type: integer + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '500': + description: Internal error. + x-stackQL-objectKey: $.token_infos + description: Lists all tokens associated with the specified workspace or user. + /api/2.0/permissions/authorization/tokens: + get: + operationId: token-permissions-getpermissions + externalDocs: + url: https://docs.databricks.com/api/workspace/tokenmanagement/getpermissions + x-stackQL-resource: token_permissions + x-stackQL-method: getpermissions + x-stackQL-verb: select + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + object_id: + type: string + object_type: + type: string + access_control_list: + type: array + items: + type: object + properties: + user_name: + type: string + group_name: + type: string + service_principal_name: + type: string + display_name: + type: string + all_permissions: + type: array + items: + type: object + properties: + permission_level: + type: string + inherited: + type: boolean + inherited_from_object: + type: array + items: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Gets the permissions of all tokens. Tokens can inherit permissions + from their root object. + put: + operationId: token-permissions-setpermissions + externalDocs: + url: https://docs.databricks.com/api/workspace/tokenmanagement/setpermissions + x-stackQL-resource: token_permissions + x-stackQL-method: setpermissions + x-stackQL-verb: replace + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + object_id: + type: string + object_type: + type: string + access_control_list: + type: array + items: + type: object + properties: + user_name: + type: string + group_name: + type: string + service_principal_name: + type: string + display_name: + type: string + all_permissions: + type: array + items: + type: object + properties: + permission_level: + type: string + inherited: + type: boolean + inherited_from_object: + type: array + items: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + access_control_list: + type: Array of object + example: + access_control_list: + - user_name: string + group_name: string + service_principal_name: string + permission_level: CAN_USE + description: Sets permissions on an object, replacing existing permissions if + they exist. Deletes all direct permissions if none are specified. Objects + can inherit permissions from their root object. + patch: + operationId: token-permissions-updatepermissions + externalDocs: + url: https://docs.databricks.com/api/workspace/tokenmanagement/updatepermissions + x-stackQL-resource: token_permissions + x-stackQL-method: updatepermissions + x-stackQL-verb: update + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + object_id: + type: string + object_type: + type: string + access_control_list: + type: array + items: + type: object + properties: + user_name: + type: string + group_name: + type: string + service_principal_name: + type: string + display_name: + type: string + all_permissions: + type: array + items: + type: object + properties: + permission_level: + type: string + inherited: + type: boolean + inherited_from_object: + type: array + items: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + access_control_list: + type: Array of object + example: + access_control_list: + - user_name: string + group_name: string + service_principal_name: string + permission_level: CAN_USE + description: Updates the permissions on all tokens. Tokens can inherit permissions + from their root object. + /api/2.0/permissions/authorization/tokens/permissionLevels: + get: + operationId: token-permission-levels-getpermissionlevels + externalDocs: + url: https://docs.databricks.com/api/workspace/tokenmanagement/getpermissionlevels + x-stackQL-resource: token_permission_levels + x-stackQL-method: getpermissionlevels + x-stackQL-verb: select + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + permission_levels: + type: array + items: + type: object + properties: + permission_level: + type: string + description: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + x-stackQL-objectKey: $.permission_levels + description: Gets the permission levels that a user can have on an object. + /api/2.0/token/create: + post: + operationId: user-tokens-create + externalDocs: + url: https://docs.databricks.com/api/workspace/tokens/create + x-stackQL-resource: user_tokens + x-stackQL-method: create + x-stackQL-verb: insert + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + token_value: + type: string + token_info: + type: object + properties: + token_id: + type: string + creation_time: + type: integer + expiry_time: + type: integer + comment: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + lifetime_seconds: + type: integer + format: int64 + comment: + type: string + example: + lifetime_seconds: 0 + comment: string + description: Creates and returns a token for a user. If this call is made through + token authentication, it creates a token with the same client ID as the authenticated + token. If the user's token quota is exceeded, this call returns an error + /api/2.0/token/list: + get: + operationId: user-tokens-listtokens + externalDocs: + url: https://docs.databricks.com/api/workspace/tokens/listtokens + x-stackQL-resource: user_tokens + x-stackQL-method: listtokens + x-stackQL-verb: select + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + token_infos: + type: array + items: + type: object + properties: + token_id: + type: string + creation_time: + type: integer + expiry_time: + type: integer + comment: + type: string + x-stackQL-objectKey: $.token_infos + description: Lists all the valid tokens for a user-workspace pair. + /api/2.0/token/delete: + post: + operationId: user-tokens-revoketoken + externalDocs: + url: https://docs.databricks.com/api/workspace/tokens/revoketoken + x-stackQL-resource: user_tokens + x-stackQL-method: revoketoken + x-stackQL-verb: exec + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: {} + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + token_id: + type: required + example: + token_id: string + description: Revokes an access token. +components: + x-stackQL-resources: + automatic_cluster_update: + id: databricks_workspace.workspace.automatic_cluster_update + name: automatic_cluster_update + title: Automatic_cluster_update + methods: + get: + operation: + $ref: '#/paths/~1api~12.0~1settings~1types~1automatic_cluster_update~1names~1default/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: '#/paths/~1api~12.0~1settings~1types~1automatic_cluster_update~1names~1default/patch' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/automatic_cluster_update/methods/get' + insert: [] + update: + - $ref: '#/components/x-stackQL-resources/automatic_cluster_update/methods/update' + replace: [] + delete: [] + exec: [] + compliance_security_profile: + id: databricks_workspace.workspace.compliance_security_profile + name: compliance_security_profile + title: Compliance_security_profile + methods: + get: + operation: + $ref: '#/paths/~1api~12.0~1settings~1types~1shield_csp_enablement_ws_db~1names~1default/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: '#/paths/~1api~12.0~1settings~1types~1shield_csp_enablement_ws_db~1names~1default/patch' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/compliance_security_profile/methods/get' + insert: [] + update: + - $ref: '#/components/x-stackQL-resources/compliance_security_profile/methods/update' + replace: [] + delete: [] + exec: [] + dashboard_embedding_access_policy: + id: databricks_workspace.workspace.dashboard_embedding_access_policy + name: dashboard_embedding_access_policy + title: Dashboard_embedding_access_policy + methods: + delete: + operation: + $ref: '#/paths/~1api~12.0~1settings~1types~1aibi_dash_embed_ws_acc_policy~1names~1default/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1api~12.0~1settings~1types~1aibi_dash_embed_ws_acc_policy~1names~1default/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: '#/paths/~1api~12.0~1settings~1types~1aibi_dash_embed_ws_acc_policy~1names~1default/patch' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/dashboard_embedding_access_policy/methods/get' + insert: [] + update: + - $ref: '#/components/x-stackQL-resources/dashboard_embedding_access_policy/methods/update' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/dashboard_embedding_access_policy/methods/delete' + exec: [] + dashboard_embedding_approved_domains: + id: databricks_workspace.workspace.dashboard_embedding_approved_domains + name: dashboard_embedding_approved_domains + title: Dashboard_embedding_approved_domains + methods: + delete: + operation: + $ref: '#/paths/~1api~12.0~1settings~1types~1aibi_dash_embed_ws_apprvd_domains~1names~1default/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1api~12.0~1settings~1types~1aibi_dash_embed_ws_apprvd_domains~1names~1default/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: '#/paths/~1api~12.0~1settings~1types~1aibi_dash_embed_ws_apprvd_domains~1names~1default/patch' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/dashboard_embedding_approved_domains/methods/get' + insert: [] + update: + - $ref: '#/components/x-stackQL-resources/dashboard_embedding_approved_domains/methods/update' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/dashboard_embedding_approved_domains/methods/delete' + exec: [] + directories: + id: databricks_workspace.workspace.directories + name: directories + title: Directories + methods: + list: + operation: + $ref: '#/paths/~1api~12.0~1workspace~1list/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.objects + mkdirs: + operation: + $ref: '#/paths/~1api~12.0~1workspace~1mkdirs/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/directories/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/directories/methods/mkdirs' + update: [] + replace: [] + delete: [] + exec: [] + enhanced_security_monitoring: + id: databricks_workspace.workspace.enhanced_security_monitoring + name: enhanced_security_monitoring + title: Enhanced_security_monitoring + methods: + get: + operation: + $ref: '#/paths/~1api~12.0~1settings~1types~1shield_esm_enablement_ws_db~1names~1default/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: '#/paths/~1api~12.0~1settings~1types~1shield_esm_enablement_ws_db~1names~1default/patch' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/enhanced_security_monitoring/methods/get' + insert: [] + update: + - $ref: '#/components/x-stackQL-resources/enhanced_security_monitoring/methods/update' + replace: [] + delete: [] + exec: [] + feature_status: + id: databricks_workspace.workspace.feature_status + name: feature_status + title: Feature_status + methods: + getstatus: + operation: + $ref: '#/paths/~1api~12.0~1workspace-conf/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + setstatus: + operation: + $ref: '#/paths/~1api~12.0~1workspace-conf/patch' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/feature_status/methods/getstatus' + insert: [] + update: [] + replace: + - $ref: '#/components/x-stackQL-resources/feature_status/methods/setstatus' + delete: [] + exec: [] + ip_access_lists: + id: databricks_workspace.workspace.ip_access_lists + name: ip_access_lists + title: Ip_access_lists + methods: + create: + operation: + $ref: '#/paths/~1api~12.0~1ip-access-lists/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1api~12.0~1ip-access-lists/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.ip_access_lists + delete: + operation: + $ref: '#/paths/~1api~12.0~1ip-access-lists~1{ip_access_list_id}/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1api~12.0~1ip-access-lists~1{ip_access_list_id}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.ip_access_list + replace: + operation: + $ref: '#/paths/~1api~12.0~1ip-access-lists~1{ip_access_list_id}/put' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: '#/paths/~1api~12.0~1ip-access-lists~1{ip_access_list_id}/patch' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/ip_access_lists/methods/get' + - $ref: '#/components/x-stackQL-resources/ip_access_lists/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/ip_access_lists/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/ip_access_lists/methods/update' + replace: + - $ref: '#/components/x-stackQL-resources/ip_access_lists/methods/replace' + delete: + - $ref: '#/components/x-stackQL-resources/ip_access_lists/methods/delete' + exec: [] + notification_destinations: + id: databricks_workspace.workspace.notification_destinations + name: notification_destinations + title: Notification_destinations + methods: + create: + operation: + $ref: '#/paths/~1api~12.0~1notification-destinations/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1api~12.0~1notification-destinations/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.results + delete: + operation: + $ref: '#/paths/~1api~12.0~1notification-destinations~1{id}/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1api~12.0~1notification-destinations~1{id}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: '#/paths/~1api~12.0~1notification-destinations~1{id}/patch' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/notification_destinations/methods/get' + - $ref: '#/components/x-stackQL-resources/notification_destinations/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/notification_destinations/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/notification_destinations/methods/update' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/notification_destinations/methods/delete' + exec: [] + objects: + id: databricks_workspace.workspace.objects + name: objects + title: Objects + methods: + delete: + operation: + $ref: '#/paths/~1api~12.0~1workspace~1delete/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + export: + operation: + $ref: '#/paths/~1api~12.0~1workspace~1export/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + import: + operation: + $ref: '#/paths/~1api~12.0~1workspace~1import/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: [] + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/objects/methods/delete' + exec: + - $ref: '#/components/x-stackQL-resources/objects/methods/import' + - $ref: '#/components/x-stackQL-resources/objects/methods/export' + object_permissions: + id: databricks_workspace.workspace.object_permissions + name: object_permissions + title: Object_permissions + methods: + getpermissions: + operation: + $ref: '#/paths/~1api~12.0~1permissions~1{workspace_object_type}~1{workspace_object_id}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + setpermissions: + operation: + $ref: '#/paths/~1api~12.0~1permissions~1{workspace_object_type}~1{workspace_object_id}/put' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + updatepermissions: + operation: + $ref: '#/paths/~1api~12.0~1permissions~1{workspace_object_type}~1{workspace_object_id}/patch' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/object_permissions/methods/getpermissions' + insert: [] + update: + - $ref: '#/components/x-stackQL-resources/object_permissions/methods/updatepermissions' + replace: + - $ref: '#/components/x-stackQL-resources/object_permissions/methods/setpermissions' + delete: [] + exec: [] + object_permission_levels: + id: databricks_workspace.workspace.object_permission_levels + name: object_permission_levels + title: Object_permission_levels + methods: + getpermissionlevels: + operation: + $ref: '#/paths/~1api~12.0~1permissions~1{workspace_object_type}~1{workspace_object_id}~1permissionLevels/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.permission_levels + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/object_permission_levels/methods/getpermissionlevels' + insert: [] + update: [] + replace: [] + delete: [] + exec: [] + object_status: + id: databricks_workspace.workspace.object_status + name: object_status + title: Object_status + methods: + getstatus: + operation: + $ref: '#/paths/~1api~12.0~1workspace~1get-status/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/object_status/methods/getstatus' + insert: [] + update: [] + replace: [] + delete: [] + exec: [] + permissions: + id: databricks_workspace.workspace.permissions + name: permissions + title: Permissions + methods: + delete: + operation: + $ref: '#/paths/~1api~12.0~1settings~1types~1default_namespace_ws~1names~1default/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1api~12.0~1settings~1types~1default_namespace_ws~1names~1default/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: '#/paths/~1api~12.0~1settings~1types~1default_namespace_ws~1names~1default/patch' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/permissions/methods/get' + insert: [] + update: + - $ref: '#/components/x-stackQL-resources/permissions/methods/update' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/permissions/methods/delete' + exec: [] + restrict_admins: + id: databricks_workspace.workspace.restrict_admins + name: restrict_admins + title: Restrict_admins + methods: + delete: + operation: + $ref: '#/paths/~1api~12.0~1settings~1types~1restrict_workspace_admins~1names~1default/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1api~12.0~1settings~1types~1restrict_workspace_admins~1names~1default/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: '#/paths/~1api~12.0~1settings~1types~1restrict_workspace_admins~1names~1default/patch' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/restrict_admins/methods/get' + insert: [] + update: + - $ref: '#/components/x-stackQL-resources/restrict_admins/methods/update' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/restrict_admins/methods/delete' + exec: [] + tokens: + id: databricks_workspace.workspace.tokens + name: tokens + title: Tokens + methods: + createobotoken: + operation: + $ref: '#/paths/~1api~12.0~1token-management~1on-behalf-of~1tokens/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: '#/paths/~1api~12.0~1token-management~1tokens~1{token_id}/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1api~12.0~1token-management~1tokens~1{token_id}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.token_info + list: + operation: + $ref: '#/paths/~1api~12.0~1token-management~1tokens/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.token_infos + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/tokens/methods/list' + - $ref: '#/components/x-stackQL-resources/tokens/methods/get' + insert: + - $ref: '#/components/x-stackQL-resources/tokens/methods/createobotoken' + update: [] + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/tokens/methods/delete' + exec: [] + token_permissions: + id: databricks_workspace.workspace.token_permissions + name: token_permissions + title: Token_permissions + methods: + getpermissions: + operation: + $ref: '#/paths/~1api~12.0~1permissions~1authorization~1tokens/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + setpermissions: + operation: + $ref: '#/paths/~1api~12.0~1permissions~1authorization~1tokens/put' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + updatepermissions: + operation: + $ref: '#/paths/~1api~12.0~1permissions~1authorization~1tokens/patch' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/token_permissions/methods/getpermissions' + insert: [] + update: + - $ref: '#/components/x-stackQL-resources/token_permissions/methods/updatepermissions' + replace: + - $ref: '#/components/x-stackQL-resources/token_permissions/methods/setpermissions' + delete: [] + exec: [] + token_permission_levels: + id: databricks_workspace.workspace.token_permission_levels + name: token_permission_levels + title: Token_permission_levels + methods: + getpermissionlevels: + operation: + $ref: '#/paths/~1api~12.0~1permissions~1authorization~1tokens~1permissionLevels/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.permission_levels + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/token_permission_levels/methods/getpermissionlevels' + insert: [] + update: [] + replace: [] + delete: [] + exec: [] + user_tokens: + id: databricks_workspace.workspace.user_tokens + name: user_tokens + title: User_tokens + methods: + create: + operation: + $ref: '#/paths/~1api~12.0~1token~1create/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + listtokens: + operation: + $ref: '#/paths/~1api~12.0~1token~1list/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.token_infos + revoketoken: + operation: + $ref: '#/paths/~1api~12.0~1token~1delete/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/user_tokens/methods/listtokens' + insert: + - $ref: '#/components/x-stackQL-resources/user_tokens/methods/create' + update: [] + replace: [] + delete: [] + exec: + - $ref: '#/components/x-stackQL-resources/user_tokens/methods/revoketoken' From 5c49615aa700b993f46809b2dd851e0b757af8f6 Mon Sep 17 00:00:00 2001 From: Jeffrey Aven Date: Fri, 20 Dec 2024 11:50:58 +1100 Subject: [PATCH 2/7] added dbx providers --- .../src/databricks_workspace/v00.00.00000/services/repos.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/providers/src/databricks_workspace/v00.00.00000/services/repos.yaml b/providers/src/databricks_workspace/v00.00.00000/services/repos.yaml index f7b97e10..627a2402 100644 --- a/providers/src/databricks_workspace/v00.00.00000/services/repos.yaml +++ b/providers/src/databricks_workspace/v00.00.00000/services/repos.yaml @@ -61,7 +61,7 @@ paths: example: git_provider: gitHub git_username: testuser - personal_access_token: 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 + personal_access_token: ghp_123 description: Creates a Git credential entry for the user. Only one Git credential per user is supported, so any attempts to create credentials if an entry already exists will fail. Use the PATCH endpoint to update existing credentials, or @@ -214,7 +214,7 @@ paths: git_provider: gitHub git_username: testuser id: '93488329053511' - personal_access_token: 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 + personal_access_token: ghp_123 description: Updates the specified Git credential. /api/2.0/permissions/repos/{repo_id}: get: From dbf9e682cd435e023244a4060888eb50de90be8d Mon Sep 17 00:00:00 2001 From: Jeffrey Aven Date: Fri, 20 Dec 2024 11:51:36 +1100 Subject: [PATCH 3/7] added dbx providers --- .../src/databricks_workspace/v00.00.00000/services/repos.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/providers/src/databricks_workspace/v00.00.00000/services/repos.yaml b/providers/src/databricks_workspace/v00.00.00000/services/repos.yaml index 627a2402..6525df77 100644 --- a/providers/src/databricks_workspace/v00.00.00000/services/repos.yaml +++ b/providers/src/databricks_workspace/v00.00.00000/services/repos.yaml @@ -61,7 +61,7 @@ paths: example: git_provider: gitHub git_username: testuser - personal_access_token: ghp_123 + personal_access_token: your_personal_access_token description: Creates a Git credential entry for the user. Only one Git credential per user is supported, so any attempts to create credentials if an entry already exists will fail. Use the PATCH endpoint to update existing credentials, or @@ -214,7 +214,7 @@ paths: git_provider: gitHub git_username: testuser id: '93488329053511' - personal_access_token: ghp_123 + personal_access_token: your_personal_access_token description: Updates the specified Git credential. /api/2.0/permissions/repos/{repo_id}: get: From bf64106d83044e48f50edca17259ebca2a84f4b1 Mon Sep 17 00:00:00 2001 From: Jeffrey Aven Date: Fri, 20 Dec 2024 11:52:32 +1100 Subject: [PATCH 4/7] added dbx providers --- .../src/databricks_workspace/v00.00.00000/services/repos.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/providers/src/databricks_workspace/v00.00.00000/services/repos.yaml b/providers/src/databricks_workspace/v00.00.00000/services/repos.yaml index 6525df77..d3688beb 100644 --- a/providers/src/databricks_workspace/v00.00.00000/services/repos.yaml +++ b/providers/src/databricks_workspace/v00.00.00000/services/repos.yaml @@ -61,7 +61,7 @@ paths: example: git_provider: gitHub git_username: testuser - personal_access_token: your_personal_access_token + personal_access_token: something description: Creates a Git credential entry for the user. Only one Git credential per user is supported, so any attempts to create credentials if an entry already exists will fail. Use the PATCH endpoint to update existing credentials, or @@ -214,7 +214,7 @@ paths: git_provider: gitHub git_username: testuser id: '93488329053511' - personal_access_token: your_personal_access_token + personal_access_token: something description: Updates the specified Git credential. /api/2.0/permissions/repos/{repo_id}: get: From d6988c132b77f2c6c09775c5e17e5393620cf416 Mon Sep 17 00:00:00 2001 From: Jeffrey Aven Date: Fri, 20 Dec 2024 11:54:27 +1100 Subject: [PATCH 5/7] added dbx providers --- .../v00.00.00000/services/repos.yaml | 9 --------- 1 file changed, 9 deletions(-) diff --git a/providers/src/databricks_workspace/v00.00.00000/services/repos.yaml b/providers/src/databricks_workspace/v00.00.00000/services/repos.yaml index d3688beb..81ca1cce 100644 --- a/providers/src/databricks_workspace/v00.00.00000/services/repos.yaml +++ b/providers/src/databricks_workspace/v00.00.00000/services/repos.yaml @@ -58,10 +58,6 @@ paths: type: string personal_access_token: type: string - example: - git_provider: gitHub - git_username: testuser - personal_access_token: something description: Creates a Git credential entry for the user. Only one Git credential per user is supported, so any attempts to create credentials if an entry already exists will fail. Use the PATCH endpoint to update existing credentials, or @@ -210,11 +206,6 @@ paths: type: required git_username: type: string - example: - git_provider: gitHub - git_username: testuser - id: '93488329053511' - personal_access_token: something description: Updates the specified Git credential. /api/2.0/permissions/repos/{repo_id}: get: From 2e0b5aab779c8c6bd3c9ef0d16e872b38deaf43a Mon Sep 17 00:00:00 2001 From: Jeffrey Aven Date: Fri, 20 Dec 2024 11:55:43 +1100 Subject: [PATCH 6/7] added dbx providers --- .../src/databricks_workspace/v00.00.00000/services/repos.yaml | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/providers/src/databricks_workspace/v00.00.00000/services/repos.yaml b/providers/src/databricks_workspace/v00.00.00000/services/repos.yaml index 81ca1cce..12da1026 100644 --- a/providers/src/databricks_workspace/v00.00.00000/services/repos.yaml +++ b/providers/src/databricks_workspace/v00.00.00000/services/repos.yaml @@ -206,6 +206,10 @@ paths: type: required git_username: type: string + example: + git_provider: gitHub + git_username: testuser + personal_access_token: something description: Updates the specified Git credential. /api/2.0/permissions/repos/{repo_id}: get: From c7535b87ac7a6ad4e2e3932526f42678ce210181 Mon Sep 17 00:00:00 2001 From: Jeffrey Aven Date: Fri, 20 Dec 2024 11:57:13 +1100 Subject: [PATCH 7/7] added dbx providers --- .../src/databricks_workspace/v00.00.00000/services/repos.yaml | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/providers/src/databricks_workspace/v00.00.00000/services/repos.yaml b/providers/src/databricks_workspace/v00.00.00000/services/repos.yaml index 12da1026..a0a2830e 100644 --- a/providers/src/databricks_workspace/v00.00.00000/services/repos.yaml +++ b/providers/src/databricks_workspace/v00.00.00000/services/repos.yaml @@ -58,6 +58,10 @@ paths: type: string personal_access_token: type: string + example: + git_provider: gitHub + git_username: testuser + personal_access_token: something description: Creates a Git credential entry for the user. Only one Git credential per user is supported, so any attempts to create credentials if an entry already exists will fail. Use the PATCH endpoint to update existing credentials, or