---
title: "Add domains' DKIM record keys"
method: GET
path: "/EmailAuth/install_dkim_private_keys"
tags: ["EmailAuth", "Email DNS Settings"]
---

# Add domains' DKIM record keys

`GET /EmailAuth/install_dkim_private_keys`

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.

**Note:**

* This function does **not** update the local DNS server's records.
* If the local DNS server is authoritative for the domain's DNS records, use the UAPI `EmailAuth::enable_dkim` function to update the local DNS server's DNS records.
  * We recommend that you use the UAPI `EmailAuth::install_dkim_private_keys` and `EmailAuth::enable_dkim functions` in a batch UAPI call.

## Query parameters

- `domain` string, domain, required
- `key` string, pem-private-key, required

## Response `200`

HTTP Request was successful.

- object
  - `apiversion` integer — The version of the API.
  - `func` string — The name of the method called.
  - `module` string — The name of the module called.
  - `result` object
    - `data` object[] — An array of objects that contains information about the DKIM private key installation to the local server.
      - `domain` string, domain — The DKIM private key's associated domain.
      - `msg` string — The DKIM private key's installation status message.
      - `status` 0 | 1 — Whether the system installed the DKIM private key to the local server. * `1` - The system installed the DKIM private key. * `0` - The system **cannot** install the DKIM private key.
    - `errors` string[], nullable — List of errors if the API failed.
    - `messages` string[], nullable — List of messages generated by the API.
    - `metadata` object
    - `status` 0 | 1 — * `1` - Success. * `0` - Failed. Check the `errors` field for more details.
    - `warnings` string[], nullable — List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.

---

[API](https://skmtc.net/cpanel/apis/cpanel-uapi.md) · [All operations](https://skmtc.net/cpanel/apis/cpanel-uapi/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/cpanel/cpanel-uapi/revisions/632e2f8e6d04/schema)