mirror of
https://github.com/CachetHQ/Cachet.git
synced 2025-01-17 13:38:20 +01:00
Start work on new API format
This commit is contained in:
parent
b3f46c812b
commit
8ea2e57eea
@ -1 +1,40 @@
|
|||||||
# API Documentation for Cachet
|
# API Documentation for Cachet
|
||||||
|
|
||||||
|
## `GET /api/v1/ping`
|
||||||
|
|
||||||
|
Ping the Cachet instance.
|
||||||
|
|
||||||
|
## `GET /api/v1/version`
|
||||||
|
|
||||||
|
Get the version of Cachet installed.
|
||||||
|
|
||||||
|
## `GET /api/v1/status`
|
||||||
|
|
||||||
|
Get the overall system status.
|
||||||
|
|
||||||
|
## `GET /api/v1/components`
|
||||||
|
|
||||||
|
Get all components.
|
||||||
|
|
||||||
|
## `GET /api/v1/components/:id`
|
||||||
|
|
||||||
|
Get a single component.
|
||||||
|
|
||||||
|
### Params
|
||||||
|
|
||||||
|
- `id` the ID of the component
|
||||||
|
|
||||||
|
## `POST /api/v1/components`
|
||||||
|
|
||||||
|
Create a new component.
|
||||||
|
|
||||||
|
### Params
|
||||||
|
|
||||||
|
- `name` the name of the component
|
||||||
|
- `description` may be left empty
|
||||||
|
- `status`
|
||||||
|
- `link`
|
||||||
|
- `order`
|
||||||
|
- `group_id`
|
||||||
|
- `enabled`
|
||||||
|
- `meta`
|
||||||
|
Loading…
x
Reference in New Issue
Block a user