Get DKIM status
Retrieve DomainKeys Identified Mail (DKIM) status and key for domain
- HTTP Method:
GET
- 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 |
Response parameters
Parameter |
Type |
Description |
dkim |
dict |
The DKIM status object |
dkim_key |
str |
DKIM public key |
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/"
r = requests.get(url, auth=("admin","long-auth_token-here"))
try:
pprint(r.json())
except:
print(r.text)
Example response (JSON)
{'dkim': {'dkim_key': 'v=DKIM1; h=sha256; k=rsa; '
'p=MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQDRfksH4CPFg8a2nRC3OVkWX+SFhgKgeVY0cqpjOcx1OVDYSE6sVa9FX8/8Jl6tbeMRlWaBv1lwXIu3NbmxZNUJw9GFTs+LAd2PE2P0wcqb8yRyotVHc5qRuJLDWTcGt6WwSUp31ZS3Ve/FHvDf3jKZgT9PdoPnnSLtnpHiSG3eNwIDAQAB',
'domain': 'vonmail.com',
'status': 'enabled'}}