6.5.4
OAS 3.0.3

Chibisafe API

Welcome to the API docs

These are the official docs for the Chibisafe project. On the sidebar you will find all available endpoints that the API has to offer. Keep in mind that some of those are accesible only to admins of the instance, for operations such as setting up the instance or managing users.

If you want to test the API, we've included a Thunder Client collection that you can import into your IDE of choice if you clone the repo. If you are using VSCode, you can install the Thunder Client extension and the collection should already be imported automatically for you.

The default rate limit for the API is 100 requests per 1000ms.

Base URL
https://chibisafe.uaiz.it
Client Libraries
Shell
Ruby
Node.js
PHP
Python
C
More
cURL Shell

Auth​

Authentication routes.

Endpoints
POST/api/auth/password/changePOST/api/auth/apikey/changePOST/api/auth/loginPOST/api/auth/register

Change password​

Change the password of the current user

Body
application/json
password
required
string

The current password of the user.

newPassword
required
string

The new password of the user.

Responses
  • 200

    Default Response

  • 4XX

    Default Response

  • 5XX

    Default Response

POST/api/auth/password/change
Shell cURL
curl --request POST \
  --url https://chibisafe.uaiz.it/api/auth/password/change \
  --header 'Content-Type: application/json' \
  --data '{
  "password": "",
  "newPassword": ""
}'
{
  "message": "…"
}

Default Response