PATCH

/usageplans/{usageplanId}/keys/{keyId}/usage

http://apigateway.{region}.amazonaws.com/usageplans/{usageplanId}/keys/{keyId}/usage

Grants a temporary extension to the remaining quota of a usage plan associated with a specified API key.

Access Token Required: API Key

Path Parameters

usageplanIdstringrequired

The Id of the usage plan associated with the usage data.

keyIdstringrequired

The identifier of the API key associated with the usage plan in which a temporary extension is granted to the remaining quota.

Body Params

patchOperationsarray

A list of operations describing the updates to apply to the specified resource. The patches are applied in the order specified in the list.

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/usageplans/{usageplanId}/keys/{keyId}/usage' \
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}