Api referenceEndpointsAdmin
A tenant's pipeline, stage by stage (instance admin)
GET
The answer the tenant's own key gets from GET /v1/pipeline.
tenantKeyheader
AuthorizationBearer <token>Tenant API key, ohs_sk_ + 43 base62 characters.
tenant_id*stringThe id of a tenant; any other value is a 404.
Format
uuidThe pipeline.
application/json- response
generated_at*stringFormat
date-timeusers*sources*array<>sync*Sync runs in flight (queued, running, retrying after a failed attempt,
rate_limited), and those created in the last 24 hours that ended failed or
succeeded.
processing*Processing jobs by status, and the records processing rejected and has not recovered (as in the coverage report).
storage*Raw payloads stored in the last 24 hours.
delivery*Webhook endpoints (failing ones are on but their last deliveries failed) and the deliveries not done.
curl -X GET 'http://localhost:8080/v1/admin/tenants/497f6eca-6276-4993-bfeb-53cbbbba6f08/pipeline' \ -H 'Authorization: Bearer ohs_sk_...'{ "generated_at": "2019-08-24T14:15:22Z", "users": { "active": 0, "deleting": 0 }, "sources": [ { "slug": "string", "name": "string", "kinds": [ "oauth" ], "enabled": true, "connections": { "property1": 0, "property2": 0 }, "broken": 0, "paused_until": "2019-08-24T14:15:22Z" } ], "sync": { "queued": 0, "running": 0, "retrying": 0, "rate_limited": 0, "failed_24h": 0, "succeeded_24h": 0 }, "processing": { "pending": 0, "running": 0, "parked": 0, "rejected_records": 0 }, "storage": { "raw_objects_24h": 0, "raw_bytes_24h": 0 }, "delivery": { "endpoints": 0, "endpoints_failing": 0, "endpoints_disabled": 0, "pending": 0, "parked": 0 }}