Node.js
import { MailChannels } from "mailchannels-sdk";
const { MAILCHANNELS_API_KEY, DOMAIN } = process.env;
if (!MAILCHANNELS_API_KEY) throw new Error("Set MAILCHANNELS_API_KEY before running");
if (!DOMAIN) throw new Error("Set DOMAIN (the sending domain, e.g. example.com)");
const mailchannels = new MailChannels(MAILCHANNELS_API_KEY);
const { data, error } = await mailchannels.domains.dkim.list(DOMAIN);
if (error) {
console.error("List DKIM keys failed:", error);
process.exit(1);
}
console.log(data);import os
import sys
import mailchannels
if not os.environ.get("MAILCHANNELS_API_KEY"):
sys.exit("Set MAILCHANNELS_API_KEY before running")
domain = os.environ.get("DOMAIN")
if not domain:
sys.exit("Set DOMAIN (the sending domain, e.g. example.com)")
# List all MailChannels-managed DKIM keys for the domain.
response = mailchannels.Dkim.list(domain)
print(response)<?php
require_once __DIR__ . '/vendor/autoload.php';
use MailChannels\Client;
$api_key = getenv('MAILCHANNELS_API_KEY') or exit("Error: MAILCHANNELS_API_KEY is not set\n");
$domain = getenv('DOMAIN') or exit("Error: DOMAIN is not set\n");
$client = new Client(apiKey: $api_key);
$response = $client->dkim->list($domain);
print_r($response->toArray());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>",
"status": "active",
"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"
}
]
}{
"errors": [
"<string>"
]
}Retrieve DKIM Keys
Search for DKIM keys by domain, with optional filters. If selector is provided, at most one key will be returned.
GET
/
domains
/
{domain}
/
dkim-keys
Node.js
import { MailChannels } from "mailchannels-sdk";
const { MAILCHANNELS_API_KEY, DOMAIN } = process.env;
if (!MAILCHANNELS_API_KEY) throw new Error("Set MAILCHANNELS_API_KEY before running");
if (!DOMAIN) throw new Error("Set DOMAIN (the sending domain, e.g. example.com)");
const mailchannels = new MailChannels(MAILCHANNELS_API_KEY);
const { data, error } = await mailchannels.domains.dkim.list(DOMAIN);
if (error) {
console.error("List DKIM keys failed:", error);
process.exit(1);
}
console.log(data);import os
import sys
import mailchannels
if not os.environ.get("MAILCHANNELS_API_KEY"):
sys.exit("Set MAILCHANNELS_API_KEY before running")
domain = os.environ.get("DOMAIN")
if not domain:
sys.exit("Set DOMAIN (the sending domain, e.g. example.com)")
# List all MailChannels-managed DKIM keys for the domain.
response = mailchannels.Dkim.list(domain)
print(response)<?php
require_once __DIR__ . '/vendor/autoload.php';
use MailChannels\Client;
$api_key = getenv('MAILCHANNELS_API_KEY') or exit("Error: MAILCHANNELS_API_KEY is not set\n");
$domain = getenv('DOMAIN') or exit("Error: DOMAIN is not set\n");
$client = new Client(apiKey: $api_key);
$response = $client->dkim->list($domain);
print_r($response->toArray());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>",
"status": "active",
"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"
}
]
}{
"errors": [
"<string>"
]
}Headers
Path Parameters
Query Parameters
Required string length:
1 - 63Available options:
active, retired, revoked, rotated Number of keys to skip before returning results. The default is 0.
Required range:
x >= 0Maximum number of keys to return. The default is 10.
Required range:
1 <= x <= 100If true, includes the suggested DKIM DNS record for each returned key. Defaults to false.
Response
Successfully retrieved DKIM keys
List of keys matching the filter. Empty if no keys match the filter.
Show child attributes
Show child attributes
Was this page helpful?

