VirtuousAI
ReferenceSync

Get Sync Plan

GET
/api/v1/sync/plan

Query Parameters

layer*string

Layer to sync: bronze or silver

org_slug?|

Organization slug to sync from

tenant_id?|

Source tenant ID (alternative to org_slug)

dest_tenant_id?|

Destination tenant ID

dataset?|

Specific dataset to sync

date_from?|

Start date (inclusive)

date_to?|

End date (exclusive)

max_files?integer

Max files to sync

Default1000
max_bytes?integer

Max bytes to sync (default 1GB)

Default1073741824

Header Parameters

authorization?|
X-API-Key?|
vai_token?|

Response Body

application/json

application/json

curl -X GET "https://loading/api/v1/sync/plan?layer=string"
{
  "datasetFilter": "string",
  "datasets": [
    {}
  ],
  "dateFrom": "2019-08-24",
  "dateTo": "2019-08-24",
  "destBucket": "string",
  "destTenantId": "string",
  "layer": "string",
  "limitExceededReason": "string",
  "sourceBucket": "string",
  "sourceTenantId": "string",
  "totalBytes": 0,
  "totalFiles": 0,
  "withinLimits": true
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}