Connections

Get Connection Config

Returns the configuration schema for a specific connection type, including required credential fields and their types. Use this to understand what parameters are needed when creating a connection of this type.

get/connections/config/{connectionType}

Request

  • Base URL: https://partner.peaka.studio/api/v1
  • URL: https://partner.peaka.studio/api/v1/connections/config/{connectionType}
  • Auth: HTTP bearer

Path parameters

connectionTypestring required

Type of connection

Response

Connection configuration

connectionTypestring

The type of the connection. e.g. stripe, airtable, etc.

connectionTypeLabelstring

The label for the connection type.

namestring

The name of the connection.

authorizationTypestring

The type of authorization used for the connection. e.g. oauth2, api_key, bearer_token, etc.

credentialSchemaTypestring

The type of the credential schema used for the connection.

redirectRequiredboolean

Flag to indicate if the connection requires redirection to a 3rd party platform.

e.g. OAuth2 connections often require redirection to the 3rd party platform for authorization.

If this flag is set to true, the connection will be redirected to the 3rd party platform for authorization.

According to your use case, some extra steps may be required to complete the authorization process.

See: https://docs.peaka.com/how-to-guides/how-to-create-oauth2-based-connections-via-peaka

categorystring

The category of the connection.

documentationUrlstring

The URL for the documentation of the connection.

keywordsstring[]

Search aliases and abbreviations for the connection type, e.g. ["pg", "psql", "postgre"] for POSTGRES. Useful for matching a user's or an LLM's free-text name for a data source to a connection type.

Example response

{
  "configuration": [
    {
      "fieldType": "text"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.