Update Prefix Dynamic Advertisement Status

PATCH

https://api.cloudflare.com/client/v4/accounts/{account_identifier}/addressing/prefixes/{prefix_identifier}/bgp/status

Last modified:2022-12-16 13:48:33

Advertise or withdraw BGP route for a prefix.

Request

Path Params

prefix_identifier

string

required

account_identifier

string

required

Body Params application/json

advertised

boolean

required

Enablement of prefix advertisement to the Internet.

Example:

true

Example

{
    "advertised": true
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PATCH 'https://api.cloudflare.com/client/v4/accounts//addressing/prefixes//bgp/status' \
--header 'Content-Type: application/json' \
--data-raw '{
    "advertised": true
}'

Responses

🟢200Update Prefix Dynamic Advertisement Status response

application/json

Body

allOf {2}

optional

object (api-response-single)

optional

errors

array [object {2}]

messages

required

Example:

[]

messages

array [object {2}]

messages

required

Example:

[]

result

required

success

enum<boolean>

required

Whether the API call was successful

Allowed value:

true

Example:

true

object

optional

result

object

optional

Example

{
    "errors": [],
    "messages": [],
    "result": {
        "advertised": true,
        "advertised_modified_at": "2014-01-01T05:20:00.12345Z"
    },
    "success": true
}

🟢200Update Prefix Dynamic Advertisement Status response failure

Modified at 2022-12-16 13:48:33

Get Advertisement Status

List Prefix Delegations