Own AWS? Customize your docs with AI search, analytics, and more.

PUT

/v2/apis/{apiId}

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

Puts an Api resource.

Access Token Required: API Key

Path Parameters

apiIdstringrequired

The API identifier.

Query Params

basepathstring

Specifies how to interpret the base path of the API during import. Valid values are ignore, prepend, and split. The default value is ignore. To learn more, see <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-import-api-basePath.html">Set the OpenAPI basePath Property</a>. Supported only for HTTP APIs.

failOnWarningsboolean

Specifies whether to rollback the API creation when a warning is encountered. By default, API creation continues if a warning is encountered.

Body Params

bodystringrequired

The OpenAPI definition. Supported only for HTTP APIs.

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://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}

PUT

/v2/apis/{apiId}

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

Puts an Api resource.

Access Token Required: API Key

Path Parameters

apiIdstringrequired

The API identifier.

Query Params

basepathstring

Specifies how to interpret the base path of the API during import. Valid values are ignore, prepend, and split. The default value is ignore. To learn more, see <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-import-api-basePath.html">Set the OpenAPI basePath Property</a>. Supported only for HTTP APIs.

failOnWarningsboolean

Specifies whether to rollback the API creation when a warning is encountered. By default, API creation continues if a warning is encountered.

Body Params

bodystringrequired

The OpenAPI definition. Supported only for HTTP APIs.

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://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}

PUT

/v2/apis/{apiId}

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

Puts an Api resource.

Access Token Required: API Key

Path Parameters

apiIdstringrequired

The API identifier.

Query Params

basepathstring

Specifies how to interpret the base path of the API during import. Valid values are ignore, prepend, and split. The default value is ignore. To learn more, see <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-import-api-basePath.html">Set the OpenAPI basePath Property</a>. Supported only for HTTP APIs.

failOnWarningsboolean

Specifies whether to rollback the API creation when a warning is encountered. By default, API creation continues if a warning is encountered.

Body Params

bodystringrequired

The OpenAPI definition. Supported only for HTTP APIs.

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://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}

PUT

/v2/apis/{apiId}

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

Puts an Api resource.

Access Token Required: API Key

Path Parameters

apiIdstringrequired

The API identifier.

Query Params

basepathstring

Specifies how to interpret the base path of the API during import. Valid values are ignore, prepend, and split. The default value is ignore. To learn more, see <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-import-api-basePath.html">Set the OpenAPI basePath Property</a>. Supported only for HTTP APIs.

failOnWarningsboolean

Specifies whether to rollback the API creation when a warning is encountered. By default, API creation continues if a warning is encountered.

Body Params

bodystringrequired

The OpenAPI definition. Supported only for HTTP APIs.

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://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}