mirror of https://github.com/statping/statping
Updated API (markdown)
parent
fd22c59691
commit
3ca677c584
32
API.md
32
API.md
|
@ -2,19 +2,39 @@ Statup includes a RESTFUL API so you can view, update, and edit your services wi
|
||||||
|
|
||||||
## Main Route `/api`
|
## Main Route `/api`
|
||||||
|
|
||||||
## All Services `/api/services`
|
## Services
|
||||||
|
|
||||||
|
#### Viewing All Services
|
||||||
|
- Endpoint: `/api/services`
|
||||||
|
- Method: `GET`
|
||||||
|
|
||||||
#### Viewing Service
|
#### Viewing Service
|
||||||
- Endpoint: `/api/services/{id}`
|
- Endpoint: `/api/services/{id}`
|
||||||
- Method: `GET`
|
- Method: `GET`
|
||||||
|
|
||||||
#### Updating Service POST `/api/services/{id}`
|
#### Updating Service
|
||||||
|
- Endpoint: `/api/services/{id}`
|
||||||
|
- Method: `POST`
|
||||||
|
|
||||||
#### Deleting Service DELETE `/api/services/{id}`
|
#### Deleting Service
|
||||||
|
- Endpoint: `/api/services/{id}`
|
||||||
|
- Method: `DELETE`
|
||||||
|
|
||||||
## Single Service `/api/services/{id}`
|
## Users
|
||||||
|
|
||||||
## All Users `/api/users`
|
#### View All Users
|
||||||
|
- Endpoint: `/api/users`
|
||||||
|
- Method: `GET`
|
||||||
|
|
||||||
## Single User `/api/users/{id}`
|
#### Viewing User
|
||||||
|
- Endpoint: `/api/users/{id}`
|
||||||
|
- Method: `GET`
|
||||||
|
|
||||||
|
#### Updating User
|
||||||
|
- Endpoint: `/api/users/{id}`
|
||||||
|
- Method: `POST`
|
||||||
|
|
||||||
|
#### Deleting User
|
||||||
|
- Endpoint: `/api/services/{id}`
|
||||||
|
- Method: `DELETE`
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue