# Install existing private key to DKIM record

This function installs existing keys for use in a DomainKeys Identified Mail (DKIM) record. This is useful if you do not want the system to generate keys for DKIM records.



* This function does  update the local DNS server's records.
* If the local DNS server is authoritative for the domain's DNS records, use the WHM API 1  function to update the local DNS server's DNS records.
* We recommend that you use the WHM API 1  and  functions in a batch WHM API 1 call.

Endpoint: GET /install_dkim_private_keys
Version: 11.134.0.5
Security: BasicAuth

## Query parameters:

  - `domain` (string, required)
    The domain for which to install an RSA private key to the local server's DKIM record.



To install RSA private keys for multiple domains, increment the parameter name. For example, use the , , and  parameters.

  - `key` (string, required)
    An RSA key in Privacy-Enhanced Mail (PEM) format.



 * You  provide this parameter for each  parameter.
 * To install multiple RSA keys for a domain, increment the parameter name. For example, use the ,  parameters.
examples:
  single:
    summary: An RSA key in Privacy-Enhanced Mail (PEM) format.
    value: key
  multiple:
    summary: RSA keys in Privacy-Enhanced Mail (PEM) format.
    value: key-1=KEYKEYKEY&key-2=KEYKEYKEY
    Example: "AAAAB3NzaC1yc2EAAAABIwAAAQEA5kSivOqhs0U9ZMN20nxFe27QZ3t0lT2zbH7OSXylKd1rjAjYXGnSXC9j2uaZlemHlptBKVziMJC86ha7Hcj6dVOVrDQ6vF4q34bOCjtKLphQ0IjBzVIvqILH9eLJdRaOrS34CmgmPaisrCk5wKVlakygvUfcj3HzaTKS6THyZDGx5shdTpa9lby8tpOD3JceV7ay4w8r0DipoKPC0OLpvS4EABEeMo9sx8zQEaKv03XygjNCCYtFvxlQQIRGlVoL7mPaHSaL3anI05RpNbm/PS+9BhZg+BqNjU4ofHBbfkXk5MiN6M7ieR4Sk5BquccboGF13U5slNgmCEekdt0amw"

## Response 200 fields (application/json):

  - `data` (object)

  - `data.payload` (array)
    An array of objects containing information about the RSA private key installation to the local server's DKIM record.

  - `data.payload.domain` (string)
    The RSA private key's associated domain.
    Example: "example.com"

  - `data.payload.msg` (string)
    The RSA private key's installation status message.
    Example: "Installed Keys"

  - `data.payload.status` (integer)
    Whether the system installed the RSA private key to the local server's DKIM record.
*  — The system installed the RSA private key.
*  — The system  install the RSA private key.
    Enum: 0, 1

  - `metadata` (object)

  - `metadata.command` (string)
    The method name called.
    Example: "install_dkim_private_keys"

  - `metadata.reason` (string)
    The reason the API function failed when the  field is . This field may display a success message when a function succeeds.
    Example: "OK"

  - `metadata.result` (integer)
    *  — Success.
*  — Failed. Check the  field for more details.
    Enum: 0, 1

  - `metadata.version` (integer)
    The version of the API function.
    Example: 1