Amazon API Gateway REST API Reference

usageplankey:delete

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

HTTP Request

DELETE /usageplans/<usageplanId>/keys/<keyId>

Remarks

After calling this action, the API key is removed from the usage plan, but remains available to be associated with this or other usage plans in the future.

Error Code

The request may throw the following exceptions:

Example

Request
DELETE /usageplans/n371pt/keys/q5ugs7qjjh HTTP/1.1
Content-Type: application/json
Host: apigateway.us-east-1.amazonaws.com
X-Amz-Date: 20160805T184030Z
Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160805/us-east-1/apigateway/aws4_request, SignedHeaders=content-length;content-type;host;x-amz-date, Signature={sigv4_hash}
Response

The successful response returns a 202 Accepted status code, without a payload.

See Also

Create and Use Usage Plans