Sign in
Sync

Retrieve acknowledgements

Changed on

Retrieve the synchronization acknowledgments for the current session.

get/sync/ack

Request

  • Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/sync/ack
  • Auth: one of:
    • HTTP bearer
    • API key in cookie immich_access_token
    • API key in header x-api-key

Response

ackstring required

Acknowledgment ID

type'AuthUserV1' | 'UserV1' | 'UserDeleteV1' | 'AssetV1' | 'AssetV2' | 'AssetDeleteV1' | 'AssetExifV1' | 'AssetEditV1' | 'AssetEditDeleteV1' | 'AssetMetadataV1' | 'AssetMetadataDeleteV1' | 'AssetOcrV1' | 'AssetOcrDeleteV1' | 'PartnerV1' | 'PartnerDeleteV1' | 'PartnerAssetV1' | 'PartnerAssetV2' | 'PartnerAssetBackfillV1' | 'PartnerAssetBackfillV2' | 'PartnerAssetDeleteV1' | 'PartnerAssetExifV1' | 'PartnerAssetExifBackfillV1' | 'PartnerStackBackfillV1' | 'PartnerStackDeleteV1' | 'PartnerStackV1' | 'AlbumV1' | 'AlbumV2' | 'AlbumDeleteV1' | 'AlbumUserV1' | 'AlbumUserBackfillV1' | 'AlbumUserDeleteV1' | 'AlbumAssetCreateV1' | 'AlbumAssetCreateV2' | 'AlbumAssetUpdateV1' | 'AlbumAssetUpdateV2' | 'AlbumAssetBackfillV1' | 'AlbumAssetBackfillV2' | 'AlbumAssetExifCreateV1' | 'AlbumAssetExifUpdateV1' | 'AlbumAssetExifBackfillV1' | 'AlbumToAssetV1' | 'AlbumToAssetDeleteV1' | 'AlbumToAssetBackfillV1' | 'MemoryV1' | 'MemoryDeleteV1' | 'MemoryToAssetV1' | 'MemoryToAssetDeleteV1' | 'StackV1' | 'StackDeleteV1' | 'PersonV1' | 'PersonDeleteV1' | 'AssetFaceV1' | 'AssetFaceV2' | 'AssetFaceDeleteV1' | 'UserMetadataV1' | 'UserMetadataDeleteV1' | 'SyncAckV1' | 'SyncResetV1' | 'SyncCompleteV1' required

Sync entity type

Changes

  • 3903d67f6b1cRevision changes
    • warning

      added the new AssetOcrDeleteV1 enum value to the / response property for the response status

    • warning

      added the new AssetOcrV1 enum value to the / response property for the response status

  • 56523954a19eRevision changes
    • warning

      added the new AlbumAssetBackfillV2 enum value to the / response property for the response status

    • warning

      added the new AlbumAssetCreateV2 enum value to the / response property for the response status

    • warning

      added the new AlbumAssetUpdateV2 enum value to the / response property for the response status

    • warning

      added the new AssetV2 enum value to the / response property for the response status

    • warning

      added the new PartnerAssetBackfillV2 enum value to the / response property for the response status

    • warning

      added the new PartnerAssetV2 enum value to the / response property for the response status