doc.json

{
    "endpoints": [
        {
            "method": "GET",
            "path": "/api/status",
            "description": "running status of the machine"
        },
        {
            "method": "POST",
            "path": "/api/status/  {\"active\": \"true/false\"}",
            "description": "change the status of the machine - on or standby"
        },
        {
            "method": "GET",
            "path": "/api/status/details",
            "description": "get a detailed status of your machine - the available information depends on the state/substate"
        },
        {
            "method": "GET",
            "path": "/api/shot/",
            "description": "get a list of the shots on your machine"
        },
        {
            "method": "GET",
            "path": "/api/shot/{shot.tcl}",
            "description": "get a single shot as "
        },
        {
            "method": "GET",
            "path": "/api/profile",
            "description": "list of profiles on your machine"
        },
        {
            "method": "GET",
            "path": "/api/profile/{profile_filename.tcl}",
            "description": ""
        },
        {
            "method": "POST",
            "path": "/api/profile/",
            "description": "add a profile to your machine - the filename of the uploaded profile will be used, so existing profiles could be overwritten"
        },
        {
            "method": "PUT",
            "path": "/api/profile/{profile_filename.tcl}",
            "description": "Select an existing profile"
        },
        {
            "method": "GET",
            "path": "/",
            "description": "Dashboard including most API functions"
        },
        {
            "method": "GET",
            "path": "/api/flush",
            "description": "Flush the log"
        },
        {
            "method": "PUT",
            "path": "/api/v2/shot/{timestamp}",
            "description": "Set the specified shots' DYE description as next planned shot in DYE."
        },
        {
          "method": "GET",
          "path": "/api/v2/shot/{timestamp}",
          "description": "Returns a json representation of the specified shot (if found)."
        },
        {
          "method": "GET",
          "path": "/api/v2/shots",
          "description": "Returns a json array of all the shots data present in SDB. Does not include graph data."
        },
        {
          "method": "GET",
          "path": "/api/help",
          "description": "Get this short API doc."
        }
    ],
    "authentication": "Authentication is done with a header param auth - if enabled it needs to match the configured string"
}