API Reference

Addressing

Prefixes

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Advertisement Status

Get Advertisement Status

Deprecated

addressing.prefixes.advertisement_status.get(strprefix_id, AdvertisementStatusGetParams**kwargs) -> AdvertisementStatusGetResponse

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

Update Prefix Dynamic Advertisement Status

Deprecated

addressing.prefixes.advertisement_status.edit(strprefix_id, AdvertisementStatusEditParams**kwargs) -> AdvertisementStatusEditResponse

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

ModelsExpand Collapse

class AdvertisementStatusGetResponse: …

advertised: Optional[bool]

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.

advertised_modified_at: Optional[datetime]

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

formatdate-time

class AdvertisementStatusEditResponse: …

advertised: Optional[bool]

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.

advertised_modified_at: Optional[datetime]

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

formatdate-time