PATCH

/v2/domainnames/{domainName}/apimappings/{apiMappingId}

http://apigateway.{region}.amazonaws.com/v2/domainnames/{domainName}/apimappings/{apiMappingId}

The API mapping.

Access Token Required: API Key

Path Parameters

apiMappingIdstringrequired

The API mapping identifier.

domainNamestringrequired

The domain name.

Body Params

apiIdstringrequired

The identifier.

stagestring

A string with a length between [1-128].

apiMappingKeystring

After evaluating a selection expression, the result is compared against one or more selection keys to find a matching key. See <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions">Selection Expressions</a> for a list of expressions and each expression's associated selection key type.

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 PATCH \
2     --url 'http://apigateway.{region}.amazonaws.com/v2/domainnames/{domainName}/apimappings/{apiMappingId}' \
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}