PATCH

/v2/apis/{apiId}

http://apigateway.{region}.amazonaws.com/v2/apis/{apiId}

Updates an Api resource.

Access Token Required: API Key

Path Parameters

apiIdstringrequired

The API identifier.

Body Params

namestring

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

targetstring

A string representation of a URI with a length between [1-2048].

versionstring

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

routeKeystring

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.

descriptionstring

A string with a length between [0-1024].

credentialsArnstring

Represents an Amazon Resource Name (ARN).

corsConfigurationobject

Represents a CORS configuration. Supported only for HTTP APIs. See <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-cors.html">Configuring CORS</a> for more information.

disableSchemaValidationboolean

Avoid validating models when creating a deployment. Supported only for WebSocket APIs.

routeSelectionExpressionstring

An expression used to extract information at runtime. 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 more information.

apiKeySelectionExpressionstring

disableExecuteApiEndpointboolean

Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.

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/apis/{apiId}' \
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}