--- title: Lists --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/go) [Rules Lists](https://developers.cloudflare.com/api/go/resources/rules) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Lists ##### [Get lists](https://developers.cloudflare.com/api/go/resources/rules/subresources/lists/methods/list) client.Rules.Lists.List(ctx, query) (\*SinglePage\[[ListsList]()], error) GET/accounts/{account\_id}/rules/lists ##### [Get a list](https://developers.cloudflare.com/api/go/resources/rules/subresources/lists/methods/get) client.Rules.Lists.Get(ctx, listID, query) (\*[ListGetResponse](), error) GET/accounts/{account\_id}/rules/lists/{list\_id} ##### [Create a list](https://developers.cloudflare.com/api/go/resources/rules/subresources/lists/methods/create) client.Rules.Lists.New(ctx, params) (\*[ListNewResponse](), error) POST/accounts/{account\_id}/rules/lists ##### [Update a list](https://developers.cloudflare.com/api/go/resources/rules/subresources/lists/methods/update) client.Rules.Lists.Update(ctx, listID, params) (\*[ListUpdateResponse](), error) PUT/accounts/{account\_id}/rules/lists/{list\_id} ##### [Delete a list](https://developers.cloudflare.com/api/go/resources/rules/subresources/lists/methods/delete) client.Rules.Lists.Delete(ctx, listID, body) (\*[ListDeleteResponse](), error) DELETE/accounts/{account\_id}/rules/lists/{list\_id} ##### ModelsExpand Collapse
type Hostname struct{…} Hostnames support ASCII(7) letters from a to z, the digits from 0 to 9, wildcards (\*), and the hyphen (-). URLHostname string Link to this property ExcludeExactHostname boolOptional Only applies to wildcard hostnames (e.g., \*.example.com). When true (default), the rule blocks only subdomains. When false, the rule blocks both the root domain and subdomains. Link to this property
[Link to this property](<#(resource)%20rules.lists%20%3E%20(model)%20hostname%20%3E%20(schema)>)
type ListsList struct{…} ID string The unique ID of the list. maxLength32 minLength32 Link to this property CreatedOn string The RFC 3339 timestamp of when the list was created. Link to this property
Kind ListsListKind The type of the list. Each type supports specific list items (IP addresses, ASNs, hostnames or redirects). One of the following: const ListsListKindIP ListsListKind = "ip" Link to this property const ListsListKindRedirect ListsListKind = "redirect" Link to this property const ListsListKindHostname ListsListKind = "hostname" Link to this property const ListsListKindASN ListsListKind = "asn" Link to this property
Link to this property ModifiedOn string The RFC 3339 timestamp of when the list was last modified. Link to this property Name string An informative name for the list. Use this name in filter and rule expressions. maxLength50 Link to this property NumItems float64 The number of items in the list. Link to this property NumReferencingFilters float64 The number of filters referencing the list. Link to this property Description stringOptional An informative summary of the list. maxLength500 Link to this property
[Link to this property](<#(resource)%20rules.lists%20%3E%20(model)%20lists_list%20%3E%20(schema)>)
type Redirect struct{…} The definition of the redirect. SourceURL string Link to this property TargetURL string Link to this property IncludeSubdomains boolOptional Link to this property PreservePathSuffix boolOptional Link to this property PreserveQueryString boolOptional Link to this property
StatusCode RedirectStatusCodeOptional One of the following: const RedirectStatusCode301 RedirectStatusCode = 301 Link to this property const RedirectStatusCode302 RedirectStatusCode = 302 Link to this property const RedirectStatusCode307 RedirectStatusCode = 307 Link to this property const RedirectStatusCode308 RedirectStatusCode = 308 Link to this property
Link to this property SubpathMatching boolOptional Link to this property
[Link to this property](<#(resource)%20rules.lists%20%3E%20(model)%20redirect%20%3E%20(schema)>) #### ListsBulk Operations ##### [Get bulk operation status](https://developers.cloudflare.com/api/go/resources/rules/subresources/lists/subresources/bulk_operations/methods/get) client.Rules.Lists.BulkOperations.Get(ctx, operationID, query) (\*[ListBulkOperationGetResponse](), error) GET/accounts/{account\_id}/rules/lists/bulk\_operations/{operation\_id} #### ListsItems ##### [Get list items](https://developers.cloudflare.com/api/go/resources/rules/subresources/lists/subresources/items/methods/list) client.Rules.Lists.Items.List(ctx, listID, params) (\*CursorPaginationAfter\[[ListItemListResponse]()], error) GET/accounts/{account\_id}/rules/lists/{list\_id}/items ##### [Get a list item](https://developers.cloudflare.com/api/go/resources/rules/subresources/lists/subresources/items/methods/get) client.Rules.Lists.Items.Get(ctx, listID, itemID, query) (\*[ListItemGetResponse](), error) GET/accounts/{account\_id}/rules/lists/{list\_id}/items/{item\_id} ##### [Create list items](https://developers.cloudflare.com/api/go/resources/rules/subresources/lists/subresources/items/methods/create) client.Rules.Lists.Items.New(ctx, listID, params) (\*[ListItemNewResponse](), error) POST/accounts/{account\_id}/rules/lists/{list\_id}/items ##### [Update all list items](https://developers.cloudflare.com/api/go/resources/rules/subresources/lists/subresources/items/methods/update) client.Rules.Lists.Items.Update(ctx, listID, params) (\*[ListItemUpdateResponse](), error) PUT/accounts/{account\_id}/rules/lists/{list\_id}/items ##### [Delete list items](https://developers.cloudflare.com/api/go/resources/rules/subresources/lists/subresources/items/methods/delete) client.Rules.Lists.Items.Delete(ctx, listID, params) (\*[ListItemDeleteResponse](), error) DELETE/accounts/{account\_id}/rules/lists/{list\_id}/items ##### ModelsExpand Collapse
type ListCursor struct{…} After stringOptional Link to this property Before stringOptional Link to this property
[Link to this property](<#(resource)%20rules.lists.items%20%3E%20(model)%20list_cursor%20%3E%20(schema)>)
type ListItem struct{…} OperationID string The unique operation ID of the asynchronous action. Link to this property
[Link to this property](<#(resource)%20rules.lists.items%20%3E%20(model)%20list_item%20%3E%20(schema)>)