Connections
Get Connection Detail
API Documentation
Organization -> Organizations
Organization -> Workspaces
Organization -> Projects
Projects (Deprecated)
Projects -> Api Key
Connections
Data -> Catalogs
Data -> Internal Tables
Data -> Queries
Data -> Semantic Catalogs
Data -> Cache
Embedded Peaka Api
Supported Drivers
Data -> Metadata
- PUTUpdate Metadata
- PUTUpdate Relation From Metadata
- DELDelete Relation From Metadata
- PUTGenerate categorical values from the the column.
- POSTGenerate semantics for the table
- POSTAdd Relation To Metadata
- GETList of golden sqls for the project.
- POSTCreate golden sql for the project
- GETGet Project Metadata
- GETGet Project Catalog Metadata Relations
- GETGenerate sample ai questions for the project
- DELDelete golden sql from the project.
Connections
Get Connection Detail
Get connection detail by ID. Returns only non-sensitive information.
GET
/
connections
/
{projectId}
/
{connectionId}
/
detail
curl --request GET \
--url https://partner.peaka.studio/api/v1/connections/{projectId}/{connectionId}/detail
{
"type": "bullhorn",
"restApiTokenUrl": "http://a.b.c",
"swimlane": "123",
"corpToken": "123"
}
Path Parameters
ID of the project
ID of the connection
Response
200 - application/json
Connection Detail
Credential object for the connection.
Its structure is dependent on the connection type and can be fetched by following url: /connections/config
curl --request GET \
--url https://partner.peaka.studio/api/v1/connections/{projectId}/{connectionId}/detail
{
"type": "bullhorn",
"restApiTokenUrl": "http://a.b.c",
"swimlane": "123",
"corpToken": "123"
}