For the complete documentation index, see llms.txt. This page is also available as Markdown.

Connections and profiles

Provider authentication, connection status, and profile management endpoints.

Use these endpoints to connect providers and manage their profiles.

Provider profiles

Every provider has a default profile. Additional profiles usually use PROVIDER-P## identifiers.

Method
Endpoint
Purpose

GET

/api/provider-instances

List profiles for every provider.

GET

/api/provider-instances/{provider}

List profiles for one provider.

POST

/api/provider-instances/{provider}/next

Create the next profile.

POST

/api/provider-instances/{provider}/{instance_id}

Create or replace a profile.

DELETE

/api/provider-instances/{provider}/{instance_id}

Delete a non-default profile.

Deletion returns 409 when active configuration references the profile.

Provider authentication

Provider family
Endpoint group
Purpose

Plex

/api/plex/*

PIN sign-in, server discovery, libraries, and users.

Jellyfin

/api/jellyfin/*

Password and Quick Connect sign-in, libraries, and users.

Emby

/api/emby/*

Password sign-in, server details, libraries, and users.

Trackers

/api/trakt/*, /api/simkl/*, /api/anilist/*

Device PIN and OAuth authorization flows.

Metadata

/api/tmdb/*, /api/tmdb_sync/*

TMDb API key and account authorization.

Other services

/api/mdblist/*, /api/publicmetadb/*, /api/nuvio/*, /api/tautulli/*

Service-specific connection flows.

Most connection routes accept an instance query parameter. Use the profile identifier returned by the profile endpoints.

Status and discovery

Method
Endpoint
Purpose

GET

/api/auth/providers

List provider authentication manifests.

GET

/api/status

Return aggregate provider health.

POST

/api/debug/clear_probe_cache

Clear cached provider probes.

GET

/api/modules/versions

Return provider and module versions.

Keep credentials out of request logs. Redacted values preserve stored secrets where supported.

Last updated

Was this helpful?