Releasesv0.1.0
Api referenceEndpointsAdmin

Sync runs of every user of the tenant (instance admin, one tenant)

GET
/v1/admin/tenants/{tenant_id}/pipeline/sync-runs

GET /v1/pipeline/sync-runs (listTenantSyncRuns) for the tenant of tenant_id, read with an instance admin key: the same parameters and the same answer as the tenant's own key gets. Recorded in the caller's audit log and, actor admin, in the tenant's. See docs/admin-api.md.

Authorization

tenantKey
headerAuthorizationBearer <token>

Tenant API key, ohs_sk_ + 43 base62 characters.

Path Parameters

tenant_id*string

The id of a tenant; any other value is a 404.

Formatuuid

Query Parameters

status?string
Value in"queued""running""retrying""rate_limited""succeeded""failed""cancelled"
provider?string

Only this provider's runs.

limit?integer
Range1 <= value <= 100
Default50
cursor?string

The next_cursor of the previous page.

Header Parameters

Authorization*string

The tenant API key, as a bearer secret.

Response Body

A page of runs.

application/json
  1. response
data*array<>
next_cursor*|

Null on the last page.

curl -X GET 'http://localhost:8080/v1/admin/tenants/497f6eca-6276-4993-bfeb-53cbbbba6f08/pipeline/sync-runs' \  -H 'Authorization: Bearer ohs_sk_...'
{  "next_cursor": "string",  "data": [    {      "id": 0,      "provider": "string",      "trigger": "backfill",      "status": "queued",      "data_type": "string",      "window_start": "2019-08-24T14:15:22Z",      "window_end": "2019-08-24T14:15:22Z",      "attempts": 0,      "objects_stored": 0,      "error": "string",      "created_at": "2019-08-24T14:15:22Z",      "started_at": "2019-08-24T14:15:22Z",      "finished_at": "2019-08-24T14:15:22Z",      "next_attempt_at": "2019-08-24T14:15:22Z",      "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5"    }  ]}
Edit on GitHub