Get Sync Status

Retrieve the synchronization status and details for a specific data source

Endpoint

GET /api/v1/providers/datasources/{id}/sync_status

Description

Returns the current synchronization status for a specific data source, including information about the last sync operation and any errors that occurred during data extraction.

API Reference

get

Authorizations

bearerAuth

AuthorizationstringRequired

Veza API key for authentication. Generate keys in Administration > API Keys.

Path parameters

idstringRequired

Responses

200

OK

application/json

default

Default error response

application/json

get

/api/v1/providers/datasources/{id}/sync_status

HTTPcURLJavaScriptPython

GET /api/v1/providers/datasources/{id}/sync_status HTTP/1.1
Host: your-tenant.vezacloud.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "job_status": {
    "id": "text",
    "status": "text"
  }
}

Path Parameters

Parameter	Type	Required?	Description
id	string	Required	The data source ID

Request Examples

curl -X GET "$BASE_URL/api/v1/providers/datasources/6961b032-3fd7-4baa-a230-146d1b70ec27/sync_status" \
  -H "authorization: Bearer $VEZA_TOKEN"

Response Examples

Standard Response:

{
  "value": {
    "datasource_id": "6961b032-3fd7-4baa-a230-146d1b70ec27",
    "status": "SUCCESS",
    "last_synced_at": "2022-01-13T20:53:23Z",
    "sync_duration_seconds": 120,
    "records_extracted": 5000,
    "errors_count": 0,
    "next_scheduled_sync": "2022-01-14T08:00:00Z"
  }
}