--- title: List account or zone rulesets --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/go) [Rulesets](https://developers.cloudflare.com/api/go/resources/rulesets) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # List account or zone rulesets client.Rulesets.List(ctx, params) (\*CursorPagination\[[RulesetListResponse]()], error) GET/{accounts\_or\_zones}/{account\_or\_zone\_id}/rulesets Fetches all rulesets. ##### 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) `Mass URL Redirects Write``Mass URL Redirects Read``Magic Firewall Write``Magic Firewall Read``L4 DDoS Managed Ruleset Write``L4 DDoS Managed Ruleset Read``Transform Rules Write``Transform Rules Read``Select Configuration Write``Select Configuration Read``Account WAF Write``Account WAF Read``Account Rulesets Read``Account Rulesets Write``Logs Write``Logs Read` ##### ParametersExpand Collapse
params RulesetListParams AccountID param.Field\[string]Optional Path param: The Account ID to use for this endpoint. Mutually exclusive with the Zone ID. Link to this property ZoneID param.Field\[string]Optional Path param: The Zone ID to use for this endpoint. Mutually exclusive with the Account ID. Link to this property Cursor param.Field\[string]Optional Query param: The cursor to use for the next page. minLength1 Link to this property PerPage param.Field\[int64]Optional Query param: The number of rulesets to return per page. maximum50 minimum1 Link to this property
[Link to this property](<#(resource)%20rulesets%20%3E%20(method)%20list%20%3E%20(params)%20default>) ##### ReturnsExpand Collapse
type RulesetListResponse struct{…} A ruleset object. ID string The unique ID of the ruleset. Link to this property
Kind Kind The kind of the ruleset. One of the following: const KindManaged Kind = "managed" Link to this property const KindCustom Kind = "custom" Link to this property const KindRoot Kind = "root" Link to this property const KindZone Kind = "zone" Link to this property
Link to this property LastUpdated Time The timestamp of when the ruleset was last modified. formatdate-time Link to this property Name string The human-readable name of the ruleset. minLength1 Link to this property
Phase Phase The phase of the ruleset. One of the following: const PhaseDDoSL4 Phase = "ddos\_l4" Link to this property const PhaseDDoSL7 Phase = "ddos\_l7" Link to this property const PhaseHTTPConfigSettings Phase = "http\_config\_settings" Link to this property const PhaseHTTPCustomErrors Phase = "http\_custom\_errors" Link to this property const PhaseHTTPLogCustomFields Phase = "http\_log\_custom\_fields" Link to this property const PhaseHTTPRatelimit Phase = "http\_ratelimit" Link to this property const PhaseHTTPRequestCacheSettings Phase = "http\_request\_cache\_settings" Link to this property const PhaseHTTPRequestDynamicRedirect Phase = "http\_request\_dynamic\_redirect" Link to this property const PhaseHTTPRequestFirewallCustom Phase = "http\_request\_firewall\_custom" Link to this property const PhaseHTTPRequestFirewallManaged Phase = "http\_request\_firewall\_managed" Link to this property const PhaseHTTPRequestLateTransform Phase = "http\_request\_late\_transform" Link to this property const PhaseHTTPRequestOrigin Phase = "http\_request\_origin" Link to this property const PhaseHTTPRequestRedirect Phase = "http\_request\_redirect" Link to this property const PhaseHTTPRequestSanitize Phase = "http\_request\_sanitize" Link to this property const PhaseHTTPRequestSBFM Phase = "http\_request\_sbfm" Link to this property const PhaseHTTPRequestTransform Phase = "http\_request\_transform" Link to this property const PhaseHTTPResponseCacheSettings Phase = "http\_response\_cache\_settings" Link to this property const PhaseHTTPResponseCompression Phase = "http\_response\_compression" Link to this property const PhaseHTTPResponseFirewallManaged Phase = "http\_response\_firewall\_managed" Link to this property const PhaseHTTPResponseHeadersTransform Phase = "http\_response\_headers\_transform" Link to this property const PhaseMagicTransit Phase = "magic\_transit" Link to this property const PhaseMagicTransitIDsManaged Phase = "magic\_transit\_ids\_managed" Link to this property const PhaseMagicTransitManaged Phase = "magic\_transit\_managed" Link to this property const PhaseMagicTransitRatelimit Phase = "magic\_transit\_ratelimit" Link to this property
Link to this property Version string The version of the ruleset. Link to this property Description stringOptional An informative description of the ruleset. Link to this property
[Link to this property](<#(resource)%20rulesets%20%3E%20(model)%20RulesetListResponse%20%3E%20(schema)>) ### List account or zone rulesets Go HTTPTypeScriptPythonGoTerraform ``` package main import ( "context" "fmt" "github.com/cloudflare/cloudflare-go" "github.com/cloudflare/cloudflare-go/option" "github.com/cloudflare/cloudflare-go/rulesets" ) func main() { client := cloudflare.NewClient( option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"), ) page, err := client.Rulesets.List(context.TODO(), rulesets.RulesetListParams{ }) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", page) } ``` 200 example ``` { "errors": [ { "message": "something bad happened", "code": 10000, "source": { "pointer": "/rules/0/action" } } ], "messages": [ { "message": "something bad happened", "code": 10000, "source": { "pointer": "/rules/0/action" } } ], "result": [ { "id": "2f2feab2026849078ba485f918791bdc", "kind": "root", "last_updated": "2000-01-01T00:00:00Z", "name": "My ruleset", "phase": "http_request_firewall_custom", "version": "1", "description": "A description for my ruleset." } ], "success": true, "result_info": { "cursors": { "after": "dGhpc2lzYW5leGFtcGxlCg" } } } ``` ##### Returns Examples 200 example ``` { "errors": [ { "message": "something bad happened", "code": 10000, "source": { "pointer": "/rules/0/action" } } ], "messages": [ { "message": "something bad happened", "code": 10000, "source": { "pointer": "/rules/0/action" } } ], "result": [ { "id": "2f2feab2026849078ba485f918791bdc", "kind": "root", "last_updated": "2000-01-01T00:00:00Z", "name": "My ruleset", "phase": "http_request_firewall_custom", "version": "1", "description": "A description for my ruleset." } ], "success": true, "result_info": { "cursors": { "after": "dGhpc2lzYW5leGFtcGxlCg" } } } ```