PUT

/v20190125/meshes/{meshName}/virtualGateway/{virtualGatewayName}/gatewayRoutes

http://appmesh.{region}.amazonaws.com/v20190125/meshes/{meshName}/virtualGateway/{virtualGatewayName}/gatewayRoutes

Creates a gateway route. A gateway route is attached to a virtual gateway and routes traffic to an existing virtual service. If a route matches a request, it can distribute traffic to a target virtual service. For more information about gateway routes, see <a href="https://docs.aws.amazon.com/app-mesh/latest/userguide/gateway-routes.html">Gateway routes</a>.

Access Token Required: API Key

Path Parameters

meshNamestringrequired

The name of the service mesh to create the gateway route in.

virtualGatewayNamestringrequired

The name of the virtual gateway to associate the gateway route with. If the virtual gateway is in a shared mesh, then you must be the owner of the virtual gateway resource.

Query Params

meshOwnerstring

The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then the account that you specify must share the mesh with your account before you can create the resource in the service mesh. For more information about mesh sharing, see <a href="https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html">Working with shared meshes</a>.

Body Params

specobjectrequired

An object that represents a gateway route specification. Specify one gateway route type.

tagsarray

Optional metadata that you can apply to the gateway route to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.

clientTokenstring

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed.

gatewayRouteNamestringrequired

The name to use for the gateway route.

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 PUT \
2     --url 'http://appmesh.{region}.amazonaws.com/v20190125/meshes/{meshName}/virtualGateway/{virtualGatewayName}/gatewayRoutes' \
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}

1curl --request PUT \ 2 --url 'http://appmesh.{region}.amazonaws.com/v20190125/meshes/{meshName}/virtualGateway/{virtualGatewayName}/gatewayRoutes' \ 3 --header 'accept: application/json' \ 4 --header 'content-type: application/json'