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 Sync API

Trigger and manage data synchronization between services

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

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

This API exposes 2 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.

2 operations 2 paths 4 schemas 1 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 Sync 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 2

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

Sync 2

Trigger and manage data synchronization between services

POST
/sync/trigger
Trigger Sync
triggerSync body → 200400401
GET
/sync/{connection_id}/{sync_name}
Get Sync Status
getSyncStatus 3 params → 200401404

Schemas 4

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

TriggerSyncRequest
object
3 properties 3 required
SyncTriggerResponse
object
2 properties
ErrorResponse
object
2 properties
SyncStatus
object
Status and history of a data synchronization
7 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

terapi-sync-api-openapi.yml Raw ↑

Other APIs Terapi publishes across the network.

Terapi Actions API
Terapi Authentication API
Terapi Connections API
Terapi Integrations API