DKIM (Rest API)

v1 - Current

Enable DKIM or Rotate Keys

URL:

[POST] https://dkimadminapicp.mlsrvr.com/dkimstatus/enable

Description:

Enables DKIM or rotates keys by generating a new certificate for message signing. Process needs to be completed using DKIM verification route.

Parameters:

Field Name	Data Type	Description
domainName	string	The domain on which to act
hostedBy	string	Can be set to external or internal
accountNumber	string	Account number the domain is under
adminEmail	string	Email address of the administrator configuring DKIM for the domain
firstName	string	First name of the administrator configuring DKIM for the domain
lastname	string	Last name of the administrator configuring DKIM for the domain
whiteLabel	string	Send white labeled email to administrator. Can be true or false

Example:

POST'/domains'

Status Code 200 Result Example:

{
  "hostedBy": "external",
  "tatus": "pendingVerification",
  "subdomain": "20170209._domainkey",
  "dnsKey": "v=DKIM1; k=rsa; p=DNSKeyGoesHere"
}

Get Domain's Current DKIM Status

URL:

[GET] https://dkimadminapicp.mlsrvr.com/DkimServiceApi/v1/dkimstatus/status

Description:

Returns the status of DKIM configuration for a domain.

Parameters:

Field Name	Data Type	Description
domain	string	The domain on which to act
hostedBy	string	Can be set to external or internal

Examples:

GET '/domains/example.com?hostedBy=external'

Status Code 200 Result Example:

{
  "hostedBy": "external",
  "status": "pendingVerification",
  "selector": "20170209",
  "subdomain": "20170209._domainkey",
  "publicKey": "-----BEGIN PUBLIC KEY-----PublicKeyGoesHere-----END PUBLIC KEY-----",
  "dnsKey": "v=DKIM1; k=rsa; p=DNSKeyGoesHere"
}

Disable DKIM on a Domain

URL:

[DELETE] https://dkimadminapicp.mlsrvr.com/DkimServiceApi/v1/dkimstatus/disable)

Description:

Disables DKIM for a domain by revoking all existing certificates.

Parameters:

Field Name	Data Type	Description
domain	string	The domain on which to act
hostedBy	string	Can be set to external or internal

Example:

DELETE '/dkimstatus/disable',

Complete and Verify Enabling DKIM or Rotating Domain Keys

URL:

[POST] https://dkimadminapicp.mlsrvr.com/DkimServiceApi/v1/dkimstatus/verification

Description:

Verifies that a DNS record has been created with the selector/public key for DKIM as been added for a domain. If the record has been successfully verified, the certificate is enabled, and any other existing certificates are deleted.

Parameters:

Field Name	Data Type	Description
domain	string	The domain on which to act

Example:

POST '/dkimstatus/verification',
{
  "hostedBy": "external",
  "verificationSuccessful": false,
  "reason": "dnsKey mismatch",
  "subdomain": "20170209._domainkey",
  "dnsKey": "v=DKIM22; k=rsa; p=IAmABadKey",
  "expectedDnsKey": "v=DKIM1; k=rsa; p=DNSKEY"
}