Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(api): health/liveness endpoint now is documented under the V2 API #962

Merged
merged 2 commits into from
May 27, 2022
Merged

docs(api): health/liveness endpoint now is documented under the V2 API #962

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9d02998
fixed
maxcao13 May 27, 2022
b18417f
added note
maxcao13 May 27, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 19 additions & 19 deletions HTTP_API.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,6 @@
| Get the URL of Cryostat's Grafana dashboard | [`GrafanaDashboardUrlGetHandler`](#GrafanaDashboardUrlGetHandler) |
| Get the URL of Cryostat's Grafana datasource | [`GrafanaDatasourceUrlGetHandler`](#GrafanaDatasourceUrlGetHandler) |
| Check the status of Cryostat's Grafana datasource and dashboard | [`HealthGetHandler`](#HealthGetHandler) |
| Check the status of Cryostat itself | [`HealthLivenessGetHandler`](#HealthLivenessGetHandler) |
| **Events and event templates** | |
| Get a list of event types that can be produced by a target JVM | [`TargetEventsGetHandler`](#TargetEventsGetHandler) |
| Get a list of event templates known to a target JVM | [`TargetTemplatesGetHandler`](#TargetTemplatesGetHandler) |
Expand Down Expand Up @@ -202,24 +201,6 @@
```


* #### `HealthLivenessGetHandler`

###### synopsis
Returns whether or not Cryostat itself is running properly
by checking for a valid No Content response.

###### request
`GET /health/liveness`

###### response
`204` - There is no content to display.

###### example
```
$ curl localhost:8181/health/liveness
```


* #### `StaticAssetsGetHandler`

###### synopsis
Expand Down Expand Up @@ -1218,6 +1199,7 @@ The handler-specific descriptions below describe how each handler populates the
| ------------------------------------------------------------------------- | --------------------------------------------------------------------------------|
| **Miscellaneous** | |
| Check user authentication | [`AuthPostHandler`](#AuthPostHandler-1) |
| Check the status of Cryostat itself | [`HealthLivenessGetHandler`](#HealthLivenessGetHandler) |
| **Target JVMs** | |
| Add a custom target definition | [`TargetsPostHandler`](#TargetsPostHandler) |
| Delete a custom target definition | [`TargetDeleteHandler`](#TargetDeleteHandler) |
Expand Down Expand Up @@ -1273,6 +1255,24 @@ The handler-specific descriptions below describe how each handler populates the
```


* #### `HealthLivenessGetHandler`

###### synopsis
Returns whether or not Cryostat itself is running properly
by checking for a valid No Content response (since: 2.2.0).

###### request
`GET /health/liveness`

###### response
`204` - There is no content to display.

###### example
```
$ curl localhost:8181/health/liveness
```


### Target JVMs

* #### `TargetsPostHandler`
Expand Down