Skip to content

AWS Network Manager API

by amazonaws.com

API keyHTTPSCloud Platforms
Open documentation ↗

Overview

Amazon Web Services enables you to centrally manage your Amazon Web Services Cloud WAN core network and your Transit Gateway network across Amazon Web Services accounts, Regions, and on-premises locations.

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

At a glance

Authentication
API key
HTTPS
Yes
CORS
Unknown
Version
2019-07-05
Endpoints
85
Spec updated
2020-03-11

Endpoints

MethodPathWhat it does
POST/attachments/{attachmentId}/accept<p>Accepts a core network attachment request. </p> <p>Once the attachment request is accepted by a core network owner, the attachment is created and connected t
GET/global-networks/{globalNetworkId}/connect-peer-associationsReturns information about a core network Connect peer associations.
POST/global-networks/{globalNetworkId}/connect-peer-associations<p>Associates a core network Connect peer with a device and optionally, with a link. </p> <p>If you specify a link, it must be associated with the specified dev
GET/global-networks/{globalNetworkId}/customer-gateway-associationsGets the association information for customer gateways that are associated with devices and links in your global network.
POST/global-networks/{globalNetworkId}/customer-gateway-associations<p>Associates a customer gateway with a device and optionally, with a link. If you specify a link, it must be associated with the specified device. </p> <p>You
GET/global-networks/{globalNetworkId}/link-associationsGets the link associations for a device or a link. Either the device ID or the link ID must be specified.
POST/global-networks/{globalNetworkId}/link-associationsAssociates a link to a device. A device can be associated to multiple links and a link can be associated to multiple devices. The device and link must be in the
GET/global-networks/{globalNetworkId}/transit-gateway-connect-peer-associationsGets information about one or more of your transit gateway Connect peer associations in a global network.
POST/global-networks/{globalNetworkId}/transit-gateway-connect-peer-associations<p>Associates a transit gateway Connect peer with a device, and optionally, with a link. If you specify a link, it must be associated with the specified device.
POST/connect-attachments<p>Creates a core network Connect attachment from a specified core network attachment. </p> <p>A core network Connect attachment is a GRE-based tunnel attachmen
GET/connect-peersReturns a list of core network Connect peers.
POST/connect-peersCreates a core network Connect peer for a specified core network connect attachment between a core network and an appliance. The peer address and transit gatewa
GET/global-networks/{globalNetworkId}/connectionsGets information about one or more of your connections in a global network.
POST/global-networks/{globalNetworkId}/connectionsCreates a connection between two devices. The devices can be a physical or virtual appliance that connects to a third-party appliance in a VPC, or a physical ap
GET/core-networksReturns a list of owned and shared core networks.
POST/core-networksCreates a core network as part of your global network, and optionally, with a core network policy.
GET/global-networks/{globalNetworkId}/devicesGets information about one or more of your devices in a global network.
POST/global-networks/{globalNetworkId}/devicesCreates a new device in a global network. If you specify both a site ID and a location, the location of the site is used for visualization in the Network Manage
GET/global-networksDescribes one or more global networks. By default, all global networks are described. To describe the objects in your global network, you must use the appropria
POST/global-networksCreates a new, empty global network.
GET/global-networks/{globalNetworkId}/links<p>Gets information about one or more links in a specified global network.</p> <p>If you specify the site ID, you cannot specify the type or provider in the sam
POST/global-networks/{globalNetworkId}/linksCreates a new link for a specified site.
GET/global-networks/{globalNetworkId}/sitesGets information about one or more of your sites in a global network.
POST/global-networks/{globalNetworkId}/sitesCreates a new site in a global network.
POST/site-to-site-vpn-attachmentsCreates an Amazon Web Services site-to-site VPN attachment on an edge location of a core network.
POST/transit-gateway-peeringsCreates a transit gateway peering connection.
POST/transit-gateway-route-table-attachmentsCreates a transit gateway route table attachment.
POST/vpc-attachmentsCreates a VPC attachment on an edge location of a core network.
DELETE/attachments/{attachmentId}Deletes an attachment. Supports all attachment types.
GET/connect-peers/{connectPeerId}Returns information about a core network Connect peer.
DELETE/connect-peers/{connectPeerId}Deletes a Connect peer.
PATCH/global-networks/{globalNetworkId}/connections/{connectionId}Updates the information for an existing connection. To remove information for any of the parameters, specify an empty string.
DELETE/global-networks/{globalNetworkId}/connections/{connectionId}Deletes the specified connection in your global network.
GET/core-networks/{coreNetworkId}Returns information about the LIVE policy for a core network.
PATCH/core-networks/{coreNetworkId}Updates the description of a core network.
DELETE/core-networks/{coreNetworkId}Deletes a core network along with all core network policies. This can only be done if there are no attachments on a core network.
DELETE/core-networks/{coreNetworkId}/core-network-policy-versions/{policyVersionId}Deletes a policy version from a core network. You can't delete the current LIVE policy.
PATCH/global-networks/{globalNetworkId}/devices/{deviceId}Updates the details for an existing device. To remove information for any of the parameters, specify an empty string.
DELETE/global-networks/{globalNetworkId}/devices/{deviceId}Deletes an existing device. You must first disassociate the device from any links and customer gateways.
PATCH/global-networks/{globalNetworkId}Updates an existing global network. To remove information for any of the parameters, specify an empty string.
DELETE/global-networks/{globalNetworkId}Deletes an existing global network. You must first delete all global network objects (devices, links, and sites), deregister all transit gateways, and delete an
PATCH/global-networks/{globalNetworkId}/links/{linkId}Updates the details for an existing link. To remove information for any of the parameters, specify an empty string.
DELETE/global-networks/{globalNetworkId}/links/{linkId}Deletes an existing link. You must first disassociate the link from any devices and customer gateways.
DELETE/peerings/{peeringId}Deletes an existing peering connection.
GET/resource-policy/{resourceArn}Returns information about a resource policy.
POST/resource-policy/{resourceArn}Creates or updates a resource policy.
DELETE/resource-policy/{resourceArn}Deletes a resource policy for the specified resource. This revokes the access of the principals specified in the resource policy.
PATCH/global-networks/{globalNetworkId}/sites/{siteId}Updates the information for an existing site. To remove information for any of the parameters, specify an empty string.
DELETE/global-networks/{globalNetworkId}/sites/{siteId}Deletes an existing site. The site cannot be associated with any device or link.
DELETE/global-networks/{globalNetworkId}/transit-gateway-registrations/{transitGatewayArn}Deregisters a transit gateway from your global network. This action does not delete your transit gateway, or modify any of its attachments. This action removes
DELETE/global-networks/{globalNetworkId}/connect-peer-associations/{connectPeerId}Disassociates a core network Connect peer from a device and a link.
DELETE/global-networks/{globalNetworkId}/customer-gateway-associations/{customerGatewayArn}Disassociates a customer gateway from a device and a link.
DELETE/global-networks/{globalNetworkId}/link-associations#deviceId&linkIdDisassociates an existing device from a link. You must first disassociate any customer gateways that are associated with the link.
DELETE/global-networks/{globalNetworkId}/transit-gateway-connect-peer-associations/{transitGatewayConnectPeerArn}Disassociates a transit gateway Connect peer from a device and link.
POST/core-networks/{coreNetworkId}/core-network-change-sets/{policyVersionId}/executeExecutes a change set on your core network. Deploys changes globally based on the policy submitted..
GET/connect-attachments/{attachmentId}Returns information about a core network Connect attachment.
GET/core-networks/{coreNetworkId}/core-network-change-events/{policyVersionId}Returns information about a core network change event.
GET/core-networks/{coreNetworkId}/core-network-change-sets/{policyVersionId}Returns a change set between the LIVE core network policy and a submitted policy.
GET/core-networks/{coreNetworkId}/core-network-policyReturns details about a core network policy. You can get details about your current live policy or any previous policy version.
POST/core-networks/{coreNetworkId}/core-network-policyCreates a new, immutable version of a core network policy. A subsequent change set is created showing the differences between the LIVE policy and the submitted
GET/global-networks/{globalNetworkId}/network-resource-countGets the count of network resources, by resource type, for the specified global network.
GET/global-networks/{globalNetworkId}/network-resource-relationshipsGets the network resource relationships for the specified global network.
GET/global-networks/{globalNetworkId}/network-resources<p>Describes the network resources for the specified global network.</p> <p>The results include information from the corresponding Describe call for the resourc
POST/global-networks/{globalNetworkId}/network-routesGets the network routes of the specified global network.
GET/global-networks/{globalNetworkId}/network-telemetryGets the network telemetry of the specified global network.
GET/global-networks/{globalNetworkId}/route-analyses/{routeAnalysisId}Gets information about the specified route analysis.
GET/site-to-site-vpn-attachments/{attachmentId}Returns information about a site-to-site VPN attachment.
GET/transit-gateway-peerings/{peeringId}Returns information about a transit gateway peer.
GET/global-networks/{globalNetworkId}/transit-gateway-registrationsGets information about the transit gateway registrations in a specified global network.
POST/global-networks/{globalNetworkId}/transit-gateway-registrationsRegisters a transit gateway in your global network. Not all Regions support transit gateways for global networks. For a list of the supported Regions, see <a hr
GET/transit-gateway-route-table-attachments/{attachmentId}Returns information about a transit gateway route table attachment.
GET/vpc-attachments/{attachmentId}Returns information about a VPC attachment.
PATCH/vpc-attachments/{attachmentId}Updates a VPC attachment.
GET/attachmentsReturns a list of core network attachments.
GET/core-networks/{coreNetworkId}/core-network-policy-versionsReturns a list of core network policy versions.
GET/organizations/service-accessGets the status of the Service Linked Role (SLR) deployment for the accounts in a given Amazon Web Services Organization.
POST/organizations/service-accessEnables the Network Manager service for an Amazon Web Services Organization. This can only be called by a management account within the organization.
GET/peeringsLists the peerings for a core network.
GET/tags/{resourceArn}Lists the tags for a specified resource.
POST/tags/{resourceArn}Tags a specified resource.
POST/attachments/{attachmentId}/rejectRejects a core network attachment request.
POST/core-networks/{coreNetworkId}/core-network-policy-versions/{policyVersionId}/restoreRestores a previous policy version as a new, immutable version of a core network policy. A subsequent change set is created showing the differences between the
POST/global-networks/{globalNetworkId}/route-analysesStarts analyzing the routing path between the specified source and destination. For more information, see <a href="https://docs.aws.amazon.com/vpc/latest/tgw/ro
DELETE/tags/{resourceArn}#tagKeysRemoves tags from a specified resource.
PATCH/global-networks/{globalNetworkId}/network-resources/{resourceArn}/metadataUpdates the resource metadata for the specified global network.

Questions

Does the AWS Network Manager API need an API key?

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

Does the AWS Network Manager API support HTTPS?

Yes, the AWS Network Manager API is served over HTTPS.

How many endpoints does the AWS Network Manager API have?

Its OpenAPI description lists 85 endpoints in version 2019-07-05. All of them are shown on this page.

What are alternatives to the AWS Network Manager 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).