Amazon API Gateway REST API Reference

apikey:delete

Deletes an ApiKey resource.

HTTP Request

DELETE /apikeys/<api_Key>

Remarks

Error Codes

The following exception may be thrown when the request fails.

  • UnauthorizedException
  • TooManyRequestsException
  • NotFoundException

For detailed error code information, including the corresponding HTTP Status Codes, see API Gateway Error Codes

Example: Delete an API Key

Request

DELETE /apikeys/a2TprUZuzf2EKbbmMUotDaHYGg8kgxFypcarGved HTTP/1.1
Content-Type: application/json
Host: apigateway.us-east-1.amazonaws.com
X-Amz-Date: 20170223T223246Z
Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20170223/us-east-1/apigateway/aws4_request, SignedHeaders=content-length;content-type;host;x-amz-date, Signature={sig4_hash}
Response

The successful response returns 202 Accepted status code and an empty payload.

See Also

AWS CLI