Difference between revisions of "DKIM (Rest API)"

From Rackspace Email & Apps API
Jump to: navigation, search
 
(3 intermediate revisions by the same user not shown)
Line 4: Line 4:
  
 
=== Authentication and Authorization ===
 
=== Authentication and Authorization ===
−
''Authentication''
+
'''Authentication'''
 +
 
 
Users of this API must be successfully authenticated.  See [http://api-wiki.apps.rackspace.com/api-wiki/index.php?title=Rest_API#Authentication Rest API - Authentication] for instructions.
 
Users of this API must be successfully authenticated.  See [http://api-wiki.apps.rackspace.com/api-wiki/index.php?title=Rest_API#Authentication Rest API - Authentication] for instructions.
  
−
''Authorization''
+
'''Authorization'''
 +
 
 
Authenticated users must have access to both the customer ID and the domain name that they provide.
 
Authenticated users must have access to both the customer ID and the domain name that they provide.
  
Line 14: Line 16:
  
 
''URL'':  
 
''URL'':  
−
  [POST] <nowiki>https://cp.rackspace.com/customers/{customer_id}/domains/{domain_name}/dkim/enable</nowiki>
+
  [POST] <nowiki>https://api.emailsrvr.com/v2/customers/{customer_id}/domains/{domain_name}/dkim</nowiki>
  
  
 
''Description'':
 
''Description'':
  
−
Enables DKIM or rotates keys by generating a new certificate for message signing. Process needs to be completed using DKIM verification route.
+
Enables DKIM or rotates keys by generating a new certificate for message signing. Process needs to be completed using DKIM verification route (below).
  
  
Line 40: Line 42:
 
''Example'':
 
''Example'':
 
<pre>
 
<pre>
−
POST '/customers/customer_id/domains/domain_name/dkim/enable'
+
POST '/v2/customers/123123123/domains/not-a-real-domain.com/dkim'
 
</pre>
 
</pre>
  
Line 47: Line 49:
 
<pre>
 
<pre>
 
{
 
{
−
   "hostedBy": "external",
+
   "HostedBy": "external",
−
   "tatus": "pendingVerification",
+
   "Status": "pendingVerification",
 
   "subdomain": "20170209._domainkey",
 
   "subdomain": "20170209._domainkey",
 
   "dnsKey": "v=DKIM1; k=rsa; p=DNSKeyGoesHere"
 
   "dnsKey": "v=DKIM1; k=rsa; p=DNSKeyGoesHere"
 
}
 
}
 
</pre>
 
</pre>
 +
  
 
=== Get Domain's Current DKIM Status ===
 
=== Get Domain's Current DKIM Status ===
Line 58: Line 61:
 
''URL'':  
 
''URL'':  
  
−
  [GET] <nowiki>https://cp.rackspace.com/customers/{customer_id}/domains/{domain_name}/dkim/status</nowiki>
+
  [GET] <nowiki>https://api.emailsrvr.com/v2/customers/{customer_id}/domains/{domain_name}/dkim</nowiki>
  
  
Line 84: Line 87:
 
''Examples'':
 
''Examples'':
 
<pre>
 
<pre>
−
GET '/customers/customer_id/domains/domain_name/dkim/status'
+
GET '/v2/customers/123123123/domains/not-a-real-domain.com/dkim'
 
</pre>
 
</pre>
  
Line 99: Line 102:
 
}
 
}
 
</pre>
 
</pre>
 +
  
 
=== Disable DKIM on a Domain ===
 
=== Disable DKIM on a Domain ===
Line 104: Line 108:
 
''URL'':
 
''URL'':
  
−
  [DELETE] <nowiki>https://cp.rackspace.com/customers/{customer_id}/domains/{domain_name}/dkim/disable</nowiki>
+
  [DELETE] <nowiki>https://api.emailsrvr.com/v2/customers/{customer_id}/domains/{domain_name}/dkim</nowiki>
  
  
Line 130: Line 134:
 
''Example'':
 
''Example'':
 
<pre>
 
<pre>
−
DELETE '/customers/customer_id/domains/domain_name/dkim/disable',
+
DELETE '/v2/customers/123123123/domains/not-a-real-domain.com/dkim',
 
</pre>
 
</pre>
 +
  
 
=== Complete and Verify Enabling DKIM or Rotating Domain Keys ===
 
=== Complete and Verify Enabling DKIM or Rotating Domain Keys ===
Line 137: Line 142:
 
''URL'':  
 
''URL'':  
  
−
  [POST] <nowiki>https://cp.rackspace.com/customers/{customer_id}/domains/{domain_name}/dkim/verification</nowiki>
+
  [POST] <nowiki>https://api.emailsrvr.com/v2/customers/{customer_id}/domains/{domain_name}/dkim/verification</nowiki>
  
  
Line 164: Line 169:
 
''Example'':
 
''Example'':
 
<pre>
 
<pre>
−
POST '/customers/customer_id/domains/domain_name/dkim/verification',
+
POST '/v2/customers/123123123/domains/not-a-real-domain.com/dkim/verification'
−
{
 
−
  "hostedBy": "external",
 
−
  "verificationSuccessful": false,
 
−
  "reason": "dnsKey mismatch",
 
−
  "subdomain": "20170209._domainkey",
 
−
  "dnsKey": "v=DKIM22; k=rsa; p=IAmABadKey",
 
−
  "expectedDnsKey": "v=DKIM1; k=rsa; p=DNSKeyGoesHere"
 
−
}
 
 
</pre>
 
</pre>

Latest revision as of 12:11, 10 July 2019

v1 - Current

Authentication and Authorization

Authentication

Users of this API must be successfully authenticated. See Rest API - Authentication for instructions.

Authorization

Authenticated users must have access to both the customer ID and the domain name that they provide.


Enable DKIM or Rotate Keys

URL: 

[POST] https://api.emailsrvr.com/v2/customers/{customer_id}/domains/{domain_name}/dkim


Description:

Enables DKIM or rotates keys by generating a new certificate for message signing. Process needs to be completed using DKIM verification route (below).


Parameters:

Field Name Data Type Description
customer_id string ID of customer who owns domain_name
domain_name string Domain to act on


Example: 

POST '/v2/customers/123123123/domains/not-a-real-domain.com/dkim'


Status Code 200 Result Example: 

{
  "HostedBy": "external",
  "Status": "pendingVerification",
  "subdomain": "20170209._domainkey",
  "dnsKey": "v=DKIM1; k=rsa; p=DNSKeyGoesHere"
}


Get Domain's Current DKIM Status

URL: 

[GET] https://api.emailsrvr.com/v2/customers/{customer_id}/domains/{domain_name}/dkim


Description:

Returns the status of DKIM configuration for a domain.


Parameters:

Field Name Data Type Description
customer_id string ID of customer who owns domain_name
domain_name string Domain to act on


Examples: 

GET '/v2/customers/123123123/domains/not-a-real-domain.com/dkim'


Status Code 200 Result Example: 

{
  "hostedBy": "external",
  "status": "pendingVerification",
  "selector": "20170209",
  "subdomain": "20170209._domainkey",
  "publicKey": "-----BEGIN PUBLIC KEY-----PublicKeyGoesHere-----END PUBLIC KEY-----",
  "dnsKey": "v=DKIM1; k=rsa; p=DNSKeyGoesHere"
}


Disable DKIM on a Domain

URL: 

[DELETE] https://api.emailsrvr.com/v2/customers/{customer_id}/domains/{domain_name}/dkim


Description:

Disables DKIM for a domain by revoking all existing certificates.


Parameters:

Field Name Data Type Description
customer_id string ID of customer who owns domain_name
domain_name string Domain to act on


Example: 

DELETE '/v2/customers/123123123/domains/not-a-real-domain.com/dkim',


Complete and Verify Enabling DKIM or Rotating Domain Keys

URL: 

[POST] https://api.emailsrvr.com/v2/customers/{customer_id}/domains/{domain_name}/dkim/verification


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
customer_id string ID of customer who owns domain_name
domain_name string Domain to act on


Example: 

POST '/v2/customers/123123123/domains/not-a-real-domain.com/dkim/verification'
Retrieved from "http://api-wiki.apps.rackspace.com/api-wiki/index.php?title=DKIM_(Rest_API)&oldid=772"