:doc:`WAFV2 <../../wafv2>` / Client / create_api_key

**************
create_api_key
**************



.. py:method:: WAFV2.Client.create_api_key(**kwargs)

  

  Creates an API key that contains a set of token domains.

   

  API keys are required for the integration of the CAPTCHA API in your JavaScript client applications. The API lets you customize the placement and characteristics of the CAPTCHA puzzle for your end users. For more information about the CAPTCHA JavaScript integration, see `WAF client application integration <https://docs.aws.amazon.com/waf/latest/developerguide/waf-application-integration.html>`__ in the *WAF Developer Guide*.

   

  You can use a single key for up to 5 domains. After you generate a key, you can copy it for use in your JavaScript integration.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/wafv2-2019-07-29/CreateAPIKey>`_  


  **Request Syntax**
  ::

    response = client.create_api_key(
        Scope='CLOUDFRONT'|'REGIONAL',
        TokenDomains=[
            'string',
        ]
    )
    
  :type Scope: string
  :param 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.
    

    

  
  :type TokenDomains: list
  :param TokenDomains: **[REQUIRED]** 

    The client application domains that you want to use this API key for.

     

    Example JSON: ``"TokenDomains": ["abc.com", "store.abc.com"]``

     

    Public suffixes aren't allowed. For example, you can't use ``gov.au`` or ``co.uk`` as token domains.

    

  
    - *(string) --* 

    

  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'APIKey': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **APIKey** *(string) --* 

        The generated, encrypted API key. You can copy this for use in your JavaScript CAPTCHA integration.

        
  
  **Exceptions**
  
  *   :py:class:`WAFV2.Client.exceptions.WAFInternalErrorException`

  
  *   :py:class:`WAFV2.Client.exceptions.WAFInvalidParameterException`

  
  *   :py:class:`WAFV2.Client.exceptions.WAFInvalidOperationException`

  
  *   :py:class:`WAFV2.Client.exceptions.WAFLimitsExceededException`

  