Collectoh
EN

This page is in English only for now. The main pages follow your choice.

Sign up free
Browse the docs

API reference

Settings

Server-wide settings (settings:manage).

Paths are relative to /api/v1 on your server.

GET/dlna#

The DLNA server

Whether the DLNA server (P6-11) is on, whose view of the libraries it shows and what that is, who acknowledged that it has no sign-in and when, where it announces itself on the home network, what stands in its way, and the devices that have used it lately.

Authorisation
Bearer token or API key · Session cookie
  • 200Success. application/json · object
  • 401UNAUTHENTICATED: no session, or the access token expired. application/json · ErrorEnvelope
  • 403FORBIDDEN: the account lacks settings:manage, or the library, label, age or schedule scope refuses it. application/json · ErrorEnvelope
PUT/dlna#

Switch the DLNA server on or off

DLNA has no sign-in: anyone on the home network can browse and play what the chosen account sees. Any change that leaves it on needs acknowledge: true (DLNA_ACKNOWLEDGEMENT_REQUIRED without it) and an active, regular account — never an owner or an admin, who sees every library (DLNA_ACCOUNT_INVALID). Switching off keeps the account for next time; restoring a backup switches it off.

Authorisation
Bearer token or API key · Session cookie
Body
application/json · object
  • 200Success. application/json · object
  • 400VALIDATION_FAILED: the request did not match the schema; details.issues lists what. application/json · ErrorEnvelope
  • 401UNAUTHENTICATED: no session, or the access token expired. application/json · ErrorEnvelope
  • 403FORBIDDEN: the account lacks settings:manage, or the library, label, age or schedule scope refuses it. application/json · ErrorEnvelope
GET/dlna/play-to#

Play To

Whether the server sends to the televisions, consoles and speakers it finds on the home network (UPnP media renderers), who last switched it on or off and when, and the renderers found lately.

Authorisation
Bearer token or API key · Session cookie
  • 200Success. application/json · object
  • 401UNAUTHENTICATED: no session, or the access token expired. application/json · ErrorEnvelope
  • 403FORBIDDEN: the account lacks settings:manage, or the library, label, age or schedule scope refuses it. application/json · ErrorEnvelope
PUT/dlna/play-to#

Switch Play To on or off

Off by default. On, the server searches the home network for renderers when someone at home opens the cast menu, and people signed in at home can send what they may watch to one. Off stops what plays on a renderer from here; restoring a backup switches it off.

Authorisation
Bearer token or API key · Session cookie
Body
application/json · object
  • 200Success. application/json · object
  • 400VALIDATION_FAILED: the request did not match the schema; details.issues lists what. application/json · ErrorEnvelope
  • 401UNAUTHENTICATED: no session, or the access token expired. application/json · ErrorEnvelope
  • 403FORBIDDEN: the account lacks settings:manage, or the library, label, age or schedule scope refuses it. application/json · ErrorEnvelope
GET/settings#

Read every setting

Authorisation
Bearer token or API key · Session cookie
  • 200Success. application/json · ServerSettings
  • 401UNAUTHENTICATED: no session, or the access token expired. application/json · ErrorEnvelope
  • 403FORBIDDEN: the account lacks settings:manage, or the library, label, age or schedule scope refuses it. application/json · ErrorEnvelope
PUT/settings#

Change settings

A partial object: only the keys sent change. Unknown keys are refused.

Authorisation
Bearer token or API key · Session cookie
Body
application/json · object
  • 200Success. application/json · ServerSettings
  • 400VALIDATION_FAILED: the request did not match the schema; details.issues lists what. application/json · ErrorEnvelope
  • 401UNAUTHENTICATED: no session, or the access token expired. application/json · ErrorEnvelope
  • 403FORBIDDEN: the account lacks settings:manage, or the library, label, age or schedule scope refuses it. application/json · ErrorEnvelope
GET/transcode/luts#

List the tone-mapping LUTs

The .cube files in the server’s LUT folder (<config>/luts) that transcode.tone_map_lut may name (P7-08), each with its size in points, its title, and why it cannot be chosen when it cannot. Nothing is uploaded here: files are put in the folder.

Authorisation
Bearer token or API key · Session cookie
  • 200Success. application/json · object
  • 401UNAUTHENTICATED: no session, or the access token expired. application/json · ErrorEnvelope
  • 403FORBIDDEN: the account lacks settings:manage, or the library, label, age or schedule scope refuses it. application/json · ErrorEnvelope