Sync export storage — API Reference

Sync tasks to an local file export/target storage connection. You will need to provide the export storage ID. You can find this using List export storages.

Sync operations with external local file directories only go one way. They either create tasks from objects in the directory (source/import storage) or push annotations to the output directory (export/target storage). Changing something on the local file side doesn’t guarantee consistency in results.

Before proceeding, you should review How sync operations work - Source storage to ensure that your data remains secure and private.

Path parameters

idstringRequired

Response

This endpoint returns an object

project

integer

A unique integer value identifying this project.

integerOptional

type

stringOptionalDefaults to localfiles

synchronizable

booleanOptional

path

stringOptional

Local path

regex_filter

stringOptional

Regex for filtering objects

use_blob_urls

booleanOptional

Interpret objects as BLOBs and generate URLs

last_sync

datetimeOptional

Last sync finished time

last_sync_count

integerOptional

Count of tasks synced last time

last_sync_job

stringOptional

Last sync job ID

status

enumOptional

Allowed values: initializedqueuedin_progressfailedcompleted

traceback

stringOptional

Traceback report for the last failed sync

1	{
2	"project": 1,
3	"id": 1,
4	"type": "type",
5	"synchronizable": true,
6	"path": "path",
7	"regex_filter": "regex_filter",
8	"use_blob_urls": true,
9	"last_sync": "2024-01-15T09:30:00Z",
10	"last_sync_count": 1,
11	"last_sync_job": "last_sync_job",
12	"status": "initialized",
13	"traceback": "traceback",
14	"meta": {
15	"meta": {
16	"key": "value"
17	}
18	},
19	"title": "title",
20	"description": "description",
21	"created_at": "2024-01-15T09:30:00Z",
22	"can_delete_objects": true
23	}

1	curl -X POST http://localhost:8080/api/storages/export/localfiles/id/sync \
2	-H "Authorization: Token <api_key>"