Connections
List Available Connections
Get Public Connection Configuration
This endpoint allows you to retrieve the public configuration details for connections.
Only the connections having “stage”: “PRODUCTION” are available in the production stage. You can use only this type of connections.
Request
Endpoint
GET /connections/public-config
Response
- Status: 200 OK
- Body:
[ { "connectionType":"", "name":"", "authorizationType":"", "credentialSchemaType":"", "category":"", "configuration":[ { "name":"", "label":"", "type":"", "required":true, "advanced":true, "visible":true, "description":"", "nested":null } ], "groupCode":null, "groupLabel":null, "documentationUrl":"", "stage":"", "earlyAccessRequested":true } ]
Sample For Airtable Connection
configuration object lists the parameters to create a connection.
e.g. connectionType=airtable has following configuration.
`{ "connectionType": "airtable", "name": "Airtable", "authorizationType": "bearer_token", "credentialSchemaType": "airtable_custom_credential_schema", "category": "Database", "configuration": [ { "name": "personalAccessToken", "label": "Personal Access Token", "type": "password", "required": true, "advanced": false, "visible": true, "description": "Personal Access Token", "nested": null } ], "groupCode": null, "groupLabel": null, "documentationUrl": "https://www.peaka.com/docs/integrations/airtable/", "stage": "PRODUCTION", "earlyAccessRequested": false }
To create a connection for Airtable, you should give credentialSchemaType and credential object.
Credential object has attributes listed in configuration object above.
{ "name": "exampleAirtableConnection", "connectionType": "airtable", "credentialSchemaType": "airtable_custom_credential_schema", "credential": { "personalAccessToken": "" } }
GET
/
connections
/
public-config
Authorizations
Authorization
string
headerrequiredBearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Response
200 - application/json
The response is of type object
.