/domains/{id}/dkim (POST)

POST

/domains/{id}/dkim

const url = 'https://example.com/api/v1/domains/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/dkim';
const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://example.com/api/v1/domains/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/dkim \
  --header 'Authorization: Bearer <token>'

Generate a new signing key and make it active (rotation). The previous key is retired; keep its DNS record for 30 days, then delete it.

Authorizations

bearer

Parameters

Path Parameters

required

string format: uuid

/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

Responses

201

Default Response

application/json

object

required

string

domainId

required

string

selector

required

string

algorithm

required

string

Allowed values: rsa

bits

required

integer

>= -9007199254740991 <= 9007199254740991

status

required

string

Allowed values: active retired

publicKey

required

string

dnsName

required

string

dnsValue

required

string

createdAt

required

string

retiredAt

required

Any of:

string
null

string

Example

{
  "algorithm": "rsa",
  "status": "active"
}