Policies API

About the Policies API

CloudWisdom’s Policies API can be used to list, inspect, create, delete, mute, and unmute policies. You can test these endpoints by visiting our Swagger page and by clicking the interactive buttons below.

GET from /policies

Use this endpoint to get a list of policies.

View Method Details.


POST to /policies

Use this endpoint to create policies and assign conditions, notifications.

View Method Details.


GET from /policies/elements

Use this endpoint to retrieve element counts for all policies within the time frame specified.

View Method Details.


GET from /policies/events

Use this endpoint to retrieve event counts for all policies within the time frame specified.

View Method Details.


GET from /policies/mute

Use this endpoint to get a list of currently muted policies.

View Method Details.


DELETE to /policies/{policyId}

Use this endpoint to delete a policy.

View Method Details.


GET from /policies/{policyId}

Use this endpoint to retrieve a specific policy.

View Method Details.


PUT to /policies/{policyId}

Use this endpoint to update a policy.

View Method Details.


GET from /policies/{policyId}/events

Use this endpoint to get a count of events by policy.

View Method Details.


DELETE to /policies/{policyId}/mute

Use this endpoint to unmute a policy.

View Method Details.


POST to /policies/{policyId}/mute/{muteMs}

Use this endpoint to mute a policy (and define the mute’s duration).

View Method Details.


How to Mute a Policy Over a Weekend

Receiving alerts during off-hours, such as over the weekend, may not be necessary for some policies. You can use the Policies API (/policies/{policyId}/mute{muteMS}) to mute specified policies until resuming regular hours of operation. This allows for you to still track events that occur while the policy is muted (versus being disabled). Read this walkthrough to learn how to mute a Policy over the weekend.

View Walkthrough.