DATA_STORE

Test Data Store Using Form

Test a data store connection using form in frontend. :param db: The database session for accessing the database. :param data_store_test_connection_request: The data store test connection request containing the data store definition and other metadata. :param auth: The authorization token for the request. :return: A data store test connection response containing the ok status and a message.

post/data_stores/form/test_connection/

Request

  • Base URL: https://api.myaltimate.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.myaltimate.com/data_stores/form/test_connection/
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer

Request body

namestring required
typestring required
descriptionstring required
accountstring nullable
userstring nullable
passwordstring nullable
rolestring nullable
databasestring nullable
warehousestring nullable
hoststring nullable
portstring nullable
pat_secretstring nullable
pat_namestring nullable
site_namestring nullable
urlstring nullable
auth_type'password' | 'key_pair'
datastore_idinteger nullable
source_site_namestring nullable

Response

Successful Response

okboolean required
messagestring nullable
site_rolestring nullable
can_publish_workbooksboolean nullable

Changes

No recorded changes to this operation across all 82 revisions of this API.