> For the complete documentation index, see [llms.txt](https://wiki.crosswatch.app/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://wiki.crosswatch.app/crosswatch/advanced-and-api/api-reference/connections-and-profiles.md).

# Connections and profiles

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.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://wiki.crosswatch.app/crosswatch/advanced-and-api/api-reference/connections-and-profiles.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
