v1/health_configs

Use the v1/health_configs API to get a list of health configurations for your account, as well as modify or delete a health configuration.

URI

http://<hostname>/ws/v1/health_configs

Formats

HTTP Method Format Description
GET /ws/v1/health_configs Get a summary of the health_configs APIs.
GET /ws/v1/health_configs/inventory Get a list of all health configurations in your inventory.
GET, PUT, DELETE /ws/v1/health_configs/inventory/{id} Get, modify, or delete a named health configuration.

Fields

id

System-generated identifier for the device type to which the health_config applies.

Parameters

Name Type Description
cursor string Cursor to get the next page of health configurations. Omit on initial call.
size integer Number of items to return. The maximum and default is 1000.
replace boolean Boolean value that indicates whether to replace the current report configuration.True or Yes: Replace the current report configuration.False or No: Update the existing report configuration with changes.