v0.1.0

jack management API

Download OpenAPI Document

JSON

Download OpenAPI Document

YAML

Operator-facing API on a separate listener from the public peer port. Drives the management UI: config, status, downloads, logs, catalog, and API keys.

Servers

http://localhost:5226Default local management port (MANAGEMENT_PORT)

---

System

Health and identity probes.

Operations

GET/ping

---

Health check

GET

/ping

Key-guarded probe: a 200 proves the key is valid and the management API is up.

Authorizations

X-Management-Key

The JACK_MANAGEMENT_KEY the management listener was started with.

Type

API Key (header: X-Management-Key)

Responses

The management API is up and the key is valid

Content-Type

application/json

{

  

"ok": true

}

GET

/ping

Samples

---

Config

Read and mutate the persisted jack/servers/peers configuration.

Operations

GET/configGET/config/peersPOST/config/peersGET/config/serversPOST/config/serversGET/config/jackPATCH/config/jackDELETE/config/peers/{id}PATCH/config/peers/{id}DELETE/config/servers/{id}PATCH/config/servers/{id}

---

Get the full config

GET

/config

The loaded configuration with secrets redacted.

Authorizations

X-Management-Key

The JACK_MANAGEMENT_KEY the management listener was started with.

Type

API Key (header: X-Management-Key)

Responses

Success

Content-Type

application/json

GET

/config

Samples

---

List configured peers

GET

/config/peers

Authorizations

X-Management-Key

The JACK_MANAGEMENT_KEY the management listener was started with.

Type

API Key (header: X-Management-Key)

Responses

Success

Content-Type

application/json

GET

/config/peers

Samples

---

Add a peer

POST

/config/peers

Persists a new peer and connects to it. ?force=true keeps the peer even if its handshake fails; it auto-retries lazily.

Authorizations

X-Management-Key

The JACK_MANAGEMENT_KEY the management listener was started with.

Type

API Key (header: X-Management-Key)

Request Body

application/json

{

  

"name": "string",

  

"url": "string",

  

"apiKey": "string",

  

"headers": {

  

  

"additionalProperties": "string"

  

}

}

Responses

Success

Content-Type

application/json

POST

/config/peers

Samples

---

List configured servers

GET

/config/servers

Authorizations

X-Management-Key

The JACK_MANAGEMENT_KEY the management listener was started with.

Type

API Key (header: X-Management-Key)

Responses

Success

Content-Type

application/json

GET

/config/servers

Samples

---

Add a Radarr/Sonarr server

POST

/config/servers

Authorizations

X-Management-Key

The JACK_MANAGEMENT_KEY the management listener was started with.

Type

API Key (header: X-Management-Key)

Request Body

application/json

{

  

"name": "string",

  

"url": "string",

  

"apiKey": "string",

  

"headers": {

  

  

"additionalProperties": "string"

  

},

  

"type": "string",

  

"source": true,

  

"destination": true,

  

"autoregister": {

  

  

"enable": true,

  

  

"priority": 0

  

}

}

Responses

Success

Content-Type

application/json

POST

/config/servers

Samples

---

Get the jack block

GET

/config/jack

Authorizations

X-Management-Key

The JACK_MANAGEMENT_KEY the management listener was started with.

Type

API Key (header: X-Management-Key)

Responses

Success

Content-Type

application/json

GET

/config/jack

Samples

---

Update the jack block

PATCH

/config/jack

Persists the new values; they take effect on next boot (no connectivity check).

Authorizations

X-Management-Key

The JACK_MANAGEMENT_KEY the management listener was started with.

Type

API Key (header: X-Management-Key)

Request Body

application/json

{

  

"internalUrl": "string",

  

"apiKey": "string",

  

"tmdbApiKey": "string"

}

Responses

Success

Content-Type

application/json

PATCH

/config/jack

Samples

---

Remove a peer

DELETE

/config/peers/{id}

Authorizations

X-Management-Key

The JACK_MANAGEMENT_KEY the management listener was started with.

Type

API Key (header: X-Management-Key)

Parameters

Path Parameters

id*

Type

string

Required

Min Length

1

Responses

Success

Content-Type

application/json

DELETE

/config/peers/{id}

Samples

---

Update a peer

PATCH

/config/peers/{id}

Persists changes and reconnects. ?force=true keeps the peer even if its handshake fails.

Authorizations

X-Management-Key

The JACK_MANAGEMENT_KEY the management listener was started with.

Type

API Key (header: X-Management-Key)

Parameters

Path Parameters

id*

Type

string

Required

Min Length

1

Request Body

application/json

{

  

"name": "string",

  

"url": "string",

  

"apiKey": "string",

  

"headers": {

  

  

"additionalProperties": "string"

  

}

}

Responses

Success

Content-Type

application/json

PATCH

/config/peers/{id}

Samples

---

Remove a server

DELETE

/config/servers/{id}

Authorizations

X-Management-Key

The JACK_MANAGEMENT_KEY the management listener was started with.

Type

API Key (header: X-Management-Key)

Parameters

Path Parameters

id*

Type

string

Required

Min Length

1

Responses

Success

Content-Type

application/json

DELETE

/config/servers/{id}

Samples

---

Update a server

PATCH

/config/servers/{id}

Authorizations

X-Management-Key

The JACK_MANAGEMENT_KEY the management listener was started with.

Type

API Key (header: X-Management-Key)

Parameters

Path Parameters

id*

Type

string

Required

Min Length

1

Request Body

application/json

{

  

"name": "string",

  

"url": "string",

  

"apiKey": "string",

  

"headers": {

  

  

"additionalProperties": "string"

  

},

  

"type": "string",

  

"source": true,

  

"destination": true,

  

"autoregister": {

  

  

"enable": true,

  

  

"priority": 0

  

}

}

Responses

Success

Content-Type

application/json

PATCH

/config/servers/{id}

Samples

---

Status

Connector and download overviews.

Operations

GET/overviewGET/downloads

---

Connector overview

GET

/overview

Configured servers and peers with their initialization state.

Authorizations

X-Management-Key

The JACK_MANAGEMENT_KEY the management listener was started with.

Type

API Key (header: X-Management-Key)

Responses

Overview of servers and peers

Content-Type

application/json

GET

/overview

Samples

---

List downloads

GET

/downloads

All download records, in-flight and finished.

Authorizations

X-Management-Key

The JACK_MANAGEMENT_KEY the management listener was started with.

Type

API Key (header: X-Management-Key)

Responses

Download records

Content-Type

application/json

GET

/downloads

Samples

---

Downloads

Manage individual download records by their numeric id.

Operations

POST/downloads/{id}/cancelPOST/downloads/{id}/retryDELETE/downloads/{id}

---

Cancel a download

POST

/downloads/{id}/cancel

Stops the active transfer and preserves its .part file for a later retry.

Authorizations

X-Management-Key

The JACK_MANAGEMENT_KEY the management listener was started with.

Type

API Key (header: X-Management-Key)

Parameters

Path Parameters

id*

Type

string

Required

Responses

The updated download record

Content-Type

application/json

POST

/downloads/{id}/cancel

Samples

---

Retry a download

POST

/downloads/{id}/retry

Repeats the last failed operation; transfers resume from the partial file, failed imports retry without re-downloading.

Authorizations

X-Management-Key

The JACK_MANAGEMENT_KEY the management listener was started with.

Type

API Key (header: X-Management-Key)

Parameters

Path Parameters

id*

Type

string

Required

Responses

The updated download record

Content-Type

application/json

POST

/downloads/{id}/retry

Samples

---

Delete a download

DELETE

/downloads/{id}

Cancels any active work, removes the history row, and deletes its unshared partial or completed artifacts.

Authorizations

X-Management-Key

The JACK_MANAGEMENT_KEY the management listener was started with.

Type

API Key (header: X-Management-Key)

Parameters

Path Parameters

id*

Type

string

Required

Responses

The updated download record

Content-Type

application/json

DELETE

/downloads/{id}

Samples

---

Logs

Backfill and live-tail the process's own logs.

Operations

GET/logsGET/logs/stream

---

Backfill recent logs

GET

/logs

The last N log records, oldest to newest, with an optional minimum level.

Authorizations

X-Management-Key

The JACK_MANAGEMENT_KEY the management listener was started with.

Type

API Key (header: X-Management-Key)

Parameters

Query Parameters

lines

Type

integer

Default

200

Minimum

1

Maximum

5000

level

Type

string

Valid values

"trace""debug""info""warn""error""fatal"

Responses

Log records

Content-Type

application/json

GET

/logs

Samples

---

Live-tail logs

GET

/logs/stream

Server-Sent Events stream; each event's data is one JSON log record. Emits a ping event every 15s to keep idle proxies from dropping the connection.

Authorizations

X-Management-Key

The JACK_MANAGEMENT_KEY the management listener was started with.

Type

API Key (header: X-Management-Key)

Parameters

Query Parameters

level

Type

string

Valid values

"trace""debug""info""warn""error""fatal"

Responses

SSE stream of log records

Content-Type

text/event-stream

GET

/logs/stream

Samples

---

Catalog

Aggregated peer catalog and TMDB-backed metadata for the UI.

Operations

GET/catalog/tmdb/statusGET/catalog/tmdb/{mediaType}/{tmdbId}GET/catalog/request-optionsPOST/catalog/requestGET/catalog

---

TMDB integration status

GET

/catalog/tmdb/status

Whether a TMDB API key is configured, so the UI knows if metadata lookups are available.

Authorizations

X-Management-Key

The JACK_MANAGEMENT_KEY the management listener was started with.

Type

API Key (header: X-Management-Key)

Responses

Success

Content-Type

application/json

GET

/catalog/tmdb/status

Samples

---

Get TMDB title metadata

GET

/catalog/tmdb/{mediaType}/{tmdbId}

Per-title lookup the catalog grid calls once per visible card.

Authorizations

X-Management-Key

The JACK_MANAGEMENT_KEY the management listener was started with.

Type

API Key (header: X-Management-Key)

Parameters

Path Parameters

mediaType*

Type

string

Required

Valid values

"movie""tv"

tmdbId*

Type

integer

Required

Minimum

-9007199254740991

Maximum

9007199254740991

Responses

Success

Content-Type

application/json

GET

/catalog/tmdb/{mediaType}/{tmdbId}

Samples

---

List request targets

GET

/catalog/request-options

Destination servers (with root folders) a catalog item can be requested into.

Authorizations

X-Management-Key

The JACK_MANAGEMENT_KEY the management listener was started with.

Type

API Key (header: X-Management-Key)

Responses

Success

Content-Type

application/json

GET

/catalog/request-options

Samples

---

Request a download

POST

/catalog/request

Grabs a peer's catalog item into one of the local destination servers.

Authorizations

X-Management-Key

The JACK_MANAGEMENT_KEY the management listener was started with.

Type

API Key (header: X-Management-Key)

Request Body

application/json

{

  

"peerId": "string",

  

"serverId": "string",

  

"mediaType": "string",

  

"tmdbId": 0,

  

"tvdbId": 0,

  

"rootFolderPath": "string"

}

Responses

Success

Content-Type

application/json

POST

/catalog/request

Samples

---

Get the aggregated catalog

GET

/catalog

Everything available across all initialized peers.

Authorizations

X-Management-Key

The JACK_MANAGEMENT_KEY the management listener was started with.

Type

API Key (header: X-Management-Key)

Responses

Success

Content-Type

application/json

GET

/catalog

Samples

---

API keys

Issue, list, and revoke the peer API keys this instance hands out.

Operations

GET/api-keysPOST/api-keysGET/api-keys/{id}DELETE/api-keys/{id}PATCH/api-keys/{id}

---

List peer API keys

GET

/api-keys

Authorizations

X-Management-Key

The JACK_MANAGEMENT_KEY the management listener was started with.

Type

API Key (header: X-Management-Key)

Responses

Success

Content-Type

application/json

GET

/api-keys

Samples

---

Create a peer API key

POST

/api-keys

Issues a named, revocable, optionally expiring key. The plaintext key is only returned by this call.

Authorizations

X-Management-Key

The JACK_MANAGEMENT_KEY the management listener was started with.

Type

API Key (header: X-Management-Key)

Request Body

application/json

{

  

"name": "string",

  

"description": "string",

  

"expiresAt": "string"

}

Responses

Success

Content-Type

application/json

POST

/api-keys

Samples

---

Get a peer API key

GET

/api-keys/{id}

Authorizations

X-Management-Key

The JACK_MANAGEMENT_KEY the management listener was started with.

Type

API Key (header: X-Management-Key)

Parameters

Path Parameters

id*

Type

integer

Required

Exclusive Minimum

0

Maximum

9007199254740991

Responses

Success

Content-Type

application/json

GET

/api-keys/{id}

Samples

---

Revoke a peer API key

DELETE

/api-keys/{id}

Authorizations

X-Management-Key

The JACK_MANAGEMENT_KEY the management listener was started with.

Type

API Key (header: X-Management-Key)

Parameters

Path Parameters

id*

Type

integer

Required

Exclusive Minimum

0

Maximum

9007199254740991

Responses

Success

Content-Type

application/json

DELETE

/api-keys/{id}

Samples

---

Update a peer API key

PATCH

/api-keys/{id}

Authorizations

X-Management-Key

The JACK_MANAGEMENT_KEY the management listener was started with.

Type

API Key (header: X-Management-Key)

Parameters

Path Parameters

id*

Type

integer

Required

Exclusive Minimum

0

Maximum

9007199254740991

Request Body

application/json

{

  

"name": "string",

  

"description": "string",

  

"expiresAt": "string"

}

Responses

Success

Content-Type

application/json

PATCH

/api-keys/{id}

Samples

---

Powered by VitePress OpenAPI