[
  {
    "type": "post",
    "url": "/containers",
    "title": "Create a container",
    "version": "0.8.0",
    "name": "CreateContainer",
    "group": "Container",
    "description": "<p>Creates a container. Returns 201 on success!</p> ",
    "header": {
      "fields": {
        "Header": [
          {
            "group": "Header",
            "type": "String",
            "optional": false,
            "field": "X-Api-Token",
            "description": "<p>API token (from /etc/wf_node_api.conf)</p> "
          }
        ]
      }
    },
    "parameter": {
      "fields": {
        "Parameter": [
          {
            "group": "Parameter",
            "type": "<p>String</p> ",
            "optional": false,
            "field": "name",
            "description": "<p>Name of the container (must be unique per node)</p> "
          },
          {
            "group": "Parameter",
            "type": "<p>String</p> ",
            "optional": false,
            "field": "ip_address",
            "description": "<p>Valid IPv4 address</p> "
          },
          {
            "group": "Parameter",
            "type": "<p>Integer</p> ",
            "optional": false,
            "field": "disk_size_gb",
            "description": "<p>Container disk size in GB</p> "
          },
          {
            "group": "Parameter",
            "type": "<p>Integer</p> ",
            "optional": false,
            "field": "memory_limit_mb",
            "description": "<p>Memory limt in MB</p> "
          },
          {
            "group": "Parameter",
            "type": "<p>Integer</p> ",
            "optional": false,
            "field": "cpu_core_count",
            "description": "<p>Amount of Vcores assigned to the container</p> "
          }
        ]
      }
    },
    "success": {
      "fields": {
        "Success 200": [
          {
            "group": "Success 200",
            "type": "<p>String</p> ",
            "optional": false,
            "field": "success",
            "description": "<p>Success message</p> "
          },
          {
            "group": "Success 200",
            "type": "<p>String</p> ",
            "optional": false,
            "field": "output",
            "description": "<p>STDOUT from container creation</p> "
          }
        ]
      }
    },
    "filename": "lib/wf_node_api/api/node_api.rb",
    "groupTitle": "Container",
    "error": {
      "fields": {
        "Unauthorized 401": [
          {
            "group": "Unauthorized 401",
            "optional": false,
            "field": "error",
            "description": "<p>No valid API token was supplied</p> "
          }
        ],
        "Bad Request 400": [
          {
            "group": "Bad Request 400",
            "optional": false,
            "field": "error",
            "description": "<p>Invalid arguments supplied</p> "
          }
        ],
        "Internal Server Error 500": [
          {
            "group": "Internal Server Error 500",
            "optional": false,
            "field": "error",
            "description": "<p>The process could not be requested due to an internal error</p> "
          }
        ]
      },
      "examples": [
        {
          "title": "401 Unauthorized",
          "content": "HTTP/1.1 401 Unauthorized\n{\n  \"error\": \"Unauthorized\"\n}",
          "type": "json"
        },
        {
          "title": "400 Bad Request",
          "content": "HTTP/1.1 400 Bad Request\n{\n  \"error\": \"The supplied container name is invalid\"\n}",
          "type": "json"
        },
        {
          "title": "500 Internal Server Error",
          "content": "HTTP/1.1 500 Internal Server Error\n{\n  \"error\": \"Unknown error occured\"\n}",
          "type": "json"
        }
      ]
    }
  },
  {
    "type": "delete",
    "url": "/containers/:name",
    "title": "Delete a container",
    "version": "0.8.0",
    "name": "DeleteContainer",
    "group": "Container",
    "description": "<p>Deletes a container if it exists.</p> ",
    "header": {
      "fields": {
        "Header": [
          {
            "group": "Header",
            "type": "String",
            "optional": false,
            "field": "X-Api-Token",
            "description": "<p>API token (from /etc/wf_node_api.conf)</p> "
          }
        ]
      }
    },
    "parameter": {
      "fields": {
        "Parameter": [
          {
            "group": "Parameter",
            "type": "<p>String</p> ",
            "optional": false,
            "field": "name",
            "description": "<p>Unique name of the container</p> "
          }
        ]
      }
    },
    "success": {
      "fields": {
        "Success 200": [
          {
            "group": "Success 200",
            "type": "<p>String</p> ",
            "optional": false,
            "field": "success",
            "description": "<p>Success message</p> "
          },
          {
            "group": "Success 200",
            "type": "<p>String</p> ",
            "optional": false,
            "field": "output",
            "description": "<p>STDOUT from container deletion</p> "
          }
        ]
      }
    },
    "filename": "lib/wf_node_api/api/node_api.rb",
    "groupTitle": "Container",
    "error": {
      "fields": {
        "Unauthorized 401": [
          {
            "group": "Unauthorized 401",
            "optional": false,
            "field": "error",
            "description": "<p>No valid API token was supplied</p> "
          }
        ],
        "Not Found 404": [
          {
            "group": "Not Found 404",
            "optional": false,
            "field": "error",
            "description": "<p>Object was not found</p> "
          }
        ],
        "Internal Server Error 500": [
          {
            "group": "Internal Server Error 500",
            "optional": false,
            "field": "error",
            "description": "<p>The process could not be requested due to an internal error</p> "
          }
        ]
      },
      "examples": [
        {
          "title": "401 Unauthorized",
          "content": "HTTP/1.1 401 Unauthorized\n{\n  \"error\": \"Unauthorized\"\n}",
          "type": "json"
        },
        {
          "title": "404 Not Found",
          "content": "HTTP/1.1 404 Not Found\n{\n  \"error\": \"Not Found\"\n}",
          "type": "json"
        },
        {
          "title": "500 Internal Server Error",
          "content": "HTTP/1.1 500 Internal Server Error\n{\n  \"error\": \"Unknown error occured\"\n}",
          "type": "json"
        }
      ]
    }
  },
  {
    "type": "get",
    "url": "/containers/:name",
    "title": "Request container by its name",
    "version": "0.8.0",
    "name": "GetContainer",
    "group": "Container",
    "description": "<p>Returns information on a specific container</p> ",
    "header": {
      "fields": {
        "Header": [
          {
            "group": "Header",
            "type": "String",
            "optional": false,
            "field": "X-Api-Token",
            "description": "<p>API token (from /etc/wf_node_api.conf)</p> "
          }
        ]
      }
    },
    "parameter": {
      "fields": {
        "Parameter": [
          {
            "group": "Parameter",
            "type": "<p>String</p> ",
            "optional": false,
            "field": "name",
            "description": "<p>Unique name of the container</p> "
          }
        ]
      }
    },
    "success": {
      "fields": {
        "Success 200": [
          {
            "group": "Success 200",
            "type": "<p>String</p> ",
            "optional": false,
            "field": "name",
            "description": "<p>Name of the container</p> "
          },
          {
            "group": "Success 200",
            "type": "<p>String</p> ",
            "optional": false,
            "field": "state",
            "description": "<p>State of the container (either 'RUNNING' or 'STOPPED')</p> "
          },
          {
            "group": "Success 200",
            "type": "<p>String</p> ",
            "optional": false,
            "field": "ip_address",
            "description": "<p>IP address assigned to the container</p> "
          },
          {
            "group": "Success 200",
            "type": "<p>Integer</p> ",
            "optional": false,
            "field": "cpu_cores",
            "description": "<p>Number of Vcores</p> "
          },
          {
            "group": "Success 200",
            "type": "<p>Integer</p> ",
            "optional": false,
            "field": "memory_limit_bytes",
            "description": "<p>Memory limit in bytes</p> "
          },
          {
            "group": "Success 200",
            "type": "<p>Integer</p> ",
            "optional": false,
            "field": "memory_usage_bytes",
            "description": "<p>Current amount of memory usage in bytes</p> "
          },
          {
            "group": "Success 200",
            "type": "<p>Integer</p> ",
            "optional": false,
            "field": "disk_space_gb",
            "description": "<p>Available disk space in GB</p> "
          },
          {
            "group": "Success 200",
            "type": "<p>Integer</p> ",
            "optional": false,
            "field": "disk_usage_gb",
            "description": "<p>Current amount of disk usage in GB</p> "
          },
          {
            "group": "Success 200",
            "type": "<p>String</p> ",
            "optional": false,
            "field": "container_type",
            "description": "<p>Container type, could be either 'lxc' or 'vserver'</p> "
          }
        ]
      }
    },
    "filename": "lib/wf_node_api/api/node_api.rb",
    "groupTitle": "Container",
    "error": {
      "fields": {
        "Unauthorized 401": [
          {
            "group": "Unauthorized 401",
            "optional": false,
            "field": "error",
            "description": "<p>No valid API token was supplied</p> "
          }
        ],
        "Internal Server Error 500": [
          {
            "group": "Internal Server Error 500",
            "optional": false,
            "field": "error",
            "description": "<p>The process could not be requested due to an internal error</p> "
          }
        ],
        "Not Found 404": [
          {
            "group": "Not Found 404",
            "optional": false,
            "field": "error",
            "description": "<p>Object was not found</p> "
          }
        ]
      },
      "examples": [
        {
          "title": "401 Unauthorized",
          "content": "HTTP/1.1 401 Unauthorized\n{\n  \"error\": \"Unauthorized\"\n}",
          "type": "json"
        },
        {
          "title": "500 Internal Server Error",
          "content": "HTTP/1.1 500 Internal Server Error\n{\n  \"error\": \"Unknown error occured\"\n}",
          "type": "json"
        },
        {
          "title": "404 Not Found",
          "content": "HTTP/1.1 404 Not Found\n{\n  \"error\": \"Not Found\"\n}",
          "type": "json"
        }
      ]
    }
  },
  {
    "type": "get",
    "url": "/containers",
    "title": "Request container list",
    "version": "0.8.0",
    "name": "GetContainers",
    "group": "Container",
    "description": "<p>Returns an array of containers which are available on the node.</p> ",
    "header": {
      "fields": {
        "Header": [
          {
            "group": "Header",
            "type": "String",
            "optional": false,
            "field": "X-Api-Token",
            "description": "<p>API token (from /etc/wf_node_api.conf)</p> "
          }
        ]
      }
    },
    "success": {
      "fields": {
        "Success 200": [
          {
            "group": "Success 200",
            "type": "<p>Object[]</p> ",
            "optional": false,
            "field": "containers",
            "description": "<p>List of available containers</p> "
          },
          {
            "group": "Success 200",
            "type": "<p>String</p> ",
            "optional": false,
            "field": "containers.name",
            "description": "<p>Name of the container</p> "
          },
          {
            "group": "Success 200",
            "type": "<p>String</p> ",
            "optional": false,
            "field": "containers.state",
            "description": "<p>State of the container (either 'RUNNING' or 'STOPPED')</p> "
          },
          {
            "group": "Success 200",
            "type": "<p>String</p> ",
            "optional": false,
            "field": "containers.ip_address",
            "description": "<p>IP address assigned to the container</p> "
          },
          {
            "group": "Success 200",
            "type": "<p>Integer</p> ",
            "optional": false,
            "field": "containers.cpu_cores",
            "description": "<p>Number of Vcores</p> "
          },
          {
            "group": "Success 200",
            "type": "<p>Integer</p> ",
            "optional": false,
            "field": "containers.memory_limit_bytes",
            "description": "<p>Memory limit in bytes</p> "
          },
          {
            "group": "Success 200",
            "type": "<p>Integer</p> ",
            "optional": false,
            "field": "containers.memory_usage_bytes",
            "description": "<p>Current amount of memory usage in bytes</p> "
          },
          {
            "group": "Success 200",
            "type": "<p>Integer</p> ",
            "optional": false,
            "field": "containers.disk_space_gb",
            "description": "<p>Available disk space in GB</p> "
          },
          {
            "group": "Success 200",
            "type": "<p>Integer</p> ",
            "optional": false,
            "field": "containers.disk_usage_gb",
            "description": "<p>Current amount of disk usage in GB</p> "
          },
          {
            "group": "Success 200",
            "type": "<p>String</p> ",
            "optional": false,
            "field": "containers.container_type",
            "description": "<p>Container type, could be either 'lxc' or 'vserver'</p> "
          }
        ]
      }
    },
    "filename": "lib/wf_node_api/api/node_api.rb",
    "groupTitle": "Container",
    "error": {
      "fields": {
        "Unauthorized 401": [
          {
            "group": "Unauthorized 401",
            "optional": false,
            "field": "error",
            "description": "<p>No valid API token was supplied</p> "
          }
        ],
        "Internal Server Error 500": [
          {
            "group": "Internal Server Error 500",
            "optional": false,
            "field": "error",
            "description": "<p>The process could not be requested due to an internal error</p> "
          }
        ]
      },
      "examples": [
        {
          "title": "401 Unauthorized",
          "content": "HTTP/1.1 401 Unauthorized\n{\n  \"error\": \"Unauthorized\"\n}",
          "type": "json"
        },
        {
          "title": "500 Internal Server Error",
          "content": "HTTP/1.1 500 Internal Server Error\n{\n  \"error\": \"Unknown error occured\"\n}",
          "type": "json"
        }
      ]
    }
  },
  {
    "type": "put",
    "url": "/containers/:name/kill",
    "title": "Kill a container",
    "version": "0.8.0",
    "name": "KillContainer",
    "group": "Container",
    "description": "<p>Kills a container if it exists. Does essentially the same as StopContainer but forces the container to shut down and does not care about processes running on it.</p> ",
    "header": {
      "fields": {
        "Header": [
          {
            "group": "Header",
            "type": "String",
            "optional": false,
            "field": "X-Api-Token",
            "description": "<p>API token (from /etc/wf_node_api.conf)</p> "
          }
        ]
      }
    },
    "parameter": {
      "fields": {
        "Parameter": [
          {
            "group": "Parameter",
            "type": "<p>String</p> ",
            "optional": false,
            "field": "name",
            "description": "<p>Unique name of the container</p> "
          }
        ]
      }
    },
    "success": {
      "fields": {
        "Success 200": [
          {
            "group": "Success 200",
            "type": "<p>String</p> ",
            "optional": false,
            "field": "success",
            "description": "<p>Success message</p> "
          },
          {
            "group": "Success 200",
            "type": "<p>String</p> ",
            "optional": false,
            "field": "output",
            "description": "<p>STDOUT from container kill</p> "
          }
        ]
      }
    },
    "filename": "lib/wf_node_api/api/node_api.rb",
    "groupTitle": "Container",
    "error": {
      "fields": {
        "Unauthorized 401": [
          {
            "group": "Unauthorized 401",
            "optional": false,
            "field": "error",
            "description": "<p>No valid API token was supplied</p> "
          }
        ],
        "Not Found 404": [
          {
            "group": "Not Found 404",
            "optional": false,
            "field": "error",
            "description": "<p>Object was not found</p> "
          }
        ],
        "Internal Server Error 500": [
          {
            "group": "Internal Server Error 500",
            "optional": false,
            "field": "error",
            "description": "<p>The process could not be requested due to an internal error</p> "
          }
        ]
      },
      "examples": [
        {
          "title": "401 Unauthorized",
          "content": "HTTP/1.1 401 Unauthorized\n{\n  \"error\": \"Unauthorized\"\n}",
          "type": "json"
        },
        {
          "title": "404 Not Found",
          "content": "HTTP/1.1 404 Not Found\n{\n  \"error\": \"Not Found\"\n}",
          "type": "json"
        },
        {
          "title": "500 Internal Server Error",
          "content": "HTTP/1.1 500 Internal Server Error\n{\n  \"error\": \"Unknown error occured\"\n}",
          "type": "json"
        }
      ]
    }
  },
  {
    "type": "put",
    "url": "/containers/:name/start",
    "title": "Start a container",
    "version": "0.8.0",
    "name": "StartContainer",
    "group": "Container",
    "description": "<p>Starts a container if it exists</p> ",
    "header": {
      "fields": {
        "Header": [
          {
            "group": "Header",
            "type": "String",
            "optional": false,
            "field": "X-Api-Token",
            "description": "<p>API token (from /etc/wf_node_api.conf)</p> "
          }
        ]
      }
    },
    "parameter": {
      "fields": {
        "Parameter": [
          {
            "group": "Parameter",
            "type": "<p>String</p> ",
            "optional": false,
            "field": "name",
            "description": "<p>Unique name of the container</p> "
          }
        ]
      }
    },
    "success": {
      "fields": {
        "Success 200": [
          {
            "group": "Success 200",
            "type": "<p>String</p> ",
            "optional": false,
            "field": "success",
            "description": "<p>Success message</p> "
          },
          {
            "group": "Success 200",
            "type": "<p>String</p> ",
            "optional": false,
            "field": "output",
            "description": "<p>STDOUT from container start</p> "
          }
        ]
      }
    },
    "filename": "lib/wf_node_api/api/node_api.rb",
    "groupTitle": "Container",
    "error": {
      "fields": {
        "Unauthorized 401": [
          {
            "group": "Unauthorized 401",
            "optional": false,
            "field": "error",
            "description": "<p>No valid API token was supplied</p> "
          }
        ],
        "Not Found 404": [
          {
            "group": "Not Found 404",
            "optional": false,
            "field": "error",
            "description": "<p>Object was not found</p> "
          }
        ],
        "Internal Server Error 500": [
          {
            "group": "Internal Server Error 500",
            "optional": false,
            "field": "error",
            "description": "<p>The process could not be requested due to an internal error</p> "
          }
        ]
      },
      "examples": [
        {
          "title": "401 Unauthorized",
          "content": "HTTP/1.1 401 Unauthorized\n{\n  \"error\": \"Unauthorized\"\n}",
          "type": "json"
        },
        {
          "title": "404 Not Found",
          "content": "HTTP/1.1 404 Not Found\n{\n  \"error\": \"Not Found\"\n}",
          "type": "json"
        },
        {
          "title": "500 Internal Server Error",
          "content": "HTTP/1.1 500 Internal Server Error\n{\n  \"error\": \"Unknown error occured\"\n}",
          "type": "json"
        }
      ]
    }
  },
  {
    "type": "put",
    "url": "/containers/:name/stop",
    "title": "Stop a container",
    "version": "0.8.0",
    "name": "StopContainer",
    "group": "Container",
    "description": "<p>Stops a container if it exists</p> ",
    "header": {
      "fields": {
        "Header": [
          {
            "group": "Header",
            "type": "String",
            "optional": false,
            "field": "X-Api-Token",
            "description": "<p>API token (from /etc/wf_node_api.conf)</p> "
          }
        ]
      }
    },
    "parameter": {
      "fields": {
        "Parameter": [
          {
            "group": "Parameter",
            "type": "<p>String</p> ",
            "optional": false,
            "field": "name",
            "description": "<p>Unique name of the container</p> "
          }
        ]
      }
    },
    "success": {
      "fields": {
        "Success 200": [
          {
            "group": "Success 200",
            "type": "<p>String</p> ",
            "optional": false,
            "field": "success",
            "description": "<p>Success message</p> "
          },
          {
            "group": "Success 200",
            "type": "<p>String</p> ",
            "optional": false,
            "field": "output",
            "description": "<p>STDOUT from container stop</p> "
          }
        ]
      }
    },
    "filename": "lib/wf_node_api/api/node_api.rb",
    "groupTitle": "Container",
    "error": {
      "fields": {
        "Unauthorized 401": [
          {
            "group": "Unauthorized 401",
            "optional": false,
            "field": "error",
            "description": "<p>No valid API token was supplied</p> "
          }
        ],
        "Not Found 404": [
          {
            "group": "Not Found 404",
            "optional": false,
            "field": "error",
            "description": "<p>Object was not found</p> "
          }
        ],
        "Internal Server Error 500": [
          {
            "group": "Internal Server Error 500",
            "optional": false,
            "field": "error",
            "description": "<p>The process could not be requested due to an internal error</p> "
          }
        ]
      },
      "examples": [
        {
          "title": "401 Unauthorized",
          "content": "HTTP/1.1 401 Unauthorized\n{\n  \"error\": \"Unauthorized\"\n}",
          "type": "json"
        },
        {
          "title": "404 Not Found",
          "content": "HTTP/1.1 404 Not Found\n{\n  \"error\": \"Not Found\"\n}",
          "type": "json"
        },
        {
          "title": "500 Internal Server Error",
          "content": "HTTP/1.1 500 Internal Server Error\n{\n  \"error\": \"Unknown error occured\"\n}",
          "type": "json"
        }
      ]
    }
  },
  {
    "type": "get",
    "url": "/info",
    "title": "Request node information",
    "version": "0.8.0",
    "name": "NodeInfo",
    "group": "Node",
    "description": "<p>Returns an array containing useful information about the node itself and the resources available on it.</p> ",
    "header": {
      "fields": {
        "Header": [
          {
            "group": "Header",
            "type": "String",
            "optional": false,
            "field": "X-Api-Token",
            "description": "<p>API token (from /etc/wf_node_api.conf)</p> "
          }
        ]
      }
    },
    "success": {
      "fields": {
        "Success 200": [
          {
            "group": "Success 200",
            "type": "<p>String</p> ",
            "optional": false,
            "field": "container_type",
            "description": "<p>The configured container type (lxc or vserver)</p> "
          },
          {
            "group": "Success 200",
            "type": "<p>String</p> ",
            "optional": false,
            "field": "hostname",
            "description": "<p>The hostname of the system</p> "
          },
          {
            "group": "Success 200",
            "type": "<p>String</p> ",
            "optional": false,
            "field": "api_version",
            "description": "<p>The version number of the node api</p> "
          },
          {
            "group": "Success 200",
            "type": "<p>Integer</p> ",
            "optional": false,
            "field": "total_cpu_cores",
            "description": "<p>The number of cpu cores available totally</p> "
          },
          {
            "group": "Success 200",
            "type": "<p>Integer</p> ",
            "optional": false,
            "field": "free_cpu_cores",
            "description": "<p>The number of free cpu cores</p> "
          }
        ]
      }
    },
    "filename": "lib/wf_node_api/api/node_api.rb",
    "groupTitle": "Node",
    "error": {
      "fields": {
        "Unauthorized 401": [
          {
            "group": "Unauthorized 401",
            "optional": false,
            "field": "error",
            "description": "<p>No valid API token was supplied</p> "
          }
        ],
        "Internal Server Error 500": [
          {
            "group": "Internal Server Error 500",
            "optional": false,
            "field": "error",
            "description": "<p>The process could not be requested due to an internal error</p> "
          }
        ]
      },
      "examples": [
        {
          "title": "401 Unauthorized",
          "content": "HTTP/1.1 401 Unauthorized\n{\n  \"error\": \"Unauthorized\"\n}",
          "type": "json"
        },
        {
          "title": "500 Internal Server Error",
          "content": "HTTP/1.1 500 Internal Server Error\n{\n  \"error\": \"Unknown error occured\"\n}",
          "type": "json"
        }
      ]
    }
  }
]