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://files.offshore.cat

Client Libraries

Shell

Ruby

Node.js

PHP

Python

cURL Shell

Auth

Authentication routes.

Endpoints

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://files.offshore.cat/api/auth/password/change \
  --header 'Content-Type: application/json' \
  --data '{
  "password": "",
  "newPassword": ""
}'

Show Schema

{
  "message": "…"
}

Default Response

Generate API key

Generate a new API key for the current user

Responses

200
Default Response
4XX
Default Response
5XX
Default Response

POST/api/auth/apikey/change

Shell cURL

curl --request POST \
  --url https://files.offshore.cat/api/auth/apikey/change

Show Schema

{
  "message": "…",
  "apiKey": "…"
}

Default Response

Login

Headers

invite
string
The invite code to use.

Body

application/json

username

required

string

The username of the user.

password

required

string

The password of the user.

Responses

200
Default Response
4XX
Default Response
5XX
Default Response

POST/api/auth/login

Shell cURL

curl --request POST \
  --url https://files.offshore.cat/api/auth/login \
  --header 'Content-Type: application/json' \
  --data '{
  "username": "",
  "password": ""
}'

Show Schema

{
  "message": "…",
  "user": {
    "uuid": "…",
    "username": "…",
    "roles": [
      {
        "name": "…"
      }
    ],
    "apiKey": "…",
    "passwordEditedAt": "…"
  },
  "token": "…"
}

Default Response

Register

Create a new user account

Headers

invite
string
The invite code to use.

Body

application/json

username

required

string

The username of the user.

password

required

string

The password of the user.

Responses

200
Default Response
4XX
Default Response
5XX
Default Response

POST/api/auth/register

Shell cURL

curl --request POST \
  --url https://files.offshore.cat/api/auth/register \
  --header 'Content-Type: application/json' \
  --data '{
  "username": "",
  "password": ""
}'

Show Schema

{
  "message": "…"
}

Default Response

User

Routes that return data related to the authenticated user.

Endpoints

GET/api/user/me

Get own user

Return the current user

Responses

200
Default Response
4XX
Default Response
5XX
Default Response

GET/api/user/me

Shell cURL

curl --request GET \
  --url https://files.offshore.cat/api/user/me

Show Schema

{
  "message": "…",
  "user": {
    "uuid": "…",
    "username": "…",
    "roles": [
      {
        "name": "…"
      }
    ],
    "apiKey": "…",
    "passwordEditedAt": "…"
  },
  "storageQuota": {
    "used": 1,
    "quota": 1,
    "overQuota": true
  }
}

Default Response

Albums

Routes that return data related to albums.

Endpoints

POST/api/files/album/add POST/api/files/albums POST/api/files/album/remove POST/api/album/create DELETE/api/album/{uuid}GET/api/album/{uuid}GET/api/album/{identifier}/view GET/api/album/{identifier}/view/count GET/api/albums DELETE/api/album/{uuid}/purge POST/api/album/{uuid}/edit POST/api/album/{uuid}/link DELETE/api/album/{uuid}/link/{linkUuid}POST/api/album/{uuid}/link/{linkUuid}/edit GET/api/album/{uuid}/links POST/api/file/{uuid}/album/{albumUuid}DELETE/api/file/{uuid}/album/{albumUuid}

Files

Routes that return data related to files.

Server

Routes that returns info about the server instance.

Endpoints

GET/api/settings/{key}GET/api/settings GET/api/version GET/api/admin/service/diagnostic POST/api/admin/service/settings GET/api/admin/service/settings GET/api/admin/service/statistics GET/api/admin/service/updateCheck GET/api/health

Invites

Routes that return data related to invites.

Endpoints

POST/api/admin/invite/create POST/api/admin/invite/delete GET/api/admin/invites

User Management

Routes that return data related to User Management.

Endpoints

POST/api/admin/user/{uuid}/demote POST/api/admin/user/{uuid}/disable POST/api/admin/user/{uuid}/enable GET/api/admin/users GET/api/admin/user/{uuid}GET/api/admin/user/{uuid}/files POST/api/admin/user/{uuid}/promote POST/api/admin/user/{uuid}/purge POST/api/admin/user/{uuid}/quota

IP Management

Routes that return data related to IP Management.

Endpoints

POST/api/admin/ip/ban GET/api/admin/ip/list POST/api/admin/ip/files POST/api/admin/ip/files/purge POST/api/admin/ip/unban

Admin

Routes that return data related to the admin panel.

Endpoints

GET/api/admin/links

Get all links

Get a list of created links

Query Parameters

page
number
The page number.
limit
number
The amount of items per page.
search
string
The text you want to search.

Responses

200
Default Response
4XX
Default Response
5XX
Default Response

GET/api/admin/links

Shell cURL

curl --request GET \
  --url https://files.offshore.cat/api/admin/links

Show Schema

{
  "message": "…",
  "links": [
    {
      "uuid": "…",
      "identifier": "…",
      "link": "…",
      "destination": "…",
      "views": 1,
      "createdAt": "…",
      "user": {
        "uuid": "…",
        "username": "…"
      }
    }
  ],
  "count": 1
}

Default Response

Bulk

Endpoints

POST/api/admin/files/allow POST/api/admin/files/delete POST/api/admin/files/quarantine POST/api/files/album/add POST/api/files/albums POST/api/files/album/remove POST/api/files/delete POST/api/files/thumbnail/regenerate

Links

Endpoints

DELETE/api/admin/link/{identifier}GET/api/admin/links POST/api/link/create DELETE/api/link/{identifier}GET/api/link/{identifier}GET/api/links GET/api/link/{identifier}/count

Snippets

Endpoints

POST/api/snippet/create DELETE/api/snippet/{uuid}GET/api/snippet/{uuid}GET/api/snippet/public/{identifier}GET/api/snippet/{identifier}/raw GET/api/snippets

Chibisafe API

Welcome to the API docs

Auth​# Copy link to "Auth"

Change password​# Copy link to "Change password"

Generate API key​# Copy link to "Generate API key"

Login​# Copy link to "Login"

Register​# Copy link to "Register"

User​# Copy link to "User"

Get own user​# Copy link to "Get own user"

Albums​# Copy link to "Albums"

Files​# Copy link to "Files"

Tags​# Copy link to "Tags"

Server​# Copy link to "Server"

Invites​# Copy link to "Invites"

User Management​# Copy link to "User Management"

IP Management​# Copy link to "IP Management"

Admin​# Copy link to "Admin"

Get all links​# Copy link to "Get all links"

Bulk​# Copy link to "Bulk"

Links​# Copy link to "Links"

Snippets​# Copy link to "Snippets"

Auth

Change password

Generate API key

Login

Register

User

Get own user

Albums

Files

Tags

Server

Invites

User Management

IP Management

Admin

Get all links

Bulk

Links

Snippets