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 14:22:47 -07:00
parent 2e6b061e8c
commit dac1cea793
1 changed files with 6 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
API.md

@ -47,7 +47,7 @@ POST Data:
### Deleting Service ### Deleting Service
- Endpoint: `/api/services/{id}` - Endpoint: `/api/services/{id}`
- Method: `DELETE` - Method: `DELETE`
- Response: [Service](https://github.com/hunterlong/statup/wiki/API#service-response) - Response: [Object Response](https://github.com/hunterlong/statup/wiki/API#object-response)
Response: Response:
```json ```json
@ -65,14 +65,17 @@ The users API endpoint will show you users that are registered inside your Statu
### View All Users ### View All Users
- Endpoint: `/api/users` - Endpoint: `/api/users`
- Method: `GET` - Method: `GET`
- Response: Array of [Users](https://github.com/hunterlong/statup/wiki/API#user-response)
### Viewing User ### Viewing User
- Endpoint: `/api/users/{id}` - Endpoint: `/api/users/{id}`
- Method: `GET` - Method: `GET`
- Response: [User](https://github.com/hunterlong/statup/wiki/API#user-response)
### Creating New User ### Creating New User
- Endpoint: `/api/users` - Endpoint: `/api/users`
- Method: `POST` - Method: `POST`
- Response: [User](https://github.com/hunterlong/statup/wiki/API#user-response)
POST Data: POST Data:
```json ```json
@ -87,6 +90,7 @@ POST Data:
### Updating User ### Updating User
- Endpoint: `/api/users/{id}` - Endpoint: `/api/users/{id}`
- Method: `POST` - Method: `POST`
- Response: [User](https://github.com/hunterlong/statup/wiki/API#user-response)
POST Data: POST Data:
```json ```json
@ -101,6 +105,7 @@ POST Data:
### Deleting User ### Deleting User
- Endpoint: `/api/services/{id}` - Endpoint: `/api/services/{id}`
- Method: `DELETE` - Method: `DELETE`
- Response: [Object Response](https://github.com/hunterlong/statup/wiki/API#object-response)
Response: Response:
```json ```json