Skip to content

Deletes the specified API key

Description

Deletes the specified API key.

After you delete a key, it can take up to 24 hours for WAF to disallow use of the key in all regions.

Usage

wafv2_delete_api_key(Scope, APIKey)

Arguments

  • Scope

    [required] Specifies whether this is for a global resource type, such as a Amazon CloudFront distribution. For an Amplify application, use CLOUDFRONT.

    To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

    • CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
    • API and SDKs - For all calls, use the Region endpoint us-east-1.

  • APIKey

    [required] The encrypted API key that you want to delete.

Value

An empty list.

Request syntax

svc$delete_api_key(
  Scope = "CLOUDFRONT"|"REGIONAL",
  APIKey = "string"
)