Skip to content
Cloudflare API
Start here
API Reference

Addressing

AddressingRegional Hostnames

List Regional Hostnames
addressing.regional_hostnames.list(RegionalHostnameListParams**kwargs) -> SyncSinglePage[RegionalHostnameListResponse]
GET/zones/{zone_id}/addressing/regional_hostnames
Fetch Regional Hostname
addressing.regional_hostnames.get(strhostname, RegionalHostnameGetParams**kwargs) -> RegionalHostnameGetResponse
GET/zones/{zone_id}/addressing/regional_hostnames/{hostname}
Create Regional Hostname
addressing.regional_hostnames.create(RegionalHostnameCreateParams**kwargs) -> RegionalHostnameCreateResponse
POST/zones/{zone_id}/addressing/regional_hostnames
Update Regional Hostname
addressing.regional_hostnames.edit(strhostname, RegionalHostnameEditParams**kwargs) -> RegionalHostnameEditResponse
PATCH/zones/{zone_id}/addressing/regional_hostnames/{hostname}
Delete Regional Hostname
addressing.regional_hostnames.delete(strhostname, RegionalHostnameDeleteParams**kwargs) -> RegionalHostnameDeleteResponse
DELETE/zones/{zone_id}/addressing/regional_hostnames/{hostname}
ModelsExpand Collapse
class RegionalHostnameListResponse: …
created_on: datetime

When the regional hostname was created

formatdate-time
hostname: str

DNS hostname to be regionalized, must be a subdomain of the zone. Wildcards are supported for one level, e.g *.example.com

region_key: str

Identifying key for the region

routing: Optional[str]

Configure which routing method to use for the regional hostname

class RegionalHostnameGetResponse: …
created_on: datetime

When the regional hostname was created

formatdate-time
hostname: str

DNS hostname to be regionalized, must be a subdomain of the zone. Wildcards are supported for one level, e.g *.example.com

region_key: str

Identifying key for the region

routing: Optional[str]

Configure which routing method to use for the regional hostname

class RegionalHostnameCreateResponse: …
created_on: datetime

When the regional hostname was created

formatdate-time
hostname: str

DNS hostname to be regionalized, must be a subdomain of the zone. Wildcards are supported for one level, e.g *.example.com

region_key: str

Identifying key for the region

routing: Optional[str]

Configure which routing method to use for the regional hostname

class RegionalHostnameEditResponse: …
created_on: datetime

When the regional hostname was created

formatdate-time
hostname: str

DNS hostname to be regionalized, must be a subdomain of the zone. Wildcards are supported for one level, e.g *.example.com

region_key: str

Identifying key for the region

routing: Optional[str]

Configure which routing method to use for the regional hostname

class RegionalHostnameDeleteResponse: …
errors: List[Error]
code: int
minimum1000
message: str
documentation_url: Optional[str]
source: Optional[ErrorSource]
pointer: Optional[str]
messages: List[Message]
code: int
minimum1000
message: str
documentation_url: Optional[str]
source: Optional[MessageSource]
pointer: Optional[str]
success: Literal[true]

Whether the API call was successful.

AddressingRegional HostnamesRegions

List Regions
addressing.regional_hostnames.regions.list(RegionListParams**kwargs) -> SyncSinglePage[RegionListResponse]
GET/accounts/{account_id}/addressing/regional_hostnames/regions
ModelsExpand Collapse
class RegionListResponse: …
key: Optional[str]

Identifying key for the region

label: Optional[str]

Human-readable text label for the region

AddressingServices

List Services
addressing.services.list(ServiceListParams**kwargs) -> SyncSinglePage[ServiceListResponse]
GET/accounts/{account_id}/addressing/services
ModelsExpand Collapse
class ServiceListResponse: …
id: Optional[str]

Identifier of a Service on the Cloudflare network. Available services and their IDs may be found in the List Services endpoint.

maxLength32
name: Optional[str]

Name of a service running on the Cloudflare network

AddressingAddress Maps

List Address Maps
addressing.address_maps.list(AddressMapListParams**kwargs) -> SyncSinglePage[AddressMap]
GET/accounts/{account_id}/addressing/address_maps
Address Map Details
addressing.address_maps.get(straddress_map_id, AddressMapGetParams**kwargs) -> AddressMapGetResponse
GET/accounts/{account_id}/addressing/address_maps/{address_map_id}
Create Address Map
addressing.address_maps.create(AddressMapCreateParams**kwargs) -> AddressMapCreateResponse
POST/accounts/{account_id}/addressing/address_maps
Update Address Map
addressing.address_maps.edit(straddress_map_id, AddressMapEditParams**kwargs) -> AddressMap
PATCH/accounts/{account_id}/addressing/address_maps/{address_map_id}
Delete Address Map
addressing.address_maps.delete(straddress_map_id, AddressMapDeleteParams**kwargs) -> AddressMapDeleteResponse
DELETE/accounts/{account_id}/addressing/address_maps/{address_map_id}
ModelsExpand Collapse
class AddressMap: …
id: Optional[str]

Identifier of an Address Map.

maxLength32
can_delete: Optional[bool]

If set to false, then the Address Map cannot be deleted via API. This is true for Cloudflare-managed maps.

can_modify_ips: Optional[bool]

If set to false, then the IPs on the Address Map cannot be modified via the API. This is true for Cloudflare-managed maps.

created_at: Optional[datetime]
formatdate-time
default_sni: Optional[str]

If you have legacy TLS clients which do not send the TLS server name indicator, then you can specify one default SNI on the map. If Cloudflare receives a TLS handshake from a client without an SNI, it will respond with the default SNI on those IPs. The default SNI can be any valid zone or subdomain owned by the account.

description: Optional[str]

An optional description field which may be used to describe the types of IPs or zones on the map.

enabled: Optional[bool]

Whether the Address Map is enabled or not. Cloudflare's DNS will not respond with IP addresses on an Address Map until the map is enabled.

modified_at: Optional[datetime]
formatdate-time
Literal["zone", "account"]

The type of the membership.

One of the following:
"zone"
"account"
class AddressMapGetResponse: …
id: Optional[str]

Identifier of an Address Map.

maxLength32
can_delete: Optional[bool]

If set to false, then the Address Map cannot be deleted via API. This is true for Cloudflare-managed maps.

can_modify_ips: Optional[bool]

If set to false, then the IPs on the Address Map cannot be modified via the API. This is true for Cloudflare-managed maps.

created_at: Optional[datetime]
formatdate-time
default_sni: Optional[str]

If you have legacy TLS clients which do not send the TLS server name indicator, then you can specify one default SNI on the map. If Cloudflare receives a TLS handshake from a client without an SNI, it will respond with the default SNI on those IPs. The default SNI can be any valid zone or subdomain owned by the account.

description: Optional[str]

An optional description field which may be used to describe the types of IPs or zones on the map.

enabled: Optional[bool]

Whether the Address Map is enabled or not. Cloudflare's DNS will not respond with IP addresses on an Address Map until the map is enabled.

ips: Optional[IPs]

The set of IPs on the Address Map.

memberships: Optional[List[Membership]]

Zones and Accounts which will be assigned IPs on this Address Map. A zone membership will take priority over an account membership.

can_delete: Optional[bool]

Controls whether the membership can be deleted via the API or not.

created_at: Optional[datetime]
formatdate-time
identifier: Optional[str]

The identifier for the membership (eg. a zone or account tag).

maxLength32
kind: Optional[Kind]

The type of the membership.

modified_at: Optional[datetime]
formatdate-time
class AddressMapCreateResponse: …
id: Optional[str]

Identifier of an Address Map.

maxLength32
can_delete: Optional[bool]

If set to false, then the Address Map cannot be deleted via API. This is true for Cloudflare-managed maps.

can_modify_ips: Optional[bool]

If set to false, then the IPs on the Address Map cannot be modified via the API. This is true for Cloudflare-managed maps.

created_at: Optional[datetime]
formatdate-time
default_sni: Optional[str]

If you have legacy TLS clients which do not send the TLS server name indicator, then you can specify one default SNI on the map. If Cloudflare receives a TLS handshake from a client without an SNI, it will respond with the default SNI on those IPs. The default SNI can be any valid zone or subdomain owned by the account.

description: Optional[str]

An optional description field which may be used to describe the types of IPs or zones on the map.

enabled: Optional[bool]

Whether the Address Map is enabled or not. Cloudflare's DNS will not respond with IP addresses on an Address Map until the map is enabled.

ips: Optional[IPs]

The set of IPs on the Address Map.

memberships: Optional[List[Membership]]

Zones and Accounts which will be assigned IPs on this Address Map. A zone membership will take priority over an account membership.

can_delete: Optional[bool]

Controls whether the membership can be deleted via the API or not.

created_at: Optional[datetime]
formatdate-time
identifier: Optional[str]

The identifier for the membership (eg. a zone or account tag).

maxLength32
kind: Optional[Kind]

The type of the membership.

modified_at: Optional[datetime]
formatdate-time
class AddressMapDeleteResponse: …
errors: List[Error]
code: int
minimum1000
message: str
documentation_url: Optional[str]
source: Optional[ErrorSource]
pointer: Optional[str]
messages: List[Message]
code: int
minimum1000
message: str
documentation_url: Optional[str]
source: Optional[MessageSource]
pointer: Optional[str]
success: Literal[true]

Whether the API call was successful.

result_info: Optional[ResultInfo]
count: Optional[float]

Total number of results for the requested service.

page: Optional[float]

Current page within paginated list of results.

per_page: Optional[float]

Number of results per page of results.

total_count: Optional[float]

Total results available without any search parameters.

AddressingAddress MapsAccounts

Add an account membership to an Address Map
addressing.address_maps.accounts.update(straddress_map_id, AccountUpdateParams**kwargs) -> AccountUpdateResponse
PUT/accounts/{account_id}/addressing/address_maps/{address_map_id}/accounts/{account_id}
Remove an account membership from an Address Map
addressing.address_maps.accounts.delete(straddress_map_id, AccountDeleteParams**kwargs) -> AccountDeleteResponse
DELETE/accounts/{account_id}/addressing/address_maps/{address_map_id}/accounts/{account_id}
ModelsExpand Collapse
class AccountUpdateResponse: …
errors: List[Error]
code: int
minimum1000
message: str
documentation_url: Optional[str]
source: Optional[ErrorSource]
pointer: Optional[str]
messages: List[Message]
code: int
minimum1000
message: str
documentation_url: Optional[str]
source: Optional[MessageSource]
pointer: Optional[str]
success: Literal[true]

Whether the API call was successful.

result_info: Optional[ResultInfo]
count: Optional[float]

Total number of results for the requested service.

page: Optional[float]

Current page within paginated list of results.

per_page: Optional[float]

Number of results per page of results.

total_count: Optional[float]

Total results available without any search parameters.

class AccountDeleteResponse: …
errors: List[Error]
code: int
minimum1000
message: str
documentation_url: Optional[str]
source: Optional[ErrorSource]
pointer: Optional[str]
messages: List[Message]
code: int
minimum1000
message: str
documentation_url: Optional[str]
source: Optional[MessageSource]
pointer: Optional[str]
success: Literal[true]

Whether the API call was successful.

result_info: Optional[ResultInfo]
count: Optional[float]

Total number of results for the requested service.

page: Optional[float]

Current page within paginated list of results.

per_page: Optional[float]

Number of results per page of results.

total_count: Optional[float]

Total results available without any search parameters.

AddressingAddress MapsIPs

Add an IP to an Address Map
addressing.address_maps.ips.update(strip_address, IPUpdateParams**kwargs) -> IPUpdateResponse
PUT/accounts/{account_id}/addressing/address_maps/{address_map_id}/ips/{ip_address}
Remove an IP from an Address Map
addressing.address_maps.ips.delete(strip_address, IPDeleteParams**kwargs) -> IPDeleteResponse
DELETE/accounts/{account_id}/addressing/address_maps/{address_map_id}/ips/{ip_address}
ModelsExpand Collapse
class IPUpdateResponse: …
errors: List[Error]
code: int
minimum1000
message: str
documentation_url: Optional[str]
source: Optional[ErrorSource]
pointer: Optional[str]
messages: List[Message]
code: int
minimum1000
message: str
documentation_url: Optional[str]
source: Optional[MessageSource]
pointer: Optional[str]
success: Literal[true]

Whether the API call was successful.

result_info: Optional[ResultInfo]
count: Optional[float]

Total number of results for the requested service.

page: Optional[float]

Current page within paginated list of results.

per_page: Optional[float]

Number of results per page of results.

total_count: Optional[float]

Total results available without any search parameters.

class IPDeleteResponse: …
errors: List[Error]
code: int
minimum1000
message: str
documentation_url: Optional[str]
source: Optional[ErrorSource]
pointer: Optional[str]
messages: List[Message]
code: int
minimum1000
message: str
documentation_url: Optional[str]
source: Optional[MessageSource]
pointer: Optional[str]
success: Literal[true]

Whether the API call was successful.

result_info: Optional[ResultInfo]
count: Optional[float]

Total number of results for the requested service.

page: Optional[float]

Current page within paginated list of results.

per_page: Optional[float]

Number of results per page of results.

total_count: Optional[float]

Total results available without any search parameters.

AddressingAddress MapsZones

Add a zone membership to an Address Map
addressing.address_maps.zones.update(straddress_map_id, ZoneUpdateParams**kwargs) -> ZoneUpdateResponse
PUT/accounts/{account_id}/addressing/address_maps/{address_map_id}/zones/{zone_id}
Remove a zone membership from an Address Map
addressing.address_maps.zones.delete(straddress_map_id, ZoneDeleteParams**kwargs) -> ZoneDeleteResponse
DELETE/accounts/{account_id}/addressing/address_maps/{address_map_id}/zones/{zone_id}
ModelsExpand Collapse
class ZoneUpdateResponse: …
errors: List[Error]
code: int
minimum1000
message: str
documentation_url: Optional[str]
source: Optional[ErrorSource]
pointer: Optional[str]
messages: List[Message]
code: int
minimum1000
message: str
documentation_url: Optional[str]
source: Optional[MessageSource]
pointer: Optional[str]
success: Literal[true]

Whether the API call was successful.

result_info: Optional[ResultInfo]
count: Optional[float]

Total number of results for the requested service.

page: Optional[float]

Current page within paginated list of results.

per_page: Optional[float]

Number of results per page of results.

total_count: Optional[float]

Total results available without any search parameters.

class ZoneDeleteResponse: …
errors: List[Error]
code: int
minimum1000
message: str
documentation_url: Optional[str]
source: Optional[ErrorSource]
pointer: Optional[str]
messages: List[Message]
code: int
minimum1000
message: str
documentation_url: Optional[str]
source: Optional[MessageSource]
pointer: Optional[str]
success: Literal[true]

Whether the API call was successful.

result_info: Optional[ResultInfo]
count: Optional[float]

Total number of results for the requested service.

page: Optional[float]

Current page within paginated list of results.

per_page: Optional[float]

Number of results per page of results.

total_count: Optional[float]

Total results available without any search parameters.

AddressingLOA Documents

Download LOA Document
addressing.loa_documents.get(strloa_document_id, LOADocumentGetParams**kwargs) -> BinaryResponseContent
GET/accounts/{account_id}/addressing/loa_documents/{loa_document_id}/download
Upload LOA Document
addressing.loa_documents.create(LOADocumentCreateParams**kwargs) -> LOADocumentCreateResponse
POST/accounts/{account_id}/addressing/loa_documents
ModelsExpand Collapse
class LOADocumentCreateResponse: …
id: Optional[str]

Identifier for the uploaded LOA document.

maxLength32
account_id: Optional[str]

Identifier of a Cloudflare account.

maxLength32
auto_generated: Optional[bool]

Whether the LOA has been auto-generated for the prefix owner by Cloudflare.

created: Optional[datetime]
formatdate-time
filename: Optional[str]

Name of LOA document. Max file size 10MB, and supported filetype is pdf.

size_bytes: Optional[int]

File size of the uploaded LOA document.

verified: Optional[bool]

Whether the LOA has been verified by Cloudflare staff.

verified_at: Optional[datetime]

Timestamp of the moment the LOA was marked as validated.

formatdate-time

AddressingPrefixes

List Prefixes
addressing.prefixes.list(PrefixListParams**kwargs) -> SyncSinglePage[Prefix]
GET/accounts/{account_id}/addressing/prefixes
Prefix Details
addressing.prefixes.get(strprefix_id, PrefixGetParams**kwargs) -> Prefix
GET/accounts/{account_id}/addressing/prefixes/{prefix_id}
Add Prefix
addressing.prefixes.create(PrefixCreateParams**kwargs) -> Prefix
POST/accounts/{account_id}/addressing/prefixes
Update Prefix Description
addressing.prefixes.edit(strprefix_id, PrefixEditParams**kwargs) -> Prefix
PATCH/accounts/{account_id}/addressing/prefixes/{prefix_id}
Delete Prefix
addressing.prefixes.delete(strprefix_id, PrefixDeleteParams**kwargs) -> PrefixDeleteResponse
DELETE/accounts/{account_id}/addressing/prefixes/{prefix_id}
ModelsExpand Collapse
class Prefix: …
id: Optional[str]

Identifier of an IP Prefix.

maxLength32
account_id: Optional[str]

Identifier of a Cloudflare account.

maxLength32
Deprecatedadvertised: Optional[bool]
Prefer the [BGP Prefixes API](https://developers.cloudflare.com/api/resources/addressing/subresources/prefixes/subresources/bgp_prefixes/) instead, which allows for advertising multiple BGP routes within a single IP Prefix.

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

Deprecatedadvertised_modified_at: Optional[datetime]
Prefer the [BGP Prefixes API](https://developers.cloudflare.com/api/resources/addressing/subresources/prefixes/subresources/bgp_prefixes/) instead, which allows for advertising multiple BGP routes within a single IP Prefix.

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

formatdate-time
approved: Optional[str]

Approval state of the prefix (P = pending, V = active).

asn: Optional[int]

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

cidr: Optional[str]

IP Prefix in Classless Inter-Domain Routing format.

created_at: Optional[datetime]
formatdate-time
delegate_loa_creation: Optional[bool]

Whether Cloudflare is allowed to generate the LOA document on behalf of the prefix owner.

description: Optional[str]

Description of the prefix.

maxLength1000
irr_validation_state: Optional[str]

State of one kind of validation for an IP prefix.

loa_document_id: Optional[str]

Identifier for the uploaded LOA document.

maxLength32
modified_at: Optional[datetime]
formatdate-time
Deprecatedon_demand_enabled: Optional[bool]
Prefer the [BGP Prefixes API](https://developers.cloudflare.com/api/resources/addressing/subresources/prefixes/subresources/bgp_prefixes/) instead, which allows for advertising multiple BGP routes within a single IP Prefix.

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

Deprecatedon_demand_locked: Optional[bool]
Prefer the [BGP Prefixes API](https://developers.cloudflare.com/api/resources/addressing/subresources/prefixes/subresources/bgp_prefixes/) instead, which allows for advertising multiple BGP routes within a single IP Prefix.

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

ownership_validation_state: Optional[str]

State of one kind of validation for an IP prefix.

ownership_validation_token: Optional[str]

Token provided to demonstrate ownership of the prefix.

rpki_validation_state: Optional[str]

State of one kind of validation for an IP prefix.

class PrefixDeleteResponse: …
errors: List[Error]
code: int
minimum1000
message: str
documentation_url: Optional[str]
source: Optional[ErrorSource]
pointer: Optional[str]
messages: List[Message]
code: int
minimum1000
message: str
documentation_url: Optional[str]
source: Optional[MessageSource]
pointer: Optional[str]
success: Literal[true]

Whether the API call was successful.

AddressingPrefixesService Bindings

List Service Bindings
addressing.prefixes.service_bindings.list(strprefix_id, ServiceBindingListParams**kwargs) -> SyncSinglePage[ServiceBinding]
GET/accounts/{account_id}/addressing/prefixes/{prefix_id}/bindings
Get Service Binding
addressing.prefixes.service_bindings.get(strbinding_id, ServiceBindingGetParams**kwargs) -> ServiceBinding
GET/accounts/{account_id}/addressing/prefixes/{prefix_id}/bindings/{binding_id}
Create Service Binding
addressing.prefixes.service_bindings.create(strprefix_id, ServiceBindingCreateParams**kwargs) -> ServiceBinding
POST/accounts/{account_id}/addressing/prefixes/{prefix_id}/bindings
Delete Service Binding
addressing.prefixes.service_bindings.delete(strbinding_id, ServiceBindingDeleteParams**kwargs) -> ServiceBindingDeleteResponse
DELETE/accounts/{account_id}/addressing/prefixes/{prefix_id}/bindings/{binding_id}
ModelsExpand Collapse
class ServiceBinding: …
id: Optional[str]

Identifier of a Service Binding.

maxLength32
cidr: Optional[str]

IP Prefix in Classless Inter-Domain Routing format.

provisioning: Optional[Provisioning]

Status of a Service Binding's deployment to the Cloudflare network

state: Optional[Literal["provisioning", "active"]]

When a binding has been deployed to a majority of Cloudflare datacenters, the binding will become active and can be used with its associated service.

One of the following:
"provisioning"
"active"
service_id: Optional[str]

Identifier of a Service on the Cloudflare network. Available services and their IDs may be found in the List Services endpoint.

maxLength32
service_name: Optional[str]

Name of a service running on the Cloudflare network

class ServiceBindingDeleteResponse: …
errors: List[Error]
code: int
minimum1000
message: str
documentation_url: Optional[str]
source: Optional[ErrorSource]
pointer: Optional[str]
messages: List[Message]
code: int
minimum1000
message: str
documentation_url: Optional[str]
source: Optional[MessageSource]
pointer: Optional[str]
success: Literal[true]

Whether the API call was successful.

AddressingPrefixesBGP Prefixes

List BGP Prefixes
addressing.prefixes.bgp_prefixes.list(strprefix_id, BGPPrefixListParams**kwargs) -> SyncSinglePage[BGPPrefix]
GET/accounts/{account_id}/addressing/prefixes/{prefix_id}/bgp/prefixes
Fetch BGP Prefix
addressing.prefixes.bgp_prefixes.get(strbgp_prefix_id, BGPPrefixGetParams**kwargs) -> BGPPrefix
GET/accounts/{account_id}/addressing/prefixes/{prefix_id}/bgp/prefixes/{bgp_prefix_id}
Create BGP Prefix
addressing.prefixes.bgp_prefixes.create(strprefix_id, BGPPrefixCreateParams**kwargs) -> BGPPrefix
POST/accounts/{account_id}/addressing/prefixes/{prefix_id}/bgp/prefixes
Update BGP Prefix
addressing.prefixes.bgp_prefixes.edit(strbgp_prefix_id, BGPPrefixEditParams**kwargs) -> BGPPrefix
PATCH/accounts/{account_id}/addressing/prefixes/{prefix_id}/bgp/prefixes/{bgp_prefix_id}
ModelsExpand Collapse
class BGPPrefix: …
id: Optional[str]

Identifier of BGP Prefix.

maxLength32
asn: Optional[int]

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

asn_prepend_count: Optional[int]

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

maximum3
minimum0
auto_advertise_withdraw: Optional[bool]

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: Optional[BGPSignalOpts]
enabled: Optional[bool]

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

modified_at: Optional[datetime]

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

formatdate-time
cidr: Optional[str]

IP Prefix in Classless Inter-Domain Routing format.

created_at: Optional[datetime]
formatdate-time
modified_at: Optional[datetime]
formatdate-time
on_demand: Optional[OnDemand]
advertised: Optional[bool]

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

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
on_demand_enabled: Optional[bool]

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

on_demand_locked: Optional[bool]

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

AddressingPrefixesAdvertisement 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

AddressingPrefixesDelegations

List Prefix Delegations
addressing.prefixes.delegations.list(strprefix_id, DelegationListParams**kwargs) -> SyncSinglePage[Delegations]
GET/accounts/{account_id}/addressing/prefixes/{prefix_id}/delegations
Create Prefix Delegation
addressing.prefixes.delegations.create(strprefix_id, DelegationCreateParams**kwargs) -> Delegations
POST/accounts/{account_id}/addressing/prefixes/{prefix_id}/delegations
Delete Prefix Delegation
addressing.prefixes.delegations.delete(strdelegation_id, DelegationDeleteParams**kwargs) -> DelegationDeleteResponse
DELETE/accounts/{account_id}/addressing/prefixes/{prefix_id}/delegations/{delegation_id}
ModelsExpand Collapse
class Delegations: …
id: Optional[str]

Identifier of a Delegation.

maxLength32
cidr: Optional[str]

IP Prefix in Classless Inter-Domain Routing format.

created_at: Optional[datetime]
formatdate-time
delegated_account_id: Optional[str]

Account identifier for the account to which prefix is being delegated.

maxLength32
modified_at: Optional[datetime]
formatdate-time
parent_prefix_id: Optional[str]

Identifier of an IP Prefix.

maxLength32
class DelegationDeleteResponse: …
id: Optional[str]

Identifier of a Delegation.

maxLength32