DKIM (Rest API) - Revision history

SOADev at 19:11, 10 July 2019

2019-07-10T19:11:00Z

SOADev: Fix URLs

2019-07-10T19:09:47Z

Fix URLs

SOADev at 14:25, 7 February 2019

2019-02-07T14:25:57Z

SOADev at 14:13, 7 February 2019

2019-02-07T14:13:59Z

SOADev at 14:08, 7 February 2019

2019-02-07T14:08:50Z

SOADev at 13:55, 7 February 2019

2019-02-07T13:55:57Z

SOADev at 13:24, 7 February 2019

2019-02-07T13:24:11Z

SOADev: Initial commit.

2019-02-04T18:33:52Z

Initial commit.

New page

__TOC__

== v1 - Current ==

=== Enable DKIM or Rotate Keys ===

''URL'':
[POST] <nowiki>https://dkimadminapicp.mlsrvr.com/DkimServiceApi/v1/domains</nowiki>
{
"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'':
{| class="wikitable"
!''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'':
<pre>
POST'/domains',
{
"domainName": "example.com",
"hostedBy": "external",
"accountNumber": "123456789",
"adminEmail": "administrator@example.com",
"firstName": "Jane",
"lastName": "Dow",
"whiteLabel": false
}
</pre>

''Status Code 200 Result Example'':
<pre>
{
"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"
}
</pre>

=== Get Domain's Current DKIM Status ===

''URL'':

[GET] <nowiki>https://dkimadminapicp.mlsrvr.com/DkimServiceApi/v1/domains/(domain)?hostedBy=(hostedBy)</nowiki>

''Description'':

Returns the status of DKIM configuration for a single domain.

''Parameters'':
{| class="wikitable"
!''Field Name''
!''Data Type''
!''Description''
|-
| domain
| string
| The domain on which to act
|-
| hostedBy
| string
| Can be set to '''external''' or '''internal'''
|}

''Examples'':
<pre>
GET '/domains/example.com?hostedBy=external'
</pre>

''Status Code 200 Result Example'':
<pre>
{
"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"
}
</pre>

=== Turn off DKIM for a Domain ===

''URL'':

[DELETE] <nowiki>https://dkimadminapicp.mlsrvr.com/DkimServiceApi/v1/domains/(domain)?hostedBy=(hostedBy)&adminEmail=(adminEmail)&firstName=(firstName)&lastName=(lastName)&whiteLabel=(whiteLabel)</nowiki>

''Description'':

Disables DKIM for a domain by revoking all existing certificates.

''Parameters'':
{| class="wikitable"
!''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'':
<pre>
delete'/domains/example.com?hostedBy=external&adminEmail=admin@gmail.com&firstName=Site&lastName=Admin&whiteLabel=true',
</pre>

=== Complete and Verify Enabling DKIM or Rotating Domain Keys ===

''URL'':

[POST] <nowiki>https://dkimadminapicp.mlsrvr.com/DkimServiceApi/v1/domains/(domain)/verification</nowiki>
{
"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'':
{| class="wikitable"
!''Field Name''
!''Data Type''
!''Description''
|-
| domain
| string
| The domain on which to act
|}

''Example'':
<pre>
POST '/domains/example.com/verification',
{
"hostedBy": "external",
"adminEmail": "administrator@example.com",
"firstName": "Jane",
"lastName": "Dow",
"whiteLabel": false
}
</pre>

← Older revision		Revision as of 19:11, 10 July 2019
Line 108:		Line 108:
	''URL'':		''URL'':

−	[DELETE] <nowiki>https://cp.~~rackspace~~.com/customers/{customer_id}/domains/{domain_name}/dkim</nowiki>	+	[DELETE] <nowiki>https://api.emailsrvr.com/v2/customers/{customer_id}/domains/{domain_name}/dkim</nowiki>

@@ Line 16: / Line 16: @@
 ''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'':
-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 42: / Line 42: @@
 ''Example'':
 <pre>
-POST '/customers/customer_id/domains/domain_name/dkim/enable'
+POST '/v2/customers/123123123/domains/not-a-real-domain.com/dkim'
 </pre>
@@ Line 49: / Line 49: @@
 <pre>
+{
-   "hostedBy": "external",
+   "HostedBy": "external",
-   "tatus": "pendingVerification",
+   "Status": "pendingVerification",
    "subdomain": "20170209._domainkey",
    "dnsKey": "v=DKIM1; k=rsa; p=DNSKeyGoesHere"
@@ Line 61: / Line 61: @@
 ''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 87: / Line 87: @@
 ''Examples'':
 <pre>
-GET '/customers/customer_id/domains/domain_name/dkim/status'
+GET '/v2/customers/123123123/domains/not-a-real-domain.com/dkim'
 </pre>
@@ Line 108: / Line 108: @@
 ''URL'':
-  [DELETE] <nowiki>https://cp.rackspace.com/customers/{customer_id}/domains/{domain_name}/dkim/disable</nowiki>
+  [DELETE] <nowiki>https://cp.rackspace.com/customers/{customer_id}/domains/{domain_name}/dkim</nowiki>
@@ Line 134: / Line 134: @@
 ''Example'':
 <pre>
-DELETE '/customers/customer_id/domains/domain_name/dkim/disable',
+DELETE '/v2/customers/123123123/domains/not-a-real-domain.com/dkim',
 </pre>
@@ Line 142: / Line 142: @@
 ''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 169: / Line 169: @@
 ''Example'':
 <pre>
-POST '/customers/customer_id/domains/domain_name/dkim/verification'
+POST '/v2/customers/123123123/domains/not-a-real-domain.com/dkim/verification'
 </pre>

@@ Line 55: / Line 55: @@
+}
 </pre>
 === Get Domain's Current DKIM Status ===
@@ Line 101: / Line 102: @@
+}
 </pre>
 === Disable DKIM on a Domain ===
@@ Line 134: / Line 136: @@
 DELETE '/customers/customer_id/domains/domain_name/dkim/disable',
 </pre>
 === Complete and Verify Enabling DKIM or Rotating Domain Keys ===
@@ Line 166: / Line 169: @@
 ''Example'':
 <pre>
-POST '/customers/customer_id/domains/domain_name/dkim/verification',
+POST '/customers/customer_id/domains/domain_name/dkim/verification'
 </pre>

@@ Line 4: / Line 4: @@
 === 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.
-''Authorization''
+'''Authorization'''
 Authenticated users must have access to both the customer ID and the domain name that they provide.

@@ Line 2: / Line 2: @@
 == v1 - Current ==
 === Enable DKIM or Rotate Keys ===
 ''URL'':
-  [POST] <nowiki>https://dkimadminapicp.mlsrvr.com/customers/{customer_id}/domains/{domain_name}/dkim/enable</nowiki>
+  [POST] <nowiki>https://cp.rackspace.com/customers/{customer_id}/domains/{domain_name}/dkim/enable</nowiki>
@@ Line 32: / Line 40: @@
 ''Example'':
 <pre>
-POST'/dkimstatus/enable'
+POST '/customers/customer_id/domains/domain_name/dkim/enable'
 </pre>
@@ Line 50: / Line 58: @@
 ''URL'':
-  [GET] <nowiki>https://dkimadminapicp.mlsrvr.com/DkimServiceApi/v1/customers/{customer_id}/domains/{domain_name}/dkim/status</nowiki>
+  [GET] <nowiki>https://cp.rackspace.com/customers/{customer_id}/domains/{domain_name}/dkim/status</nowiki>
@@ Line 76: / Line 84: @@
 ''Examples'':
 <pre>
-GET '/domains/example.com?hostedBy=external'
+GET '/customers/customer_id/domains/domain_name/dkim/status'
 </pre>
@@ Line 96: / Line 104: @@
 ''URL'':
-  [DELETE] <nowiki>https://dkimadminapicp.mlsrvr.com/DkimServiceApi/v1/customers/{customer_id}/domains/{domain_name}/dkim/disable)</nowiki>
+  [DELETE] <nowiki>https://cp.rackspace.com/customers/{customer_id}/domains/{domain_name}/dkim/disable</nowiki>
@@ Line 122: / Line 130: @@
 ''Example'':
 <pre>
-DELETE '/dkimstatus/disable',
+DELETE '/customers/customer_id/domains/domain_name/dkim/disable',
 </pre>
@@ Line 129: / Line 137: @@
 ''URL'':
-  [POST] <nowiki>https://dkimadminapicp.mlsrvr.com/DkimServiceApi/v1/customers/{customer_id}/domains/{domain_name}/dkim/verification</nowiki>
+  [POST] <nowiki>https://cp.rackspace.com/customers/{customer_id}/domains/{domain_name}/dkim/verification</nowiki>
@@ Line 156: / Line 164: @@
 ''Example'':
 <pre>
-POST '/dkimstatus/verification',
+POST '/customers/customer_id/domains/domain_name/dkim/verification',
+{
    "hostedBy": "external",

@@ Line 6: / Line 6: @@
 ''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''
 |-
-| domainName
+| customer_id
 | string
-| The domain on which to act
+| ID of customer who owns domain_name
 |-
-| hostedBy
+| domain_name
 | string
-| Can be set to '''external''' or '''internal'''
+| Domain to act on
 |}
@@ Line 52: / Line 32: @@
 ''Example'':
 <pre>
-POST'/domains'
+POST'/dkimstatus/enable'
 </pre>
@@ Line 70: / Line 50: @@
 ''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''
 |-
-| domain
+| customer_id
 | string
-| The domain on which to act
+| ID of customer who owns domain_name
 |-
-| hostedBy
+| domain_name
 | string
-| Can be set to '''external''' or '''internal'''
+| Domain to act on
 |}
@@ Line 116: / Line 96: @@
 ''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''
 |-
-| domain
+| customer_id
 | string
-| The domain on which to act
+| ID of customer who owns domain_name
 |-
-| hostedBy
+| domain_name
 | string
-| Can be set to '''external''' or '''internal'''
+| Domain to act on
 |}
@@ Line 149: / Line 129: @@
 ''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''
 |-
-| domain
+| customer_id
 | string
-| The domain on which to act
+| Domain to act on
 |}
@@ Line 179: / Line 163: @@
    "subdomain": "20170209._domainkey",
    "dnsKey": "v=DKIM22; k=rsa; p=IAmABadKey",
-   "expectedDnsKey": "v=DKIM1; k=rsa; p=DNSKEY"
+   "expectedDnsKey": "v=DKIM1; k=rsa; p=DNSKeyGoesHere"
+}
 </pre>