github
/
statping
mirror of https://github.com/statping/statping
1
0
Fork 0
Code Issues Releases Wiki Activity

Updated API (markdown)

master
Hunter Long 2018-09-12 09:48:06 -07:00
parent 3ca677c584
commit 90f081e631
1 changed files with 7 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
API.md

@ -1,8 +1,14 @@
Statup includes a RESTFUL API so you can view, update, and edit your services with easy to use routes.
## Authentication
HTTP Request Header: `Authorization: API SECRET HERE`
## Main Route `/api`
The main API route will show you all services and failures along with them.
## Services
The services API endpoint will show you detailed information about services and will allow you to edit/delete services with POST/DELETE http methods.
#### Viewing All Services
- Endpoint: `/api/services`
@ -21,6 +27,7 @@ Statup includes a RESTFUL API so you can view, update, and edit your services wi
- Method: `DELETE`
## Users
The users API endpoint will show you users that are registered inside your Statup instance.
#### View All Users
- Endpoint: `/api/users`