Skip to content

Table of contents

Public routes

These routes are public: no authentication is required for them.


GET /public/avatar

Returns an image chosen by the user as their avatar. If no image has been chosen, a fallback will be used, depending of the fallback parameter in the query-string:

  • default: a default image that shows the Cozy Cloud logo, but it can be overriden by dynamic assets per context
  • initials: a generated image with the initials of the owner’s public name
  • 404: just a 404 - Not found error.


GET /public/prelogin

This route returns information that could be useful to show a login page (like in the flagship app).


GET /public/prelogin HTTP/1.1
Host: cozy.localhost:8080


HTTP/1.1 200 OK
Content-Type: application/json
  "Kdf": 0,
  "KdfIterations": 100000,
  "OIDC": false,
  "FranceConnect": false,
  "locale": "en",
  "magic_link": false,
  "name": "Claude"

Response when the instance has not been onboarded

HTTP/1.1 412 Precondition failed
Content-Type: application/json
  "error": "the instance has not been onboarded"