Enable DKIM

Enable DomainKeys Identified Mail (DKIM) for a domain

  • HTTP Method: POST
  • URL: https://example.domain.tld/api/v1/domains/dkim/<domain>/
  • Require authentication: Yes
  • Permission level required: MasterAdmin / DomainAdmin

Path parameters

Parameter Type Description Required
domain str Domain name Required

Request parameters

Parameter Type Description Required
None None Some placeholder data Required

Response parameters

Parameter Type Description
dkim dict The DKIM status object
domain str Domain name
status str Status

Example request (Python)

import requests
import json
from pprint import pprint

url = "https://example.domain.tld/api/v1/domains/dkim/vonmail.com/"
data = {
None : None
}
r = requests.post(url, json=data, auth=("admin","long-auth_token-here"))
try:
    pprint(r.json())
except: 
    print(r.text)

Example response (JSON)

{'dkim': {'domain': 'vonmail.com', 'status': 'pending_key_generation'}}