DeleteApiKey - Amazon API Gateway

DeleteApiKey

Deletes the ApiKey resource.

Request Syntax

DELETE /apikeys/api_Key HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

api_Key

The identifier of the ApiKey resource to be deleted.

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 202

Response Elements

If the action is successful, the service sends back an HTTP 202 response with an empty HTTP body.

Errors

For information about the errors that are common to all actions, see Common Errors.

NotFoundException

The requested resource is not found. Make sure that the request URI is correct.

HTTP Status Code: 404

TooManyRequestsException

The request has reached its throttling limit. Retry after the specified time period.

HTTP Status Code: 429

UnauthorizedException

The request is denied because the caller has insufficient permissions.

HTTP Status Code: 401

Examples

Retrieve client certificates

The following example request retrieves the available client certificates in the caller's AWS account.

A successful response returns the requested ClientCertificate resources that can be navigated to by following the linked item or examining the embedded item resource.

Sample Request

Sample Response

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: