Amazon EC2 Ec2 Route Server API
The Ec2 Route Server API from Amazon EC2 — 6 operation(s) for ec2 route server.
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-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 API
version: '2016-11-15'
description: Generated from AWS's published Smithy model for Amazon Elastic Compute Cloud. 6 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
paths:
/?Action=AssociateRouteServer:
post:
operationId: AssociateRouteServer
summary: Associate Route Server
description: Associates a route server with a VPC to enable dynamic route updates. A route server association is the connection established between a route server and a VPC. 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/AssociateRouteServerResult'
requestBody:
required: true
content:
application/x-www-form-urlencoded:
schema:
allOf:
- type: object
required:
- Action
- Version
properties:
Action:
type: string
const: AssociateRouteServer
Version:
type: string
const: '2016-11-15'
- $ref: '#/components/schemas/AssociateRouteServerRequest'
tags:
- Route Server
/?Action=CreateRouteServer:
post:
operationId: CreateRouteServer
summary: Create Route Server
description: 'Creates a new route server to manage dynamic routing in a VPC. Amazon VPC Route Server simplifies routing for traffic between workloads that are deployed within a VPC and its internet gateways. With this feature, VPC Route Server dynamically updates VPC and internet gateway route tables with your preferred IPv4 or IPv6 routes to achieve routing fault tolerance for those workloads. This enables you to automatically reroute traffic within a VPC, which increases the manageability of VPC routing and interoperability with third-party workloads. Route server supports the follow route table types: VPC route tables not associated with subnets Subnet route tables Internet gateway route tables Route server does not support route tables associated with virtual private gateways. To propagate routes into a transit gateway route table, use Transit Gateway Connect. 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/CreateRouteServerResult'
requestBody:
required: true
content:
application/x-www-form-urlencoded:
schema:
allOf:
- type: object
required:
- Action
- Version
properties:
Action:
type: string
const: CreateRouteServer
Version:
type: string
const: '2016-11-15'
- $ref: '#/components/schemas/CreateRouteServerRequest'
tags:
- Route Server
/?Action=DeleteRouteServer:
post:
operationId: DeleteRouteServer
summary: Delete Route Server
description: 'Deletes the specified route server. Amazon VPC Route Server simplifies routing for traffic between workloads that are deployed within a VPC and its internet gateways. With this feature, VPC Route Server dynamically updates VPC and internet gateway route tables with your preferred IPv4 or IPv6 routes to achieve routing fault tolerance for those workloads. This enables you to automatically reroute traffic within a VPC, which increases the manageability of VPC routing and interoperability with third-party workloads. Route server supports the follow route table types: VPC route tables not associated with subnets Subnet route tables Internet gateway route tables Route server does not support route tables associated with virtual private gateways. To propagate routes into a transit gateway route table, use Transit Gateway Connect. 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/DeleteRouteServerResult'
requestBody:
required: true
content:
application/x-www-form-urlencoded:
schema:
allOf:
- type: object
required:
- Action
- Version
properties:
Action:
type: string
const: DeleteRouteServer
Version:
type: string
const: '2016-11-15'
- $ref: '#/components/schemas/DeleteRouteServerRequest'
tags:
- Route Server
/?Action=DescribeRouteServers:
post:
operationId: DescribeRouteServers
summary: Describe Route Servers
description: 'Describes one or more route servers. Amazon VPC Route Server simplifies routing for traffic between workloads that are deployed within a VPC and its internet gateways. With this feature, VPC Route Server dynamically updates VPC and internet gateway route tables with your preferred IPv4 or IPv6 routes to achieve routing fault tolerance for those workloads. This enables you to automatically reroute traffic within a VPC, which increases the manageability of VPC routing and interoperability with third-party workloads. Route server supports the follow route table types: VPC route tables not associated with subnets Subnet route tables Internet gateway route tables Route server does not support route tables associated with virtual private gateways. To propagate routes into a transit gateway route table, use Transit Gateway Connect. 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/DescribeRouteServersResult'
requestBody:
required: true
content:
application/x-www-form-urlencoded:
schema:
allOf:
- type: object
required:
- Action
- Version
properties:
Action:
type: string
const: DescribeRouteServers
Version:
type: string
const: '2016-11-15'
- $ref: '#/components/schemas/DescribeRouteServersRequest'
tags:
- Route Server
/?Action=DisassociateRouteServer:
post:
operationId: DisassociateRouteServer
summary: Disassociate Route Server
description: Disassociates a route server from a VPC. A route server association is the connection established between a route server and a VPC. 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/DisassociateRouteServerResult'
requestBody:
required: true
content:
application/x-www-form-urlencoded:
schema:
allOf:
- type: object
required:
- Action
- Version
properties:
Action:
type: string
const: DisassociateRouteServer
Version:
type: string
const: '2016-11-15'
- $ref: '#/components/schemas/DisassociateRouteServerRequest'
tags:
- Route Server
/?Action=ModifyRouteServer:
post:
operationId: ModifyRouteServer
summary: Modify Route Server
description: 'Modifies the configuration of an existing route server. Amazon VPC Route Server simplifies routing for traffic between workloads that are deployed within a VPC and its internet gateways. With this feature, VPC Route Server dynamically updates VPC and internet gateway route tables with your preferred IPv4 or IPv6 routes to achieve routing fault tolerance for those workloads. This enables you to automatically reroute traffic within a VPC, which increases the manageability of VPC routing and interoperability with third-party workloads. Route server supports the follow route table types: VPC route tables not associated with subnets Subnet route tables Internet gateway route tables Route server does not support route tables associated with virtual private gateways. To propagate routes into a transit gateway route table, use Transit Gateway Connect. 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/ModifyRouteServerResult'
requestBody:
required: true
content:
application/x-www-form-urlencoded:
schema:
allOf:
- type: object
required:
- Action
- Version
properties:
Action:
type: string
const: ModifyRouteServer
Version:
type: string
const: '2016-11-15'
- $ref: '#/components/schemas/ModifyRouteServerRequest'
tags:
- Route Server
components:
schemas:
DescribeRouteServersResult:
type: object
properties:
RouteServers:
type: array
items:
$ref: '#/components/schemas/RouteServer'
description: Information about the described route servers.
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.
RouteServer:
type: object
properties:
RouteServerId:
type: string
description: The unique identifier of the route server.
AmazonSideAsn:
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.
State:
type: string
enum:
- pending
- available
- modifying
- deleting
- deleted
description: The current state of the route server.
Tags:
type: array
items:
$ref: '#/components/schemas/Tag'
description: Any tags assigned to the route server.
PersistRoutesState:
type: string
enum:
- enabling
- enabled
- resetting
- disabling
- disabled
- modifying
description: The current state of route persistence for the route server.
PersistRoutesDuration:
type: integer
description: The number of minutes a route server will wait after BGP is re-established to unpersist the routes in the FIB and RIB. Value must be in the range of 1-5. The default value is 1. Only valid if persistRoutesState is 'enabled'. If you set the duration to 1 minute, then when your network appliance re-establishes BGP with route server, it has 1 minute to relearn it's adjacent network and advertise those routes to route server before route server resumes normal functionality. In most cases, 1 minute is probably sufficient. If, however, you have concerns that your BGP network may not be capable of fu
SnsNotificationsEnabled:
type: boolean
description: Indicates whether SNS notifications are enabled for the route server. Enabling SNS notifications persists BGP status changes to an SNS topic provisioned by Amazon Web Services.
SnsTopicArn:
type: string
description: The ARN of the SNS topic where notifications are published.
DeleteRouteServerRequest:
type: object
properties:
RouteServerId:
type: string
description: The ID of the route server 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:
- RouteServerId
AssociateRouteServerRequest:
type: object
properties:
RouteServerId:
type: string
description: The unique identifier for the route server to be associated.
VpcId:
type: string
description: The ID of the VPC to associate with the route server.
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:
- RouteServerId
- VpcId
CreateRouteServerResult:
type: object
properties:
RouteServer:
$ref: '#/components/schemas/RouteServer'
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.'
DisassociateRouteServerResult:
type: object
properties:
RouteServerAssociation:
$ref: '#/components/schemas/RouteServerAssociation'
ModifyRouteServerResult:
type: object
properties:
RouteServer:
$ref: '#/components/schemas/RouteServer'
DeleteRouteServerResult:
type: object
properties:
RouteServer:
$ref: '#/components/schemas/RouteServer'
ModifyRouteServerRequest:
type: object
properties:
RouteServerId:
type: string
description: The ID of the route server to modify.
PersistRoutes:
type: string
enum:
- enable
- disable
- reset
description: 'Specifies whether to persist routes after all BGP sessions are terminated. enable: Routes will be persisted in FIB and RIB after all BGP sessions are terminated. disable: Routes will not be persisted in FIB and RIB after all BGP sessions are terminated. reset: If a route server has persisted routes due to all BGP sessions having ended, reset will withdraw all routes and reset route server to an empty FIB and RIB.'
PersistRoutesDuration:
type: integer
description: The number of minutes a route server will wait after BGP is re-established to unpersist the routes in the FIB and RIB. Value must be in the range of 1-5. Required if PersistRoutes is enabled. If you set the duration to 1 minute, then when your network appliance re-establishes BGP with route server, it has 1 minute to relearn it's adjacent network and advertise those routes to route server before route server resumes normal functionality. In most cases, 1 minute is probably sufficient. If, however, you have concerns that your BGP network may not be capable of fully re-establishing and re-learni
SnsNotificationsEnabled:
type: boolean
description: Specifies whether to enable SNS notifications for route server events. Enabling SNS notifications persists BGP status changes to an SNS topic provisioned by Amazon Web Services.
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:
- RouteServerId
RouteServerAssociation:
type: object
properties:
RouteServerId:
type: string
description: The ID of the associated route server.
VpcId:
type: string
description: The ID of the associated VPC.
State:
type: string
enum:
- associating
- associated
- disassociating
description: The current state of the association.
DescribeRouteServersRequest:
type: object
properties:
RouteServerIds:
type: array
items:
type: string
description: The IDs of the route servers 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.
CreateRouteServerRequest:
type: object
properties:
AmazonSideAsn:
type: integer
description: The private Autonomous System Number (ASN) for the Amazon side of the BGP session. 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.
ClientToken:
type: string
description: Unique, case-sensitive identifier to ensure idempotency of the 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.
PersistRoutes:
type: string
enum:
- enable
- disable
- reset
description: Indicates whether routes should be persisted after all BGP sessions are terminated.
PersistRoutesDuration:
type: integer
description: The number of minutes a route server will wait after BGP is re-established to unpersist the routes in the FIB and RIB. Value must be in the range of 1-5. Required if PersistRoutes is enabled. If you set the duration to 1 minute, then when your network appliance re-establishes BGP with route server, it has 1 minute to relearn it's adjacent network and advertise those routes to route server before route server resumes normal functionality. In most cases, 1 minute is probably sufficient. If, however, you have concerns that your BGP network may not be capable of fully re-establishing and re-learni
SnsNotificationsEnabled:
type: boolean
description: Indicates whether SNS notifications should be enabled for route server events. Enabling SNS notifications persists BGP status changes to an SNS topic provisioned by Amazon Web Services.
TagSpecifications:
type: array
items:
$ref: '#/components/schemas/TagSpecification'
description: The tags to apply to the route server during creation.
required:
- AmazonSideAsn
DisassociateRouteServerRequest:
type: object
properties:
RouteServerId:
type: string
description: The ID of the route server to disassociate.
VpcId:
type: string
description: The ID of the VPC to disassociate from the route server.
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:
- RouteServerId
- VpcId
AssociateRouteServerResult:
type: object
properties:
RouteServerAssociation:
$ref: '#/components/schemas/RouteServerAssociation'
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.
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.
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)