Skip to content
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
bin
endpoints Added auth(entication|orization) on DEL /dashboards/:id Mar 29, 2015
lib Using es6 syntax Mar 28, 2015
tests
.editorconfig Added .editorconfig Nov 26, 2014
.eslintrc Improved eslint rules Mar 28, 2015
.gitignore updated ignores Nov 28, 2014
.jshintrc
README.md
app.js
config.js
npm-shrinkwrap.json Added npm prune && npm shrinkwrap before running test Apr 1, 2015
package.json Added npm prune && npm shrinkwrap before running test Apr 1, 2015

README.md

dashy-server-api

Dashboard Management Platform - Server API

Aiming to release stable 1.0.0 on 15 March 2015

Codeship Status for dashy-io/dashy-server-api Stories in Ready

Uptime Report for api.dashy.io: Last 30  days Response Time Report for api.dashy.io: Last 30 days

Credits

GET /status

Status check.

Returns:

  • 200 OK if the system is working

Example: http://api.dashy.io/status

curl http://api.dashy.io/dashboards/status
{
  "env": "production"
}

GET /dashboards/:dashboard-id

Returns a dashboard configuration

Returns:

  • 200 OK if the dashboard exists
  • 404 Not Found if the dashboard was not found

Example: http://api.dashy.io/dashboards/example-dashboard

curl http://api.dashy.io/dashboards/example-dashboard

Example: http://api.dashy.io/dashboards/example-dashboard

{
  "id" : "test-dashboard",
  "interval" : 15,
  "name" : "Test Dashboard",
  "urls" : [
    "http://citydashboard.org/london/",
    "http://www.casa.ucl.ac.uk/cumulus/ipad.html",
    "http://www.gridwatch.templar.co.uk/",
    "http://www.casa.ucl.ac.uk/weather/colours.html"
  ]
}

POST /dashboards

Creates a new dashboard and implicitly an new short-code

Note: Content-Type must be set to application/json.

Returns:

  • 201 Created If a new dashboard was created
  • 409 Conflict If a dashboard with the same ID already exists
  • 400 Bad Request If ID not specified in the body
  • 400 Bad Request If there are unexpected parameters in the body

Example:

curl -X POST -H 'Content-Type: application/json' http://api.dashy.io/dashboards -d @- << EOF
{
  "id" : "c98ba5ef-08c1-4360-9eb3-85c4530e0d1a"
}
EOF

PUT /dashboards/:dashboard-id

Updates an existing dashboard

Note: Content-Type must be set to application/json.

Returns:

  • 200 OK If the dashboard was updated
  • 404 Not Found If the dashboard was not found
  • 409 Conflict If the dashboard ID in the body does not match the one in the url
  • 400 Bad Request If there are unexpected parameters in the body
  • 409 Conflict If trying to modify the code property

Example:

curl -X PUT -H 'Content-Type: application/json' http://api.dashy.io/dashboards/example-dashboard -d @- << EOF
{
  "interval" : 15,
  "name" : "Test Dashboard",
  "urls" : [
    "http://citydashboard.org/london/",
    "http://www.casa.ucl.ac.uk/cumulus/ipad.html",
    "http://www.gridwatch.templar.co.uk/",
    "http://www.casa.ucl.ac.uk/weather/colours.html"
  ]
}
EOF

DELETE /dashboards/:dashboard-id

Deletes a dashboard

Returns:

  • 204 No Content If the dashboard was deleted
  • 404 Not Found If the dashboard was not found

Returns:

  • 200 OK if the system is working

Example: http://api.dashy.io/status

GET /dashboards/:dashboard-id/code

Returns the short-code of a dashboard

Returns:

  • 200 OK if the dashboard exists
  • 404 Not Found if the dashboard was not found

Example: http://api.dashy.io/dashboards/example-dashboard/code

curl http://api.dashy.io/dashboards/example-dashboard/code
{
  "code" : "12345678"
}

WIP: POST /users/:user-id/claims/

Claims a dashboard by providing a SHORT-CODE and connects it to a user's account.

Example:

curl -X DELETE http://api.dashy.io/example-dashboard

WIP: GET /users/:user-id

Returns user details and associated dashboard

Example: http://api.dashy.io/users/test-user

{
  "id" : "test-user",
  "name" : "Test User",
  "dashboards": [
    "test-dashboard"
  ]
}

WIP: POST /users/:user-id

Sets user details

You can’t perform that action at this time.