diff --git a/src/content/docs/ruleset-engine/rulesets-api/add-rule.mdx b/src/content/docs/ruleset-engine/rulesets-api/add-rule.mdx index 6f134c89332952a..d9dde7b119972bc 100644 --- a/src/content/docs/ruleset-engine/rulesets-api/add-rule.mdx +++ b/src/content/docs/ruleset-engine/rulesets-api/add-rule.mdx @@ -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/)
+ `POST /accounts/{account_id}/rulesets/{ruleset_id}/rules` +- [Create a zone ruleset rule](/api/resources/rulesets/subresources/rules/methods/create/)
+ `POST /zones/{zone_id}/rulesets/{ruleset_id}/rules` Include the rule definition in the request body. diff --git a/src/content/docs/ruleset-engine/rulesets-api/create.mdx b/src/content/docs/ruleset-engine/rulesets-api/create.mdx index fa8971d4e592f27..20fdf0bcd177e34 100644 --- a/src/content/docs/ruleset-engine/rulesets-api/create.mdx +++ b/src/content/docs/ruleset-engine/rulesets-api/create.mdx @@ -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/)
+ `POST /accounts/{account_id}/rulesets` +- [Create a zone ruleset](/api/resources/rulesets/methods/create/)
+ `POST /zones/{zone_id}/rulesets` The following parameters are required: diff --git a/src/content/docs/ruleset-engine/rulesets-api/delete-rule.mdx b/src/content/docs/ruleset-engine/rulesets-api/delete-rule.mdx index b0f7f413edd6bf3..c68d742e4393a9a 100644 --- a/src/content/docs/ruleset-engine/rulesets-api/delete-rule.mdx +++ b/src/content/docs/ruleset-engine/rulesets-api/delete-rule.mdx @@ -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/)
+ `DELETE /accounts/{account_id}/rulesets/{ruleset_id}/rules/{rule_id}` +- [Delete a zone ruleset rule](/api/resources/rulesets/subresources/rules/methods/delete/)
+ `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. diff --git a/src/content/docs/ruleset-engine/rulesets-api/delete.mdx b/src/content/docs/ruleset-engine/rulesets-api/delete.mdx index b32dc208b253fb5..5db36bda472daf3 100644 --- a/src/content/docs/ruleset-engine/rulesets-api/delete.mdx +++ b/src/content/docs/ruleset-engine/rulesets-api/delete.mdx @@ -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/)
+ `DELETE /accounts/{account_id}/rulesets/{ruleset_id}` +- [Delete a zone ruleset](/api/resources/rulesets/methods/delete/)
+ `DELETE /zones/{zone_id}/rulesets/{ruleset_id}` If the delete operation succeeds, the API method call returns a `204 No Content` HTTP status code. @@ -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/)
+ `DELETE /accounts/{account_id}/rulesets/{ruleset_id}/versions/{version_number}` +- [Delete a zone ruleset version](/api/resources/rulesets/subresources/versions/methods/delete/)
+ `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. diff --git a/src/content/docs/ruleset-engine/rulesets-api/update-rule.mdx b/src/content/docs/ruleset-engine/rulesets-api/update-rule.mdx index 464f7a883c1fb86..1fda550288b8fc1 100644 --- a/src/content/docs/ruleset-engine/rulesets-api/update-rule.mdx +++ b/src/content/docs/ruleset-engine/rulesets-api/update-rule.mdx @@ -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/)
+ `PATCH /accounts/{account_id}/rulesets/{ruleset_id}/rules/{rule_id}` +- [Update a zone ruleset rule](/api/resources/rulesets/subresources/rules/methods/edit/)
+ `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. diff --git a/src/content/docs/ruleset-engine/rulesets-api/update.mdx b/src/content/docs/ruleset-engine/rulesets-api/update.mdx index 8cca3fe5df232aa..5ee23e55a776603 100644 --- a/src/content/docs/ruleset-engine/rulesets-api/update.mdx +++ b/src/content/docs/ruleset-engine/rulesets-api/update.mdx @@ -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/)
+ `PUT /accounts/{account_id}/rulesets/{ruleset_id}` +- [Update an account entry point ruleset](/api/resources/rulesets/subresources/phases/methods/update/)
+ `PUT /accounts/{account_id}/rulesets/phases/{phase_name}/entrypoint` +- [Update a zone ruleset](/api/resources/rulesets/methods/update/)
+ `PUT /zones/{zone_id}/rulesets/{ruleset_id}` +- [Update a zone entry point ruleset](/api/resources/rulesets/subresources/phases/methods/update/)
+ `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. diff --git a/src/content/docs/ruleset-engine/rulesets-api/view.mdx b/src/content/docs/ruleset-engine/rulesets-api/view.mdx index 9fe196dd135407a..6d57153e5513c98 100644 --- a/src/content/docs/ruleset-engine/rulesets-api/view.mdx +++ b/src/content/docs/ruleset-engine/rulesets-api/view.mdx @@ -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/)
+ `GET /accounts/{account_id}/rulesets` +- [List zone rulesets](/api/resources/rulesets/methods/list/)
+ `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. @@ -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/)
+ `GET /accounts/{account_id}/rulesets/{ruleset_id}` +- [Get an account entry point ruleset](/api/resources/rulesets/subresources/phases/methods/get/)
+ `GET /accounts/{account_id}/rulesets/phases/{phase_name}/entrypoint` +- [Get a zone ruleset](/api/resources/rulesets/methods/get/)
+ `GET /zones/{zone_id}/rulesets/{ruleset_id}` +- [Get a zone entry point ruleset](/api/resources/rulesets/subresources/phases/methods/get/)
+ `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`). @@ -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/)
+ `GET /accounts/{account_id}/rulesets/{ruleset_id}/versions` +- [List account entry point ruleset versions](/api/resources/rulesets/subresources/phases/subresources/versions/methods/list/)
+ `GET /accounts/{account_id}/rulesets/phases/{phase_name}/entrypoint/versions` +- [List zone ruleset versions](/api/resources/rulesets/subresources/versions/methods/list/)
+ `GET /zones/{zone_id}/rulesets/{ruleset_id}/versions` +- [List zone entry point ruleset versions](/api/resources/rulesets/subresources/phases/subresources/versions/methods/list/)
+ `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. @@ -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/)
+ `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/)
+ `GET /accounts/{account_id}/rulesets/phases/{phase_name}/entrypoint/versions/{version_number}` +- [Get a zone ruleset version](/api/resources/rulesets/subresources/versions/methods/get/)
+ `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/)
+ `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. @@ -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
+ `GET /accounts/{account_id}/rulesets/{ruleset_id}/versions/{version_number}/by_tag/{tag_name}` ### Example