prometheus/cadvisor
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Add API v1.3 documentation.

Browse Source
This commit is contained in:
Victor Marmol 2015-04-01 10:06:52 -07:00
parent c5b4f30ad9
commit 278d0a858b
1 changed files with 28 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
docs/api.md
View File

@ -4,7 +4,34 @@ cAdvisor exposes its raw and processed stats via a versioned remote REST API:
`http://<hostname>:<port>/api/<version>/<request>` `http://<hostname>:<port>/api/<version>/<request>`
The current version of the API is `v1.2`. The current version of the API is `v1.3`.
There is a beta release of the `v2.0` API [available](api_v2.md).
## Version 1.3
This version exposes the same endpoints as `v1.2` with one additional read-only endpoint.
### Events
The resource name for Docker container information is as follows:
`/api/v1.3/events/<absolute container name>`
Querying the endpoint receives a list of events which are a serialized `Event` JSON objects (found in [info/v1/container.go](../info/v1/container.go)).
The endpoint accepts a certain number of query parameters:
| Parameter | Description | Default |
|-------------------|--------------------------------------------------------------------------------|-------------------|
| `start_time` | Start time of events to query (for stream=false) | Beginning of time |
| `end_time` | End time of events to query (for stream=false) | Now |
| `stream` | Whether to stream new events as they occur. If false returns historical events | false |
| `subcontainers` | Whether to also return events for all subcontainers | false |
| `max_events` | The max number of events to return (for stream=false) | 10 |
| `oom_events` | Whether to include OOM events | false |
| `creation_events` | Whether to include container creation events | false |
| `deletion_events` | Whether to include container deletion events | false |
## Version 1.2 ## Version 1.2