Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Terapi Connections API

Manage end-user connections to third-party integrations

Terapi Connections API is one of 5 APIs that Terapi publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Connections. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and a getting-started guide.

This API exposes 4 operations across 2 paths, and defines 4 schemas. It is described by OpenAPI 3.0.3, at version 1.0.

Requests are made against 2 base URLs: https://api.terapi.dev, http://localhost:3003.

4 operations 2 paths 4 schemas 1 DELETE2 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0
Servers
https://api.terapi.dev
http://localhost:3003
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Terapi Connections API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (SecretKeyAuth). By default, every request must be authenticated.

  • SecretKeyAuth — Secret key from Terapi environment settings. Passed as 'Bearer {secretkey}'

Paths & Operations 4

Across 2 paths, the API surfaces 4 operations — 1 DELETE, 2 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Connections 4

Manage end-user connections to third-party integrations

GET
/connection
List Connections
listConnections 2 params → 200401
POST
/connection
Create Connection
createConnection body → 200400401
GET
/connection/{connection_id}
Get Connection
getConnection 2 params → 200401404
DELETE
/connection/{connection_id}
Delete Connection
deleteConnection 2 params → 204401404

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are Connection (7 properties), CreateConnectionRequest (4 properties), ErrorResponse (2 properties), ConnectionListResponse (1 property). Each schema is shown below with its type and property counts.

CreateConnectionRequest
object
4 properties 2 required
ConnectionListResponse
object
1 property
Connection
object
An authenticated connection between an end-user and a third-party service
7 properties
ErrorResponse
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

terapi-connections-api-openapi.yml Raw ↑

Other APIs Terapi publishes across the network.

Terapi Actions API
Terapi Authentication API
Terapi Integrations API
Terapi Sync API