Skip to main content
Solved

Chronicle API Endpoint to GET deployment state of a curated rule

  • July 23, 2026
  • 5 replies
  • 38 views

ar3diu
Forum|alt.badge.img+11

Since we can now change the deployment state of individual curated rules, I expected to read (GET) the same information using one of the following endpoints:

Any guidance on how to GET there? 😁

Best answer by whathehack81

Hi ar3diu,

You are correct—the curatedRuleSetDeployments resource only returns deployment state at the curated rule-set and precision level. It does not expose an override applied to one individual curated rule.

For the individual rule state, use the unified Rules API rather than curatedRules or rules/{id}/deployment.

First, list Google-owned curated rules using the configuration view:

GET https://{endpoint}/v1alpha/projects/{project}/locations/{location}/instances/{instance}/rules?filter=rule_owner%3A%22GOOGLE%22&view=CONFIG_ONLY&pageSize=5000

Locate the specific rule’s unified resource name:

projects/{project}/locations/{location}/instances/{instance}/rules/ur_{rule_id}

Then retrieve that individual curated rule:

GET https://{endpoint}/v1alpha/projects/{project}/locations/{location}/instances/{instance}/rules/ur_{rule_id}?view=CONFIG_ONLY

The returned Rule configuration contains the individual state:

{

  "displayName": "...",

  "ruleOwner": "GOOGLE",

  "alertingEnabled": false,

  "liveModeEnabled": true,

  "archived": false,

  "executionState": "DEFAULT"

}

The important distinction is that the identifier must be the unified ur_... rule ID. A legacy curated-rule ID passed to:

/rules/{rule}/deployment

will return a 404 because that endpoint expects the legacy RuleDeployment child resource.

CONFIG_ONLY is specifically intended to return the per-rule configuration, including alerting and live-mode state. The unified Rules API is currently Pre-GA, so availability may depend on whether the unified rules feature is enabled for the instance. �

Google Cloud Documentation +2

R.Q

whathehack81

5 replies

cmorris
Staff
Forum|alt.badge.img+14
  • Staff
  • July 23, 2026

ar3diu
Forum|alt.badge.img+11
  • Author
  • Silver 2
  • July 23, 2026

@cmorris This is for curated rule sets. I need to read the deployment state of an individual curated rule from a curated rule set.

 

In my understanding, you could have a curated rule set where alerting is ON for all PRECISE rules and you configure this at the curated rule set level, but then go in the Rules tab and turn OFF alerting on one of the PRECISE rules in that specific rule set.


whathehack81
Forum|alt.badge.img+6
  • Bronze 1
  • Answer
  • July 23, 2026

Hi ar3diu,

You are correct—the curatedRuleSetDeployments resource only returns deployment state at the curated rule-set and precision level. It does not expose an override applied to one individual curated rule.

For the individual rule state, use the unified Rules API rather than curatedRules or rules/{id}/deployment.

First, list Google-owned curated rules using the configuration view:

GET https://{endpoint}/v1alpha/projects/{project}/locations/{location}/instances/{instance}/rules?filter=rule_owner%3A%22GOOGLE%22&view=CONFIG_ONLY&pageSize=5000

Locate the specific rule’s unified resource name:

projects/{project}/locations/{location}/instances/{instance}/rules/ur_{rule_id}

Then retrieve that individual curated rule:

GET https://{endpoint}/v1alpha/projects/{project}/locations/{location}/instances/{instance}/rules/ur_{rule_id}?view=CONFIG_ONLY

The returned Rule configuration contains the individual state:

{

  "displayName": "...",

  "ruleOwner": "GOOGLE",

  "alertingEnabled": false,

  "liveModeEnabled": true,

  "archived": false,

  "executionState": "DEFAULT"

}

The important distinction is that the identifier must be the unified ur_... rule ID. A legacy curated-rule ID passed to:

/rules/{rule}/deployment

will return a 404 because that endpoint expects the legacy RuleDeployment child resource.

CONFIG_ONLY is specifically intended to return the per-rule configuration, including alerting and live-mode state. The unified Rules API is currently Pre-GA, so availability may depend on whether the unified rules feature is enabled for the instance. �

Google Cloud Documentation +2

R.Q

whathehack81


ar3diu
Forum|alt.badge.img+11
  • Author
  • Silver 2
  • July 23, 2026

Thanks @whathehack81!

I actually ran this before but totally missed the fields I was looking for. Good job! 🙌


whathehack81
Forum|alt.badge.img+6

Thanks @whathehack81!

I actually ran this before but totally missed the fields I was looking for. Good job! 🙌

🙏