Amazon EC2 Ec2 Route Server Peer API
The Ec2 Route Server Peer API from Amazon EC2 — 3 operation(s) for ec2 route server peer.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/amazon-ec2:amazon-ec2-route-server-peer-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Amazon Elastic Compute Cloud Route Server Peer API
version: '2016-11-15'
description: Generated from AWS's published Smithy model for Amazon Elastic Compute Cloud. 3 operation(s).
contact:
name: Amazon Web Services
url: https://aws.amazon.com/contact-us/
license:
name: Apache 2.0
identifier: Apache-2.0
url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://ec2.{region}.amazonaws.com
variables:
region:
default: us-east-1
security:
- sigv4: []
tags:
- name: Route Server Peer
paths:
/?Action=CreateRouteServerPeer:
post:
operationId: CreateRouteServerPeer
summary: Create Route Server Peer
description: 'Creates a new BGP peer for a specified route server endpoint. A route server peer is a session between a route server endpoint and the device deployed in Amazon Web Services (such as a firewall appliance or other network security function running on an EC2 instance). The device must meet these requirements: Have an elastic network interface in the VPC Support BGP (Border Gateway Protocol) Can initiate BGP sessions For more information see Dynamic routing in your VPC with VPC Route Server in the Amazon VPC User Guide.'
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/CreateRouteServerPeerResult'
requestBody:
required: true
content:
application/x-www-form-urlencoded:
schema:
allOf:
- type: object
required:
- Action
- Version
properties:
Action:
type: string
const: CreateRouteServerPeer
Version:
type: string
const: '2016-11-15'
- $ref: '#/components/schemas/CreateRouteServerPeerRequest'
tags:
- Route Server Peer
/?Action=DeleteRouteServerPeer:
post:
operationId: DeleteRouteServerPeer
summary: Delete Route Server Peer
description: 'Deletes the specified BGP peer from a route server. A route server peer is a session between a route server endpoint and the device deployed in Amazon Web Services (such as a firewall appliance or other network security function running on an EC2 instance). The device must meet these requirements: Have an elastic network interface in the VPC Support BGP (Border Gateway Protocol) Can initiate BGP sessions'
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DeleteRouteServerPeerResult'
requestBody:
required: true
content:
application/x-www-form-urlencoded:
schema:
allOf:
- type: object
required:
- Action
- Version
properties:
Action:
type: string
const: DeleteRouteServerPeer
Version:
type: string
const: '2016-11-15'
- $ref: '#/components/schemas/DeleteRouteServerPeerRequest'
tags:
- Route Server Peer
/?Action=DescribeRouteServerPeers:
post:
operationId: DescribeRouteServerPeers
summary: Describe Route Server Peers
description: 'Describes one or more route server peers. A route server peer is a session between a route server endpoint and the device deployed in Amazon Web Services (such as a firewall appliance or other network security function running on an EC2 instance). The device must meet these requirements: Have an elastic network interface in the VPC Support BGP (Border Gateway Protocol) Can initiate BGP sessions For more information see Dynamic routing in your VPC with VPC Route Server in the Amazon VPC User Guide.'
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeRouteServerPeersResult'
requestBody:
required: true
content:
application/x-www-form-urlencoded:
schema:
allOf:
- type: object
required:
- Action
- Version
properties:
Action:
type: string
const: DescribeRouteServerPeers
Version:
type: string
const: '2016-11-15'
- $ref: '#/components/schemas/DescribeRouteServerPeersRequest'
tags:
- Route Server Peer
components:
schemas:
DescribeRouteServerPeersRequest:
type: object
properties:
RouteServerPeerIds:
type: array
items:
type: string
description: The IDs of the route server peers to describe.
NextToken:
type: string
description: The token for the next page of results.
MaxResults:
type: integer
description: The maximum number of results to return with a single call.
Filters:
type: array
items:
$ref: '#/components/schemas/Filter'
description: One or more filters to apply to the describe request.
DryRun:
type: boolean
description: A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
DeleteRouteServerPeerResult:
type: object
properties:
RouteServerPeer:
$ref: '#/components/schemas/RouteServerPeer'
RouteServerBgpOptions:
type: object
properties:
PeerAsn:
type: integer
description: The Border Gateway Protocol (BGP) Autonomous System Number (ASN) for the appliance. Valid values are from 1 to 4294967295. We recommend using a private ASN in the 64512–65534 (16-bit ASN) or 4200000000–4294967294 (32-bit ASN) range.
PeerLivenessDetection:
type: string
enum:
- bfd
- bgp-keepalive
description: 'The liveness detection protocol used for the BGP peer. The requested liveness detection protocol for the BGP peer. bgp-keepalive: The standard BGP keep alive mechanism (RFC4271) that is stable but may take longer to fail-over in cases of network impact or router failure. bfd: An additional Bidirectional Forwarding Detection (BFD) protocol (RFC5880) that enables fast failover by using more sensitive liveness detection. Defaults to bgp-keepalive.'
DeleteRouteServerPeerRequest:
type: object
properties:
RouteServerPeerId:
type: string
description: The ID of the route server peer to delete.
DryRun:
type: boolean
description: A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
required:
- RouteServerPeerId
CreateRouteServerPeerResult:
type: object
properties:
RouteServerPeer:
$ref: '#/components/schemas/RouteServerPeer'
Tag:
type: object
properties:
Key:
type: string
description: 'The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.'
Value:
type: string
description: 'The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.'
RouteServerBgpStatus:
type: object
properties:
Status:
type: string
enum:
- up
- down
description: The operational status of the BGP session. The status enables you to monitor session liveness if you lack monitoring on your router/appliance.
RouteServerBgpOptionsRequest:
type: object
properties:
PeerAsn:
type: integer
description: The Border Gateway Protocol (BGP) Autonomous System Number (ASN) for the appliance. Valid values are from 1 to 4294967295. We recommend using a private ASN in the 64512–65534 (16-bit ASN) or 4200000000–4294967294 (32-bit ASN) range.
PeerLivenessDetection:
type: string
enum:
- bfd
- bgp-keepalive
description: 'The requested liveness detection protocol for the BGP peer. bgp-keepalive: The standard BGP keep alive mechanism (RFC4271) that is stable but may take longer to fail-over in cases of network impact or router failure. bfd: An additional Bidirectional Forwarding Detection (BFD) protocol (RFC5880) that enables fast failover by using more sensitive liveness detection. Defaults to bgp-keepalive.'
required:
- PeerAsn
RouteServerPeer:
type: object
properties:
RouteServerPeerId:
type: string
description: The unique identifier of the route server peer.
RouteServerEndpointId:
type: string
description: The ID of the route server endpoint associated with this peer.
RouteServerId:
type: string
description: The ID of the route server associated with this peer.
VpcId:
type: string
description: The ID of the VPC containing the route server peer.
SubnetId:
type: string
description: The ID of the subnet containing the route server peer.
State:
type: string
enum:
- pending
- available
- deleting
- deleted
- failing
- failed
description: The current state of the route server peer.
FailureReason:
type: string
description: The reason for any failure in peer creation or operation.
EndpointEniId:
type: string
description: The ID of the Elastic network interface for the route server endpoint.
EndpointEniAddress:
type: string
description: The IP address of the Elastic network interface for the route server endpoint.
PeerAddress:
type: string
description: The IPv4 address of the peer device.
BgpOptions:
$ref: '#/components/schemas/RouteServerBgpOptions'
BgpStatus:
$ref: '#/components/schemas/RouteServerBgpStatus'
BfdStatus:
$ref: '#/components/schemas/RouteServerBfdStatus'
Tags:
type: array
items:
$ref: '#/components/schemas/Tag'
description: Any tags assigned to the route server peer.
RouteServerBfdStatus:
type: object
properties:
Status:
type: string
enum:
- up
- down
description: The operational status of the BFD session.
TagSpecification:
type: object
properties:
ResourceType:
type: string
enum:
- capacity-reservation
- client-vpn-endpoint
- customer-gateway
- carrier-gateway
- coip-pool
- declarative-policies-report
- dedicated-host
- dhcp-options
- egress-only-internet-gateway
- elastic-ip
- elastic-gpu
- export-image-task
- export-instance-task
- fleet
- fpga-image
- host-reservation
- image
- image-usage-report
- import-image-task
- import-snapshot-task
- instance
- instance-event-window
- internet-gateway
- ipam
- ipam-pool
- ipam-scope
- ipv4pool-ec2
- ipv6pool-ec2
- key-pair
- launch-template
- local-gateway
- local-gateway-route-table
- local-gateway-virtual-interface
- local-gateway-virtual-interface-group
- local-gateway-route-table-vpc-association
- local-gateway-route-table-virtual-interface-group-association
- natgateway
- network-acl
- network-interface
- network-insights-analysis
- network-insights-path
- network-insights-access-scope
- network-insights-access-scope-analysis
- outpost-lag
- placement-group
- prefix-list
- replace-root-volume-task
- reserved-instances
- route-table
- security-group
- security-group-rule
- service-link-virtual-interface
- snapshot
- spot-fleet-request
- spot-instances-request
- subnet
- subnet-cidr-reservation
- traffic-mirror-filter
- traffic-mirror-session
- traffic-mirror-target
- transit-gateway
- transit-gateway-attachment
- transit-gateway-connect-peer
- transit-gateway-multicast-domain
- transit-gateway-policy-table
- transit-gateway-metering-policy
- transit-gateway-route-table
- transit-gateway-route-table-announcement
- volume
- vpc
- vpc-endpoint
- vpc-endpoint-connection
- vpc-endpoint-service
- vpc-endpoint-service-permission
- vpc-peering-connection
- vpn-connection
- vpn-gateway
- vpc-flow-log
- capacity-reservation-fleet
- traffic-mirror-filter-rule
- vpc-endpoint-connection-device-type
- verified-access-instance
- verified-access-group
- verified-access-endpoint
- verified-access-policy
- verified-access-trust-provider
- vpn-connection-device-type
- vpc-block-public-access-exclusion
- vpc-encryption-control
- route-server
- route-server-endpoint
- route-server-peer
- ipam-resource-discovery
- ipam-resource-discovery-association
- instance-connect-endpoint
- verified-access-endpoint-target
- ipam-external-resource-verification-token
- capacity-block
- mac-modification-task
- ipam-prefix-list-resolver
- ipam-policy
- ipam-prefix-list-resolver-target
- ipam-internet-registry-association
- secondary-interface
- secondary-network
- secondary-subnet
- capacity-manager-data-export
- vpn-concentrator
- ipam-pool-allocation
- capacity-reservation-cancellation-quote
- application-status-check
- capacity-reservation-modification-quote
description: The type of resource to tag on creation.
Tags:
type: array
items:
$ref: '#/components/schemas/Tag'
description: The tags to apply to the resource.
CreateRouteServerPeerRequest:
type: object
properties:
RouteServerEndpointId:
type: string
description: The ID of the route server endpoint for which to create a peer.
PeerAddress:
type: string
description: The IPv4 address of the peer device.
BgpOptions:
$ref: '#/components/schemas/RouteServerBgpOptionsRequest'
DryRun:
type: boolean
description: A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
TagSpecifications:
type: array
items:
$ref: '#/components/schemas/TagSpecification'
description: The tags to apply to the route server peer during creation.
required:
- RouteServerEndpointId
- PeerAddress
- BgpOptions
Filter:
type: object
properties:
Name:
type: string
description: The name of the filter. Filter names are case-sensitive.
Values:
type: array
items:
type: string
description: The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.
DescribeRouteServerPeersResult:
type: object
properties:
RouteServerPeers:
type: array
items:
$ref: '#/components/schemas/RouteServerPeer'
description: Information about the described route server peers.
NextToken:
type: string
description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
securitySchemes:
sigv4:
type: apiKey
in: header
name: Authorization
description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
x-aws-sigv4:
signingName: ec2
x-provenance:
method: harvested
publisher: Amazon Web Services
source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/ec2/service/2016-11-15/ec2-2016-11-15.json
note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)