mirror of https://github.com/dapr/docs.git
Adding the /healthz API spec
This commit is contained in:
parent
c2b672207b
commit
fdc0840c0b
|
@ -0,0 +1,34 @@
|
|||
# Dapr health API reference
|
||||
|
||||
Dapr provides health checking probes that can be used as readiness or liveness of Dapr.
|
||||
|
||||
### Get Dapr health state
|
||||
|
||||
Gets the health state for Dapr.
|
||||
|
||||
#### HTTP Request
|
||||
|
||||
```http
|
||||
GET http://localhost:<daprPort>/v1.0/healthz
|
||||
```
|
||||
|
||||
#### HTTP Response Codes
|
||||
|
||||
Code | Description
|
||||
---- | -----------
|
||||
200 | health is ok
|
||||
500 | health is not ok
|
||||
|
||||
#### URL Parameters
|
||||
|
||||
Parameter | Description
|
||||
--------- | -----------
|
||||
daprPort | The Dapr port.
|
||||
|
||||
#### Examples
|
||||
|
||||
```shell
|
||||
curl http://localhost:3500/v1.0/healthz
|
||||
-H "Content-Type: application/json"
|
||||
```
|
||||
|
Loading…
Reference in New Issue