POST /connections – Creates a new connection.
Headers:
Authorization: Bearer <access_token>
Body:
Path Parameters:
Query Parameters:
201 Created
400
401
500
{ "error": "Detailed error message here"} Copy
{ "error": "Detailed error message here"}
POST /connections{ "connectionBody": { "name": "example-connection", "displayName": "Connection Name", "metadata": { "key": "value" }, }} Copy
POST /connections{ "connectionBody": { "name": "example-connection", "displayName": "Connection Name", "metadata": { "key": "value" }, }}
POST /connections{ "provider": "cognito-connection", "connectionBody": { "name": "example-connection", "metadata": { "key": "value" }, }} Copy
POST /connections{ "provider": "cognito-connection", "connectionBody": { "name": "example-connection", "metadata": { "key": "value" }, }}
{ "connectionId": "connection_id", "name": "example-connection", "type": "connection_type", "status": "active|inactive", "createdAt": "2023-01-01T00:00:00Z", "updatedAt": "2025-01-01T00:00:00Z", "metadata": { "key": "value" }, "configuration": { "setting": "value" } Copy
{ "connectionId": "connection_id", "name": "example-connection", "type": "connection_type", "status": "active|inactive", "createdAt": "2023-01-01T00:00:00Z", "updatedAt": "2025-01-01T00:00:00Z", "metadata": { "key": "value" }, "configuration": { "setting": "value" }
The API Gateway event containing the request.
A Promise resolving to an API Gateway-compatible response.
POST /connections – Creates a new connection.
Remarks
📥 Request
Headers:
Authorization: Bearer <access_token>(required)Body:
Path Parameters:
Query Parameters:
📤 Response
201 Created– JSON stringified object representing the created connection. See Connection.❗ Errors
400401500Error Response Format
📦 Examples
📥 Auth0 Request
📥 Cognito Request
📤 Response Example