Skip to content

[Ruleset Engine] Move tables to lists #23914

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 24, 2025
Merged

[Ruleset Engine] Move tables to lists #23914

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 4 additions & 7 deletions src/content/docs/ruleset-engine/rulesets-api/add-rule.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,10 @@ Adds a single rule to an existing ruleset. Use this endpoint to add a rule witho

Use one of the following API endpoints:

| Operation | Method + Endpoint |
| -------------------------------------------- | --------------------------------------------------------- |
| [Create an account ruleset rule][ar-account] | `POST /accounts/{account_id}/rulesets/{ruleset_id}/rules` |
| [Create a zone ruleset rule][ar-zone] | `POST /zones/{zone_id}/rulesets/{ruleset_id}/rules` |

[ar-account]: /api/resources/rulesets/subresources/rules/methods/create/
[ar-zone]: /api/resources/rulesets/subresources/rules/methods/create/
- [Create an account ruleset rule](/api/resources/rulesets/subresources/rules/methods/create/)<br/>
`POST /accounts/{account_id}/rulesets/{ruleset_id}/rules`
- [Create a zone ruleset rule](/api/resources/rulesets/subresources/rules/methods/create/)<br/>
`POST /zones/{zone_id}/rulesets/{ruleset_id}/rules`

Include the rule definition in the request body.

Expand Down
11 changes: 4 additions & 7 deletions src/content/docs/ruleset-engine/rulesets-api/create.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,10 @@ Creates a ruleset of a given kind in the specified phase. Allows you to create p

Use one of the following API endpoints:

| Operation | Method + Endpoint |
| --------------------------------------- | -------------------------------------- |
| [Create an account ruleset][cr-account] | `POST /accounts/{account_id}/rulesets` |
| [Create a zone ruleset][cr-zone] | `POST /zones/{zone_id}/rulesets` |

[cr-account]: /api/resources/rulesets/methods/create/
[cr-zone]: /api/resources/rulesets/methods/create/
- [Create an account ruleset](/api/resources/rulesets/methods/create/)<br/>
`POST /accounts/{account_id}/rulesets`
- [Create a zone ruleset](/api/resources/rulesets/methods/create/)<br/>
`POST /zones/{zone_id}/rulesets`

The following parameters are required:

Expand Down
11 changes: 4 additions & 7 deletions src/content/docs/ruleset-engine/rulesets-api/delete-rule.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,10 @@ Deletes a single rule in a ruleset at the account or zone level.

Use one of the following API endpoints:

| Operation | Method + Endpoint |
| -------------------------------------------- | --------------------------------------------------------------------- |
| [Delete an account ruleset rule][dr-account] | `DELETE /accounts/{account_id}/rulesets/{ruleset_id}/rules/{rule_id}` |
| [Delete a zone ruleset rule][dr-zone] | `DELETE /zones/{zone_id}/rulesets/{ruleset_id}/rules/{rule_id}` |

[dr-account]: /api/resources/rulesets/subresources/rules/methods/delete/
[dr-zone]: /api/resources/rulesets/methods/delete/
- [Delete an account ruleset rule](/api/resources/rulesets/subresources/rules/methods/delete/)<br/>
`DELETE /accounts/{account_id}/rulesets/{ruleset_id}/rules/{rule_id}`
- [Delete a zone ruleset rule](/api/resources/rulesets/subresources/rules/methods/delete/)<br/>
Copy link
Contributor Author

@pedrosousa pedrosousa Jul 24, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This link was fixed.

`DELETE /zones/{zone_id}/rulesets/{ruleset_id}/rules/{rule_id}`

If the delete operation succeeds, the API method call returns a `200 OK` HTTP status code with the complete ruleset in the response body.

Expand Down
22 changes: 8 additions & 14 deletions src/content/docs/ruleset-engine/rulesets-api/delete.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,13 +19,10 @@ Deletes all the versions of an existing ruleset at the account or zone level.

Use one of the following API endpoints:

| Operation | Method + Endpoint |
| --------------------------------------- | ----------------------------------------------------- |
| [Delete an account ruleset][dr-account] | `DELETE /accounts/{account_id}/rulesets/{ruleset_id}` |
| [Delete a zone ruleset][dr-zone] | `DELETE /zones/{zone_id}/rulesets/{ruleset_id}` |

[dr-account]: /api/resources/rulesets/methods/delete/
[dr-zone]: /api/resources/rulesets/methods/delete/
- [Delete an account ruleset](/api/resources/rulesets/methods/delete/)<br/>
`DELETE /accounts/{account_id}/rulesets/{ruleset_id}`
- [Delete a zone ruleset](/api/resources/rulesets/methods/delete/)<br/>
`DELETE /zones/{zone_id}/rulesets/{ruleset_id}`

If the delete operation succeeds, the API method call returns a `204 No Content` HTTP status code.

Expand All @@ -52,13 +49,10 @@ Deletes a specific version of a ruleset.

Use one of the following API endpoints:

| Operation | Method + Endpoint |
| ------------------------------------------------ | ------------------------------------------------------------------------------- |
| [Delete an account ruleset version][drv-account] | `DELETE /accounts/{account_id}/rulesets/{ruleset_id}/versions/{version_number}` |
| [Delete a zone ruleset version][drv-zone] | `DELETE /zones/{zone_id}/rulesets/{ruleset_id}/versions/{version_number}` |

[drv-account]: /api/resources/rulesets/subresources/versions/methods/delete/
[drv-zone]: /api/resources/rulesets/subresources/versions/methods/delete/
- [Delete an account ruleset version](/api/resources/rulesets/subresources/versions/methods/delete/)<br/>
`DELETE /accounts/{account_id}/rulesets/{ruleset_id}/versions/{version_number}`
- [Delete a zone ruleset version](/api/resources/rulesets/subresources/versions/methods/delete/)<br/>
`DELETE /zones/{zone_id}/rulesets/{ruleset_id}/versions/{version_number}`

If the delete operation succeeds, the method call returns a `204 No Content` HTTP status code.

Expand Down
11 changes: 4 additions & 7 deletions src/content/docs/ruleset-engine/rulesets-api/update-rule.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,10 @@ Applies one or more changes to an existing rule in a ruleset at the account or z

Use one of the following API endpoints:

| Operation | Method + Endpoint |
| -------------------------------------------- | -------------------------------------------------------------------- |
| [Update an account ruleset rule][ur-account] | `PATCH /accounts/{account_id}/rulesets/{ruleset_id}/rules/{rule_id}` |
| [Update a zone ruleset rule][ur-zone] | `PATCH /zones/{zone_id}/rulesets/{ruleset_id}/rules/{rule_id}` |

[ur-account]: /api/resources/rulesets/subresources/rules/methods/edit/
[ur-zone]: /api/resources/rulesets/methods/update/
- [Update an account ruleset rule](/api/resources/rulesets/subresources/rules/methods/edit/)<br/>
`PATCH /accounts/{account_id}/rulesets/{ruleset_id}/rules/{rule_id}`
- [Update a zone ruleset rule](/api/resources/rulesets/subresources/rules/methods/edit/)<br/>
Copy link
Contributor Author

@pedrosousa pedrosousa Jul 24, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This link was fixed.

`PATCH /zones/{zone_id}/rulesets/{ruleset_id}/rules/{rule_id}`

You can update the definition of the rule, changing its fields, or change the order of the rule in the ruleset. Invoking this method creates a new version of the ruleset.

Expand Down
19 changes: 8 additions & 11 deletions src/content/docs/ruleset-engine/rulesets-api/update.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,17 +15,14 @@ You can use the API to update:

Use one of the following API endpoints:

| Operation | Method + Endpoint |
| ---------------------------------------------------- | -------------------------------------------------------------------- |
| [Update an account ruleset][ur-account] | `PUT /accounts/{account_id}/rulesets/{ruleset_id}` |
| [Update a zone ruleset][ur-zone] | `PUT /zones/{zone_id}/rulesets/{ruleset_id}` |
| [Update an account entry point ruleset][uep-account] | `PUT /accounts/{account_id}/rulesets/phases/{phase_name}/entrypoint` |
| [Update a zone entry point ruleset][uep-zone] | `PUT /zones/{zone_id}/rulesets/phases/{phase_name}/entrypoint` |

[ur-account]: /api/resources/rulesets/methods/update/
[ur-zone]: /api/resources/rulesets/methods/update/
[uep-account]: /api/resources/rulesets/subresources/phases/methods/update/
[uep-zone]: /api/resources/rulesets/subresources/phases/methods/update/
- [Update an account ruleset](/api/resources/rulesets/methods/update/)<br/>
`PUT /accounts/{account_id}/rulesets/{ruleset_id}`
- [Update an account entry point ruleset](/api/resources/rulesets/subresources/phases/methods/update/)<br/>
`PUT /accounts/{account_id}/rulesets/phases/{phase_name}/entrypoint`
- [Update a zone ruleset](/api/resources/rulesets/methods/update/)<br/>
`PUT /zones/{zone_id}/rulesets/{ruleset_id}`
- [Update a zone entry point ruleset](/api/resources/rulesets/subresources/phases/methods/update/)<br/>
`PUT /zones/{zone_id}/rulesets/phases/{phase_name}/entrypoint`

:::note
You cannot update the name of the ruleset or its type. Do not include these fields in the `data` field of your `PUT` request.
Expand Down
73 changes: 30 additions & 43 deletions src/content/docs/ruleset-engine/rulesets-api/view.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,13 +20,10 @@ Returns the list of existing rulesets at the account level or at the zone level.

Use one of the following API endpoints:

| Operation | Method + Endpoint |
| ----------------------------------- | ------------------------------------- |
| [List account rulesets][lr-account] | `GET /accounts/{account_id}/rulesets` |
| [List zone rulesets][lr-zone] | `GET /zones/{zone_id}/rulesets` |

[lr-account]: /api/resources/rulesets/methods/list/
[lr-zone]: /api/resources/rulesets/methods/list/
- [List account rulesets](/api/resources/rulesets/methods/list/)<br/>
`GET /accounts/{account_id}/rulesets`
- [List zone rulesets](/api/resources/rulesets/methods/list/)<br/>
`GET /zones/{zone_id}/rulesets`

The result includes rulesets across all phases at a given level (account or zone). The `phase` field in each result element indicates the [phase](/ruleset-engine/about/phases/) where that ruleset is defined.

Expand Down Expand Up @@ -67,17 +64,14 @@ Returns the properties of the most recent version of the ruleset with the specif

Use one of the following API endpoints:

| Operation | Method + Endpoint |
| ------------------------------------------------- | -------------------------------------------------------------------- |
| [Get an account ruleset][gr-account] | `GET /accounts/{account_id}/rulesets/{ruleset_id}` |
| [Get a zone ruleset][gr-zone] | `GET /zones/{zone_id}/rulesets/{ruleset_id}` |
| [Get an account entry point ruleset][gep-account] | `GET /accounts/{account_id}/rulesets/phases/{phase_name}/entrypoint` |
| [Get a zone entry point ruleset][gep-zone] | `GET /zones/{zone_id}/rulesets/phases/{phase_name}/entrypoint` |

[gr-account]: /api/resources/rulesets/methods/get/
[gr-zone]: /api/resources/rulesets/methods/get/
[gep-account]: /api/resources/rulesets/subresources/phases/methods/get/
[gep-zone]: /api/resources/rulesets/subresources/phases/methods/get/
- [Get an account ruleset](/api/resources/rulesets/methods/get/)<br/>
`GET /accounts/{account_id}/rulesets/{ruleset_id}`
- [Get an account entry point ruleset](/api/resources/rulesets/subresources/phases/methods/get/)<br/>
`GET /accounts/{account_id}/rulesets/phases/{phase_name}/entrypoint`
- [Get a zone ruleset](/api/resources/rulesets/methods/get/)<br/>
`GET /zones/{zone_id}/rulesets/{ruleset_id}`
- [Get a zone entry point ruleset](/api/resources/rulesets/subresources/phases/methods/get/)<br/>
`GET /zones/{zone_id}/rulesets/phases/{phase_name}/entrypoint`

:::note
You can only use the _Get a zone ruleset_ operation for zone-level phase entry points (entry points where `kind` is set to `zone`).
Expand Down Expand Up @@ -127,17 +121,14 @@ Returns a list of all the versions of a ruleset.

Use one of the following API endpoints:

| Operation | Method + Endpoint |
| -------------------------------------------------------- | ----------------------------------------------------------------------------- |
| [List account ruleset versions][lv-account] | `GET /accounts/{account_id}/rulesets/{ruleset_id}/versions` |
| [List zone ruleset versions][lv-zone] | `GET /zones/{zone_id}/rulesets/{ruleset_id}/versions` |
| [List account entry point ruleset versions][lev-account] | `GET /accounts/{account_id}/rulesets/phases/{phase_name}/entrypoint/versions` |
| [List zone entry point ruleset versions][lev-zone] | `GET /zones/{zone_id}/rulesets/phases/{phase_name}/entrypoint/versions` |

[lv-account]: /api/resources/rulesets/subresources/versions/methods/list/
[lv-zone]: /api/resources/rulesets/subresources/versions/methods/list/
[lev-account]: /api/resources/rulesets/subresources/phases/subresources/versions/methods/list/
[lev-zone]: /api/resources/rulesets/subresources/phases/subresources/versions/methods/list/
- [List account ruleset versions](/api/resources/rulesets/subresources/versions/methods/list/)<br/>
`GET /accounts/{account_id}/rulesets/{ruleset_id}/versions`
- [List account entry point ruleset versions](/api/resources/rulesets/subresources/phases/subresources/versions/methods/list/)<br/>
`GET /accounts/{account_id}/rulesets/phases/{phase_name}/entrypoint/versions`
- [List zone ruleset versions](/api/resources/rulesets/subresources/versions/methods/list/)<br/>
`GET /zones/{zone_id}/rulesets/{ruleset_id}/versions`
- [List zone entry point ruleset versions](/api/resources/rulesets/subresources/phases/subresources/versions/methods/list/)<br/>
`GET /zones/{zone_id}/rulesets/phases/{phase_name}/entrypoint/versions`

The result contains the ruleset properties of each version, but it does not include the list of rules. Refer to [View a specific version of a ruleset](#view-a-specific-version-of-a-ruleset) for instructions on obtaining this information.

Expand Down Expand Up @@ -184,17 +175,14 @@ Returns the configuration of a specific version of a ruleset, including its rule

Use one of the following API endpoints:

| Operation | Method + Endpoint |
| ---------------------------------------------------------- | ---------------------------------------------------------------------------------------------- |
| [Get an account ruleset version][grv-account] | `GET /account/{account_id}/rulesets/{ruleset_id}/versions/{version_number}` |
| [Get a zone ruleset version][grv-zone] | `GET /zones/{zone_id}/rulesets/{ruleset_id}/versions/{version_number}` |
| [Get an account entry point ruleset version][gerv-account] | `GET /accounts/{account_id}/rulesets/phases/{phase_name}/entrypoint/versions/{version_number}` |
| [Get a zone entry point ruleset version][gerv-zone] | `GET /zones/{zone_id}/rulesets/phases/{phase_name}/entrypoint/versions/{version_number}` |

[grv-account]: /api/resources/rulesets/subresources/versions/methods/get/
[grv-zone]: /api/resources/rulesets/subresources/versions/methods/get/
[gerv-account]: /api/resources/rulesets/subresources/phases/subresources/versions/methods/get/
[gerv-zone]: /api/resources/rulesets/subresources/phases/subresources/versions/methods/get/
- [Get an account ruleset version](/api/resources/rulesets/subresources/versions/methods/get/)<br/>
`GET /account/{account_id}/rulesets/{ruleset_id}/versions/{version_number}`
- [Get an account entry point ruleset version](/api/resources/rulesets/subresources/phases/subresources/versions/methods/get/)<br/>
`GET /accounts/{account_id}/rulesets/phases/{phase_name}/entrypoint/versions/{version_number}`
- [Get a zone ruleset version](/api/resources/rulesets/subresources/versions/methods/get/)<br/>
`GET /zones/{zone_id}/rulesets/{ruleset_id}/versions/{version_number}`
- [Get a zone entry point ruleset version](/api/resources/rulesets/subresources/phases/subresources/versions/methods/get/)<br/>
`GET /zones/{zone_id}/rulesets/phases/{phase_name}/entrypoint/versions/{version_number}`

When the specified phase entry point ruleset does not exist, this API method returns a `404 Not Found` HTTP status code.

Expand Down Expand Up @@ -242,9 +230,8 @@ When you view a specific version of a managed ruleset, each rule listed in the r

Returns a list of all the rules in a managed ruleset with a specific tag.

| Operation | Method + Endpoint |
| -------------------------------------------- | ------------------------------------------------------------------------------------------------------ |
| List rules in account ruleset version by tag | `GET /accounts/{account_id}/rulesets/{managed_ruleset_id}/versions/{version_number}/by_tag/{tag_name}` |
- List an account ruleset version's rules by tag<br/>
Copy link
Contributor Author

@pedrosousa pedrosousa Jul 24, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Renamed according to the name in the API schema.

`GET /accounts/{account_id}/rulesets/{ruleset_id}/versions/{version_number}/by_tag/{tag_name}`

### Example

Expand Down