AimableDocs
DocsAPI Reference
POST/v1/spaces/{space_id}/collections/{collection_id}/connectors/{connector_id}/sync/cancel

Cancel Sync

Path Parameters

NameTypeRequiredDescription
space_idstring (uuid)Required
collection_idstring (uuid)Required
connector_idstring (uuid)Required

Headers

NameTypeRequiredDescription
X-API-KeystringOptional

Request

curl -X POST '/api-proxy/v1/spaces/{space_id}/collections/{collection_id}/connectors/{connector_id}/sync/cancel' \
  -H 'Authorization: Bearer <YOUR_TOKEN>'

Response

200(generated)
{
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "collection_connector_id": "550e8400-e29b-41d4-a716-446655440000",
    "status": "string",
    "started_at": {},
    "completed_at": {},
    "records_fetched": 0,
    "error_message": {},
    "metadata": {},
    "created_at": "2024-01-01T00:00:00Z"
  }
}

Error Responses