## List BGP Prefixes

`client.addressing.prefixes.bgpPrefixes.list(stringprefixId, BGPPrefixListParamsparams, RequestOptionsoptions?): SinglePage<BGPPrefix>`

**get** `/accounts/{account_id}/addressing/prefixes/{prefix_id}/bgp/prefixes`

List all BGP Prefixes within the specified IP Prefix. BGP Prefixes are used to control which specific subnets are advertised to the Internet. It is possible to advertise subnets more specific than an IP Prefix by creating more specific BGP Prefixes.

### Parameters

- `prefixId: string`

  Identifier of an IP Prefix.

- `params: BGPPrefixListParams`

  - `account_id: string`

    Identifier of a Cloudflare account.

### Returns

- `BGPPrefix`

  - `id?: string`

    Identifier of BGP Prefix.

  - `asn?: number | null`

    Autonomous System Number (ASN) the prefix will be advertised under.

  - `asn_prepend_count?: number`

    Number of times to prepend the Cloudflare ASN to the BGP AS-Path attribute

  - `auto_advertise_withdraw?: boolean`

    Determines if Cloudflare advertises a BYOIP BGP prefix even when there is no matching BGP prefix in the Magic routing table. When true, Cloudflare will automatically withdraw the BGP prefix when there are no matching BGP routes, and will resume advertising when there is at least one matching BGP route.

  - `bgp_signal_opts?: BGPSignalOpts`

    - `enabled?: boolean`

      Whether control of advertisement of the prefix to the Internet is enabled to be performed via BGP signal

    - `modified_at?: string | null`

      Last time BGP signaling control was toggled. This field is null if BGP signaling has never been enabled.

  - `cidr?: string`

    IP Prefix in Classless Inter-Domain Routing format.

  - `created_at?: string`

  - `modified_at?: string`

  - `on_demand?: OnDemand`

    - `advertised?: boolean | null`

      Prefix advertisement status to the Internet. This field is only not 'null' if on demand is enabled.

    - `advertised_modified_at?: string | null`

      Last time the advertisement status was changed. This field is only not 'null' if on demand is enabled.

    - `on_demand_enabled?: boolean`

      Whether advertisement of the prefix to the Internet may be dynamically enabled or disabled.

    - `on_demand_locked?: boolean`

      Whether the advertisement status of the prefix is locked, meaning it cannot be changed.

### Example

```node
import Cloudflare from 'cloudflare';

const client = new Cloudflare({
  apiEmail: process.env['CLOUDFLARE_EMAIL'], // This is the default and can be omitted
  apiKey: process.env['CLOUDFLARE_API_KEY'], // This is the default and can be omitted
});

// Automatically fetches more pages as needed.
for await (const bgpPrefix of client.addressing.prefixes.bgpPrefixes.list(
  '2af39739cc4e3b5910c918468bb89828',
  { account_id: '258def64c72dae45f3e4c8516e2111f2' },
)) {
  console.log(bgpPrefix.id);
}
```

#### Response

```json
{
  "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": "7009ba364c7a5760798ceb430e603b74",
      "asn": 13335,
      "asn_prepend_count": 2,
      "auto_advertise_withdraw": true,
      "bgp_signal_opts": {
        "enabled": false,
        "modified_at": "2014-01-01T05:20:00.12345Z"
      },
      "cidr": "192.0.2.0/24",
      "created_at": "2014-01-01T05:20:00.12345Z",
      "modified_at": "2014-01-01T05:20:00.12345Z",
      "on_demand": {
        "advertised": true,
        "advertised_modified_at": "2014-01-01T05:20:00.12345Z",
        "on_demand_enabled": true,
        "on_demand_locked": false
      }
    }
  ]
}
```