Sign in

v1

latestOpenAPI 3.1.02026-07-26252382475.4 KB
Connections

Create Connection

Creates a new connection with validation, duplicate checking, and OAuth2 processing.

Args: current_user: Authenticated user profile session: Database session connection_data: Connection creation data

Returns: dict: Status message with connection ID or OAuth2 redirect URL

Raises: HTTPException: If connection already exists or validation fails

post/v1/connections/applications

Request body

appidstring required

Application ID or application name

connection_type'basic_auth' | 'bearer_token' | 'api_key_auth' | 'oauth2_auth_code' | 'oauth2_implicit' | 'oauth2_password' | 'oauth2_client_creds' | 'key_value_creds' required
credentialsobject required

Credentials as a JSON object

sharedboolean

Whether the connection is shared, default is true

Response

Connection created successfully.

statusstring
messagestring
connection_idstring

Example response

{
  "status": "success",
  "message": "Connection created successfully.",
  "connection_id": "123e4567-e89b-12d3-a456-426614174000"
}