Skip to content

docs(waf): add API documentation for WAF Exceptions and update termin… - #2212

Merged
egermano merged 1 commit into
mainfrom
EDU-6664-waf-exceptions-api-endpoints
Jun 25, 2026
Merged

docs(waf): add API documentation for WAF Exceptions and update termin…#2212
egermano merged 1 commit into
mainfrom
EDU-6664-waf-exceptions-api-endpoints

Conversation

@gabriel-alves-azion

@gabriel-alves-azion gabriel-alves-azion commented Jun 25, 2026

Copy link
Copy Markdown
Contributor

…ology

  • Rename "Custom Allowed Rules" to "Exceptions" to align with API terminology
  • Add comprehensive API documentation for managing WAF Exceptions programmatically
  • Include endpoints for listing, creating, retrieving, updating, and deleting exceptions
  • Add note clarifying that "Exceptions" (API) and "Allowed Rules" (Console) refer to the same functionality
  • Update both English and Portuguese documentation

Related issue: EDU-6664

I've updated the WAF documentation to include the new Exceptions API endpoints. Here's a summary of the changes:

Files Modified

English Documentation

  1. custom-allowed-rule.mdx

    • Updated title from "WAF Custom Allowed Rules" to "WAF Exceptions"
    • Added note explaining the terminology change (Allowed Rules in Console = Exceptions in API)
    • Added comprehensive "Managing Exceptions via API" section with:
      • API endpoint table (List, Create, Retrieve, Update, Partial update, Delete)
      • Code examples for each operation
      • Exception object fields reference table
      • Tip about automation use cases
  2. web-application-firewall.mdx

    • Added note about Exceptions terminology in the Allowed Rules section
    • Added "Managing Exceptions via API" subsection with links to detailed documentation

Portuguese Documentation (PT-BR)

  1. waf-custom-allowed-rules.mdx

    • Updated title from "WAF Custom Allowed Rules" to "Exceções do WAF"
    • Added note explaining the terminology change
    • Added comprehensive "Gerenciando Exceções via API" section with all API examples translated
  2. web-application-firewall.mdx

    • Added note about Exceções terminology in the Allowed Rules section
    • Added "Gerenciando Exceções via API" subsection with links to detailed documentation

API Endpoints Documented

Operation Endpoint
List GET /v4/edge_firewall/wafs/{waf_id}/exceptions
Create POST /v4/edge_firewall/wafs/{waf_id}/exceptions
Retrieve GET /v4/edge_firewall/wafs/{waf_id}/exceptions/{exception_id}
Update PUT /v4/edge_firewall/wafs/{waf_id}/exceptions/{exception_id}
Partial update PATCH /v4/edge_firewall/wafs/{waf_id}/exceptions/{exception_id}
Delete DELETE /v4/edge_firewall/wafs/{waf_id}/exceptions/{exception_id}

All documentation links point to the official API reference at https://api.azion.com/v4#/operations/list_waf_exceptions.

Changes

Additional links

…ology

- Rename "Custom Allowed Rules" to "Exceptions" to align with API terminology
- Add comprehensive API documentation for managing WAF Exceptions programmatically
- Include endpoints for listing, creating, retrieving, updating, and deleting exceptions
- Add note clarifying that "Exceptions" (API) and "Allowed Rules" (Console) refer to the same functionality
- Update both English and Portuguese documentation
@gabriel-alves-azion
gabriel-alves-azion requested a review from a team as a code owner June 25, 2026 16:30
@egermano
egermano merged commit 79e68f1 into main Jun 25, 2026
3 checks passed
@egermano
egermano deleted the EDU-6664-waf-exceptions-api-endpoints branch June 25, 2026 20:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

2 participants