Get Policy By Id

Get policy by ID

  • policy_id (UUID): The ID of the policy.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Returns one policy by its ID. Its status is one of pending, healthy, unhealthy, error, or no_data.

When to use it

Use it to check a policy's configuration and when it last ran and runs next.

Required parameters

  • policy_id (path): the ID of the policy.

Response

A successful call returns 200 OK with the PolicyResponse object, including id, name, status, data_config, threshold_settings, cron_expression, destination_ids, last_evaluation, and next_evaluation.

Related: List policies, Update a policy, Trigger a policy

Path Params
uuid
required
Responses

404

Not Found

500

Internal Server Error

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json