POST

/global-networks/{globalNetworkId}/route-analyses

http://networkmanager.{region}.amazonaws.com/global-networks/{globalNetworkId}/route-analyses

Starts analyzing the routing path between the specified source and destination. For more information, see <a href="https://docs.aws.amazon.com/vpc/latest/tgw/route-analyzer.html">Route Analyzer</a>.

Access Token Required: API Key

Path Parameters

globalNetworkIdstringrequired

The ID of the global network.

Body Params

Sourceobjectrequired

Describes a source or a destination.

Destinationobjectrequired

Describes a source or a destination.

UseMiddleboxesboolean

Indicates whether to include the location of middlebox appliances in the route analysis. The default is <code>false</code>.

IncludeReturnPathboolean

Indicates whether to analyze the return path. The default is <code>false</code>.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request POST \
2     --url 'http://networkmanager.{region}.amazonaws.com/global-networks/{globalNetworkId}/route-analyses' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}