HomeGuidesAPI ReferenceRelease notes
Log In
API Reference

Update policy by ID

Update policy by ID.

  • payload (PolicyUpdate): Required. The updated policy information with:
    • name (str or None): The updated name of the policy.
    • data_config: Configuration relevant to the retrieval of data for this policy:
      for compare distribution policy:
      • query_a (Query): Cube.js query.
      • query_b (Query): Cube.js query.
      • query_a_time_range_config: (TimeRangeConfig or None): Time range configuration for query A.
      • query_b_time_range_config: (TimeRangeConfig or None): Time range configuration for query B.
      • distance_function (DistanceFunction): Distance function to use.
        for statistics policy:
      • query (Query): Cube.js query.
    • cron_expression (str or None): The updated cron expression for the policy evaluation.
    • condition_above_value (float or None): The updated condition above value.
    • condition_below_value (float or None): The updated condition below value.
    • destination_ids (list of UUID or None): The updated list of communication channels to get notified through.
    • alert_on_status (AlertOnStatusDirection or None): The updated trigger policy action if the value is above/below.
    • alert_on_policy_level (bool or None): The updated trigger policy action on a single group/entire groups.
    • dataset_id (str or None): The updated dataset this policy is monitoring.
  • policy_id (UUID): Required. The ID of the policy to be updated.
Language
Credentials
OAuth2
Click Try It! to start a request and see the response here!