Connections
Get Connection Config
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 Config
GET
/
connections
/
config
/
{connectionType}
curl --request GET \
--url https://partner.peaka.studio/api/v1/connections/config/{connectionType} \
--header 'Authorization: Bearer <token>'
{
"connectionType": "<string>",
"connectionTypeLabel": "<string>",
"name": "<string>",
"authorizationType": "<string>",
"credentialSchemaType": "<string>",
"redirectRequired": true,
"category": "<string>",
"configuration": [
{
"fieldName": "<string>",
"fieldType": "text",
"required": true,
"description": "<string>"
}
],
"documentationUrl": "<string>"
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
Type of connection
Response
200 - */*
OK
The response is of type object
.
curl --request GET \
--url https://partner.peaka.studio/api/v1/connections/config/{connectionType} \
--header 'Authorization: Bearer <token>'
{
"connectionType": "<string>",
"connectionTypeLabel": "<string>",
"name": "<string>",
"authorizationType": "<string>",
"credentialSchemaType": "<string>",
"redirectRequired": true,
"category": "<string>",
"configuration": [
{
"fieldName": "<string>",
"fieldType": "text",
"required": true,
"description": "<string>"
}
],
"documentationUrl": "<string>"
}