--- title: List Prefixes --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api) [Addressing](https://developers.cloudflare.com/api/resources/addressing) [Prefixes](https://developers.cloudflare.com/api/resources/addressing/subresources/prefixes) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # List Prefixes GET/accounts/{account\_id}/addressing/prefixes List all prefixes owned by the account. ##### 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) `Magic Transit Read``Magic Transit Write``IP Prefixes: Write``IP Prefixes: Read``IP Prefixes: BGP On Demand Write``IP Prefixes: BGP On Demand Read` ##### P ath ParametersExpand Collapse account\_id: string Identifier of a Cloudflare account. maxLength32 [Link to this property](<#(resource)%20addressing.prefixes%20%3E%20(method)%20list%20%3E%20(params)%20default%20%3E%20(param)%20account_id%20%3E%20(schema)>) ##### ReturnsExpand Collapse

errors: array of object {code, message, documentation\_url, source }

code: number minimum1000 Link to this property message: string Link to this property documentation\_url: optional string Link to this property

source: optional object {pointer }

pointer: optional string Link to this property

Link to this property

[Link to this property](<#(resource)%20addressing.prefixes%20%3E%20(method)%20list%20%3E%20(network%20schema)%20%3E%20(property)%20errors>)

messages: array of object {code, message, documentation\_url, source }

code: number minimum1000 Link to this property message: string Link to this property documentation\_url: optional string Link to this property

source: optional object {pointer }

pointer: optional string Link to this property

Link to this property

[Link to this property](<#(resource)%20addressing.prefixes%20%3E%20(method)%20list%20%3E%20(network%20schema)%20%3E%20(property)%20messages>) success: true Whether the API call was successful. [Link to this property](<#(resource)%20addressing.prefixes%20%3E%20(method)%20list%20%3E%20(network%20schema)%20%3E%20(property)%20success>)

result: optional array of Prefix { id, account\_id, advertised, 15 more }

id: optional string Identifier of an IP Prefix. maxLength32 Link to this property account\_id: optional string Identifier of a Cloudflare account. maxLength32 Link to this property Deprecatedadvertised: optional boolean Prefer the BGP Prefixes API instead, which allows for advertising multiple BGP routes within a single IP Prefix. Prefix advertisement status to the Internet. This field is only not ‘null’ if on demand is enabled. Link to this property Deprecatedadvertised\_modified\_at: optional string Prefer the BGP Prefixes API instead, which allows for advertising multiple BGP routes within a single IP Prefix. Last time the advertisement status was changed. This field is only not ‘null’ if on demand is enabled. formatdate-time Link to this property approved: optional string Approval state of the prefix (P = pending, V = active). Link to this property asn: optional number Autonomous System Number (ASN) the prefix will be advertised under. Link to this property cidr: optional string IP Prefix in Classless Inter-Domain Routing format. Link to this property created\_at: optional string formatdate-time Link to this property delegate\_loa\_creation: optional boolean Whether Cloudflare is allowed to generate the LOA document on behalf of the prefix owner. Link to this property description: optional string Description of the prefix. maxLength1000 Link to this property irr\_validation\_state: optional string State of one kind of validation for an IP prefix. Link to this property loa\_document\_id: optional string Identifier for the uploaded LOA document. maxLength32 Link to this property modified\_at: optional string formatdate-time Link to this property Deprecatedon\_demand\_enabled: optional boolean Prefer the BGP Prefixes API instead, which allows for advertising multiple BGP routes within a single IP Prefix. Whether advertisement of the prefix to the Internet may be dynamically enabled or disabled. Link to this property Deprecatedon\_demand\_locked: optional boolean Prefer the BGP Prefixes API instead, which allows for advertising multiple BGP routes within a single IP Prefix. Whether advertisement status of the prefix is locked, meaning it cannot be changed. Link to this property ownership\_validation\_state: optional string State of one kind of validation for an IP prefix. Link to this property ownership\_validation\_token: optional string Token provided to demonstrate ownership of the prefix. Link to this property rpki\_validation\_state: optional string State of one kind of validation for an IP prefix. Link to this property

[Link to this property](<#(resource)%20addressing.prefixes%20%3E%20(method)%20list%20%3E%20(network%20schema)%20%3E%20(property)%20result>) ### List Prefixes HTTP HTTPTypeScriptPythonGoTerraform ``` curl https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/addressing/prefixes \ -H "Authorization: Bearer $CLOUDFLARE_API_TOKEN" ``` 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" } } ], "success": true, "result": [ { "id": "2af39739cc4e3b5910c918468bb89828", "account_id": "258def64c72dae45f3e4c8516e2111f2", "advertised": true, "advertised_modified_at": "2014-01-01T05:20:00.12345Z", "approved": "P", "asn": 13335, "cidr": "192.0.2.0/24", "created_at": "2014-01-01T05:20:00.12345Z", "delegate_loa_creation": true, "description": "Internal test prefix", "irr_validation_state": "pending", "loa_document_id": "d933b1530bc56c9953cf8ce166da8004", "modified_at": "2014-01-01T05:20:00.12345Z", "on_demand_enabled": true, "on_demand_locked": false, "ownership_validation_state": "pending", "ownership_validation_token": "1234a5b6-1234-1abc-12a3-1234a5b6789c", "rpki_validation_state": "pending" } ] } ``` ##### 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" } } ], "success": true, "result": [ { "id": "2af39739cc4e3b5910c918468bb89828", "account_id": "258def64c72dae45f3e4c8516e2111f2", "advertised": true, "advertised_modified_at": "2014-01-01T05:20:00.12345Z", "approved": "P", "asn": 13335, "cidr": "192.0.2.0/24", "created_at": "2014-01-01T05:20:00.12345Z", "delegate_loa_creation": true, "description": "Internal test prefix", "irr_validation_state": "pending", "loa_document_id": "d933b1530bc56c9953cf8ce166da8004", "modified_at": "2014-01-01T05:20:00.12345Z", "on_demand_enabled": true, "on_demand_locked": false, "ownership_validation_state": "pending", "ownership_validation_token": "1234a5b6-1234-1abc-12a3-1234a5b6789c", "rpki_validation_state": "pending" } ] } ```