Get an ACL rule

get

Authorizations

cookieapi_token

defguard_sessionstringRequired

Path parameters

idinteger · int64Required

ID of the ACL rule.

Responses

200

ACL rule details.

application/json

An ACL rule. All relations represented as arrays of IDs.

addressesstringRequired

aliasesinteger · int64[]Required

all_locationsbooleanRequired

allow_all_groupsbooleanRequired

allow_all_network_devicesbooleanRequired

allow_all_usersbooleanRequired

allowed_groupsinteger · int64[]Required

allowed_network_devicesinteger · int64[]Required

allowed_usersinteger · int64[]Required

any_addressbooleanRequired

any_portbooleanRequired

any_protocolbooleanRequired

denied_groupsinteger · int64[]Required

denied_network_devicesinteger · int64[]Required

denied_usersinteger · int64[]Required

deny_all_groupsbooleanRequired

deny_all_network_devicesbooleanRequired

deny_all_usersbooleanRequired

destinationsinteger · int64[]Required

enabledbooleanRequired

expiresstring · nullableOptional

idinteger · int64Required

locationsinteger · int64[]Required

modified_atstring · date-timeRequired

modified_bystringRequired

namestringRequired

parent_idinteger · int64 · nullableOptional

portsstringRequired

protocolsinteger · int32[]Required

statestring · enumRequired

ACL rule can be in one of the following states:

• New: the rule has been created and not yet applied
• Modified: the rule has been modified and not yet applied
• Deleted: the rule has been marked for deletion but not yed removed
• Applied: the rule was applied
• Expired: the rule is past it's expiration date

Applied state does NOT guarantee that all locations have received the rule and performed appropriate operations, only that the next time configuration is being sent it will include this rule.

Possible values:

use_manual_destination_settingsbooleanRequired

401

Session is missing or invalid.

application/json

403

Requires admin privileges and an active enterprise license.

application/json

404

ACL rule not found.

500

Unable to get ACL rule.

application/json

get/api/v1/acl/rule/{id}

HTTPcURLJavaScriptPython

GET /api/v1/acl/rule/{id} HTTP/1.1
Accept: */*

{
  "addresses": "text",
  "aliases": [
    1
  ],
  "all_locations": true,
  "allow_all_groups": true,
  "allow_all_network_devices": true,
  "allow_all_users": true,
  "allowed_groups": [
    1
  ],
  "allowed_network_devices": [
    1
  ],
  "allowed_users": [
    1
  ],
  "any_address": true,
  "any_port": true,
  "any_protocol": true,
  "denied_groups": [
    1
  ],
  "denied_network_devices": [
    1
  ],
  "denied_users": [
    1
  ],
  "deny_all_groups": true,
  "deny_all_network_devices": true,
  "deny_all_users": true,
  "destinations": [
    1
  ],
  "enabled": true,
  "expires": null,
  "id": 1,
  "locations": [
    1
  ],
  "modified_at": "2026-08-08T03:31:29.285Z",
  "modified_by": "text",
  "name": "text",
  "parent_id": null,
  "ports": "text",
  "protocols": [
    1
  ],
  "state": "New",
  "use_manual_destination_settings": true
}