Difference between revisions of "DKIM (Rest API)"

From Rackspace Email & Apps API
Jump to: navigation, search
Line 6: Line 6:
  
 
''URL'':  
 
''URL'':  
−
  [POST] <nowiki>https://dkimadminapicp.mlsrvr.com/dkimstatus/enable</nowiki>
+
  [POST] <nowiki>https://dkimadminapicp.mlsrvr.com/customers/{customer_id}/domains/{domain_name}/dkim/enable</nowiki>
  
  
Line 20: Line 20:
 
!''Description''
 
!''Description''
 
|-
 
|-
−
| domainName
+
| customer_id
 
| string
 
| string
−
| The domain on which to act
+
| ID of customer who owns domain_name
 
|-
 
|-
−
| hostedBy
+
| domain_name
 
| string
 
| string
−
| Can be set to '''external''' or '''internal'''
+
| Domain to act on
−
|-
 
−
| 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'''
 
 
|}
 
|}
  
Line 52: Line 32:
 
''Example'':
 
''Example'':
 
<pre>
 
<pre>
−
POST'/domains'
+
POST'/dkimstatus/enable'
 
</pre>
 
</pre>
  
Line 70: Line 50:
 
''URL'':  
 
''URL'':  
  
−
  [GET] <nowiki>https://dkimadminapicp.mlsrvr.com/DkimServiceApi/v1/dkimstatus/status</nowiki>
+
  [GET] <nowiki>https://dkimadminapicp.mlsrvr.com/DkimServiceApi/v1/customers/{customer_id}/domains/{domain_name}/dkim/status</nowiki>
  
  
Line 84: Line 64:
 
!''Description''
 
!''Description''
 
|-
 
|-
−
| domain
+
| customer_id
 
| string
 
| string
−
| The domain on which to act
+
| ID of customer who owns domain_name
 
|-
 
|-
−
| hostedBy
+
| domain_name
 
| string
 
| string
−
| Can be set to '''external''' or '''internal'''
+
| Domain to act on
 
|}
 
|}
  
Line 116: Line 96:
 
''URL'':
 
''URL'':
  
−
  [DELETE] <nowiki>https://dkimadminapicp.mlsrvr.com/DkimServiceApi/v1/dkimstatus/disable)</nowiki>
+
  [DELETE] <nowiki>https://dkimadminapicp.mlsrvr.com/DkimServiceApi/v1/customers/{customer_id}/domains/{domain_name}/dkim/disable)</nowiki>
  
  
Line 130: Line 110:
 
!''Description''
 
!''Description''
 
|-
 
|-
−
| domain
+
| customer_id
 
| string
 
| string
−
| The domain on which to act
+
| ID of customer who owns domain_name
 
|-
 
|-
−
| hostedBy
+
| domain_name
 
| string
 
| string
−
| Can be set to '''external''' or '''internal'''
+
| Domain to act on
 
|}
 
|}
  
Line 149: Line 129:
 
''URL'':  
 
''URL'':  
  
−
  [POST] <nowiki>https://dkimadminapicp.mlsrvr.com/DkimServiceApi/v1/dkimstatus/verification</nowiki>
+
  [POST] <nowiki>https://dkimadminapicp.mlsrvr.com/DkimServiceApi/v1/customers/{customer_id}/domains/{domain_name}/dkim/verification</nowiki>
  
  
Line 164: Line 144:
 
!''Description''
 
!''Description''
 
|-
 
|-
−
| domain
+
| customer_id
 +
| string
 +
| ID of customer who owns domain_name
 +
|-
 +
| domain_name
 
| string
 
| string
−
| The domain on which to act
+
| Domain to act on
 
|}
 
|}
  
Line 179: Line 163:
 
   "subdomain": "20170209._domainkey",
 
   "subdomain": "20170209._domainkey",
 
   "dnsKey": "v=DKIM22; k=rsa; p=IAmABadKey",
 
   "dnsKey": "v=DKIM22; k=rsa; p=IAmABadKey",
−
   "expectedDnsKey": "v=DKIM1; k=rsa; p=DNSKEY"
+
   "expectedDnsKey": "v=DKIM1; k=rsa; p=DNSKeyGoesHere"
 
}
 
}
 
</pre>
 
</pre>

Revision as of 06:55, 7 February 2019

v1 - Current

Enable DKIM or Rotate Keys

URL: 

[POST] https://dkimadminapicp.mlsrvr.com/customers/{customer_id}/domains/{domain_name}/dkim/enable


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


Example: 

POST'/dkimstatus/enable'


Status Code 200 Result Example: 

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

Get Domain's Current DKIM Status

URL: 

[GET] https://dkimadminapicp.mlsrvr.com/DkimServiceApi/v1/customers/{customer_id}/domains/{domain_name}/dkim/status


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 '/domains/example.com?hostedBy=external'


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://dkimadminapicp.mlsrvr.com/DkimServiceApi/v1/customers/{customer_id}/domains/{domain_name}/dkim/disable)


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 '/dkimstatus/disable',

Complete and Verify Enabling DKIM or Rotating Domain Keys

URL: 

[POST] https://dkimadminapicp.mlsrvr.com/DkimServiceApi/v1/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 '/dkimstatus/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"
}
Retrieved from "http://api-wiki.apps.rackspace.com/api-wiki/index.php?title=DKIM_(Rest_API)&oldid=759"