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

Zluri Syncs API

Create and manage sync sessions for uploading data to Zluri. A sync must be created before uploading data, and finished after all data is uploaded.

Zluri Syncs API is one of 4 APIs that Zluri publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 12 JSON Schema definitions.

Tagged areas include Syncs. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 12 JSON Schemas.

This API exposes 3 operations across 3 paths, and defines 2 schemas. It is described by OpenAPI 3.1.0, at version 2.0.0.

Requests are made against a single base URL, https://api-ext.zluri.com/v2.

3 operations 3 paths 2 schemas 1 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
2.0.0
Server
https://api-ext.zluri.com/v2
Authentication
HTTP Bearer
Terms of Service
Resource Areas
1

Authentication & Security 1

Zluri Syncs API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — Bearer token authentication. Obtain your API token from the Zluri admin dashboard.

Paths & Operations 3

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

Syncs 3

Create and manage sync sessions for uploading data to Zluri. A sync must be created before uploading data, and finished after all data is uploaded.

POST
/integrations-sync/instances/{instance_id}/syncs
Zluri Create Sync
createSync 1 param → 201400401404409429
GET
/integrations-sync/instances/{instance_id}/syncs/{sync_id}
Zluri Get Sync Status
getSyncStatus 2 params → 200401404429
POST
/integrations-sync/instances/{instance_id}/syncs/{sync_id}/finish
Zluri Finish Sync
finishSync 2 params → 200400401404429

Schemas 2

The contract defines 2 schemas that model the data the API accepts and returns. The most detailed are Sync (5 properties), Error (2 properties). Each schema is shown below with its type and property counts.

Error
object
2 properties
Sync
object
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zluri-syncs-api-openapi.yml Raw ↑

Other APIs Zluri publishes across the network.

Zluri Data Upload API
Zluri Instances API
Zluri Webhooks API