We are excited to announce our new API Documentation.
Optional
addressThe address family for the BGP peer.
Optional
amazonThe IP address assigned to the Amazon interface.
Optional
asnThe autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
Optional
authThe authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.
Optional
awsThe Direct Connect endpoint that terminates the BGP peer.
Optional
awsThe Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.
Optional
bgpThe ID of the BGP peer.
Optional
bgpThe state of the BGP peer. The following are the possible values:
verifying
: The BGP peering addresses or ASN require validation before the BGP peer can be created. This state applies only to public virtual interfaces.
pending
: The BGP peer is created, and remains in this state until it is ready to be established.
available
: The BGP peer is ready to be established.
deleting
: The BGP peer is being deleted.
deleted
: The BGP peer is deleted and cannot be established.
Optional
bgpThe status of the BGP peer. The following are the possible values:
up
: The BGP peer is established. This state does not indicate the
state of the routing function. Ensure that you are receiving routes over the BGP session.
down
: The BGP peer is down.
unknown
: The BGP peer status is not available.
Optional
customerThe IP address assigned to the customer interface.
Information about a BGP peer.