Get Advertisement Status

Deprecated

GET /accounts/{account_id}/addressing/prefixes/{prefix_id}/bgp/status

Copy endpoint

https://api.cloudflare.com/client/v4

View the current advertisement state for a prefix.

Deprecated: Prefer the BGP Prefixes endpoints, which additionally allow for advertising and withdrawing subnets of an IP prefix.

Parameters

path Path Parameters

Name	Type
`prefix_id` required	type AddressingPrefixIdentifier = string
`account_id` required	type AddressingAccountIdentifier = string

Responses

200 application/json

Get Advertisement Status response

type AddressingAdvertisedResponse = type AddressingApiResponseSingle = interface AddressingApiResponseCommon {
errors:

AddressingMessages

type AddressingMessages = {
code: number;
documentation_url?: string;
message: string;
source?: { pointer?: string; };
}[]

;
messages:

AddressingMessages

type AddressingMessages = {
code: number;
documentation_url?: string;
message: string;
source?: { pointer?: string; };
}[]

;
success: true;
} & {} & { result?: { advertised?:

AddressingSchemasAdvertised

Advertisement status of the prefix. If true, the BGP route for the prefix is advertised to the Internet. If false, the BGP route is withdrawn.

type AddressingSchemasAdvertised = boolean

;advertised_modified_at?:

AddressingModifiedAtNullable

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

type AddressingModifiedAtNullable = string | null

; }; }

Client Errors

4XX application/json

Get Advertisement Status response failure

type AddressingAdvertisedResponse = type AddressingApiResponseSingle = interface AddressingApiResponseCommon {
errors:

AddressingMessages

type AddressingMessages = {
code: number;
documentation_url?: string;
message: string;
source?: { pointer?: string; };
}[]

;
messages:

AddressingMessages

type AddressingMessages = {
code: number;
documentation_url?: string;
message: string;
source?: { pointer?: string; };
}[]

;
success: true;
} & {} & { result?: { advertised?:

AddressingSchemasAdvertised

Advertisement status of the prefix. If true, the BGP route for the prefix is advertised to the Internet. If false, the BGP route is withdrawn.

type AddressingSchemasAdvertised = boolean

;advertised_modified_at?:

AddressingModifiedAtNullable

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

type AddressingModifiedAtNullable = string | null

; }; } & interface AddressingApiResponseCommonFailure {
errors:

AddressingMessages

type AddressingMessages = {
code: number;
documentation_url?: string;
message: string;
source?: { pointer?: string; };
}[]

;
messages:

AddressingMessages

type AddressingMessages = {
code: number;
documentation_url?: string;
message: string;
source?: { pointer?: string; };
}[]

;
result: null;
success: false;
}