Health endpoint REST URLs
- Last UpdatedFeb 09, 2024
- 1 minute read
|
Relative URL |
HTTP verb |
Action |
|---|---|---|
|
api/v1/configuration/system/ healthEndpoints |
GET |
Gets all configured health endpoints |
|
api/v1/configuration/system/ healthEndpoints |
DELETE |
Deletes all configured health endpoints |
|
api/v1/configuration/system/ healthEndpoints |
POST |
Adds an array of health endpoints or a single endpoint. Fails if any endpoint already exists |
|
api/v1/configuration/system/ healthEndpoints |
PUT |
Replaces all health endpoints. Note: Requires an array of endpoints |
|
api/v1/configuration/system/ healthEndpoints |
PATCH |
Allows partial updating of configured health endpoints Note: The request must be an array containing one or more health endpoints. Each health endpoint in the array must include its Id. |
|
api/v1/configuration/system/ healthEndpoints/<Id> |
GET |
Gets configured health endpoint by Id. |
|
api/v1/configuration/system/ healthEndpoints/<Id> |
DELETE |
Deletes configured health endpoint by Id. |
|
api/v1/configuration/system/ healthEndpoints/<Id> |
PUT |
Updates or creates a new health endpoint with the specified Id. |
|
api/v1/configuration/system/ healthEndpoints/<Id> |
PATCH |
Allows partial updating of configured health endpoint by Id. |
Note: Replace <Id> with the Id of the health endpoint.