Sign in
integrations

Connect

Connect or update an integration.

Connect or update an integration with an external provider (e.g., Immich). Credentials are encrypted before storage.

post/api/v1/integrations/connect

Request

  • The document declares no server URL.
  • Auth: OAuth 2 (password, token URL /api/v1/auth/token)

Cookies

access_tokenstring nullable

Request body

provider'immich' required

Supported integration providers.

Add new providers here as they are implemented. Each provider must have a corresponding client module in app/integrations/{provider}.py

credentialsobject required

Provider-specific authentication credentials (e.g., {'api_key': '...'})

base_urlstring nullable

Override provider base URL (optional, defaults to .env value)

import_mode'link_only' | 'copy'

Import mode for external assets.

Determines how assets are handled when imported from external providers.

Response

Successful Response

statusstring

Connection status (always 'connected' on success)

provider'immich' required

Supported integration providers.

Add new providers here as they are implemented. Each provider must have a corresponding client module in app/integrations/{provider}.py

external_user_idstring required

Verified user ID from the provider

connected_atstring date-time required

When the integration was connected

Changes

No recorded changes to this operation across all 9 revisions of this API.