Collectoh
EN

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

Sign up free
Browse the docs

API reference

Setup

The first-run wizard. Only answers until an owner exists (SETUP_ALREADY_COMPLETE after).

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

POST/setup#

Complete first-run setup

Authorisation
None
Body
application/json · object
  • 201Success. application/json · object
  • 400VALIDATION_FAILED: the request did not match the schema; details.issues lists what. application/json · ErrorEnvelope
  • 409SETUP_ALREADY_COMPLETE: an owner already exists application/json · ErrorEnvelope
GET/setup/browse#

Browse the host filesystem during setup

Authorisation
None
ParameterInTypeDescription
rootPath requiredquerystring
pathquerystring
  • 200Success. application/json · object
  • 400VALIDATION_FAILED: the request did not match the schema; details.issues lists what. application/json · ErrorEnvelope
POST/setup/preview#

Preview what a folder would scan as

Authorisation
None
Body
application/json · object
  • 200Success. application/json · object
  • 400VALIDATION_FAILED: the request did not match the schema; details.issues lists what. application/json · ErrorEnvelope
POST/setup/remote-check#

Check whether a public URL reaches this server

Authorisation
None
Body
application/json · object
  • 200Success. application/json · object
  • 400VALIDATION_FAILED: the request did not match the schema; details.issues lists what. application/json · ErrorEnvelope
POST/setup/storage/test#

Test a storage before creating it

Authorisation
None
Body
application/json · object
  • 200Success. application/json · object
  • 400VALIDATION_FAILED: the request did not match the schema; details.issues lists what. application/json · ErrorEnvelope