DKIM Security

Automatic Sender Security DKIM Key APIs. To enable this feature please see 'Update a domain' API docs.

Update Automatic Sender Security DKIM key rotation for a domain

put/v1/dkim_management/domains/{name}/rotation

The minimum allowed interval for rotation is 5 days.

SecuritybasicAuth
Request
path Parameters
name
required
string

The Domain name

Request Body schema: multipart/form-data
required
rotation_enabled
required
boolean

If true, enables DKIM Auto-Rotation. If false, disables it

rotation_interval
string

The interval at which to rotate keys. Example, '5d' for five days

Responses
200

A 200 response

Response Schema: application/json
required
object
id
required
string
account_id
required
string
sid
required
string
name
required
string
state
required
string
rotation_enabled
required
string
rotation_interval
required
string
Array of objects
active_selector
string
400

A 400 response

404

A 404 response

Request samples 
Response samples 
application/json
{
  • "domain": {
    • "state": "enabled",
    • "records": [
      ],
    • "account_id": "000000000000000000000001",
    • "active_selector": "pdk1",
    • "id": "000000000000000000000002",
    • "sid": "789",
    • "name": "example.com",
    • "rotation_enabled": "true",
    • "rotation_interval": "24h"
    }
}
Rotate Automatic Sender Security DKIM key for a domain
post/v1/dkim_management/domains/{name}/rotate
Immediately rotate your DKIM key. This will trigger a rotation even if auto-rotation is disabled on the domain.


SecuritybasicAuth 
Request 
path Parameters
name
required
string
The Domain name


 
Responses 
200
A 200 response


Response Schema: application/json
message
required
string
 
400
A 400 response


404
A 404 response


Request samples 
Response samples 
application/json
{
  • "message": "ok"
}
Cookie PolicyGDPR Email ComplianceAcceptable Use PolicyTerms of ServicePrivacy Policy
© 2024 Sinch Mailgun. All rights reserved.