Skip to content
Cloudflare API
Start here
API Reference
Magic Transit
Sites

ACLs

List Site ACLs
client.magicTransit.sites.acls.list(stringsiteId, ACLListParams { account_id } params, RequestOptionsoptions?): SinglePage<ACL { id, description, forward_locally, 5 more } >
GET/accounts/{account_id}/magic/sites/{site_id}/acls
Site ACL Details
client.magicTransit.sites.acls.get(stringsiteId, stringaclId, ACLGetParams { account_id } params, RequestOptionsoptions?): ACL { id, description, forward_locally, 5 more }
GET/accounts/{account_id}/magic/sites/{site_id}/acls/{acl_id}
Create a new Site ACL
client.magicTransit.sites.acls.create(stringsiteId, ACLCreateParams { account_id, lan_1, lan_2, 5 more } params, RequestOptionsoptions?): ACL { id, description, forward_locally, 5 more }
POST/accounts/{account_id}/magic/sites/{site_id}/acls
Update Site ACL
client.magicTransit.sites.acls.update(stringsiteId, stringaclId, ACLUpdateParams { account_id, description, forward_locally, 5 more } params, RequestOptionsoptions?): ACL { id, description, forward_locally, 5 more }
PUT/accounts/{account_id}/magic/sites/{site_id}/acls/{acl_id}
Patch Site ACL
client.magicTransit.sites.acls.edit(stringsiteId, stringaclId, ACLEditParams { account_id, description, forward_locally, 5 more } params, RequestOptionsoptions?): ACL { id, description, forward_locally, 5 more }
PATCH/accounts/{account_id}/magic/sites/{site_id}/acls/{acl_id}
Delete Site ACL
client.magicTransit.sites.acls.delete(stringsiteId, stringaclId, ACLDeleteParams { account_id } params, RequestOptionsoptions?): ACL { id, description, forward_locally, 5 more }
DELETE/accounts/{account_id}/magic/sites/{site_id}/acls/{acl_id}
ModelsExpand Collapse
ACL { id, description, forward_locally, 5 more }

Bidirectional ACL policy for network traffic within a site.

id?: string

Identifier

maxLength32
description?: string

Description for the ACL.

forward_locally?: boolean

The desired forwarding action for this ACL policy. If set to “false”, the policy will forward traffic to Cloudflare. If set to “true”, the policy will forward traffic locally on the Magic Connector. If not included in request, will default to false.

lan_1?: ACLConfiguration { lan_id, lan_name, port_ranges, 2 more }
lan_2?: ACLConfiguration { lan_id, lan_name, port_ranges, 2 more }
name?: string

The name of the ACL.

protocols?: Array<AllowedProtocol>
One of the following:
"tcp"
"udp"
"icmp"
unidirectional?: boolean

The desired traffic direction for this ACL policy. If set to “false”, the policy will allow bidirectional traffic. If set to “true”, the policy will only allow traffic in one direction. If not included in request, will default to false.

ACLConfiguration { lan_id, lan_name, port_ranges, 2 more }
lan_id: string

The identifier for the LAN you want to create an ACL policy with.

lan_name?: string

The name of the LAN based on the provided lan_id.

port_ranges?: Array<string>

Array of port ranges on the provided LAN that will be included in the ACL. If no ports or port rangess are provided, communication on any port on this LAN is allowed.

ports?: Array<number>

Array of ports on the provided LAN that will be included in the ACL. If no ports or port ranges are provided, communication on any port on this LAN is allowed.

subnets?: Array<Subnet>

Array of subnet IPs within the LAN that will be included in the ACL. If no subnets are provided, communication on any subnets on this LAN are allowed.

AllowedProtocol = "tcp" | "udp" | "icmp"

Array of allowed communication protocols between configured LANs. If no protocols are provided, all protocols are allowed.

One of the following:
"tcp"
"udp"
"icmp"
Subnet = string

A valid IPv4 address.