Skip to content

API

API usage

Warning

  • Very experimental and some things may change in the future - Only a few important endpoints are documented for now.
  • If you need any more added, please join the Discord and let us know!

Base URL

http://{instance}/api

  • Replace {instance} with your instance domain or ip:port

Endpoints

server-ping

Usage

name type data type description
request required string endpoint name
apikey required string instance api key
http code content-type response
200 application/json {"code":"200","response":{"result":"v7.2.7"}}
423 application/json {"code":"423","error":"Migration in progress"} 
curl -X GET -H "Content-Type: application/json" http://{instance}/api/?request=server-ping&apikey=<redacted>

stats-getContainersList

Usage

name type data type description
request required string endpoint name
apikey required string instance api key
http code content-type response
200 application/json JSON 
curl -X GET -H "Content-Type: application/json" http://{instance}/api/?request=stats-getContainersList&apikey=<redacted>

stats-getOverview

Usage

name type data type description
request required string endpoint name
apikey required string instance api key
http code content-type response
200 application/json JSON

Usage values:

  • disk and netIO = bytes
  • cpu and memory = percentage
curl -X GET -H "Content-Type: application/json" http://{instance}/api/?request=stats-getOverview&apikey=<redacted>