Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-14120262383.5 KB

Creates a usage plan key for adding an existing API key to a usage plan.

post/usageplans/{usageplanId}/keys

Path parameters

usageplanIdstring required

The Id of the UsagePlan resource representing the usage plan containing the to-be-created UsagePlanKey resource representing a plan customer.

Request body

keyIdstring required

The identifier of a UsagePlanKey resource for a plan customer.

keyTypestring required

The type of a UsagePlanKey resource for a plan customer.

Response

Success

idstring

The Id of a usage plan key.

typestring

The type of a usage plan key. Currently, the valid key type is <code>API_KEY</code>.

valuestring

The value of a usage plan key.

namestring

The name of a usage plan key.