---
title: "Start a QuickConnect pairing request"
method: POST
path: "/quickconnect/initiate"
tags: ["Authentication"]
---

# Start a QuickConnect pairing request

`POST /quickconnect/initiate`

No authentication: a device with no session yet asks for a short code, shows it to the person signing in, then polls `/quickconnect/status` with the returned `secret` until it comes back authorized. Off unless the `quickconnect_enable` preference is on.

## Query parameters

- `device_id` string
- `device_name` string
- `client` string
- `version` string

## Request body

- QuickconnectInitiateRequest
  - `device_id` string — An id the caller makes up and keeps, so its own initiate rate limit applies.
  - `device_name` string — Shown to the approving user alongside the code.
  - `client` string — Client/agent name recorded with the request.
  - `version` string — The app version, shown to the approving user.

## Response `200`

Pairing request created

- QuickConnectInitiateResponse, nullable
  - `secret` string, required
  - `code` string, required
  - `device_id` string, required
  - `device_name` string, required
  - `app_name` string, required
  - `app_version` string, required
  - `date_added` integer, required
  - `authorized` boolean, required

## Other responses

- `400` — HTTP 400 Bad Request (errors 4705, 4710).
- `401` — HTTP 401 Unauthorized (error 4701).
- `403` — HTTP 403 Forbidden (errors 4700, 4703, 4742).
- `500` — HTTP 500 Internal Server Error (error 4702).

## Changes

- **2026-09-17** `f5f2ac6877d8` — 1 info
  - endpoint added

[Change history](https://skmtc.dev/ampache/apis/ampache-rest-api/changes/quickconnect/initiate/post.md)

---

[API](https://skmtc.dev/ampache/apis/ampache-rest-api.md) · [All operations](https://skmtc.dev/ampache/apis/ampache-rest-api/llms.txt) · [OpenAPI document](https://skmtc.dev/ampache/apis/ampache-rest-api/revisions/82b9d2421c83?raw)