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-12-04 00:09:39 -08:00
parent 0ba05a0c9a
commit a47ec56ad0
1 changed files with 10 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
API.md

@ -1,7 +1,7 @@
Statping includes a RESTFUL API so you can view, update, and edit your services with easy to use routes. You can currently view, update and delete services, view, create, update users, and get detailed information about the Statping instance. To make life easy, try out a Postman or Swagger JSON file and use it on your Statping Server. Statping includes a RESTFUL API so you can view, update, and edit your services with easy to use routes. You can currently view, update and delete services, view, create, update users, and get detailed information about the Statping instance. To make life easy, try out a Postman or Swagger JSON file and use it on your Statping Server.
<p align="center"> <p align="center">
<a href="https://documenter.getpostman.com/view/1898229/RzZDhGuD">Postman</a> | <a href="https://github.com/hunterlong/statup/blob/master/source/tmpl/postman.json">Postman JSON Export</a> | <a href="https://github.com/hunterlong/statup/blob/master/dev/swagger.json">Swagger Export</a> <a href="https://documenter.getpostman.com/view/1898229/RzZDhGuD">Postman</a> | <a href="https://github.com/hunterlong/statping/blob/master/source/tmpl/postman.json">Postman JSON Export</a> | <a href="https://github.com/hunterlong/statping/blob/master/dev/swagger.json">Swagger Export</a>
</p> </p>
## Authentication ## Authentication
@ -19,21 +19,21 @@ The services API endpoint will show you detailed information about services and
### Viewing All Services ### Viewing All Services
- Endpoint: `/api/services` - Endpoint: `/api/services`
- Method: `GET` - Method: `GET`
- Response: Array of [Services](https://github.com/hunterlong/statup/wiki/API#service-response) - Response: Array of [Services](https://github.com/hunterlong/statping/wiki/API#service-response)
- Response Type: `application/json` - Response Type: `application/json`
- Request Type: `application/json` - Request Type: `application/json`
### Viewing Service ### Viewing Service
- Endpoint: `/api/services/{id}` - Endpoint: `/api/services/{id}`
- Method: `GET` - Method: `GET`
- Response: [Service](https://github.com/hunterlong/statup/wiki/API#service-response) - Response: [Service](https://github.com/hunterlong/statping/wiki/API#service-response)
- Response Type: `application/json` - Response Type: `application/json`
- Request Type: `application/json` - Request Type: `application/json`
### Updating Service ### Updating Service
- Endpoint: `/api/services/{id}` - Endpoint: `/api/services/{id}`
- Method: `POST` - Method: `POST`
- Response: [Service](https://github.com/hunterlong/statup/wiki/API#service-response) - Response: [Service](https://github.com/hunterlong/statping/wiki/API#service-response)
- Response Type: `application/json` - Response Type: `application/json`
- Request Type: `application/json` - Request Type: `application/json`
@ -57,7 +57,7 @@ POST Data:
### Deleting Service ### Deleting Service
- 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: [Object Response](https://github.com/hunterlong/statping/wiki/API#object-response)
- Response Type: `application/json` - Response Type: `application/json`
- Request Type: `application/json` - Request Type: `application/json`
@ -77,21 +77,21 @@ The users API endpoint will show you users that are registered inside your Statp
### 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) - Response: Array of [Users](https://github.com/hunterlong/statping/wiki/API#user-response)
- Response Type: `application/json` - Response Type: `application/json`
- Request Type: `application/json` - Request Type: `application/json`
### 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) - Response: [User](https://github.com/hunterlong/statping/wiki/API#user-response)
- Response Type: `application/json` - Response Type: `application/json`
- Request Type: `application/json` - Request Type: `application/json`
### 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) - Response: [User](https://github.com/hunterlong/statping/wiki/API#user-response)
- Response Type: `application/json` - Response Type: `application/json`
- Request Type: `application/json` - Request Type: `application/json`
@ -108,7 +108,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) - Response: [User](https://github.com/hunterlong/statping/wiki/API#user-response)
- Response Type: `application/json` - Response Type: `application/json`
- Request Type: `application/json` - Request Type: `application/json`
@ -125,7 +125,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: [Object Response](https://github.com/hunterlong/statping/wiki/API#object-response)
- Response Type: `application/json` - Response Type: `application/json`
- Request Type: `application/json` - Request Type: `application/json`