Difference between revisions of "DKIM (Rest API)"
From Rackspace Email & Apps API
(Initial commit.) |
(No difference)
|
Revision as of 10:33, 4 February 2019
Contents
v1 - Current
Enable DKIM or Rotate Keys
URL:
[POST] https://dkimadminapicp.mlsrvr.com/DkimServiceApi/v1/domains
{
"domainName": "example.com",
"hostedBy": "external",
"accountNumber": "123456789",
"adminEmail": "administrator@example.com",
"firstName": "Jane",
"lastName": "Dow",
"whiteLabel": false
}
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',
{
"domainName": "example.com",
"hostedBy": "external",
"accountNumber": "123456789",
"adminEmail": "administrator@example.com",
"firstName": "Jane",
"lastName": "Dow",
"whiteLabel": false
}
Status Code 200 Result Example:
{
"domainName": "example.com",
"hostedBy": "external",
"dkimStatus": "pendingVerification",
"selector": "20170209",
"subdomain": "20170209._domainkey",
"publicKey": "-----BEGIN PUBLIC KEY-----PublicKeyGoesHere-----END PUBLIC KEY-----",
"dnsKey": "v=DKIM1; k=rsa; p=DNSKeyGoesHere"
}
Get Domain's Current DKIM Status
URL:
[GET] https://dkimadminapicp.mlsrvr.com/DkimServiceApi/v1/domains/(domain)?hostedBy=(hostedBy)
Description:
Returns the status of DKIM configuration for a single 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:
{
"domainName": "example.com",
"hostedBy": "external",
"dkimStatus": "pendingVerification",
"selector": "20170209",
"subdomain": "20170209._domainkey",
"publicKey": "-----BEGIN PUBLIC KEY-----PublicKeyGoesHere-----END PUBLIC KEY-----",
"dnsKey": "v=DKIM1; k=rsa; p=DNSKeyGoesHere"
}
Turn off DKIM for a Domain
URL:
[DELETE] https://dkimadminapicp.mlsrvr.com/DkimServiceApi/v1/domains/(domain)?hostedBy=(hostedBy)&adminEmail=(adminEmail)&firstName=(firstName)&lastName=(lastName)&whiteLabel=(whiteLabel)
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 |
| 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:
delete'/domains/example.com?hostedBy=external&adminEmail=admin@gmail.com&firstName=Site&lastName=Admin&whiteLabel=true',
Complete and Verify Enabling DKIM or Rotating Domain Keys
URL:
[POST] https://dkimadminapicp.mlsrvr.com/DkimServiceApi/v1/domains/(domain)/verification
{
"hostedBy": "external",
"adminEmail": "administrator@example.com",
"firstName": "Jane",
"lastName": "Dow",
"whiteLabel": false
}
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 '/domains/example.com/verification',
{
"hostedBy": "external",
"adminEmail": "administrator@example.com",
"firstName": "Jane",
"lastName": "Dow",
"whiteLabel": false
}
