Skip to content

Latest commit

 

History

History
71 lines (43 loc) · 2.63 KB

ConnectionApi.md

File metadata and controls

71 lines (43 loc) · 2.63 KB

ConnectionApi

All URIs are relative to https://domainnameofpartner

Method HTTP request Description
connect POST /connect
deleteConnection POST /delete-connection
testConnection POST /test-connection

connect

Connection connect(User-Agent, ConnectRequest, Accept-Language, Content-Type)

The Connect API is used to sign-in or sign-up a user with a partner with Databricks resources pre-configured.

Parameters

Name Type Description Notes
User-Agent String The user agent making the call. This will be set to databricks. [default to databricks] [enum: databricks]
ConnectRequest ConnectRequest The connection payload.
Accept-Language String Preferred language [optional] [default to en-US]
Content-Type String Content type [optional] [default to application/json; charset=utf-8]

Return type

Connection

Authorization

basicAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

deleteConnection

DeleteConnectionResponse deleteConnection(User-Agent, DeleteConnectionRequest, Accept-Language, Content-Type)

Delete the connection created by partner. This API is used for automated tests and is required in the Partner Connect experience. In the Partner Connect experience, Databricks calls this API to notify partners about connection deletion from Databricks's side.

Parameters

Name Type Description Notes
User-Agent String The user agent making the call. This will be set to databricks. [default to databricks] [enum: databricks]
DeleteConnectionRequest DeleteConnectionRequest The delete connection payload.
Accept-Language String Preferred language [optional] [default to en-US]
Content-Type String Content type [optional] [default to application/json; charset=utf-8]

Return type

DeleteConnectionResponse

Authorization

basicAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json