Delete Sync

Delete a sync configuration and optionally its associated data.

Args:

db: The database session sync_id: The ID of the sync to delete delete_data: Whether to delete the data associated with the sync user: The current user

Returns:

sync (schemas.Sync): The deleted sync

Path parameters

sync_idstringRequired

Query parameters

delete_databooleanOptionalDefaults to false

Response

Successful Response

namestring

source_connection_idstringformat: "uuid"

destination_connection_idslist of strings

statusenum

Sync status enum.

Allowed values:

idstringformat: "uuid"

organization_idstringformat: "uuid"

created_atdatetime

modified_atdatetime

created_by_emailstringformat: "email"

modified_by_emailstringformat: "email"

embedding_model_connection_idstringOptionalformat: "uuid"Defaults to 33333333-3333-3333-3333-333333333333

descriptionstringOptional

cron_schedulestringOptional

next_scheduled_rundatetimeOptional

white_label_idstringOptionalformat: "uuid"

white_label_user_identifierstringOptional

sync_metadatamap from strings to anyOptional

1	from airweave import AirweaveSDK
2
3	client = AirweaveSDK(
4	api_key="YOUR_API_KEY",
5	)
6	client.sync.delete_sync(
7	sync_id="sync_id",
8	)

1	{
2	"name": "name",
3	"source_connection_id": "source_connection_id",
4	"destination_connection_ids": [
5	"destination_connection_ids"
6	],
7	"status": "active",
8	"id": "id",
9	"organization_id": "organization_id",
10	"created_at": "2024-01-15T09:30:00Z",
11	"modified_at": "2024-01-15T09:30:00Z",
12	"created_by_email": "created_by_email",
13	"modified_by_email": "modified_by_email",
14	"embedding_model_connection_id": "embedding_model_connection_id",
15	"description": "description",
16	"cron_schedule": "cron_schedule",
17	"next_scheduled_run": "2024-01-15T09:30:00Z",
18	"white_label_id": "white_label_id",
19	"white_label_user_identifier": "white_label_user_identifier",
20	"sync_metadata": {
21	"key": "value"
22	}
23	}

Args:

Returns:

Path parameters

Headers

Query parameters

Response

Errors