--- title: Get a firewall rule --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/go) [Firewall](https://developers.cloudflare.com/api/go/resources/firewall) [Rules](https://developers.cloudflare.com/api/go/resources/firewall/subresources/rules) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Get a firewall rule Deprecated: The Firewall Rules API is deprecated in favour of using the Ruleset Engine. See https://developers.cloudflare.com/fundamentals/api/reference/deprecations/#firewall-rules-api-and-filters-api for full details. client.Firewall.Rules.Get(ctx, ruleID, query) (\*[FirewallRule](), error) GET/zones/{zone\_id}/firewall/rules/{rule\_id} **This endpoint has been deprecated and returns 410 Gone. Please use the [Rulesets API](https://developers.cloudflare.com/ruleset-engine/) instead.** Fetches the details of a firewall rule. ##### Security
API Token The preferred authorization scheme for interacting with the Cloudflare API. Create a token. **Example:**Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY
API Email + API Key The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key. **Example:**X-Auth-Email: user@example.com The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys. **Example:**X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194
##### Accepted Permissions (at least one required) `Firewall Services Write``Firewall Services Read` ##### ParametersExpand Collapse ruleID string The unique identifier of the firewall rule. maxLength32 [Link to this property](<#(resource)%20firewall.rules%20%3E%20(method)%20get%20%3E%20(params)%20default%20%3E%20(param)%20rule_id%20%3E%20(schema)>)
query RuleGetParams ZoneID param.Field\[string] Defines an identifier. maxLength32 Link to this property
[Link to this property](<#(resource)%20firewall.rules%20%3E%20(method)%20get%20%3E%20(params)%20default>) ##### ReturnsExpand Collapse
type FirewallRule struct{…} ID stringOptional The unique identifier of the firewall rule. maxLength32 Link to this property
Action ActionOptional The action to apply to a matched request. The log action is only available on an Enterprise plan. One of the following: const ActionBlock Action = "block" Link to this property const ActionChallenge Action = "challenge" Link to this property const ActionJSChallenge Action = "js\_challenge" Link to this property const ActionManagedChallenge Action = "managed\_challenge" Link to this property const ActionAllow Action = "allow" Link to this property const ActionLog Action = "log" Link to this property const ActionBypass Action = "bypass" Link to this property
Link to this property Description stringOptional An informative summary of the firewall rule. maxLength500 Link to this property
Filter FirewallRuleFilterOptional One of the following:
type FirewallFilter struct{…} ID stringOptional The unique identifier of the filter. maxLength32 minLength32 Link to this property Description stringOptional An informative summary of the filter. maxLength500 Link to this property Expression stringOptional The filter expression. For more information, refer to Expressions. Link to this property Paused boolOptional When true, indicates that the filter is currently paused. Link to this property Ref stringOptional A short reference tag. Allows you to select related filters. maxLength50 Link to this property
Link to this property
type DeletedFilter struct{…} ID string The unique identifier of the filter. maxLength32 minLength32 Link to this property Deleted bool When true, indicates that the firewall rule was deleted. Link to this property
Link to this property
Link to this property Paused boolOptional When true, indicates that the firewall rule is currently paused. Link to this property Priority float64Optional The priority of the rule. Optional value used to define the processing order. A lower number indicates a higher priority. If not provided, rules with a defined priority will be processed before rules without a priority. maximum2147483647 minimum0 Link to this property
Products \[]ProductOptional One of the following: const ProductZoneLockdown Product = "zoneLockdown" Link to this property const ProductUABlock Product = "uaBlock" Link to this property const ProductBIC Product = "bic" Link to this property const ProductHot Product = "hot" Link to this property const ProductSecurityLevel Product = "securityLevel" Link to this property const ProductRateLimit Product = "rateLimit" Link to this property const ProductWAF Product = "waf" Link to this property
Link to this property Ref stringOptional A short reference tag. Allows you to select related firewall rules. maxLength50 Link to this property
[Link to this property](<#(resource)%20firewall.rules%20%3E%20(model)%20firewall_rule%20%3E%20(schema)>) ### Get a firewall rule Go HTTPTypeScriptPythonGoTerraform ``` package main import ( "context" "fmt" "github.com/cloudflare/cloudflare-go" "github.com/cloudflare/cloudflare-go/firewall" "github.com/cloudflare/cloudflare-go/option" ) func main() { client := cloudflare.NewClient( option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"), ) firewallRule, err := client.Firewall.Rules.Get( context.TODO(), "372e67954025e0ba6aaa6d586b9e0b60", firewall.RuleGetParams{ ZoneID: cloudflare.F("023e105f4ecef8ad9ca31a8372d0c353"), }, ) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", firewallRule.ID) } ``` 200 example ``` { "errors": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "messages": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "result": { "id": "372e67954025e0ba6aaa6d586b9e0b60", "action": "block", "description": "Blocks traffic identified during investigation for MIR-31", "filter": { "id": "372e67954025e0ba6aaa6d586b9e0b61", "description": "Restrict access from these browsers on this address range.", "expression": "(http.request.uri.path ~ \".*wp-login.php\" or http.request.uri.path ~ \".*xmlrpc.php\") and ip.addr ne 172.16.22.155", "paused": false, "ref": "FIL-100" }, "paused": false, "priority": 50, "products": [ "waf" ], "ref": "MIR-31" }, "success": true } ``` ##### Returns Examples 200 example ``` { "errors": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "messages": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "result": { "id": "372e67954025e0ba6aaa6d586b9e0b60", "action": "block", "description": "Blocks traffic identified during investigation for MIR-31", "filter": { "id": "372e67954025e0ba6aaa6d586b9e0b61", "description": "Restrict access from these browsers on this address range.", "expression": "(http.request.uri.path ~ \".*wp-login.php\" or http.request.uri.path ~ \".*xmlrpc.php\") and ip.addr ne 172.16.22.155", "paused": false, "ref": "FIL-100" }, "paused": false, "priority": 50, "products": [ "waf" ], "ref": "MIR-31" }, "success": true } ```