Info
Content

Available APIs

This is just a temporary documentation. A more detailed documentation will follow soon!

 

cUrl Example:
curl -X POST \
  http://api.cavecloud.net/api/cloudApi/<context> \	  // See available APIs
  -F token=<your user token> \                                // Usertokens can be found in the "users.json" file.
  -F host=<cloud host> \									  // Cloud host has to be verified with the api key.
  -F port=<cloud port> \									  // Port on which the cloud is running
  -F apiKey=<your api key>									  // API key you created

 

Available APIs:

{
    "server/console": {
        "parameters": [
            "group",
            "id"
        ],
        "authNeeded": true,
    },
    "server/start": {
        "parameters": [
            "group"
        ],
        "authNeeded": true,
    },
    "server/stop": {
        "parameters": [
            "group",
            "id"
        ],
        "authNeeded": true,
    },
    "server/list": {
        "parameters": [
            "group"
        ],
        "authNeeded": true,
    },
    "server/execute": {
        "parameters": [
            "group",
            "id",
            "command"
        ],
        "authNeeded": true,
    },
    "group/list": {
        "parameters": [],
        "authNeeded": true,
    },
    "group/delete": {
        "parameters": [
            "group"
        ],
        "authNeeded": true,
    },
    "group/create": {
        "parameters": [
            "name",
            "ram",
            "static",
            "start_amount",
            "wrapper",
            "copyGlobal",
            "serverJar"
        ],
        "authNeeded": true,
    },
    "proxy/console": {
        "parameters": [],
        "authNeeded": true,
    },
    "proxy/stop": {
        "parameters": [],
        "authNeeded": true,
    },
    "proxy/start": {
        "parameters": [],
        "authNeeded": true,
    },
    "proxy/execute": {
        "parameters": [
            "command"
        ],
        "authNeeded": true,
    },
    "proxy/state": {
        "parameters": [],
        "authNeeded": true,
    },
    "player/list": {
        "parameters": [],
        "authNeeded": true,
    },
    "wrapper/list": {
        "parameters": [],
        "authNeeded": true,
    },
    "wrapper/create": {
        "parameters": [
            "id",
            "wrapperhost"
        ],
        "authNeeded": true,
    },
    "wrapper/delete": {
        "parameters": [
            "id"
        ],
        "authNeeded": true,
    },
    "wrapper/downloadJar": {
        "parameters": [
            "id",
            "url",
            "filename"
        ],
        "authNeeded": true,
    },
    "wrapper/listJar": {
        "parameters": [
            "id"
        ],
        "authNeeded": true,
    },
    "cloud/info": {
        "parameters": [],
        "authNeeded": true,
    },
    "verify": {
        "parameters": [],
        "authNeeded": false,
    }
}
No Comments
Back to top