Amazon API Gateway REST API Reference

UsagePlanKey

Represents a usage plan key to identify a plan customer.

"

Relation Description Method Templated
self

A relation that refers to the current resource.

GET No
usageplankey:delete

Deletes a specified UsagePlanKey resource and removes the associated ApiKey from the specified usage plan.

DELETE No


Properties

{
  "id" : "String",
  "type" : "String",
  "value" : "String",
  "name" : "String"
}

  • id
  • The Id of a usage plan key.

  • type
  • The type of a usage plan key. Currently, the valid key type is API_KEY.

  • value
  • The value of a usage plan key.

  • name
  • The name of a usage plan key.

Remarks

To associate an API stage with a selected API key in a usage plan, you must create a UsagePlanKey resource to represent the selected ApiKey.

See Also

Create and Use Usage Plans