Skip to main content
GET
/
domains
/
{domain}
/
dkim-keys
Retrieve DKIM Keys
curl --request GET \
  --url https://api.mailchannels.net/tx/v1/domains/{domain}/dkim-keys \
  --header 'X-Api-Key: <x-api-key>'
{
  "keys": [
    {
      "algorithm": "<string>",
      "domain": "<string>",
      "public_key": "<string>",
      "selector": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "dkim_dns_records": [
        {
          "name": "<string>",
          "type": "TXT",
          "value": "<string>"
        }
      ],
      "gracePeriodExpiresAt": "2023-11-07T05:31:56Z",
      "key_length": 123,
      "retiresAt": "2023-11-07T05:31:56Z",
      "status_modified_at": "2023-11-07T05:31:56Z"
    }
  ]
}

Headers

​
X-Api-Key
string
required

Path Parameters

​
domain
string
required

Query Parameters

​
selector
string
Required string length: 1 - 63
​
status
enum<string>
Available options:
active,
retired,
revoked,
rotated
​
offset
integer
default:0

Number of keys to skip before returning results. The default is 0.

Required range: x >= 0
​
limit
integer
default:10

Maximum number of keys to return. The default is 10.

Required range: 1 <= x <= 100
​
include_dns_record
boolean
default:false

If true, includes the suggested DKIM DNS record for each returned key. Defaults to false.

Response

Successfully retrieved DKIM keys

​
keys
object[]
required

List of keys matching the filter. Empty if no keys match the filter.