API
🌱
API documentation is incomplete but will be available soon !
Version #
GET /api/version (get the version number)
Parameters #
None
Responses #
| http code | content-type | response |
|---|
200 | application/json | {"version":"2.1.0"} |
Example cURL #
curl -X GET -H "Content-Type: application/json" https://localhost:3000/api/version
Scheduled Tasks #
POST /api/cronjob/checkStatus (Check status and send alerts)
Parameters #
None
| key | value |
|---|
Authorization | Bearer CRONJOB_KEY |
Responses #
| http code | content-type | response |
|---|
200 | application/json | {"success":"Status cron has been executed."} |
401 | application/json | {"status":401,"message":"Unauthorized"} |
Example cURL #
curl -i --request POST --url 'https://localhost:3000/api/cronjob/checkStatus' --header 'Authorization: Bearer CRONJOB_KEY'
POST /api/cronjob/getStorageUsed (Retrieve storage of repositories)
Parameters #
None
| key | value |
|---|
Authorization | Bearer CRONJOB_KEY |
Responses #
| http code | content-type | response |
|---|
200 | application/json | {"success":"Storage cron has been executed."} |
401 | application/json | {"status":401,"message":"Unauthorized"} |
Example cURL #
curl -i --request POST --url 'https://localhost:3000/api/cronjob/getStorageUsed' --header 'Authorization: Bearer CRONJOB_KEY'