Skip to content

AWS Direct Connect API

by amazonaws.com

API keyHTTPSCloud Platforms
Open documentation ↗

Overview

Direct Connect links your internal network to an Direct Connect location over a standard Ethernet fiber-optic cable. One end of the cable is connected to your router, the other to an Direct Connect router. With this connection in place, you can create virtual interfaces directly to the Amazon Web Services Cloud (for example, to Amazon EC2 and Amazon S3) and to Amazon VPC, bypassing Internet service providers in your network path. A connection provides access to all Amazon Web Services Regions except the China (Beijing) and (China) Ningxia Regions. Amazon Web Services resources in the China Regions can only be accessed through locations associated with those Regions.

AWS Direct Connect is a cloud platforms API from amazonaws.com. Requests are authenticated with an API key. It is served over HTTPS. Its OpenAPI description documents 63 endpoints.

At a glance

Authentication
API key
HTTPS
Yes
CORS
Unknown
Version
2012-10-25
Endpoints
63
Spec updated
2020-03-11

Endpoints

MethodPathWhat it does
POST/#X-Amz-Target=OvertureService.AcceptDirectConnectGatewayAssociationProposalAccepts a proposal request to attach a virtual private gateway or transit gateway to a Direct Connect gateway.
POST/#X-Amz-Target=OvertureService.AllocateConnectionOnInterconnectdeprecated<p>Deprecated. Use <a>AllocateHostedConnection</a> instead.</p> <p>Creates a hosted connection on an interconnect.</p> <p>Allocates a VLAN number and a specifie
POST/#X-Amz-Target=OvertureService.AllocateHostedConnection<p>Creates a hosted connection on the specified interconnect or a link aggregation group (LAG) of interconnects.</p> <p>Allocates a VLAN number and a specified
POST/#X-Amz-Target=OvertureService.AllocatePrivateVirtualInterface<p>Provisions a private virtual interface to be owned by the specified Amazon Web Services account.</p> <p>Virtual interfaces created using this action must be
POST/#X-Amz-Target=OvertureService.AllocatePublicVirtualInterface<p>Provisions a public virtual interface to be owned by the specified Amazon Web Services account.</p> <p>The owner of a connection calls this function to provi
POST/#X-Amz-Target=OvertureService.AllocateTransitVirtualInterface<p>Provisions a transit virtual interface to be owned by the specified Amazon Web Services account. Use this type of interface to connect a transit gateway to y
POST/#X-Amz-Target=OvertureService.AssociateConnectionWithLag<p>Associates an existing connection with a link aggregation group (LAG). The connection is interrupted and re-established as a member of the LAG (connectivity
POST/#X-Amz-Target=OvertureService.AssociateHostedConnection<p>Associates a hosted connection and its virtual interfaces with a link aggregation group (LAG) or interconnect. If the target interconnect or LAG has an exist
POST/#X-Amz-Target=OvertureService.AssociateMacSecKey<p>Associates a MAC Security (MACsec) Connection Key Name (CKN)/ Connectivity Association Key (CAK) pair with an Direct Connect dedicated connection.</p> <p>You
POST/#X-Amz-Target=OvertureService.AssociateVirtualInterface<p>Associates a virtual interface with a specified link aggregation group (LAG) or connection. Connectivity to Amazon Web Services is temporarily interrupted as
POST/#X-Amz-Target=OvertureService.ConfirmConnection<p>Confirms the creation of the specified hosted connection on an interconnect.</p> <p>Upon creation, the hosted connection is initially in the <code>Ordering</
POST/#X-Amz-Target=OvertureService.ConfirmCustomerAgreementThe confirmation of the terms of agreement when creating the connection/link aggregation group (LAG).
POST/#X-Amz-Target=OvertureService.ConfirmPrivateVirtualInterface<p>Accepts ownership of a private virtual interface created by another Amazon Web Services account.</p> <p>After the virtual interface owner makes this call, th
POST/#X-Amz-Target=OvertureService.ConfirmPublicVirtualInterface<p>Accepts ownership of a public virtual interface created by another Amazon Web Services account.</p> <p>After the virtual interface owner makes this call, the
POST/#X-Amz-Target=OvertureService.ConfirmTransitVirtualInterface<p>Accepts ownership of a transit virtual interface created by another Amazon Web Services account.</p> <p> After the owner of the transit virtual interface mak
POST/#X-Amz-Target=OvertureService.CreateBGPPeer<p>Creates a BGP peer on the specified virtual interface.</p> <p>You must create a BGP peer for the corresponding address family (IPv4/IPv6) in order to access
POST/#X-Amz-Target=OvertureService.CreateConnection<p>Creates a connection between a customer network and a specific Direct Connect location.</p> <p>A connection links your internal network to an Direct Connect
POST/#X-Amz-Target=OvertureService.CreateDirectConnectGatewayCreates a Direct Connect gateway, which is an intermediate object that enables you to connect a set of virtual interfaces and virtual private gateways. A Direct
POST/#X-Amz-Target=OvertureService.CreateDirectConnectGatewayAssociationCreates an association between a Direct Connect gateway and a virtual private gateway. The virtual private gateway must be attached to a VPC and must not be ass
POST/#X-Amz-Target=OvertureService.CreateDirectConnectGatewayAssociationProposal<p>Creates a proposal to associate the specified virtual private gateway or transit gateway with the specified Direct Connect gateway.</p> <p>You can associate
POST/#X-Amz-Target=OvertureService.CreateInterconnect<p>Creates an interconnect between an Direct Connect Partner's network and a specific Direct Connect location.</p> <p>An interconnect is a connection that is ca
POST/#X-Amz-Target=OvertureService.CreateLag<p>Creates a link aggregation group (LAG) with the specified number of bundled physical dedicated connections between the customer network and a specific Direct
POST/#X-Amz-Target=OvertureService.CreatePrivateVirtualInterface<p>Creates a private virtual interface. A virtual interface is the VLAN that transports Direct Connect traffic. A private virtual interface can be connected to
POST/#X-Amz-Target=OvertureService.CreatePublicVirtualInterface<p>Creates a public virtual interface. A virtual interface is the VLAN that transports Direct Connect traffic. A public virtual interface supports sending traff
POST/#X-Amz-Target=OvertureService.CreateTransitVirtualInterface<p>Creates a transit virtual interface. A transit virtual interface should be used to access one or more transit gateways associated with Direct Connect gateway
POST/#X-Amz-Target=OvertureService.DeleteBGPPeer<p>Deletes the specified BGP peer on the specified virtual interface with the specified customer address and ASN.</p> <p>You cannot delete the last BGP peer fro
POST/#X-Amz-Target=OvertureService.DeleteConnection<p>Deletes the specified connection.</p> <p>Deleting a connection only stops the Direct Connect port hour and data transfer charges. If you are partnering with
POST/#X-Amz-Target=OvertureService.DeleteDirectConnectGatewayDeletes the specified Direct Connect gateway. You must first delete all virtual interfaces that are attached to the Direct Connect gateway and disassociate all
POST/#X-Amz-Target=OvertureService.DeleteDirectConnectGatewayAssociation<p>Deletes the association between the specified Direct Connect gateway and virtual private gateway.</p> <p>We recommend that you specify the <code>associationI
POST/#X-Amz-Target=OvertureService.DeleteDirectConnectGatewayAssociationProposalDeletes the association proposal request between the specified Direct Connect gateway and virtual private gateway or transit gateway.
POST/#X-Amz-Target=OvertureService.DeleteInterconnect<p>Deletes the specified interconnect.</p> <note> <p>Intended for use by Direct Connect Partners only.</p> </note>
POST/#X-Amz-Target=OvertureService.DeleteLagDeletes the specified link aggregation group (LAG). You cannot delete a LAG if it has active virtual interfaces or hosted connections.
POST/#X-Amz-Target=OvertureService.DeleteVirtualInterfaceDeletes a virtual interface.
POST/#X-Amz-Target=OvertureService.DescribeConnectionLoadeprecated<p>Deprecated. Use <a>DescribeLoa</a> instead.</p> <p>Gets the LOA-CFA for a connection.</p> <p>The Letter of Authorization - Connecting Facility Assignment (LO
POST/#X-Amz-Target=OvertureService.DescribeConnectionsDisplays the specified connection or all connections in this Region.
POST/#X-Amz-Target=OvertureService.DescribeConnectionsOnInterconnectdeprecated<p>Deprecated. Use <a>DescribeHostedConnections</a> instead.</p> <p>Lists the connections that have been provisioned on the specified interconnect.</p> <note> <
POST/#X-Amz-Target=OvertureService.DescribeCustomerMetadataGet and view a list of customer agreements, along with their signed status and whether the customer is an NNIPartner, NNIPartnerV2, or a nonPartner.
POST/#X-Amz-Target=OvertureService.DescribeDirectConnectGatewayAssociationProposalsDescribes one or more association proposals for connection between a virtual private gateway or transit gateway and a Direct Connect gateway.
POST/#X-Amz-Target=OvertureService.DescribeDirectConnectGatewayAssociations<p>Lists the associations between your Direct Connect gateways and virtual private gateways and transit gateways. You must specify one of the following:</p> <ul
POST/#X-Amz-Target=OvertureService.DescribeDirectConnectGatewayAttachmentsLists the attachments between your Direct Connect gateways and virtual interfaces. You must specify a Direct Connect gateway, a virtual interface, or both. If y
POST/#X-Amz-Target=OvertureService.DescribeDirectConnectGatewaysLists all your Direct Connect gateways or only the specified Direct Connect gateway. Deleted Direct Connect gateways are not returned.
POST/#X-Amz-Target=OvertureService.DescribeHostedConnections<p>Lists the hosted connections that have been provisioned on the specified interconnect or link aggregation group (LAG).</p> <note> <p>Intended for use by Dire
POST/#X-Amz-Target=OvertureService.DescribeInterconnectLoadeprecated<p>Deprecated. Use <a>DescribeLoa</a> instead.</p> <p>Gets the LOA-CFA for the specified interconnect.</p> <p>The Letter of Authorization - Connecting Facility
POST/#X-Amz-Target=OvertureService.DescribeInterconnectsLists the interconnects owned by the Amazon Web Services account or only the specified interconnect.
POST/#X-Amz-Target=OvertureService.DescribeLagsDescribes all your link aggregation groups (LAG) or the specified LAG.
POST/#X-Amz-Target=OvertureService.DescribeLoa<p>Gets the LOA-CFA for a connection, interconnect, or link aggregation group (LAG).</p> <p>The Letter of Authorization - Connecting Facility Assignment (LOA-CF
POST/#X-Amz-Target=OvertureService.DescribeLocationsLists the Direct Connect locations in the current Amazon Web Services Region. These are the locations that can be selected when calling <a>CreateConnection</a>
POST/#X-Amz-Target=OvertureService.DescribeRouterConfigurationDetails about the router.
POST/#X-Amz-Target=OvertureService.DescribeTagsDescribes the tags associated with the specified Direct Connect resources.
POST/#X-Amz-Target=OvertureService.DescribeVirtualGateways<p>Lists the virtual private gateways owned by the Amazon Web Services account.</p> <p>You can create one or more Direct Connect private virtual interfaces link
POST/#X-Amz-Target=OvertureService.DescribeVirtualInterfaces<p>Displays all virtual interfaces for an Amazon Web Services account. Virtual interfaces deleted fewer than 15 minutes before you make the request are also ret
POST/#X-Amz-Target=OvertureService.DisassociateConnectionFromLag<p>Disassociates a connection from a link aggregation group (LAG). The connection is interrupted and re-established as a standalone connection (the connection i
POST/#X-Amz-Target=OvertureService.DisassociateMacSecKeyRemoves the association between a MAC Security (MACsec) security key and an Direct Connect dedicated connection.
POST/#X-Amz-Target=OvertureService.ListVirtualInterfaceTestHistoryLists the virtual interface failover test history.
POST/#X-Amz-Target=OvertureService.StartBgpFailoverTest<p>Starts the virtual interface failover test that verifies your configuration meets your resiliency requirements by placing the BGP peering session in the DOWN
POST/#X-Amz-Target=OvertureService.StopBgpFailoverTestStops the virtual interface failover test.
POST/#X-Amz-Target=OvertureService.TagResource<p>Adds the specified tags to the specified Direct Connect resource. Each resource can have a maximum of 50 tags.</p> <p>Each tag consists of a key and an optio
POST/#X-Amz-Target=OvertureService.UntagResourceRemoves one or more tags from the specified Direct Connect resource.
POST/#X-Amz-Target=OvertureService.UpdateConnection<p>Updates the Direct Connect dedicated connection configuration.</p> <p>You can update the following parameters for a connection:</p> <ul> <li> <p>The connecti
POST/#X-Amz-Target=OvertureService.UpdateDirectConnectGatewayUpdates the name of a current Direct Connect gateway.
POST/#X-Amz-Target=OvertureService.UpdateDirectConnectGatewayAssociation<p>Updates the specified attributes of the Direct Connect gateway association.</p> <p>Add or remove prefixes from the association.</p>
POST/#X-Amz-Target=OvertureService.UpdateLag<p>Updates the attributes of the specified link aggregation group (LAG).</p> <p>You can update the following LAG attributes:</p> <ul> <li> <p>The name of the LA
POST/#X-Amz-Target=OvertureService.UpdateVirtualInterfaceAttributes<p>Updates the specified attributes of the specified virtual private interface.</p> <p>Setting the MTU of a virtual interface to 9001 (jumbo frames) can cause a

Questions

Does the AWS Direct Connect API need an API key?

Yes. The AWS Direct Connect API uses API key authentication; the documentation explains how to get credentials.

Does the AWS Direct Connect API support HTTPS?

Yes, the AWS Direct Connect API is served over HTTPS.

How many endpoints does the AWS Direct Connect API have?

Its OpenAPI description lists 63 endpoints in version 2012-10-25. All of them are shown on this page.

What are alternatives to the AWS Direct Connect API?

Other Cloud Platforms APIs include Remote Settings PROD, Linode API, DigitalOcean API, Vercel API, Platform API.

Compare alternatives →

Remote Settings PROD

Cloud Platforms

Firefox is a free web browser backed by Mozilla, a non-profit dedicated to internet health and privacy.

No auth19 endpoints

Linode API

Cloud Platforms

## Introduction The Linode API provides the ability to programmatically manage the full range of Linode products and services. This reference is designed to assist application developers and system administrators. Each endpoint includes descriptions, request syntax, and examples using standard HTTP requests. Response data is returned in JSON format. This document was generated from our OpenAPI Specification. See the <a target="_top" href="https://www.openapis.org">OpenAPI website</a> for more information. <a target="_top" href="/docs/api/openapi.yaml">Download the Linode OpenAPI Specification</a>. ## Changelog <a target="_top" href="/docs/products/tools/api/release-notes/">View our Changelog</a> to see release notes on all changes made to our API. ## Access and Authentication Some endpoints are publicly accessible without requiring authentication. All endpoints affecting your Account, however, require either a Personal Access Token or OAuth authentication (when using third-party applications). ### Personal Access Token The easiest way to access the API is with a Personal Access Token (PAT) generated from the <a target="_top" href="https://cloud.linode.com/profile/tokens">Linode Cloud Manager</a> or the [Create Personal Access Token](/docs/api/profile/#personal-access-token-create) endpoint. All scopes for the OAuth security model ([defined below](/docs/api/profile/#oauth)) apply to this security model as well. #### Authentication | Security Scheme Type: | HTTP | |-----------------------|------| | **HTTP Authorization Scheme** | bearer | ### OAuth If you only need to access the Linode API for personal use, we recommend that you create a [personal access token](/docs/api/#personal-access-token). If you're designing an application that can authenticate with an arbitrary Linode user, then you should use the OAuth 2.0 workflows presented in this section. For a more detailed example of an OAuth 2.0 implementation, see our guide on [How to Create an OAuth App with the Linode Python API Library](/docs/products/tools/api/guides/create-an-oauth-app-with-the-python-api-library/#oauth-2-authentication-exchange). Before you implement OAuth in your application, you first need to create an OAuth client. You can do this [with the Linode API](/docs/api/account/#oauth-client-create) or [via the Cloud Manager](https://cloud.linode.com/profile/clients): - When creating the client, you'll supply a `label` and a `redirect_uri` (referred to as the Callback URL in the Cloud Manager). - The response from this endpoint will give you a `client_id` and a `secret`. - Clients can be public or private, and are private by default. You can choose to make the client public when it is created. - A private client is used with applications which can securely store the client secret (that is, the secret returned to you when you first created the client). For example, an application running on a secured server that only the developer has access to would use a private OAuth client. This is also called a confidential client in some OAuth documentation. - A public client is used with applications where the client secret is not guaranteed to be secure. For example, a native app running on a user's computer may not be able to keep the client secret safe, as a user could potentially inspect the source of the application. So, native apps or apps that run in a user's browser should use a public client. - Public and private clients follow different workflows, as described below. #### OAuth Workflow The OAuth workflow is a series of exchanges between your third-party app and Linode. The workflow is used to authenticate a user before an application can start making API calls on the user's behalf. Notes: - With respect to the diagram in [section 1.2 of RFC 6749](https://tools.ietf.org/html/rfc6749#section-1.2), login.linode.com (referred to in this section as the *login server*) is the Resource Owner and the Authorization Server; api.linode.com (referred to here as the *api se

Bearer token350 endpoints

DigitalOcean API

Cloud Platforms

# Introduction The DigitalOcean API allows you to manage Droplets and resources within the DigitalOcean cloud in a simple, programmatic way using conventional HTTP requests. All of the functionality that you are familiar with in the DigitalOcean control panel is also available through the API, allowing you to script the complex actions that your situation requires. The API documentation will start with a general overview about the design and technology that has been implemented, followed by reference information about specific endpoints. ## Requests Any tool that is fluent in HTTP can communicate with the API simply by requesting the correct URI. Requests should be made using the HTTPS protocol so that traffic is encrypted. The interface responds to different methods depending on the action required. |Method|Usage| |--- |--- | |GET|For simple retrieval of information about your account, Droplets, or environment, you should use the GET method. The information you request will be returned to you as a JSON object. The attributes defined by the JSON object can be used to form additional requests. Any request using the GET method is read-only and will not affect any of the objects you are querying.| |DELETE|To destroy a resource and remove it from your account and environment, the DELETE method should be used. This will remove the specified object if it is found. If it is not found, the operation will return a response indicating that the object was not found. This idempotency means that you do not have to check for a resource's availability prior to issuing a delete command, the final state will be the same regardless of its existence.| |PUT|To update the information about a resource in your account, the PUT method is available. Like the DELETE Method, the PUT method is idempotent. It sets the state of the target using the provided values, regardless of their current values. Requests using the PUT method do not need to check the current attributes of the object.| |PATCH|Some resources support partial modification. In these cases, the PATCH method is available. Unlike PUT which generally requires a complete representation of a resource, a PATCH request is is a set of instructions on how to modify a resource updating only specific attributes.| |POST|To create a new object, your request should specify the POST method. The POST request includes all of the attributes necessary to create a new object. When you wish to create a new object, send a POST request to the target endpoint.| |HEAD|Finally, to retrieve metadata information, you should use the HEAD method to get the headers. This returns only the header of what would be returned with an associated GET request. Response headers contain some useful information about your API access and the results that are available for your request. For instance, the headers contain your current rate-limit value and the amount of time available until the limit resets. It also contains metrics about the total number of objects found, pagination information, and the total content length.| ## HTTP Statuses Along with the HTTP methods that the API responds to, it will also return standard HTTP statuses, including error codes. In the event of a problem, the status will contain the error code, while the body of the response will usually contain additional information about the problem that was encountered. In general, if the status returned is in the 200 range, it indicates that the request was fulfilled successfully and that no error was encountered. Return codes in the 400 range typically indicate that there was an issue with the request that was sent. Among other things, this could mean that you did not authenticate correctly, that you are requesting an action that you do not have authorization for, that the object you are requesting does not exist, or that your request is malformed. If you receive a status in the 500 range, this generally indicates a server-side problem. This means that we are having

Bearer token290 endpoints

Vercel API

Cloud Platforms

Vercel combines the best developer experience with an obsessive focus on end-user performance. Our platform enables frontend teams to do their best work.

Bearer token112 endpoints

Platform API

Cloud Platforms

The [REST API specification](https://www.ably.io/documentation/rest-api) for Ably.

HTTP Basic22 endpoints

Azure Data Lake Storage

Cloud Platforms

Azure Data Lake Storage provides storage for Hadoop and other big data workloads.

No auth10 endpoints

Listed from APIs.guru (CC0).