Firewall policy — rules, objects, change management, audits, NAT, automation, and WAF exceptions. Auto-generated from the platform OpenAPI schema so it matches the running API.
REST API for this feature — 121 operations across 67 resource paths, auto-generated from the platform's live OpenAPI schema (drf-spectacular).
Base URL
https://<your-versus-host>/api· AuthAuthorization: Bearer <JWT>(fromPOST /api/auth/token/) · 📄 Download the OpenAPI spec for Postman/Insomnia/Swagger · see the API overview for pagination, filtering, and errors.
POST /api/policy/analyze/POST /api/policy/analyze/
Responses: 200
GET /api/policy/controls/CRUD for compliance controls.
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
check_type | query | no | string | * rule_predicate - Rule Predicate |
enabled | query | no | boolean | |
framework | query | no | string | * pci_dss - PCI DSS |
is_builtin | query | no | boolean | |
ordering | query | no | string | Which field to use when ordering the results. |
page | query | no | integer | A page number within the paginated result set. |
page_size | query | no | integer | Number of results to return per page. |
search | query | no | string | A search term. |
Responses: 200 → PaginatedComplianceControlList
POST /api/policy/controls/CRUD for compliance controls.
Request body (application/json): ComplianceControlRequest
Responses: 201 → ComplianceControl
GET /api/policy/controls/{id}/CRUD for compliance controls.
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this compliance control. |
Responses: 200 → ComplianceControl
PUT /api/policy/controls/{id}/CRUD for compliance controls.
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this compliance control. |
Request body (application/json): ComplianceControlRequest
Responses: 200 → ComplianceControl
PATCH /api/policy/controls/{id}/CRUD for compliance controls.
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this compliance control. |
Request body (application/json): PatchedComplianceControlRequest
Responses: 200 → ComplianceControl
DELETE /api/policy/controls/{id}/CRUD for compliance controls.
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this compliance control. |
Responses: 204
GET /api/policy/exceptions/CRUD for policy exceptions.
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
approved_by | query | no | integer | |
is_active | query | no | boolean | |
ordering | query | no | string | Which field to use when ordering the results. |
page | query | no | integer | A page number within the paginated result set. |
page_size | query | no | integer | Number of results to return per page. |
search | query | no | string | A search term. |
violation | query | no | integer |
Responses: 200 → PaginatedPolicyExceptionList
POST /api/policy/exceptions/CRUD for policy exceptions.
Request body (application/json): PolicyExceptionRequest
Responses: 201 → PolicyException
GET /api/policy/exceptions/{id}/CRUD for policy exceptions.
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this policy exception. |
Responses: 200 → PolicyException
PUT /api/policy/exceptions/{id}/CRUD for policy exceptions.
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this policy exception. |
Request body (application/json): PolicyExceptionRequest
Responses: 200 → PolicyException
PATCH /api/policy/exceptions/{id}/CRUD for policy exceptions.
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this policy exception. |
Request body (application/json): PatchedPolicyExceptionRequest
Responses: 200 → PolicyException
DELETE /api/policy/exceptions/{id}/CRUD for policy exceptions.
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this policy exception. |
Responses: 204
GET /api/policy/exposure/GET /api/policy/exposure/
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
cve_id | query | no | string | |
device | query | no | integer | |
ordering | query | no | string | Which field to use when ordering the results. |
page | query | no | integer | A page number within the paginated result set. |
page_size | query | no | integer | Number of results to return per page. |
reachable_from_zone | query | no | string | |
search | query | no | string | A search term. |
Responses: 200 → PaginatedExposureFindingList
GET /api/policy/exposure/{id}/GET /api/policy/exposure/
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this exposure finding. |
Responses: 200 → ExposureFinding
GET /api/policy/findings/GET/PATCH /api/policy/findings/
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
device | query | no | integer | |
finding_type | query | no | string | * unused - Unused |
ordering | query | no | string | Which field to use when ordering the results. |
page | query | no | integer | A page number within the paginated result set. |
page_size | query | no | integer | Number of results to return per page. |
search | query | no | string | A search term. |
severity | query | no | string | * critical - Critical |
status | query | no | string | * open - Open |
Responses: 200 → PaginatedRuleFindingList
GET /api/policy/findings/{id}/GET/PATCH /api/policy/findings/
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this rule finding. |
Responses: 200 → RuleFinding
PATCH /api/policy/findings/{id}/GET/PATCH /api/policy/findings/
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this rule finding. |
Request body (application/json): PatchedRuleFindingRequest
Responses: 200 → RuleFinding
GET /api/firewall-audits/List firewall audits
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
audit_type | query | no | string | * pci_dss_v4 - PCI DSS v4.0 |
device | query | no | integer | |
ordering | query | no | string | Which field to use when ordering the results. |
page | query | no | integer | A page number within the paginated result set. |
page_size | query | no | integer | Number of results to return per page. |
search | query | no | string | A search term. |
status | query | no | string | * running - Running |
Responses: 200 → PaginatedFirewallAuditRunList
GET /api/firewall-audits/checklist/Return the full PCI DSS v4.0 checklist definition with descriptions and severity.
Responses: 200 → FirewallAuditRun
POST /api/firewall-audits/run_all/Run PCI audit on every firewall/ADC device, optionally scoped to a device group.
Request body (application/json): FirewallAuditRunRequest
Responses: 200 → FirewallAuditRun
POST /api/firewall-audits/run_audit/Create run audit
Request body (application/json): FirewallAuditRunRequest
Responses: 200 → FirewallAuditRun
GET /api/firewall-audits/{id}/Retrieve firewall audit
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this firewall audit run. |
Responses: 200 → FirewallAuditRun
GET /api/firewall-audits/{id}/findings/Findings: firewall audit
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this firewall audit run. |
Responses: 200 → FirewallAuditRun
GET /api/firewall-automation/access-requests/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
ordering | query | no | string | Which field to use when ordering the results. |
search | query | no | string | A search term. |
Responses: 200 → AccessRequestList[]
POST /api/firewall-automation/access-requests/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
Request body (application/json): AccessRequestRequest
Responses: 201 → AccessRequest
GET /api/firewall-automation/access-requests/{id}/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this access request. |
Responses: 200 → AccessRequest
PUT /api/firewall-automation/access-requests/{id}/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this access request. |
Request body (application/json): AccessRequestRequest
Responses: 200 → AccessRequest
PATCH /api/firewall-automation/access-requests/{id}/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this access request. |
Request body (application/json): PatchedAccessRequestRequest
Responses: 200 → AccessRequest
DELETE /api/firewall-automation/access-requests/{id}/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this access request. |
Responses: 204
POST /api/firewall-automation/access-requests/{id}/approve/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this access request. |
Request body (application/json): AccessRequestRequest
Responses: 200 → AccessRequest
POST /api/firewall-automation/access-requests/{id}/reject/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this access request. |
Request body (application/json): AccessRequestRequest
Responses: 200 → AccessRequest
POST /api/firewall-automation/access-requests/{id}/retry_path/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this access request. |
Request body (application/json): AccessRequestRequest
Responses: 200 → AccessRequest
GET /api/firewall-automation/access-requests/{id}/timeline/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this access request. |
Responses: 200 → AccessRequest
POST /api/firewall-automation/snow-webhook/Create snow webhook
Responses: 200
GET /api/firewall-changes/List firewall changes
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
change_type | query | no | string | * create - Create Rule |
device | query | no | integer | |
ordering | query | no | string | Which field to use when ordering the results. |
page | query | no | integer | A page number within the paginated result set. |
page_size | query | no | integer | Number of results to return per page. |
search | query | no | string | A search term. |
status | query | no | string | * pending_snow - Creating SNOW CHG |
Responses: 200 → PaginatedFirewallChangeRequestList
GET /api/firewall-changes/{id}/Retrieve firewall change
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this firewall change request. |
Responses: 200 → FirewallChangeRequest
POST /api/firewall-changes/{id}/cancel/Cancel a pending change request and close the SNOW CHG.
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this firewall change request. |
Request body (application/json): FirewallChangeRequestRequest
Responses: 200 → FirewallChangeRequest
POST /api/firewall-changes/{id}/check_approval/Poll ServiceNow for approval status and update the change record.
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this firewall change request. |
Request body (application/json): FirewallChangeRequestRequest
Responses: 200 → FirewallChangeRequest
POST /api/firewall-changes/{id}/execute/Execute an approved change (checks SNOW approval first).
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this firewall change request. |
Request body (application/json): FirewallChangeRequestRequest
Responses: 200 → FirewallChangeRequest
GET /api/firewall-objects/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
device | query | no | integer | |
name | query | no | string | |
object_type | query | no | string | * address - Address |
ordering | query | no | string | Which field to use when ordering the results. |
page | query | no | integer | A page number within the paginated result set. |
page_size | query | no | integer | Number of results to return per page. |
search | query | no | string | A search term. |
vsys | query | no | string |
Responses: 200 → PaginatedFirewallObjectList
POST /api/firewall-objects/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
Request body (application/json): FirewallObjectRequest
Responses: 201 → FirewallObject
GET /api/firewall-objects/resolve/Recursively resolve an address object/group to a flat list of IPs/CIDRs.
Responses: 200 → FirewallObject
GET /api/firewall-objects/{id}/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this firewall object. |
Responses: 200 → FirewallObject
PUT /api/firewall-objects/{id}/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this firewall object. |
Request body (application/json): FirewallObjectRequest
Responses: 200 → FirewallObject
PATCH /api/firewall-objects/{id}/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this firewall object. |
Request body (application/json): PatchedFirewallObjectRequest
Responses: 200 → FirewallObject
DELETE /api/firewall-objects/{id}/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this firewall object. |
Responses: 204
GET /api/firewall-rule-sets/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
device | query | no | integer | |
ordering | query | no | string | Which field to use when ordering the results. |
page | query | no | integer | A page number within the paginated result set. |
page_size | query | no | integer | Number of results to return per page. |
rule_type | query | no | string | |
search | query | no | string | A search term. |
vsys | query | no | string |
Responses: 200 → PaginatedFirewallRuleSetList
POST /api/firewall-rule-sets/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
Request body (application/json): FirewallRuleSetRequest
Responses: 201 → FirewallRuleSet
GET /api/firewall-rule-sets/{id}/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this firewall rule set. |
Responses: 200 → FirewallRuleSet
PUT /api/firewall-rule-sets/{id}/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this firewall rule set. |
Request body (application/json): FirewallRuleSetRequest
Responses: 200 → FirewallRuleSet
PATCH /api/firewall-rule-sets/{id}/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this firewall rule set. |
Request body (application/json): PatchedFirewallRuleSetRequest
Responses: 200 → FirewallRuleSet
DELETE /api/firewall-rule-sets/{id}/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this firewall rule set. |
Responses: 204
GET /api/firewall-rules/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
action | query | no | string | * allow - Allow |
device | query | no | integer | |
enabled | query | no | boolean | |
ordering | query | no | string | Which field to use when ordering the results. |
page | query | no | integer | A page number within the paginated result set. |
page_size | query | no | integer | Number of results to return per page. |
rule_set | query | no | integer | |
search | query | no | string | A search term. |
Responses: 200 → PaginatedFirewallRuleList
POST /api/firewall-rules/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
Request body (application/json): FirewallRuleRequest
Responses: 201 → FirewallRule
POST /api/firewall-rules/sync_hit_counts/Pull rule hit counts from Panorama and update hit_count / last_hit on each rule.
Request body (application/json): FirewallRuleRequest
Responses: 200 → FirewallRule
GET /api/firewall-rules/{id}/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this firewall rule. |
Responses: 200 → FirewallRule
PUT /api/firewall-rules/{id}/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this firewall rule. |
Request body (application/json): FirewallRuleRequest
Responses: 200 → FirewallRule
PATCH /api/firewall-rules/{id}/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this firewall rule. |
Request body (application/json): PatchedFirewallRuleRequest
Responses: 200 → FirewallRule
DELETE /api/firewall-rules/{id}/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this firewall rule. |
Responses: 204
POST /api/firewall-rules/{id}/push_to_device/Gate a push-to-device behind a ServiceNow change request.
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this firewall rule. |
Request body (application/json): FirewallRuleRequest
Responses: 200 → FirewallRule
POST /api/firewall-rules/{id}/toggle_enabled/Gate enable/disable behind a ServiceNow change request.
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this firewall rule. |
Request body (application/json): FirewallRuleRequest
Responses: 200 → FirewallRule
POST /api/policy/impact-analysis/POST /api/policy/impact-analysis/
Responses: 200
GET /api/nat-rules/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
device | query | no | integer | |
enabled | query | no | boolean | |
nat_type | query | no | string | * static - Static NAT |
ordering | query | no | string | Which field to use when ordering the results. |
page | query | no | integer | A page number within the paginated result set. |
page_size | query | no | integer | Number of results to return per page. |
search | query | no | string | A search term. |
Responses: 200 → PaginatedNatRuleList
POST /api/nat-rules/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
Request body (application/json): NatRuleRequest
Responses: 201 → NatRule
GET /api/nat-rules/{id}/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this nat rule. |
Responses: 200 → NatRule
PUT /api/nat-rules/{id}/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this nat rule. |
Request body (application/json): NatRuleRequest
Responses: 200 → NatRule
PATCH /api/nat-rules/{id}/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this nat rule. |
Request body (application/json): PatchedNatRuleRequest
Responses: 200 → NatRule
DELETE /api/nat-rules/{id}/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this nat rule. |
Responses: 204
GET /api/policies/List policys
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
device | query | no | integer | |
ordering | query | no | string | Which field to use when ordering the results. |
page | query | no | integer | A page number within the paginated result set. |
page_size | query | no | integer | Number of results to return per page. |
partition | query | no | string | |
search | query | no | string | A search term. |
Responses: 200 → PaginatedLtmPolicyList
GET /api/policies/{id}/Retrieve policy
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this ltm policy. |
Responses: 200 → LtmPolicy
GET /api/policy/recert/Full CRUD + transition actions for recertification reviews.
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
assigned_to | query | no | integer | |
ordering | query | no | string | Which field to use when ordering the results. |
page | query | no | integer | A page number within the paginated result set. |
page_size | query | no | integer | Number of results to return per page. |
search | query | no | string | A search term. |
status | query | no | string | * open - Open |
trigger | query | no | string | * scheduled - Scheduled |
Responses: 200 → PaginatedRecertReviewList
POST /api/policy/recert/Full CRUD + transition actions for recertification reviews.
Request body (application/json): RecertReviewRequest
Responses: 201 → RecertReview
GET /api/policy/recert/{id}/Full CRUD + transition actions for recertification reviews.
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this recert review. |
Responses: 200 → RecertReview
PUT /api/policy/recert/{id}/Full CRUD + transition actions for recertification reviews.
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this recert review. |
Request body (application/json): RecertReviewRequest
Responses: 200 → RecertReview
PATCH /api/policy/recert/{id}/Full CRUD + transition actions for recertification reviews.
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this recert review. |
Request body (application/json): PatchedRecertReviewRequest
Responses: 200 → RecertReview
DELETE /api/policy/recert/{id}/Full CRUD + transition actions for recertification reviews.
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this recert review. |
Responses: 204
POST /api/policy/recert/{id}/assign/Full CRUD + transition actions for recertification reviews.
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this recert review. |
Request body (application/json): RecertReviewRequest
Responses: 200 → RecertReview
POST /api/policy/recert/{id}/certify/Full CRUD + transition actions for recertification reviews.
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this recert review. |
Request body (application/json): RecertReviewRequest
Responses: 200 → RecertReview
POST /api/policy/recert/{id}/decertify/Full CRUD + transition actions for recertification reviews.
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this recert review. |
Request body (application/json): RecertReviewRequest
Responses: 200 → RecertReview
POST /api/policy/recert/{id}/request-modify/Full CRUD + transition actions for recertification reviews.
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this recert review. |
Request body (application/json): RecertReviewRequest
Responses: 200 → RecertReview
GET /api/policy/rule-meta/GET/POST/PATCH /api/policy/rule-meta/
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
certification_status | query | no | string | * never_reviewed - Never Reviewed |
ordering | query | no | string | Which field to use when ordering the results. |
owner | query | no | integer | |
page | query | no | integer | A page number within the paginated result set. |
page_size | query | no | integer | Number of results to return per page. |
rule | query | no | integer | |
search | query | no | string | A search term. |
Responses: 200 → PaginatedRuleMetaList
POST /api/policy/rule-meta/GET/POST/PATCH /api/policy/rule-meta/
Request body (application/json): RuleMetaRequest
Responses: 201 → RuleMeta
POST /api/policy/rule-meta/bulk-assign-owner/GET/POST/PATCH /api/policy/rule-meta/
Request body (application/json): RuleMetaRequest
Responses: 200 → RuleMeta
GET /api/policy/rule-meta/{id}/GET/POST/PATCH /api/policy/rule-meta/
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this rule meta. |
Responses: 200 → RuleMeta
PUT /api/policy/rule-meta/{id}/GET/POST/PATCH /api/policy/rule-meta/
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this rule meta. |
Request body (application/json): RuleMetaRequest
Responses: 200 → RuleMeta
PATCH /api/policy/rule-meta/{id}/GET/POST/PATCH /api/policy/rule-meta/
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this rule meta. |
Request body (application/json): PatchedRuleMetaRequest
Responses: 200 → RuleMeta
DELETE /api/policy/rule-meta/{id}/GET/POST/PATCH /api/policy/rule-meta/
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this rule meta. |
Responses: 204
GET /api/policy/seg-policy/CRUD + activate action for segmentation policies.
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
ordering | query | no | string | Which field to use when ordering the results. |
page | query | no | integer | A page number within the paginated result set. |
page_size | query | no | integer | Number of results to return per page. |
search | query | no | string | A search term. |
status | query | no | string | * draft - Draft |
Responses: 200 → PaginatedSegmentationPolicyList
POST /api/policy/seg-policy/CRUD + activate action for segmentation policies.
Request body (application/json): SegmentationPolicyRequest
Responses: 201 → SegmentationPolicy
GET /api/policy/seg-policy/{id}/CRUD + activate action for segmentation policies.
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this segmentation policy. |
Responses: 200 → SegmentationPolicy
PUT /api/policy/seg-policy/{id}/CRUD + activate action for segmentation policies.
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this segmentation policy. |
Request body (application/json): SegmentationPolicyRequest
Responses: 200 → SegmentationPolicy
PATCH /api/policy/seg-policy/{id}/CRUD + activate action for segmentation policies.
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this segmentation policy. |
Request body (application/json): PatchedSegmentationPolicyRequest
Responses: 200 → SegmentationPolicy
DELETE /api/policy/seg-policy/{id}/CRUD + activate action for segmentation policies.
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this segmentation policy. |
Responses: 204
POST /api/policy/seg-policy/{id}/activate/CRUD + activate action for segmentation policies.
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this segmentation policy. |
Request body (application/json): SegmentationPolicyRequest
Responses: 200 → SegmentationPolicy
GET /api/policy/usage/GET /api/policy/usage/
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
device | query | no | integer | |
ordering | query | no | string | Which field to use when ordering the results. |
page | query | no | integer | A page number within the paginated result set. |
page_size | query | no | integer | Number of results to return per page. |
rule_uid | query | no | string | |
search | query | no | string | A search term. |
Responses: 200 → PaginatedRuleUsageStateList
GET /api/policy/usage/{id}/GET /api/policy/usage/
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this rule usage state. |
Responses: 200 → RuleUsageState
GET /api/policy/violations/CRUD + add_exception action for compliance violations.
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
control | query | no | integer | |
device | query | no | integer | |
ordering | query | no | string | Which field to use when ordering the results. |
page | query | no | integer | A page number within the paginated result set. |
page_size | query | no | integer | Number of results to return per page. |
search | query | no | string | A search term. |
status | query | no | string | * open - Open |
Responses: 200 → PaginatedComplianceViolationList
GET /api/policy/violations/{id}/CRUD + add_exception action for compliance violations.
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this compliance violation. |
Responses: 200 → ComplianceViolation
PATCH /api/policy/violations/{id}/CRUD + add_exception action for compliance violations.
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this compliance violation. |
Request body (application/json): PatchedComplianceViolationRequest
Responses: 200 → ComplianceViolation
GET /api/waf-exceptions/WAF exception requests go through a risk-tiered ServiceNow change +
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
ordering | query | no | string | Which field to use when ordering the results. |
page | query | no | integer | A page number within the paginated result set. |
page_size | query | no | integer | Number of results to return per page. |
search | query | no | string | A search term. |
status | query | no | string | * requested - Requested |
virtual_server | query | no | integer |
Responses: 200 → PaginatedWafExceptionList
POST /api/waf-exceptions/WAF exception requests go through a risk-tiered ServiceNow change +
Request body (application/json): WafExceptionRequest
Responses: 201 → WafException
POST /api/waf-exceptions/shadow-check/Preview endpoint (§4.4): runs the same shadow/conflict analysis
Request body (application/json): WafExceptionRequest
Responses: 200 → WafException
GET /api/waf-exceptions/{id}/WAF exception requests go through a risk-tiered ServiceNow change +
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this waf exception. |
Responses: 200 → WafException
PUT /api/waf-exceptions/{id}/WAF exception requests go through a risk-tiered ServiceNow change +
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this waf exception. |
Request body (application/json): WafExceptionRequest
Responses: 200 → WafException
PATCH /api/waf-exceptions/{id}/WAF exception requests go through a risk-tiered ServiceNow change +
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this waf exception. |
Request body (application/json): PatchedWafExceptionRequest
Responses: 200 → WafException
DELETE /api/waf-exceptions/{id}/WAF exception requests go through a risk-tiered ServiceNow change +
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this waf exception. |
Responses: 204
POST /api/waf-exceptions/{id}/retry/Starts a fresh apply-pipeline run for this exception — used when
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this waf exception. |
Request body (application/json): WafExceptionRequest
Responses: 200 → WafException
GET /api/waf-requests/List waf requests
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
device | query | no | integer | |
enforced | query | no | boolean | |
ordering | query | no | string | Which field to use when ordering the results. |
page | query | no | integer | A page number within the paginated result set. |
page_size | query | no | integer | Number of results to return per page. |
search | query | no | string | A search term. |
severity | query | no | string |
Responses: 200 → PaginatedWafRequestList
POST /api/waf-requests/Create waf request
Request body (application/json): WafRequestRequest
Responses: 201 → WafRequest
GET /api/waf-requests/summary/List summarys
Responses: 200 → WafRequest
GET /api/waf-requests/{id}/Retrieve waf request
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this waf request. |
Responses: 200 → WafRequest
PUT /api/waf-requests/{id}/Update waf request
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this waf request. |
Request body (application/json): WafRequestRequest
Responses: 200 → WafRequest
PATCH /api/waf-requests/{id}/Update waf request
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this waf request. |
Request body (application/json): PatchedWafRequestRequest
Responses: 200 → WafRequest
DELETE /api/waf-requests/{id}/Delete waf request
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this waf request. |
Responses: 204
GET /api/policy/zone-cells/CRUD for zone policy cells.
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
dst_zone | query | no | string | |
ordering | query | no | string | Which field to use when ordering the results. |
page | query | no | integer | A page number within the paginated result set. |
page_size | query | no | integer | Number of results to return per page. |
policy | query | no | integer | |
search | query | no | string | A search term. |
src_zone | query | no | string | |
stance | query | no | string | * allow_all - Allow All |
Responses: 200 → PaginatedZonePolicyCellList
POST /api/policy/zone-cells/CRUD for zone policy cells.
Request body (application/json): ZonePolicyCellRequest
Responses: 201 → ZonePolicyCell
GET /api/policy/zone-cells/{id}/CRUD for zone policy cells.
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this zone policy cell. |
Responses: 200 → ZonePolicyCell
PUT /api/policy/zone-cells/{id}/CRUD for zone policy cells.
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this zone policy cell. |
Request body (application/json): ZonePolicyCellRequest
Responses: 200 → ZonePolicyCell
PATCH /api/policy/zone-cells/{id}/CRUD for zone policy cells.
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this zone policy cell. |
Request body (application/json): PatchedZonePolicyCellRequest
Responses: 200 → ZonePolicyCell
DELETE /api/policy/zone-cells/{id}/CRUD for zone policy cells.
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this zone policy cell. |
Responses: 204
Auto-generated from drf-spectacular OpenAPI. Endpoint descriptions come from viewset docstrings/serializers; enriching those improves this page on the next generation.