PATCH /accounts/{account_id}/addressing/prefixes/{prefix_id}/bgp/prefixes/{bgp_prefix_id}

Update the properties of a BGP Prefix, such as the on demand advertisement status (advertised or withdrawn).

Servers

Path parameters

Name Type Required Description
bgp_prefix_id String Yes
prefix_id String Yes
account_id String Yes

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
on_demand Object No
on_demand.advertised Boolean No
withdraw_if_no_route Boolean No

Controls whether the BGP prefix is automatically withdrawn when prefix is withdrawn from Magic routing table (for Magic Transit customers using Direct CNI)

Default value: false

asn_prepend_count Integer No

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

Default value: 0

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.