Rackspace Email & Apps API - User contributions [en]

Rackspace Mailbox Spam (Rest API)

2019-09-10T16:18:36Z

SOADev:

__TOC__

== v1 - Current ==

=== Spam Settings ===

==== Show ====

''URL'':
<nowiki>[GET] https://api.emailsrvr.com/v1/customers/(customer account number)/domains/(domain name)
/rs/mailboxes/(mailbox name)/spam/settings</nowiki>

''Description'':

This operation returns the spam settings associated with the mailbox.

''Example'':
<pre>
get '/customers/12345678/domains/example.com/rs/mailboxes/alex.smith/spam/settings'
</pre>

''XML Result Example'':

<pre>
<?xml version="1.0" encoding="utf-8"?>
<rsMailboxSpamSetting xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="urn:xml:RSMailboxSpamSetting">
<filterLevel>on</filterLevel>
<rsEmailSettings>
<spamHandling>toFolder</spamHandling>
<hasFolderCleaner>false</hasFolderCleaner>
<spamFolderAgeLimit>0</spamFolderAgeLimit>
<spamFolderNumLimit>0</spamFolderNumLimit>
<spamForwardingAddress />
</rsEmailSettings>
</rsMailboxSpamSetting>
</pre>

''Json Result Example'':

<pre>
{ "filterLevel":"on",
"rsEmailSettings":{
"hasFolderCleaner":false,
"spamFolderAgeLimit":0,
"spamFolderNumLimit":0,
"spamForwardingAddress":"",
"spamHandling":"toFolder"
}
}
</pre>

==== Edit ====

''URL'':
<nowiki>[PUT] https://api.emailsrvr.com/v1/customers/(customer account number)/domains/(domain name)/rs/mailboxes/(mailbox name)/spam/settings</nowiki>

''Description'':

This operation will modify the mailbox spam settings.

{| class="wikitable"
!''Field Name''
!''Data Type''
!''Description''
|-
| filterLevel
| string
| This is a required field. Spam filter status: 'on', 'off', or 'exclusive'. Exclusive mode allows only email cleared by the Safelist.
|
|-
| rsEmail.spamHandling
| string
| The string 'toFolder' will deliver the email to the user's Spam folder, 'delete' will delete the mail immediately, 'labelSubject' will prepend [SPAM] to the email's subject line, and 'toAddress' will send the email to a specified folder instead.

Valid Field Combinations:

(toFolder => hasFolderCleaner, spamFolderAgeLimit, spamFolderNumLimit)

(toAddress => spamForwardingAddress)
|-
| rsEmail.hasFolderCleaner
| string
| This field is effective when rsEmail.spamHandling option is set to 'toFolder'. This field controls how the spam that is delivered o the spam folder is handled. There are currently two options supported for handling spam. First option is to set a limit after which the spam gets deleted. One can set limit on the number of days or on the number of spam emails. Second option is to never automatically delete the spam. For both these options to be enabled the rsEmail.hasFolderCleaner field should be set to 'true'.
The folder cleaner fields (hasFolderCleaner, spamFolderAgeLimit, spamFolderNumLimit) are allowed
only when the spamHandling field is set to 'toFolder'. In order to never delete the spam set the spamFolderAgeLimit and spamFolderNumLimit fields to 0.
|-
| rsEmail.spamFolderAgeLimit
| string
| The number of days a message stays in the Spam folder before its deleted. This field is effective only when rsEmail.spamHandling is set to 'toFolder', and 'rs.hasFolderCleaner' is set to 'true'. This field cannot have negative value.
|-
| rsEmail.spamFolderNumLimit
| string
| The maximum number of emails the Spam folder holds. This field is effective only when rsEmail.spamHandling is set to 'toFolder', and 'rs.hasFolderCleaner' is set to 'true'. This field cannot have negative value.
|-
| rsEmail.spamForwardingAddress
| string
| The email address that Spam emails will be redirected to. This field is required when the spamHandling field is set to 'toAddress'
|}

''Example'':
<pre>
put '/customers/100018/domains/resellerallservices.net/rs/mailboxes/unittestexist/spam/settings',
{
'filterLevel' => 'on',
'rsEmail.spamHandling' => 'toFolder',
'rsEmail.hasFolderCleaner' => 'true',
'rsEmail.spamFolderAgeLimit' => '7',
'rsEmail.spamFolderNumLimit' => '100',
}, Formats.xml
</pre>

''Errors'':

{| class="wikitable"
!''Description''
!''HTTP Response Code''
!''Sample Message''
|-
| Invalid input for form field 'filterLevel'
| 400
| Invalid FilterLevel: Input must be: on/off/exclusive
|-
| Invalid input for form field 'spamHandling'
| 400
| Invalid RSEmail SpamHandling: Input must be: toFolder/delete/labelSubject/toAddress
|-
| Invalid email address in spam forwarding address
| 400
| Invalid email address
|-
| Empty forwarding address
| 400
| Spam Forwarding Address cannot be empty for spam handling policy: toAddress
|-
| Invalid value for field 'spamFolderAgeLimit'
| 400
| Invalid RSEmail SpamCleanupOption: -1. rsEmail.spamFolderAgeLimit should be non-negative
|-
| Invalid value for field 'spamFolderNumLimit'
| 400
| Invalid RSEmail SpamCleanupOption: -1. rsEmail.spamNumberLimit should be non-negative.
|-
| Invalid field combination
| 400
| Invalid field combination: Folder cleaner options cannot be specified with spam handling policy: delete.
|-
| Invalid field combination
| 400
| Invalid field combination: Folder cleaner options cannot be specified with spam handling policy: labelSubject.
|-
| Invalid field combination
| 400
| Invalid field combination: Folder cleaner options cannot be specified with spam handling policy: toAddress.
|}

=== Blacklist ===

==== Index ====

''URL'':
<nowiki>[GET] https://api.emailsrvr.com/v1/customers/(customer account number)/domains/(domain name)
/rs/mailboxes/(mailbox name)/spam/blacklist</nowiki>

''Description'':

This operation returns email address blacklist associated with the mailbox.

''Remarks'':

The Index operation only supports the GET HTTP verb.

''Example'':
<pre>
get '/customers/12345678/domains/example.com/rs/mailboxes/alex.smith/spam/blacklist'
</pre>

''XML Result Example'':

<pre>
<?xml version="1.0" encoding="utf-8"?>
<blacklist xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="urn:xml:blacklist">
<addresses>
<address>name1@spam.com</address>
<address>name2@spam.com</address>
</addresses>
</blacklist>
</pre>

''Json Result Example'':

{"addresses":["name1@spam.com","name2@spam.com"]}

==== Add ====

''URL'':
<nowiki>[POST] https://api.emailsrvr.com/v1/customers/(customer account number)/domains/(domain name)
/rs/mailboxes/(mailbox name)/spam/blacklist/(email address)</nowiki>

''Description'':

Adds an email address or domain to the blacklist.

''Example'':
<pre>
post '/customers/12345678/domains/example.com/rs/mailboxes/alex.smith/spam/blacklist/anyone@spam.com', {}
</pre>

''Errors'':

{| class="wikitable"
!''Description''
!''HTTP Response Code''
!''Sample Message''
|-
| Entered invalid email or domain
| 400
| invalid email address: abc
|-
| Entered current domain
| 400
| Adding example.com would blacklist the current domain
|}

==== Delete ====

''URL'':
<nowiki>[DELETE] https://api.emailsrvr.com/v1/customers/(customer account number)/domains/(domain name)
/rs/mailboxes/(mailbox name)/spam/blacklist/(email address)</nowiki>

''Description'':

Removes an email address or domain from the blacklist.

''Example'':
<pre>
delete '/customers/12345678/domains/example.com/rs/mailboxes/alex.smith/spam/blacklist/anyone@yahoo.com'
</pre>

''Errors'':

{| class="wikitable"
!''Description''
!''HTTP Response Code''
!''Sample Message''
|-
| Entered invalid email or domain
| 400
| invalid email address: abc
|-
| Entered email or domain is not on the current blacklist
| 400
| abc@junkmail.com is not found on the blacklist
|}

==== Edit ====

''URL'':
<nowiki>[PUT] https://api.emailsrvr.com/v1/customers/(customer account number)/domains/(domain name)
/rs/mailboxes/(mailbox name)/spam/blacklist</nowiki>

''Description'':

Edit email addresses on the blacklist.

{| class="wikitable"
!''Field Name''
!''Data Type''
!''Description''
|-
| addList
| string
| Comma separated list of email addresses to add to the list
|-
| removeList
| string
| Comma separated list of email addresses to remove from the list
|}

''Note'':

You can use a '%' as a wildcard in domains, but not in the TLD (.com, .net, etc). You cannot use wildcards in email addresses. For example, the following are allowed: @%.example.com, @examp%.com.

''Example'':
<pre>
put '/customers/12345678/domains/example.com/rs/mailboxes/jane.doe/spam/blacklist',
{
'addList' => '@%.example.com,abc@example.com',
'removeList' => '@examp%.com'
}
</pre>

=== IP Blacklist ===

==== Index ====

''URL'':
<nowiki>[GET] https://api.emailsrvr.com/v1/customers/(customer account number)/domains/(domain name)
/rs/mailboxes/(mailbox name)/spam/ipblacklist</nowiki>

''Description'':

This operation returns IP blacklist associated with the mailbox.

''Remarks'':

The Index operation only supports the GET HTTP verb.

''Example'':
<pre>
get '/customers/12345678/domains/example.com/rs/mailboxes/alex.smith/spam/ipblacklist'
</pre>

''XML Result Example':

<pre>
<?xml version="1.0" encoding="utf-8"?>
<ipBlacklist xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="urn:xml:ipBlacklist">
<addresses>
<ip>216.12.34.1</ip>
<ip>216.12.34.2</ip>
</addresses>
</ipBlacklist>
</pre>

''Json Result Example'':

{"addresses":["216.12.34.1","216.12.34.2"]}

==== Add ====

''URL'':
<nowiki>[POST] https://api.emailsrvr.com/v1/customers/(customer account number)/domains/(domain name)
/rs/mailboxes/(mailbox name)/spam/ipblacklist/(ip address)</nowiki>

''Description'':

Adds an IP to the blacklist.

''Example'':
<pre>
post '/customers/12345678/domains/example.com/rs/mailboxes/alex.smith/spam/blacklist/216.12.34.1', {}
</pre>

==== Delete ====

''URL'':
<nowiki>[DELETE] https://api.emailsrvr.com/v1/customers/(customer account number)/domains/(domain name)
/rs/mailboxes/(mailbox name)/spam/ipblacklist/(ip address)</nowiki>

''Description'':

Removes an IP from the blacklist.

''Example'':
<pre>
delete '/customers/12345678/domains/example.com/rs/mailboxes/alex.smith/spam/ipblacklist/216.12.34.1'
</pre>

''Errors'':

{| class="wikitable"
!''Description''
!''HTTP Response Code''
!''Sample Message''
|-
| Entered IP is not on the current blacklist
| 400
| 216.12.34.1 is not found on the blacklist
|}

==== Edit ====

''URL'':
<nowiki>[PUT] https://api.emailsrvr.com/v1/customers/(customer account number)/domains/(domain name)
/rs/mailboxes/(mailbox name)/spam/ipblacklist</nowiki>

''Description'':

Edit IP addresses on the blacklist.

{| class="wikitable"
!''Field Name''
!''Data Type''
!''Description''
|-
| addList
| string
| Comma separated list of IP addresses to add to the list
|-
| removeList
| string
| Comma separated list of IP addresses to remove from the list
|}

''Note'':

You can use a '%' as a wildcard in the last octets to specify IP ranges. For example: 216.12.34.%, 216.12.%.%, 216.%.%.%.

''Example'':
<pre>
put '/customers/12345678/domains/example.com/rs/mailboxes/jane.doe/spam/ipblacklist',
{
'addList' => '216.12.34.%,216.12.%.%',
'removeList' => '216.%.%.%'
}
</pre>

=== Safelist ===

==== Index ====

''URL'':
<nowiki>[GET] https://api.emailsrvr.com/v1/customers/(customer account number)/domains/(domain name)
/rs/mailboxes/(mailbox name)/spam/safelist</nowiki>

''Description'':

This operation returns email address safelist associated with the mailbox.

''Remarks'':

The Index operation only supports the GET HTTP verb.

''Example'':
<pre>
get '/customers/12345678/domains/example.com/rs/mailboxes/alex.smith/spam/safelist'
</pre>

''XML Result Example'':

<pre>
<?xml version="1.0" encoding="utf-8"?>
<safelist xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="urn:xml:safelist">
<addresses>
<address>name1@notspam.com</address>
<address>name2@notspam.com</address>
</addresses>
</safelist>
</pre>

''Json Result Example'':

{"addresses":["name1@notspam.com","name2@notspam.com"]}

==== Add ====

''URL'':
<nowiki>[POST] https://api.emailsrvr.com/v1/customers/(customer account number)/domains/(domain name)
/rs/mailboxes/(mailbox name)/spam/safelist/(email address)</nowiki>

''Description'':

Adds an email address or domain to the safelist.

''Example'':
<pre>
post '/customers/12345678/domains/example.com/rs/mailboxes/alex.smith/spam/safelist/anyone@yahoo.com', {}
</pre>

''Errors'':

{| class="wikitable"
!''Description''
!''HTTP Response Code''
!''Sample Message''
|-
| Entered invalid email or domain
| 400
| invalid email address: abc
|}

==== Delete ====

''URL'':
<nowiki>[DELETE] https://api.emailsrvr.com/v1/customers/(customer account number)/domains/(domain name)
/rs/mailboxes/(mailbox name)/spam/safelist/(email address)</nowiki>

''Description'':

Removes an email address or domain from the safelist.

''Example'':
<pre>
delete '/customers/12345678/domains/example.com/rs/mailboxes/alex.smith/spam/safelist/anyone@yahoo.com'
</pre>

''Errors'':

{| class="wikitable"
!''Description''
!''HTTP Response Code''
!''Sample Message''
|-
| Entered invalid email or domain
| 400
| invalid email address: abc
|-
| Entered email or domain is not on the current safelist
| 400
| anyone@yahoo.com is not found on the safelist
|}

==== Edit ====

''URL'':
<nowiki>[PUT] https://api.emailsrvr.com/v1/customers/(customer account number)/domains/(domain name)
/rs/mailboxes/(mailbox name)/spam/safelist</nowiki>

''Description'':

Edit email addresses on the safelist.

{| class="wikitable"
!''Field Name''
!''Data Type''
!''Description''
|-
| addList
| string
| Comma separated list of email addresses to add to the list
|-
| removeList
| string
| Comma separated list of email addresses to remove from the list
|}

''Note'':

You can use a '%' as a wildcard in domains, but not in the TLD (.com, .net, etc). You cannot use wildcards in email addresses. For example, the following are allowed: @%.example.com, @examp%.com.

''Example'':
<pre>
put '/customers/12345678/domains/example.com/rs/mailboxes/jane.doe/spam/safelist',
{
'addList' => '@%.example.com,abc@example.com',
'removeList' => '@examp%.com'
}
</pre>

=== IP Safelist ===

==== Index ====

''URL'':
<nowiki>[GET] https://api.emailsrvr.com/v1/customers/(customer account number)/domains/(domain name)
/rs/mailboxes/(mailbox name)/spam/ipsafelist</nowiki>

''Description'':

This operation returns IP safelist associated with the mailbox.

''Remarks'':

The Index operation only supports the GET HTTP verb.

''Example'':
<pre>
get '/customers/12345678/domains/example.com/rs/mailboxes/alex.smith/spam/ipsafelist'
</pre>

''XML Result Example'':

<pre>
<?xml version="1.0" encoding="utf-8"?>
<ipSafelist xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="urn:xml:ipSafelist">
<addresses>
<ip>192.168.0.1</ip>
<ip>192.168.0.2</ip>
</addresses>
</ipSafelist>
</pre>

''Json Result Example'':

{"addresses":["192.168.0.1","192.168.0.2"]}

==== Add ====

''URL'':
<nowiki>[POST] https://api.emailsrvr.com/v1/customers/(customer account number)/domains/(domain name)
/rs/mailboxes/(mailbox name)/spam/ipsafelist/(ip address)</nowiki>

''Description'':

Adds an IP to the ipsafelist.

''Example'':
<pre>
post '/customers/12345678/domains/example.com/rs/mailboxes/alex.smith/spam/ipsafelist/216.12.34.1', {}
</pre>

''Errors'':

{| class="wikitable"
!''Description''
!''HTTP Response Code''
!''Sample Message''
|-
| Entered invalid IP address
| 400
| invalid ip address: 123
|}

==== Delete ====

''URL'':
<nowiki>[DELETE] https://api.emailsrvr.com/v1/customers/(customer account number)/domains/(domain name)
/rs/mailboxes/(mailbox name)/spam/ipsafelist/(email address)</nowiki>

''Description'':

Removes an IP from the safelist.

''Example'':
<pre>
delete '/customers/12345678/domains/example.com/rs/mailboxes/alex.smith/spam/ipsafelist/216.12.34.1'
</pre>

''Errors'':

{| class="wikitable"
!''Description''
!''HTTP Response Code''
!''Sample Message''
|-
| Entered IP is not on the current safelist
| 400
| 216.12.34.1 is not found on the safelist
|}

==== Edit ====

''URL'':
<nowiki>[PUT] https://api.emailsrvr.com/v1/customers/(customer account number)/domains/(domain name)
/rs/mailboxes/(mailbox name)/spam/ipsafelist</nowiki>

''Description'':

Edit IP addresses on the safelist.

{| class="wikitable"
!''Field Name''
!''Data Type''
!''Description''
|-
| addList
| string
| Comma separated list of IP addresses to add to the list
|-
| removeList
| string
| Comma separated list of IP addresses to remove from the list
|}

''Note'':

You can use a '%' as a wildcard in the last octets to specify IP ranges. For example: 216.12.34.%, 216.12.%.%, 216.%.%.%.

''Example'':
<pre>
put '/customers/12345678/domains/example.com/rs/mailboxes/jane.doe/spam/ipsafelist',
{
'addList' => '216.12.34.%,216.12.%.%',
'removeList' => '216.%.%.%'
}
</pre>

DKIM (Rest API)

2019-07-10T19:11:00Z

SOADev:

__TOC__

== v1 - Current ==

=== Authentication and Authorization ===
'''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'''

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

=== Enable DKIM or Rotate Keys ===

''URL'':
[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 (below).

''Parameters'':
{| class="wikitable"
!''Field Name''
!''Data Type''
!''Description''
|-
| customer_id
| string
| ID of customer who owns domain_name
|-
| domain_name
| string
| Domain to act on
|}

''Example'':
<pre>
POST '/v2/customers/123123123/domains/not-a-real-domain.com/dkim'
</pre>

''Status Code 200 Result Example'':
<pre>
{
"HostedBy": "external",
"Status": "pendingVerification",
"subdomain": "20170209._domainkey",
"dnsKey": "v=DKIM1; k=rsa; p=DNSKeyGoesHere"
}
</pre>

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

''URL'':

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

''Description'':

Returns the status of DKIM configuration for a domain.

''Parameters'':
{| class="wikitable"
!''Field Name''
!''Data Type''
!''Description''
|-
| customer_id
| string
| ID of customer who owns domain_name
|-
| domain_name
| string
| Domain to act on
|}

''Examples'':
<pre>
GET '/v2/customers/123123123/domains/not-a-real-domain.com/dkim'
</pre>

''Status Code 200 Result Example'':
<pre>
{
"hostedBy": "external",
"status": "pendingVerification",
"selector": "20170209",
"subdomain": "20170209._domainkey",
"publicKey": "-----BEGIN PUBLIC KEY-----PublicKeyGoesHere-----END PUBLIC KEY-----",
"dnsKey": "v=DKIM1; k=rsa; p=DNSKeyGoesHere"
}
</pre>

=== Disable DKIM on a Domain ===

''URL'':

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

''Description'':

Disables DKIM for a domain by revoking all existing certificates.

''Parameters'':
{| class="wikitable"
!''Field Name''
!''Data Type''
!''Description''
|-
| customer_id
| string
| ID of customer who owns domain_name
|-
| domain_name
| string
| Domain to act on
|}

''Example'':
<pre>
DELETE '/v2/customers/123123123/domains/not-a-real-domain.com/dkim',
</pre>

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

''URL'':

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

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

''Example'':
<pre>
POST '/v2/customers/123123123/domains/not-a-real-domain.com/dkim/verification'
</pre>

DKIM (Rest API)

2019-07-10T19:09:47Z

SOADev: Fix URLs

__TOC__

== v1 - Current ==

=== Authentication and Authorization ===
'''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'''

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

=== Enable DKIM or Rotate Keys ===

''URL'':
[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 (below).

''Parameters'':
{| class="wikitable"
!''Field Name''
!''Data Type''
!''Description''
|-
| customer_id
| string
| ID of customer who owns domain_name
|-
| domain_name
| string
| Domain to act on
|}

''Example'':
<pre>
POST '/v2/customers/123123123/domains/not-a-real-domain.com/dkim'
</pre>

''Status Code 200 Result Example'':
<pre>
{
"HostedBy": "external",
"Status": "pendingVerification",
"subdomain": "20170209._domainkey",
"dnsKey": "v=DKIM1; k=rsa; p=DNSKeyGoesHere"
}
</pre>

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

''URL'':

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

''Description'':

Returns the status of DKIM configuration for a domain.

''Parameters'':
{| class="wikitable"
!''Field Name''
!''Data Type''
!''Description''
|-
| customer_id
| string
| ID of customer who owns domain_name
|-
| domain_name
| string
| Domain to act on
|}

''Examples'':
<pre>
GET '/v2/customers/123123123/domains/not-a-real-domain.com/dkim'
</pre>

''Status Code 200 Result Example'':
<pre>
{
"hostedBy": "external",
"status": "pendingVerification",
"selector": "20170209",
"subdomain": "20170209._domainkey",
"publicKey": "-----BEGIN PUBLIC KEY-----PublicKeyGoesHere-----END PUBLIC KEY-----",
"dnsKey": "v=DKIM1; k=rsa; p=DNSKeyGoesHere"
}
</pre>

=== Disable DKIM on a Domain ===

''URL'':

[DELETE] <nowiki>https://cp.rackspace.com/customers/{customer_id}/domains/{domain_name}/dkim</nowiki>

''Description'':

Disables DKIM for a domain by revoking all existing certificates.

''Parameters'':
{| class="wikitable"
!''Field Name''
!''Data Type''
!''Description''
|-
| customer_id
| string
| ID of customer who owns domain_name
|-
| domain_name
| string
| Domain to act on
|}

''Example'':
<pre>
DELETE '/v2/customers/123123123/domains/not-a-real-domain.com/dkim',
</pre>

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

''URL'':

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

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

''Example'':
<pre>
POST '/v2/customers/123123123/domains/not-a-real-domain.com/dkim/verification'
</pre>

Deprecation

2019-02-07T15:21:14Z

SOADev:

* [[AddDomainSpamBlackList()|AddDomainSpamBlackList]]
* [[AddDomainSpamIPBlackList()|AddDomainSpamIPBlackList]]
* [[AddDomainSpamIPSafeList()|AddDomainSpamIPSafeList]]
* [[AddDomainVirus()|AddDomainVirus]]
* [[AddUsersBulk()|AddUsersBulk]]
* [[AddUserSpamBlackList()|AddUserSpamBlackList]]
* [[AddUserSpamIPBlackList()|AddUserSpamIPBlackList]]
* [[AddUserSpamIPSafeList()|AddUserSpamIPSafeList]]
* [[AddUserVirus()|AddUserVirus]]
* [[AddUserVirusBulk()|AddUserVirusBulk]]
* [[AddUserWithLdapAttributesString()|AddUserWithLdapAttributesString]]
* [[CleanAliasesByUser()|CleanAliasesByUser]]
* [[DeleteDomainSpam()|DeleteDomainSpam]]
* [[DeleteDomainVirus()|DeleteDomainVirus]]
* [[DeleteUserAliasesBulk()|DeleteUserAliasesBulk]]
* [[DeleteUserVirus()|DeleteUserVirus]]
* [[DeleteUserVirusBulk()|DeleteUserVirusBulk]]
* [[DisableSubaccount()|DisableSubaccount]]
* [[EnableSubaccount()|EnableSubaccount]]
* [[GetAllDomainsMXRecords()|GetAllDomainsMXRecords]]
* [[GetAllDomainsSettings()|GetAllDomainsSettings]]
* [[GetAllDomainsStats()|GetAllDomainsStats]]
* [[GetAllDomainsUserCount()|GetAllDomainsUserCount]]
* [[GetAllocatedStorage()|GetAllocatedStorage]]
* [[GetDomainAdministrators()|GetDomainAdministrators]]
* [[GetDomainAllUserCurrentSizeActive()|GetDomainAllUserCurrentSizeActive]]
* [[GetDomainAllUserCurrentSizeAlpha()|GetDomainAllUserCurrentSizeAlpha]]
* [[GetDomainAllUserLastLoginActive()|GetDomainAllUserLastLoginActive]]
* [[GetDomainAllUserLastLoginAlpha()|GetDomainAllUserLastLoginAlpha]]
* [[GetDomainAllUserStatsAlpha()|GetDomainAllUserStatsAlpha]]
* [[GetDomainMXRecords()|GetDomainMXRecords]]
* [[GetDomainNotify()|GetDomainNotify]]
* [[GetDomainNumBcc()|GetDomainNumBcc]]
* [[GetDomainNumSync()|GetDomainNumSync]]
* [[GetDomainNumUserAliases()|GetDomainNumUserAliases]]
* [[GetDomainNumUsersActive()|GetDomainNumUsersActive]]
* [[GetDomainSpamCleaner()|GetDomainSpamCleaner]]
* [[GetDomainSpamGreylist()|GetDomainSpamGreylist]]
* [[GetDomainUsersBlackListStatusString()|GetDomainUsersBlackListStatusString]]
* [[GetDomainUsersSafeListStatusString()|GetDomainUsersSafeListStatusString]]
* [[GetDomainUsersSpamStatusString()|GetDomainUsersSpamStatusString]]
* [[GetDomainUsersString()|GetDomainUsersString]]
* [[GetDomainVirus()|GetDomainVirus]]
* [[GetGroupAliasesString()|GetGroupAliasesString]]
* [[GetListUsers()|GetListUsers]]
* [[GetMailTotalStorage()|GetMailTotalStorage]]
* [[GetSubaccountStatus()|GetSubaccountStatus]]
* [[GetSubaccountsWithStatus()|GetSubaccountsWithStatus]]
* [[GetUserAliasesStringAlpha()|GetUserAliasesStringAlpha]]
* [[GetUserNumMessages()|GetUserNumMessages]]
* [[GetUserSpamGreylist()|GetUserSpamGreylist]]
* [[GetUserVirus()|GetUserVirus]]
* [[GetUserVirusBulk()|GetUserVirusBulk]]
* [[ModifyDomainAdministrator()|ModifyDomainAdministrator]]
* [[ModifyGroupAlias()|ModifyGroupAlias]]
* [[ModifyUsersBulk()|ModifyUsersBulk]]
* [[ModifyUserWithLdapAttributesString()|ModifyUserWithLdapAttributesString]]
* [[RemoveDomainSpamBlackList()|RemoveDomainSpamBlackList]]
* [[RemoveDomainSpamIPBlackList()|RemoveDomainSpamIPBlackList]]
* [[RemoveDomainSpamIPSafeList()|RemoveDomainSpamIPSafeList]]
* [[RemoveDomainSpamSafeList()|RemoveDomainSpamSafeList]]
* [[RemoveUserSpamBlackList()|RemoveUserSpamBlackList]]
* [[RemoveUserSpamIPBlackList()|RemoveUserSpamIPBlackList]]
* [[RemoveUserSpamIPSafeList()|RemoveUserSpamIPSafeList]]
* [[RemoveUserSpamSafeList()|RemoveUserSpamSafeList]]
* [[RetCode()|RetCode]]
* [[SendMailDomainUsersAll()|SendMailDomainUsersAll]]
* [[SetAliasSingleAddress()|SetAliasSingleAddress]]
* [[SetDomainSpamBlackList()|SetDomainSpamBlackList]]
* [[SetDomainSpamGreylist()|SetDomainSpamGreylist]]
* [[SetDomainSpamIPBlackList()|SetDomainSpamIPBlackList]]
* [[SetDomainSpamIPSafeList()|SetDomainSpamIPSafeList]]
* [[SetListUsers()|SetListUsers]]
* [[SetUserSpamGreylist()|SetUserSpamGreylist]]
* [[Subaccount_GetAccountSetting()|Subaccount_GetAccountSetting]]
* [[Subaccount_GetAccountSettings()|Subaccount_GetAccountSettings]]
* [[Subaccount_GetAdminType()|Subaccount_GetAdminType]]
* [[Subaccount_GetAllocatedStorage()|Subaccount_GetAllocatedStorage]]
* [[Subaccount_GetLimitedAdminPermissions()|Subaccount_GetLimitedAdminPermissions]]
* [[Subaccount_GetMailTotalStorage()|Subaccount_GetMailTotalStorage]]
* [[Subaccount_GetNumBcc()|Subaccount_GetNumBcc]]
* [[Subaccount_GetNumDomains()|Subaccount_GetNumDomains]]
* [[Subaccount_GetNumMailboxes()|Subaccount_GetNumMailboxes]]
* [[Subaccount_GetNumSync()|Subaccount_GetNumSync]]
* [[Subaccount_ModifyAccountSetting()|Subaccount_ModifyAccountSetting]]
* [[Subaccount_ModifyDomain()|Subaccount_ModifyDomain]]
* [[UndeleteUser()|UndeleteUser]]

Deprecation

2019-02-07T15:20:29Z

SOADev:

Soap API (Deprecated)

2019-02-07T15:19:14Z

SOADev: /* What is currently missing from the REST API, that you plan to add? */

== The Rackspace Email Soap API Deprecation ==

=== Why are you doing this? ===
In order to maximize our ability to deliver great functionality quickly, we have to make the tough call to deprecate old stuff that slows us down. We feel that REST is a better approach to web services: It is more scaleable, more securable, more evolvable, and generally simpler to consume, maintain, and support.

=== What does this mean for me? ===

* For customers new to our APIs
For the best support, you should integrate with our [[Main_Page|REST API]]. If there is functionality you need that is not available in the REST API, please tell us. We thrive on your feedback!

* For customers who consume our SOAP API
Deprecation of the SOAP API is not imminent but we highly encourage you to consider revisiting your current applications and update them to use the newer REST API. Once a SOAP API deprecation date has been set there will be 6 month notice prior to its End-Of-Life.

We will not be porting over every function from our SOAP API to our REST API. So the only way to ensure you'll have everything you need when the SOAP API is officially deprecated is to start early, and let us know what is missing.

=== What is currently missing from the REST API, that you plan to add? ===
* Search for a Domain
* Get default max mailbox size for domain
* Get/Set max size for mailbox
* Get mailbox last login date/time
* Get addresses configured to receive forwarded email
* Search mailboxes
* Get the number of messages in an inbox and the number of those messages that are new

If you rely on functionality that is not currently in the [[Main_Page|REST API]], or in this list, please tell us.

== The Rackspace Email Soap API (Deprecated) ==

The Rackspace Email [http://en.wikipedia.org/wiki/Api API] comprises a robust set of web services designed to allow businesses to fully integrate administrative email functions into their own applications. Based on [http://en.wikipedia.org/wiki/SOAP SOAP], functions in the API allow programs written in many different languages to perform operations such as [[AddUser()|adding mailboxes]] and changing settings. The API can also be used to provide [[LoginUserWebmail()|single sign on]] functionality in concert with other web applications. The Webmail API runs on the same robust server platform that supports our high-availability [http://www.rackspace.com/email_hosting webmail] and email services.

* [[webmail|Webmail User API]] - provides a short list of webmail user functions

* [[business|Business API]] - provides a list of functions designed for single business/domain usage

* [[reseller|Reseller API]] - provides a complete list of functions for multiple domains and sub-accounts

=== Code Examples ===

{|
|
*[[Perl]]
|
*[[PHP]]
|-
|
*[[ASP]]
|
*[[C#]]
|-
|
*[[ColdFusion]]
|
*[[Ruby]]
|-
|
* [[HTML]] (not part of the API, strictly speaking)
|}

=== Getting Started Screencast ===
[http://www.mailtrust.com/api-wiki/screencasts/api-pings.htm Screencast] of accessing two of our SOAP API's from PHP using Ubuntu linux.

=== Result Codes ===
Consult the [[resultcodes|Result Code Table]] for a list of result codes and their meaning.

=== Deprecation ===

Functions returning error code -777 indicates that it has been deprecated.
* [[Deprecation|View list of deprecated functions]]

Deprecation

2019-02-07T15:16:51Z

SOADev:

Rest API

2019-02-07T14:51:18Z

SOADev: /* Operations */

== Recent Changes ==

'''09/01/10 '''
{|
|
New features:
* Now Rackspace Email Mailboxes can be visible in Exchange Global Address List. And Exchange Mailboxes can be visible in Rackspace Email Company Directory.
* Now Index Rackspace Email/Exchange Mailbox can filter mailboxes by "enabled" flag.
* Added "lastLogin" to Rackspace Email/Exchange Mailbox Show.
|
|}

'''08/01/10 '''
{|
|
New features:
* Added Rackspace Email Mailbox Contact info. See [[Rackspace_Mailbox_(Rest_API)| here]].
* Added Create Login Token. See [[Customer_(Rest_API)#Create_Login_Tokens| here]].
|
|}

'''06/20/10 '''
{|
|
New features:
* Added [[Rackspace_Alias(Rest_API)| Rackspace Email Alias]].
|
|}

'''06/11/10 '''
{|
|
New features:
* Added Rackspace Email Mailbox Spam Settings/Blacklist/Safelist. See [[Rackspace_Mailbox_Spam_(Rest_API)| here]].
* Now Rackspace Email Mailbox can Show/Edit vacation message and email forwarding address. See [[Rackspace_Mailbox_(Rest_API)| here]].
* Added SharePoint Service Settings. See [[SharePoint_(Rest_API)| here]].
|
|}

== Introduction ==

The Email & Apps Control Panel API provides most of the functions of the Control Panel through a REST-based [http://en.wikipedia.org/wiki/Web_service web API]. Whether it is adding a new customer account, adding mailboxes, or any other of the supported features the API allows your application to administer the changes regardless of your application's language or nature. For more information on RESTful web services refer to the following sites:

[http://www.peej.co.uk/articles/restfully-delicious.html Paul James's Homepage: A RESTful Web service, an example]

[http://en.wikipedia.org/wiki/Representational_State_Transfer#External_links Wikipedia: Representational State Transfer - External Links]

The API is accessible to all with access to Control Panel, including resellers, business customers, enterprise customers, and indirect customers. However, not all operations are available to non-resellers. See the [[Rest_API#Operations|Operations]] section for more details.

== Operations ==

The following pages detail the operations that the API supports. The operations are grouped into sections based on the entity/object types that each operation interacts with. Non-resellers do not have access to all functions.

{| class="wikitable"
!Resource
!Example URI
!Business User Access
|-
| [[Customer_(Rest_API)| Customer]]
| /customers/123456789
| [[Customer_(Rest_API)#Create_Login_Tokens| Create Login Token]]
|-
| [[DKIM (Rest_API)| DKIM]]
| /customers/123456789/domains/example.com/dkim/enable
| All
|-
| [[Domain_(Rest_API)| Domain]]
| /customers/123456789/domains/example.com
| [[Domain_(Rest_API)#Index| Index]], [[Domain_(Rest_API)#Show| Show]], [[Domain_(Rest_API)#Split Domain Routing| Split Domain Routing]], [[Domain_(Rest_API)#Archiving SSO Login URL| Archiving SSO Login URL]], [[Domain_(Rest_API)#Domain Public Folders|Domain Public Folders ]]
|-
| [[Domain_Spam_(Rest_API)| Domain Spam Settings]]
| /customers/123456789/domains/example.com/spam/settings
| All
|-
| [[Rackspace_Mailbox_(Rest_API)| Rackspace Email Mailbox]]
| /customers/123456789/domains/example.com/rs/mailboxes/john.smith
| All
|-
| [[Rackspace_Mailbox_Spam_(Rest_API)| Rackspace Email Mailbox Spam Settings]]
| /customers/123456789/domains/example.com/rs/mailboxes/john.smith/spam
| All
|-
| [[Rackspace_Alias(Rest_API)| Rackspace Email Alias]]
| /customers/123456789/domains/example.com/rs/mailboxes/john.smith/alias
| All
|-
| [[Exchange_Mailbox_(Rest_API)| Exchange Mailbox]]
| /customers/123456789/domains/example.com/ex/mailboxes/john.smith
| All
|-
| [[Exchange_Mailbox_Spam_(Rest_API)| Exchange Mailbox Spam Settings]]
| /customers/123456789/domains/example.com/ex/mailboxes/john.smith/spam
| All
|-
| [[Exchange_Contact_(Rest_API)| Exchange Contact]]
| /customers/123456789/domains/example.com/ex/contacts/john.smith
| All
|-
| [[Exchange_Distribution_List_(Rest_API)| Exchange Distribution List]]
| /customers/123456789/domains/example.com/ex/distributionlists/group.name
| All
|-
| [[Exchange_Resource_Mailbox_(Rest_API)| Exchange Resource Mailbox]]
| /customers/123456789/domains/example.com/ex/resources/conference.room
| All
|-
| [[SharePoint_(Rest_API)| SharePoint]]
| /customers/123456789/sharepoint/settings
| [[SharePoint_(Rest_API)#Show | Show]]
|}

The examples shown in the operation pages are written in Ruby and extensively use the helper functions shown in the Ruby Examples below.

== Quick Start ==

'''What you need:'''
* A Rackspace Email and Apps Control Panel admin account
* A HTTP class library that supports TLS and the HTTP methods: GET, POST, PUT, DELETE.

'''Making your first API call, an Show Customer request:'''
# Obtain your API keys
#:* Click on My Account at the top of the [https://apps.rackspace.com/?cp Control Panel web interface]. Under the Administrators heading there will be an link for the API keys page.
# Set up your client's HTTP request
#:* Set up your client to make calls to a URL beginning with <nowiki>https://api.emailsrvr.com/v0</nowiki>.
#:* Populate the Accept, User-Agent and X-Api-Signature HTTP request headers correctly. This is explained in detail [[#HTTP Headers|here]].
# Make a GET request to /customers/me.
#:* The complete URI will be <nowiki>https://api.emailsrvr.com/v0/customers/me</nowiki>. Use your HTTP library to retrieve the HTTP response code, 'x-error-message' HTTP response header and HTTP response body so that they may be displayed to help debug and determine success.
'''From here:'''
* Learn about the operations you'll be implementing at the subpages [[#Operations|here]].

== Accessing the API ==

Your application will need to make HTTP requests to remote servers. Most programming languages have this function provided in its class library. In addition to the common GET and POST HTTP methods, the library used will also need to support PUT and DELETE.


Calls without [http://en.wikipedia.org/wiki/Transport_Layer_Security TLS] (formerly SSL) will complete successfully but it is HIGHLY RECOMMENDED that TLS always be used. Interception of unencrypted communication will allow a third party to have complete access to all functions available via the API.

For some language libraries just using an URL with https:// will cause the library to use TLS. In some other libraries however some options specific to the library may have to be configured to utilize TLS.

All API calls should be directed to a URL in the following format:
<pre>https://api.emailsrvr.com/(version)/(resource)</pre>

Example:
<pre>https://api.emailsrvr.com/v0/customers/12345678/domains/customerbusiness.com</pre>

=== Versions ===

{| class="wikitable"
!''Supported Versions''
!''URL''
!''Version Documentation''
|-
| v0 (current)
| <nowiki>https://api.emailsrvr.com/v0/</nowiki>
| http://api-wiki.apps.rackspace.com/api-wiki/index.php/RestAPI
|}

The API version number is a component of the URL that is used to access the API. For example, to access the root of the API, the URL is https://api.emailsrvr.com/v0/. Bug fixes and minor non-breaking changes will be made without changing the version number. When major features or breaking changes are introduced, the version number will be incremented. It is not yet determined how many versions are going to be supported at any one time.

{| class="wikitable"
!''Non-breaking Changes''
!''Breaking Changes''
|-
| Adding new fields or attributes to form fields sent
| Changing or deleting any fields in form fields sent
|-
| Adding fields in returned data
| Changing or removing fields in returned data
|-
|
| Changing the URI of any resource
|}

=== Authentication ===

To gain access to the API, your request must include a properly constructed X-Api-Signature HTTP header. Details on what to put in the header are below. To construct the header, you must have the following keys that that are generated from the [https://apps.rackspace.com/?cp Control Panel Web interface]. The key generation page can be found by clicking 'My Account' at the top, then 'Generate API Keys' in the Administrators section.

{| class="wikitable"
!Key Name
!Description
!Example
|-
| User Key
| A public key that corresponds to your admin id
| ''eGbq9/2hcZsRlr1JV1Pi''
|-
| Secret Key
| A shared secret key
| ''QHOvchm/40czXhJ1OxfxK7jDHr3t''
|}

An unsuccessful authentication will result in a 403 HTTP code.

==== X-Api-Signature Header ====

Format is as follows:
<'''User Key'''>:<'''Timestamp'''>:<'''SHA1 Hash'''> 
Example: ''eGbq9/2hcZsRlr1JV1Pi:20010317143725:46VIwd66mOFGG8IkbgnLlXnfnkU=''

Remember to include the colons between the data strings!

 
'''User Key''': 
This is the public key issued by the Control Panel browser interface.

 
'''Timestamp''': 
The format is YYYYMMDDHHmmss. All values besides year are zero-padded to two spaces. For example, March 08th 2001 at 2:37.25pm would be ''20010308143725''.

{| class="wikitable"
|YYYY
|Four-digit year
|-
| MM
| Month
|-
| DD
| Day
|-
| HH
| Hour in 24h format
|-
| mm
| Minute
|-
| ss
| Second
|}

'''SHA1 Hash''':

A SHA1 (Secure Hash Algorithm) hash must be applied to a string with the following information:

<'''User Key'''><'''User Agent'''><'''Timestamp'''><'''Secret Key'''>

Note that the 'User Agent' must be the exact same as what is specified in the User-Agent HTTP header. Using the above example data, the string before hashing is: ''eGbq9/2hcZsRlr1JV1PiRackspace Management Interface20010308143725QHOvchm/40czXhJ1OxfxK7jDHr3t''

Resulting base-64 SHA1 Hash: ''46VIwd66mOFGG8IkbgnLlXnfnkU=''

Be sure to encode the binary hash, not the hex hash, into base-64. The resulting string should be 28 characters long.

== Using the API ==

=== Requests ===

HTTP requests should be sent to the server with the correct URL, HTTP method, HTTP headers and form data (if needed). The URL specifies the resource, the HTTP method specifies what operation is done on the resource, and form data is used to specify the details of the resource when the resource is added or edited.

The URLs, corresponding HTTP methods, and necessary form data for the desired operations are detailed in the [[#Operations|operation pages]].

If you're getting the HTTP status code 417 see [[Handling HTTP code 417: Expectation failed]]

==== URL ====

The URLs are specifies the resource or resource collection. Objects are organized in a tree collection, starting with customers at the top, then domains, then domain objects next (such as mailboxes, contacts, and distribution lists) and so on. The URLs of the resources and collections accessible are found on the operation pages.

==== HTTP Method ====

It is the HTTP method that specifies what operation will be done on the resource. For example, to get the details of a mailbox a HTTP GET will be done on /customers/12345678/domains/example.com/ex/mailboxes/john.smith. If the mailbox does not exist, a HTTP POST to the same URL with the necessary form data will add the mailbox. Then, a HTTP PUT to the same URL will edit mailbox. And to delete the mailbox, an HTTP DELETE would be used.

The types of operations a certain method performs is outlined below.

{| class="wikitable"
!''HTTP Method''
!''Operations''
!''Response''
|-
|rowspan=2|GET
|Index - returns a list of the resources
|rowspan=2|XML or JSON formatted data
|-
|Show - returns the details of the resource
|-
|POST
|Add - adds a new resource
|rowspan=3|Response code and error message (if applicable) only
|-
|PUT
|Edit - changes the details of the resource
|-
|DELETE
|Delete - deletes the resource
|}

==== HTTP Headers ====

All requests to the API must then include HTTP headers with the following information:

{| class="wikitable"
!''Header Name''
!''Description''
!''Example Header Value''
|-
| Accept
| The requested content type (required for Index and Show actions). Fill this with either 'text/xml' or 'application/json'. See [[#Formats|Response Formats]]
| ''text/xml''
|-
| User-Agent
| An identifier you choose for your client software
| ''Rackspace Management Interface''
|-
| X-Api-Signature
| An authentication string explained in detail [[#X-Api-Signature_Header|here]]
| ''eGbq9/2hcZsRlr1JV1Pi:20010317143725:HKUn0aajpSDx7qqGK3vqzn3FglI=''
|}

==== Form Data ====

When using Add and Edit operations, the details of the resource are sent to the API server via HTTP form data. Your HTTP library should include methods for sending form data along with an HTTP request. The library should by default send the data in the HTTP request body using the 'application/x-www-form-urlencoded' data format.

==== Index Filter/Search ====

The results of Index actions can be filtered/searched. The index URLs can take either one of the query strings: "?startswith=xx" or "?contains=xx," where "xx" is the key word. If the request specifies more than one of these two query strings, a 400 HTTP error will be returned. Different fields will be searched depending on the resource type, see below.

Note that "0-9" is a reserved key word for query string "startswith." It represents any result starting with numbers.

{| class="wikitable"
!''Index Actions''
!''Where the key word will be searched''
|-
| Customer
| Customer name, account number, reference number
|-
| Domain
| Domain name
|-
| Mailbox
| Mailbox name, mailbox display name
|-
| Contact
| Contact display name, external email
|-
| Group
| Group name, group display name
|-
| Mobile Service
| Associated mailbox name, mailbox display name
|}

==== Throttling ====

The server limits the number of requests allowed per user in a certain period of time. The number of requests made are logged per minute. Calls that were made correctly with a user's API key, but not completed for any reason, including those exceeding the throttle limit, are included in this count.

If a user is over the throttling limit then a 403 HTTP code will be returned with an "Exceeded request limits" message.

{| class="wikitable"
!''Operation Category''
!''Request Limit''
|-
| GET
| 60 per minute
|-
| PUT, POST, DELETE
| 30 per minute
|-
| POST, PUT, DELETE on a domain
| 2 per minute
|-
| POST, DELETE on alternate domains
| 2 per minute
|-
| Enabling public folders for a domain
| 1 per 5 minutes
|}

==== Examples ====

Index of Exchange Mailboxes:
<pre>
Hypertext Transfer Protocol
GET /v0/customers/12345678/domains/example.com/ex/mailboxes?size=100&offset=100 HTTP/1.1
Host: api.emailsrvr.com
User-Agent: Rackspace Management Interface
X-Api-Signature: eGbq9/2hcZsRlr1JV1Pi:20010317143725:HKUn0aajpSDx7qqGK3vqzn3FglI=
Accept: text/xml
</pre>

Adding New Exchange Mailbox:
<pre>
Hypertext Transfer Protocol
POST /v0/customers/12345678/domains/example.com/ex/mailboxes/john.smith HTTP/1.1
Host: api.emailsrvr.com
User-Agent: Rackspace Management Interface
X-Api-Signature: eGbq9/2hcZsRlr1JV1Pi:20010317143725:HKUn0aajpSDx7qqGK3vqzn3FglI=
Content-Length: 53
[Content length: 53]
Content-Type: application/x-www-form-urlencoded

Line-based text data: application/x-www-form-urlencoded
size=2048&displayName=John%20Smith&password=abcABC123

</pre>

=== Responses ===

==== HTTP Status Code ====

On a successfully executed request, a 200 HTTP Code is returned. If the request was unsuccessful however, an HTTP error code in the 400s or 500s will be returned.

==== HTTP Response Body ====

If the request is an Index or Show request, the request data will be returned in the format specified in the HTTP Body.

===== Formats =====

Requests for data (index and show requests) are returned with XML or JSON data based on what your application populates the [[#HTTP_Headers|HTTP Accept headers]] with.

For XML, populate the header with 'text/xml' (ex: Headers!["Accept"] = "text/xml"). The XML document returned will conform to a published XSD (XML Schema Document). There are many ways to parse the data in an XML document, but we have found that the [http://www.w3schools.com/XPath/default.asp XPath] tree-style traversal has served our purposes. In any case, your application will likely need to use a class library for your chosen method.

For JSON, populate the header with 'application/json' (ex: Headers!["Accept"] = "application/json"). As with XML, a library will likely be needed to parse the data.

==== HTTP Headers ====

The only data returned in the header is the error message (if any).

{| class="wikitable"
!''Header Name''
!''Description''
!''Example Header Value''
|-
| x-error-message
| The error message. See [[#Errors|Errors]].
| Missing required field: name
|}

==== Errors ====

In the event of an error, the error message will be returned the HTTP header '''x-error-message''' and an HTTP Status Code in the '''400'''s or '''500'''s will be returned.

Note: Every language's HTTP library provides methods for retrieving HTTP response codes and response headers.

Below are some errors that are common to many operations. Each operation also has some specific errors which are outlined with the operation.

{| class="wikitable"
!''Description''
!''HTTP Response Code''
!''Sample Message''
|-
|Format is invalid
|400
|When requesting an index or show on a resource the 'Accept' header should be either 'text/xml' or 'application/json'
|-
|Expectation Failed: See [[Handling HTTP code 417: Expectation failed]]
|417
|(none)
|-
|Customer account number is invalid
|404
|Invalid account number
|-
|Domain is not found
|404
|<domain name> not found
|-
|Mailbox is not found
|404
|Mailbox not found
|-
|Required form field is missing
|400
|Missing required field: <required field>
|-
|Required form field has null or empty string input
|400
|Required field <required field> cannot be empty
|-
|Integer form field has non-integer input
|400
|Invalid format for <field>, input must be an integer
|-
|Boolean form field has non-boolean input
|400
|Invalid format for <field>, input must be True or False
|-
|Form data has an unrecognized field
|400
|Unrecognized field: <field>
|-
| Entered invalid IP address
| 400
| invalid ip address: 123
|}

==== Paging ====

The results of Index actions are split into pages to lessen potentially high resource usage. The index URLs have a query string with parameters in the format "?size=xx&offset=xx." If a query parameter is omitted, the default value is used.

{| class="wikitable"
!''Query Parameter''
!''Default''
!''Maximum''
!''Notes''
|-
| size
| 50
| 250
| This is the number of elements per page.
|-
| offset
| 0
| N/A
| This is the number of items to offset away from the first item in the list.
|}

===== Example =====

A PHP Example of paging can be found [[PHP_Examples_(Rest_API)| here]].

==== Examples ====

<pre>
HTTP/1.1 200 OK
Cache-Control: private
Content-Type: text/xml; charset=utf-8
Server: Microsoft-IIS/7.0
Date: Fri, 04 Dec 2009 19:08:11 GMT
Content-Length: 430

<?xml version="1.0" encoding="utf-8"?>
<domainList xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="urn:xml:domainList">
<offset>0</offset>
<size>50</size>
<total>1</total>
<domains>
<domain>
<name>customer.com</name>
<accountNumber>123456</accountNumber>
<serviceType>rsemail</serviceType>
</domain>
</domains>
</domainList>
</pre>

<pre>
HTTP/1.1 404 Not Found
Cache-Control: private
Server: Microsoft-IIS/7.0
x-error-message: Customer Not Found
Date: Fri, 04 Dec 2009 19:13:59 GMT
Content-Length: 0
</pre>

<pre>
HTTP/1.1 400 Bad Request
Cache-Control: private
Server: Microsoft-IIS/7.0
x-error-message: Missing required field: type
Date: Fri, 04 Dec 2009 19:17:29 GMT
Content-Length: 0
</pre>

== Examples ==

=== Ruby ===

This examples is written in [http://www.ruby-lang.org/en/ Ruby]. To make the examples shorter, helper methods have been written. These methods are part of a NetMethods module. The contents of the NetMethods module is listed below.

<pre>
require 'server.rb'

server = Server.new

response = server.get '/customers', server.xml_format

#fields = Hash['serviceType' => 'exchange', 'exchangeMaxNumMailboxes' => '4']
#response = server.post '/customers/me/domains/newdomain.com', fields

puts response.code
puts response['x-error-message']
puts response.body
</pre>

<pre>
require 'test/unit/assertions'
require 'net/http'
require 'date'
require 'date/format'
require 'digest/sha1'
require 'base64'
require 'time'

class Server
include Test::Unit::Assertions

def initialize(server='api.emailsrvr.com', version_prefix='/v0', user_key='xxxxxxxxxxxxxxxxxxxx', secret_hash='xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx')
@server = server
@version_prefix = version_prefix
@user_key = user_key
@secret_hash = secret_hash
end

# Response Type Enums

def xml_format
'text/xml'
end

def json_format
'application/json'
end

#
# HTTP Request Verbs
#
def get(url_string, format)
uri = full_uri(url_string)
headers = prepared_headers
headers['Accept'] = format
request = Net::HTTP::Get.new(request_uri(uri), headers)
http_response = make_request request, uri
end

def delete(url_string)
uri = full_uri(url_string)
request = Net::HTTP::Delete.new(request_uri(uri), prepared_headers)
http_response = make_request request, uri
end

def put(url_string, fields_hash)
uri = full_uri(url_string)
request = Net::HTTP::Put.new(request_uri(uri), prepared_headers)
request.set_form_data(fields_hash)
http_response = make_request request, uri
end

def post(url_string, fields_hash)
uri = full_uri(url_string)
request = Net::HTTP::Post.new(request_uri(uri), prepared_headers)
request.set_form_data(fields_hash)
http_response = make_request request, uri
end

#
# HTTP Request Helpers
#
def make_request request, uri
response = Net::HTTP::start(uri.host, uri.port) do |http|
http.request request
end

response
end

def full_uri url_string
URI.parse('http://' + @server + @version_prefix + url_string)
end

def request_uri uri
request = uri.path
if ! uri.query.nil?
request = request + '?' + uri.query
end
request
end

def prepared_headers
headers = Hash.new
headers.merge! headers_auth_creds(@user_key, @secret_hash)
headers['Accept'] = xml_format
headers
end

def headers_auth_creds apiKey, secretKey
userAgent = 'Ruby Test Client'
timestamp = DateTime.now.strftime('%Y%m%d%H%M%S')

data_to_sign = apiKey + userAgent + timestamp + secretKey

hash = Base64.encode64(Digest::SHA1.digest(data_to_sign))
signature = apiKey + ":" + timestamp + ":" + hash

headers = Hash['User-Agent' => userAgent, 'X-Api-Signature' => signature]
end
end
</pre>

=== C# ===

This examples is written in [http://msdn.microsoft.com/en-us/vcsharp/default.aspx C#].

<pre>
using System;
using System.Collections.Specialized;
using System.Security.Cryptography;
using System.Text;
using System.Net;

public class WebMethods
{
private WebClientBase client;
private string baseUrl;
private string apiKey;
private string secretKey;

public WebMethods(WebClientBase client, string baseUrl, string apiKey, string secretKey)
{
this.client = client;
this.baseUrl = baseUrl;
this.apiKey = apiKey;
this.secretKey = secretKey;
}

public virtual string Get(string url)
{
return MakeRemoteCall((client) =>
{
return client.DownloadString(baseUrl + url);
},
format);
}

public virtual string Post(string url, NameValueCollection data)
{
return MakeRemoteCall((client) =>
{
var bytes = client.UploadValues(baseUrl + url, data);
return Encoding.UTF8.GetString(bytes);
},
format);
}

private void SignMessage()
{
var userAgent = "C# Client Library";
client.Headers["User-Agent"] = userAgent;

var dateTime = DateTime.UtcNow.ToString("yyyyMMddHHmmss");

var dataToSign = apiKey + userAgent + dateTime + secretKey;
var hash = SHA1.Create();
var signedBytes = hash.ComputeHash(Encoding.UTF8.GetBytes(dataToSign));
var signature = Convert.ToBase64String(signedBytes);

client.Headers["X-Api-Signature"] = apiKey + ":" + dateTime + ":" + signature;
}

private void AssignFormat(string format)
{
client.Headers["Accept"] = format;
}

private string MakeRemoteCall(Func<WebClientBase, string> remoteCall, string format)
{
try
{
SignMessage();
AssignFormat(format);
return remoteCall.Invoke(client);
}
catch (WebException e)
{
throw new ApiException(e);
}
}
}
</pre>

=== PHP ===

The PHP Example can be found [[PHP_Examples_(Rest_API)| here]].

Rest API

2019-02-07T14:50:48Z

SOADev: /* Operations */

== Recent Changes ==

'''09/01/10 '''
{|
|
New features:
* Now Rackspace Email Mailboxes can be visible in Exchange Global Address List. And Exchange Mailboxes can be visible in Rackspace Email Company Directory.
* Now Index Rackspace Email/Exchange Mailbox can filter mailboxes by "enabled" flag.
* Added "lastLogin" to Rackspace Email/Exchange Mailbox Show.
|
|}

'''08/01/10 '''
{|
|
New features:
* Added Rackspace Email Mailbox Contact info. See [[Rackspace_Mailbox_(Rest_API)| here]].
* Added Create Login Token. See [[Customer_(Rest_API)#Create_Login_Tokens| here]].
|
|}

'''06/20/10 '''
{|
|
New features:
* Added [[Rackspace_Alias(Rest_API)| Rackspace Email Alias]].
|
|}

'''06/11/10 '''
{|
|
New features:
* Added Rackspace Email Mailbox Spam Settings/Blacklist/Safelist. See [[Rackspace_Mailbox_Spam_(Rest_API)| here]].
* Now Rackspace Email Mailbox can Show/Edit vacation message and email forwarding address. See [[Rackspace_Mailbox_(Rest_API)| here]].
* Added SharePoint Service Settings. See [[SharePoint_(Rest_API)| here]].
|
|}

== Introduction ==

The Email & Apps Control Panel API provides most of the functions of the Control Panel through a REST-based [http://en.wikipedia.org/wiki/Web_service web API]. Whether it is adding a new customer account, adding mailboxes, or any other of the supported features the API allows your application to administer the changes regardless of your application's language or nature. For more information on RESTful web services refer to the following sites:

[http://www.peej.co.uk/articles/restfully-delicious.html Paul James's Homepage: A RESTful Web service, an example]

[http://en.wikipedia.org/wiki/Representational_State_Transfer#External_links Wikipedia: Representational State Transfer - External Links]

The API is accessible to all with access to Control Panel, including resellers, business customers, enterprise customers, and indirect customers. However, not all operations are available to non-resellers. See the [[Rest_API#Operations|Operations]] section for more details.

== Operations ==

The following pages detail the operations that the API supports. The operations are grouped into sections based on the entity/object types that each operation interacts with. Non-resellers do not have access to all functions.

{| class="wikitable"
!Resource
!Example URI
!Business User Access
|-
| [[Customer_(Rest_API)| Customer]]
| /customers/123456789
| [[Customer_(Rest_API)#Create_Login_Tokens| Create Login Token]]
|-
| [[DKIM (Rest_API)| DKIM]]
| /customers/123456789/domains/example.com/dkim/eanble
| All
|-
| [[Domain_(Rest_API)| Domain]]
| /customers/123456789/domains/example.com
| [[Domain_(Rest_API)#Index| Index]], [[Domain_(Rest_API)#Show| Show]], [[Domain_(Rest_API)#Split Domain Routing| Split Domain Routing]], [[Domain_(Rest_API)#Archiving SSO Login URL| Archiving SSO Login URL]], [[Domain_(Rest_API)#Domain Public Folders|Domain Public Folders ]]
|-
| [[Domain_Spam_(Rest_API)| Domain Spam Settings]]
| /customers/123456789/domains/example.com/spam/settings
| All
|-
| [[Rackspace_Mailbox_(Rest_API)| Rackspace Email Mailbox]]
| /customers/123456789/domains/example.com/rs/mailboxes/john.smith
| All
|-
| [[Rackspace_Mailbox_Spam_(Rest_API)| Rackspace Email Mailbox Spam Settings]]
| /customers/123456789/domains/example.com/rs/mailboxes/john.smith/spam
| All
|-
| [[Rackspace_Alias(Rest_API)| Rackspace Email Alias]]
| /customers/123456789/domains/example.com/rs/mailboxes/john.smith/alias
| All
|-
| [[Exchange_Mailbox_(Rest_API)| Exchange Mailbox]]
| /customers/123456789/domains/example.com/ex/mailboxes/john.smith
| All
|-
| [[Exchange_Mailbox_Spam_(Rest_API)| Exchange Mailbox Spam Settings]]
| /customers/123456789/domains/example.com/ex/mailboxes/john.smith/spam
| All
|-
| [[Exchange_Contact_(Rest_API)| Exchange Contact]]
| /customers/123456789/domains/example.com/ex/contacts/john.smith
| All
|-
| [[Exchange_Distribution_List_(Rest_API)| Exchange Distribution List]]
| /customers/123456789/domains/example.com/ex/distributionlists/group.name
| All
|-
| [[Exchange_Resource_Mailbox_(Rest_API)| Exchange Resource Mailbox]]
| /customers/123456789/domains/example.com/ex/resources/conference.room
| All
|-
| [[SharePoint_(Rest_API)| SharePoint]]
| /customers/123456789/sharepoint/settings
| [[SharePoint_(Rest_API)#Show | Show]]
|}

The examples shown in the operation pages are written in Ruby and extensively use the helper functions shown in the Ruby Examples below.

== Quick Start ==

'''What you need:'''
* A Rackspace Email and Apps Control Panel admin account
* A HTTP class library that supports TLS and the HTTP methods: GET, POST, PUT, DELETE.

'''Making your first API call, an Show Customer request:'''
# Obtain your API keys
#:* Click on My Account at the top of the [https://apps.rackspace.com/?cp Control Panel web interface]. Under the Administrators heading there will be an link for the API keys page.
# Set up your client's HTTP request
#:* Set up your client to make calls to a URL beginning with <nowiki>https://api.emailsrvr.com/v0</nowiki>.
#:* Populate the Accept, User-Agent and X-Api-Signature HTTP request headers correctly. This is explained in detail [[#HTTP Headers|here]].
# Make a GET request to /customers/me.
#:* The complete URI will be <nowiki>https://api.emailsrvr.com/v0/customers/me</nowiki>. Use your HTTP library to retrieve the HTTP response code, 'x-error-message' HTTP response header and HTTP response body so that they may be displayed to help debug and determine success.
'''From here:'''
* Learn about the operations you'll be implementing at the subpages [[#Operations|here]].

== Accessing the API ==

Your application will need to make HTTP requests to remote servers. Most programming languages have this function provided in its class library. In addition to the common GET and POST HTTP methods, the library used will also need to support PUT and DELETE.


Calls without [http://en.wikipedia.org/wiki/Transport_Layer_Security TLS] (formerly SSL) will complete successfully but it is HIGHLY RECOMMENDED that TLS always be used. Interception of unencrypted communication will allow a third party to have complete access to all functions available via the API.

For some language libraries just using an URL with https:// will cause the library to use TLS. In some other libraries however some options specific to the library may have to be configured to utilize TLS.

All API calls should be directed to a URL in the following format:
<pre>https://api.emailsrvr.com/(version)/(resource)</pre>

Example:
<pre>https://api.emailsrvr.com/v0/customers/12345678/domains/customerbusiness.com</pre>

=== Versions ===

{| class="wikitable"
!''Supported Versions''
!''URL''
!''Version Documentation''
|-
| v0 (current)
| <nowiki>https://api.emailsrvr.com/v0/</nowiki>
| http://api-wiki.apps.rackspace.com/api-wiki/index.php/RestAPI
|}

The API version number is a component of the URL that is used to access the API. For example, to access the root of the API, the URL is https://api.emailsrvr.com/v0/. Bug fixes and minor non-breaking changes will be made without changing the version number. When major features or breaking changes are introduced, the version number will be incremented. It is not yet determined how many versions are going to be supported at any one time.

{| class="wikitable"
!''Non-breaking Changes''
!''Breaking Changes''
|-
| Adding new fields or attributes to form fields sent
| Changing or deleting any fields in form fields sent
|-
| Adding fields in returned data
| Changing or removing fields in returned data
|-
|
| Changing the URI of any resource
|}

=== Authentication ===

To gain access to the API, your request must include a properly constructed X-Api-Signature HTTP header. Details on what to put in the header are below. To construct the header, you must have the following keys that that are generated from the [https://apps.rackspace.com/?cp Control Panel Web interface]. The key generation page can be found by clicking 'My Account' at the top, then 'Generate API Keys' in the Administrators section.

{| class="wikitable"
!Key Name
!Description
!Example
|-
| User Key
| A public key that corresponds to your admin id
| ''eGbq9/2hcZsRlr1JV1Pi''
|-
| Secret Key
| A shared secret key
| ''QHOvchm/40czXhJ1OxfxK7jDHr3t''
|}

An unsuccessful authentication will result in a 403 HTTP code.

==== X-Api-Signature Header ====

Format is as follows:
<'''User Key'''>:<'''Timestamp'''>:<'''SHA1 Hash'''> 
Example: ''eGbq9/2hcZsRlr1JV1Pi:20010317143725:46VIwd66mOFGG8IkbgnLlXnfnkU=''

Remember to include the colons between the data strings!

 
'''User Key''': 
This is the public key issued by the Control Panel browser interface.

 
'''Timestamp''': 
The format is YYYYMMDDHHmmss. All values besides year are zero-padded to two spaces. For example, March 08th 2001 at 2:37.25pm would be ''20010308143725''.

{| class="wikitable"
|YYYY
|Four-digit year
|-
| MM
| Month
|-
| DD
| Day
|-
| HH
| Hour in 24h format
|-
| mm
| Minute
|-
| ss
| Second
|}

'''SHA1 Hash''':

A SHA1 (Secure Hash Algorithm) hash must be applied to a string with the following information:

<'''User Key'''><'''User Agent'''><'''Timestamp'''><'''Secret Key'''>

Note that the 'User Agent' must be the exact same as what is specified in the User-Agent HTTP header. Using the above example data, the string before hashing is: ''eGbq9/2hcZsRlr1JV1PiRackspace Management Interface20010308143725QHOvchm/40czXhJ1OxfxK7jDHr3t''

Resulting base-64 SHA1 Hash: ''46VIwd66mOFGG8IkbgnLlXnfnkU=''

Be sure to encode the binary hash, not the hex hash, into base-64. The resulting string should be 28 characters long.

== Using the API ==

=== Requests ===

HTTP requests should be sent to the server with the correct URL, HTTP method, HTTP headers and form data (if needed). The URL specifies the resource, the HTTP method specifies what operation is done on the resource, and form data is used to specify the details of the resource when the resource is added or edited.

The URLs, corresponding HTTP methods, and necessary form data for the desired operations are detailed in the [[#Operations|operation pages]].

If you're getting the HTTP status code 417 see [[Handling HTTP code 417: Expectation failed]]

==== URL ====

The URLs are specifies the resource or resource collection. Objects are organized in a tree collection, starting with customers at the top, then domains, then domain objects next (such as mailboxes, contacts, and distribution lists) and so on. The URLs of the resources and collections accessible are found on the operation pages.

==== HTTP Method ====

It is the HTTP method that specifies what operation will be done on the resource. For example, to get the details of a mailbox a HTTP GET will be done on /customers/12345678/domains/example.com/ex/mailboxes/john.smith. If the mailbox does not exist, a HTTP POST to the same URL with the necessary form data will add the mailbox. Then, a HTTP PUT to the same URL will edit mailbox. And to delete the mailbox, an HTTP DELETE would be used.

The types of operations a certain method performs is outlined below.

{| class="wikitable"
!''HTTP Method''
!''Operations''
!''Response''
|-
|rowspan=2|GET
|Index - returns a list of the resources
|rowspan=2|XML or JSON formatted data
|-
|Show - returns the details of the resource
|-
|POST
|Add - adds a new resource
|rowspan=3|Response code and error message (if applicable) only
|-
|PUT
|Edit - changes the details of the resource
|-
|DELETE
|Delete - deletes the resource
|}

==== HTTP Headers ====

All requests to the API must then include HTTP headers with the following information:

{| class="wikitable"
!''Header Name''
!''Description''
!''Example Header Value''
|-
| Accept
| The requested content type (required for Index and Show actions). Fill this with either 'text/xml' or 'application/json'. See [[#Formats|Response Formats]]
| ''text/xml''
|-
| User-Agent
| An identifier you choose for your client software
| ''Rackspace Management Interface''
|-
| X-Api-Signature
| An authentication string explained in detail [[#X-Api-Signature_Header|here]]
| ''eGbq9/2hcZsRlr1JV1Pi:20010317143725:HKUn0aajpSDx7qqGK3vqzn3FglI=''
|}

==== Form Data ====

When using Add and Edit operations, the details of the resource are sent to the API server via HTTP form data. Your HTTP library should include methods for sending form data along with an HTTP request. The library should by default send the data in the HTTP request body using the 'application/x-www-form-urlencoded' data format.

==== Index Filter/Search ====

The results of Index actions can be filtered/searched. The index URLs can take either one of the query strings: "?startswith=xx" or "?contains=xx," where "xx" is the key word. If the request specifies more than one of these two query strings, a 400 HTTP error will be returned. Different fields will be searched depending on the resource type, see below.

Note that "0-9" is a reserved key word for query string "startswith." It represents any result starting with numbers.

{| class="wikitable"
!''Index Actions''
!''Where the key word will be searched''
|-
| Customer
| Customer name, account number, reference number
|-
| Domain
| Domain name
|-
| Mailbox
| Mailbox name, mailbox display name
|-
| Contact
| Contact display name, external email
|-
| Group
| Group name, group display name
|-
| Mobile Service
| Associated mailbox name, mailbox display name
|}

==== Throttling ====

The server limits the number of requests allowed per user in a certain period of time. The number of requests made are logged per minute. Calls that were made correctly with a user's API key, but not completed for any reason, including those exceeding the throttle limit, are included in this count.

If a user is over the throttling limit then a 403 HTTP code will be returned with an "Exceeded request limits" message.

{| class="wikitable"
!''Operation Category''
!''Request Limit''
|-
| GET
| 60 per minute
|-
| PUT, POST, DELETE
| 30 per minute
|-
| POST, PUT, DELETE on a domain
| 2 per minute
|-
| POST, DELETE on alternate domains
| 2 per minute
|-
| Enabling public folders for a domain
| 1 per 5 minutes
|}

==== Examples ====

Index of Exchange Mailboxes:
<pre>
Hypertext Transfer Protocol
GET /v0/customers/12345678/domains/example.com/ex/mailboxes?size=100&offset=100 HTTP/1.1
Host: api.emailsrvr.com
User-Agent: Rackspace Management Interface
X-Api-Signature: eGbq9/2hcZsRlr1JV1Pi:20010317143725:HKUn0aajpSDx7qqGK3vqzn3FglI=
Accept: text/xml
</pre>

Adding New Exchange Mailbox:
<pre>
Hypertext Transfer Protocol
POST /v0/customers/12345678/domains/example.com/ex/mailboxes/john.smith HTTP/1.1
Host: api.emailsrvr.com
User-Agent: Rackspace Management Interface
X-Api-Signature: eGbq9/2hcZsRlr1JV1Pi:20010317143725:HKUn0aajpSDx7qqGK3vqzn3FglI=
Content-Length: 53
[Content length: 53]
Content-Type: application/x-www-form-urlencoded

Line-based text data: application/x-www-form-urlencoded
size=2048&displayName=John%20Smith&password=abcABC123

</pre>

=== Responses ===

==== HTTP Status Code ====

On a successfully executed request, a 200 HTTP Code is returned. If the request was unsuccessful however, an HTTP error code in the 400s or 500s will be returned.

==== HTTP Response Body ====

If the request is an Index or Show request, the request data will be returned in the format specified in the HTTP Body.

===== Formats =====

Requests for data (index and show requests) are returned with XML or JSON data based on what your application populates the [[#HTTP_Headers|HTTP Accept headers]] with.

For XML, populate the header with 'text/xml' (ex: Headers!["Accept"] = "text/xml"). The XML document returned will conform to a published XSD (XML Schema Document). There are many ways to parse the data in an XML document, but we have found that the [http://www.w3schools.com/XPath/default.asp XPath] tree-style traversal has served our purposes. In any case, your application will likely need to use a class library for your chosen method.

For JSON, populate the header with 'application/json' (ex: Headers!["Accept"] = "application/json"). As with XML, a library will likely be needed to parse the data.

==== HTTP Headers ====

The only data returned in the header is the error message (if any).

{| class="wikitable"
!''Header Name''
!''Description''
!''Example Header Value''
|-
| x-error-message
| The error message. See [[#Errors|Errors]].
| Missing required field: name
|}

==== Errors ====

In the event of an error, the error message will be returned the HTTP header '''x-error-message''' and an HTTP Status Code in the '''400'''s or '''500'''s will be returned.

Note: Every language's HTTP library provides methods for retrieving HTTP response codes and response headers.

Below are some errors that are common to many operations. Each operation also has some specific errors which are outlined with the operation.

{| class="wikitable"
!''Description''
!''HTTP Response Code''
!''Sample Message''
|-
|Format is invalid
|400
|When requesting an index or show on a resource the 'Accept' header should be either 'text/xml' or 'application/json'
|-
|Expectation Failed: See [[Handling HTTP code 417: Expectation failed]]
|417
|(none)
|-
|Customer account number is invalid
|404
|Invalid account number
|-
|Domain is not found
|404
|<domain name> not found
|-
|Mailbox is not found
|404
|Mailbox not found
|-
|Required form field is missing
|400
|Missing required field: <required field>
|-
|Required form field has null or empty string input
|400
|Required field <required field> cannot be empty
|-
|Integer form field has non-integer input
|400
|Invalid format for <field>, input must be an integer
|-
|Boolean form field has non-boolean input
|400
|Invalid format for <field>, input must be True or False
|-
|Form data has an unrecognized field
|400
|Unrecognized field: <field>
|-
| Entered invalid IP address
| 400
| invalid ip address: 123
|}

==== Paging ====

The results of Index actions are split into pages to lessen potentially high resource usage. The index URLs have a query string with parameters in the format "?size=xx&offset=xx." If a query parameter is omitted, the default value is used.

{| class="wikitable"
!''Query Parameter''
!''Default''
!''Maximum''
!''Notes''
|-
| size
| 50
| 250
| This is the number of elements per page.
|-
| offset
| 0
| N/A
| This is the number of items to offset away from the first item in the list.
|}

===== Example =====

A PHP Example of paging can be found [[PHP_Examples_(Rest_API)| here]].

==== Examples ====

<pre>
HTTP/1.1 200 OK
Cache-Control: private
Content-Type: text/xml; charset=utf-8
Server: Microsoft-IIS/7.0
Date: Fri, 04 Dec 2009 19:08:11 GMT
Content-Length: 430

<?xml version="1.0" encoding="utf-8"?>
<domainList xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="urn:xml:domainList">
<offset>0</offset>
<size>50</size>
<total>1</total>
<domains>
<domain>
<name>customer.com</name>
<accountNumber>123456</accountNumber>
<serviceType>rsemail</serviceType>
</domain>
</domains>
</domainList>
</pre>

<pre>
HTTP/1.1 404 Not Found
Cache-Control: private
Server: Microsoft-IIS/7.0
x-error-message: Customer Not Found
Date: Fri, 04 Dec 2009 19:13:59 GMT
Content-Length: 0
</pre>

<pre>
HTTP/1.1 400 Bad Request
Cache-Control: private
Server: Microsoft-IIS/7.0
x-error-message: Missing required field: type
Date: Fri, 04 Dec 2009 19:17:29 GMT
Content-Length: 0
</pre>

== Examples ==

=== Ruby ===

This examples is written in [http://www.ruby-lang.org/en/ Ruby]. To make the examples shorter, helper methods have been written. These methods are part of a NetMethods module. The contents of the NetMethods module is listed below.

<pre>
require 'server.rb'

server = Server.new

response = server.get '/customers', server.xml_format

#fields = Hash['serviceType' => 'exchange', 'exchangeMaxNumMailboxes' => '4']
#response = server.post '/customers/me/domains/newdomain.com', fields

puts response.code
puts response['x-error-message']
puts response.body
</pre>

<pre>
require 'test/unit/assertions'
require 'net/http'
require 'date'
require 'date/format'
require 'digest/sha1'
require 'base64'
require 'time'

class Server
include Test::Unit::Assertions

def initialize(server='api.emailsrvr.com', version_prefix='/v0', user_key='xxxxxxxxxxxxxxxxxxxx', secret_hash='xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx')
@server = server
@version_prefix = version_prefix
@user_key = user_key
@secret_hash = secret_hash
end

# Response Type Enums

def xml_format
'text/xml'
end

def json_format
'application/json'
end

#
# HTTP Request Verbs
#
def get(url_string, format)
uri = full_uri(url_string)
headers = prepared_headers
headers['Accept'] = format
request = Net::HTTP::Get.new(request_uri(uri), headers)
http_response = make_request request, uri
end

def delete(url_string)
uri = full_uri(url_string)
request = Net::HTTP::Delete.new(request_uri(uri), prepared_headers)
http_response = make_request request, uri
end

def put(url_string, fields_hash)
uri = full_uri(url_string)
request = Net::HTTP::Put.new(request_uri(uri), prepared_headers)
request.set_form_data(fields_hash)
http_response = make_request request, uri
end

def post(url_string, fields_hash)
uri = full_uri(url_string)
request = Net::HTTP::Post.new(request_uri(uri), prepared_headers)
request.set_form_data(fields_hash)
http_response = make_request request, uri
end

#
# HTTP Request Helpers
#
def make_request request, uri
response = Net::HTTP::start(uri.host, uri.port) do |http|
http.request request
end

response
end

def full_uri url_string
URI.parse('http://' + @server + @version_prefix + url_string)
end

def request_uri uri
request = uri.path
if ! uri.query.nil?
request = request + '?' + uri.query
end
request
end

def prepared_headers
headers = Hash.new
headers.merge! headers_auth_creds(@user_key, @secret_hash)
headers['Accept'] = xml_format
headers
end

def headers_auth_creds apiKey, secretKey
userAgent = 'Ruby Test Client'
timestamp = DateTime.now.strftime('%Y%m%d%H%M%S')

data_to_sign = apiKey + userAgent + timestamp + secretKey

hash = Base64.encode64(Digest::SHA1.digest(data_to_sign))
signature = apiKey + ":" + timestamp + ":" + hash

headers = Hash['User-Agent' => userAgent, 'X-Api-Signature' => signature]
end
end
</pre>

=== C# ===

This examples is written in [http://msdn.microsoft.com/en-us/vcsharp/default.aspx C#].

<pre>
using System;
using System.Collections.Specialized;
using System.Security.Cryptography;
using System.Text;
using System.Net;

public class WebMethods
{
private WebClientBase client;
private string baseUrl;
private string apiKey;
private string secretKey;

public WebMethods(WebClientBase client, string baseUrl, string apiKey, string secretKey)
{
this.client = client;
this.baseUrl = baseUrl;
this.apiKey = apiKey;
this.secretKey = secretKey;
}

public virtual string Get(string url)
{
return MakeRemoteCall((client) =>
{
return client.DownloadString(baseUrl + url);
},
format);
}

public virtual string Post(string url, NameValueCollection data)
{
return MakeRemoteCall((client) =>
{
var bytes = client.UploadValues(baseUrl + url, data);
return Encoding.UTF8.GetString(bytes);
},
format);
}

private void SignMessage()
{
var userAgent = "C# Client Library";
client.Headers["User-Agent"] = userAgent;

var dateTime = DateTime.UtcNow.ToString("yyyyMMddHHmmss");

var dataToSign = apiKey + userAgent + dateTime + secretKey;
var hash = SHA1.Create();
var signedBytes = hash.ComputeHash(Encoding.UTF8.GetBytes(dataToSign));
var signature = Convert.ToBase64String(signedBytes);

client.Headers["X-Api-Signature"] = apiKey + ":" + dateTime + ":" + signature;
}

private void AssignFormat(string format)
{
client.Headers["Accept"] = format;
}

private string MakeRemoteCall(Func<WebClientBase, string> remoteCall, string format)
{
try
{
SignMessage();
AssignFormat(format);
return remoteCall.Invoke(client);
}
catch (WebException e)
{
throw new ApiException(e);
}
}
}
</pre>

=== PHP ===

The PHP Example can be found [[PHP_Examples_(Rest_API)| here]].

DKIM (Rest API)

2019-02-07T14:25:57Z

SOADev:

__TOC__

== v1 - Current ==

=== Authentication and Authorization ===
'''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'''

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

=== Enable DKIM or Rotate Keys ===

''URL'':
[POST] <nowiki>https://cp.rackspace.com/customers/{customer_id}/domains/{domain_name}/dkim/enable</nowiki>

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

''Example'':
<pre>
POST '/customers/customer_id/domains/domain_name/dkim/enable'
</pre>

''Status Code 200 Result Example'':
<pre>
{
"hostedBy": "external",
"tatus": "pendingVerification",
"subdomain": "20170209._domainkey",
"dnsKey": "v=DKIM1; k=rsa; p=DNSKeyGoesHere"
}
</pre>

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

''URL'':

[GET] <nowiki>https://cp.rackspace.com/customers/{customer_id}/domains/{domain_name}/dkim/status</nowiki>

''Description'':

Returns the status of DKIM configuration for a domain.

''Parameters'':
{| class="wikitable"
!''Field Name''
!''Data Type''
!''Description''
|-
| customer_id
| string
| ID of customer who owns domain_name
|-
| domain_name
| string
| Domain to act on
|}

''Examples'':
<pre>
GET '/customers/customer_id/domains/domain_name/dkim/status'
</pre>

''Status Code 200 Result Example'':
<pre>
{
"hostedBy": "external",
"status": "pendingVerification",
"selector": "20170209",
"subdomain": "20170209._domainkey",
"publicKey": "-----BEGIN PUBLIC KEY-----PublicKeyGoesHere-----END PUBLIC KEY-----",
"dnsKey": "v=DKIM1; k=rsa; p=DNSKeyGoesHere"
}
</pre>

=== Disable DKIM on a Domain ===

''URL'':

[DELETE] <nowiki>https://cp.rackspace.com/customers/{customer_id}/domains/{domain_name}/dkim/disable</nowiki>

''Description'':

Disables DKIM for a domain by revoking all existing certificates.

''Parameters'':
{| class="wikitable"
!''Field Name''
!''Data Type''
!''Description''
|-
| customer_id
| string
| ID of customer who owns domain_name
|-
| domain_name
| string
| Domain to act on
|}

''Example'':
<pre>
DELETE '/customers/customer_id/domains/domain_name/dkim/disable',
</pre>

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

''URL'':

[POST] <nowiki>https://cp.rackspace.com/customers/{customer_id}/domains/{domain_name}/dkim/verification</nowiki>

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

''Example'':
<pre>
POST '/customers/customer_id/domains/domain_name/dkim/verification'
</pre>

DKIM (Rest API)

2019-02-07T14:13:59Z

SOADev:

__TOC__

== v1 - Current ==

=== Authentication and Authorization ===
'''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'''

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

=== Enable DKIM or Rotate Keys ===

''URL'':
[POST] <nowiki>https://cp.rackspace.com/customers/{customer_id}/domains/{domain_name}/dkim/enable</nowiki>

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

''Example'':
<pre>
POST '/customers/customer_id/domains/domain_name/dkim/enable'
</pre>

''Status Code 200 Result Example'':
<pre>
{
"hostedBy": "external",
"tatus": "pendingVerification",
"subdomain": "20170209._domainkey",
"dnsKey": "v=DKIM1; k=rsa; p=DNSKeyGoesHere"
}
</pre>

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

''URL'':

[GET] <nowiki>https://cp.rackspace.com/customers/{customer_id}/domains/{domain_name}/dkim/status</nowiki>

''Description'':

Returns the status of DKIM configuration for a domain.

''Parameters'':
{| class="wikitable"
!''Field Name''
!''Data Type''
!''Description''
|-
| customer_id
| string
| ID of customer who owns domain_name
|-
| domain_name
| string
| Domain to act on
|}

''Examples'':
<pre>
GET '/customers/customer_id/domains/domain_name/dkim/status'
</pre>

''Status Code 200 Result Example'':
<pre>
{
"hostedBy": "external",
"status": "pendingVerification",
"selector": "20170209",
"subdomain": "20170209._domainkey",
"publicKey": "-----BEGIN PUBLIC KEY-----PublicKeyGoesHere-----END PUBLIC KEY-----",
"dnsKey": "v=DKIM1; k=rsa; p=DNSKeyGoesHere"
}
</pre>

=== Disable DKIM on a Domain ===

''URL'':

[DELETE] <nowiki>https://cp.rackspace.com/customers/{customer_id}/domains/{domain_name}/dkim/disable</nowiki>

''Description'':

Disables DKIM for a domain by revoking all existing certificates.

''Parameters'':
{| class="wikitable"
!''Field Name''
!''Data Type''
!''Description''
|-
| customer_id
| string
| ID of customer who owns domain_name
|-
| domain_name
| string
| Domain to act on
|}

''Example'':
<pre>
DELETE '/customers/customer_id/domains/domain_name/dkim/disable',
</pre>

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

''URL'':

[POST] <nowiki>https://cp.rackspace.com/customers/{customer_id}/domains/{domain_name}/dkim/verification</nowiki>

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

''Example'':
<pre>
POST '/customers/customer_id/domains/domain_name/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>

DKIM (Rest API)

2019-02-07T14:08:50Z

SOADev:

__TOC__

== v1 - Current ==

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

=== Enable DKIM or Rotate Keys ===

''URL'':
[POST] <nowiki>https://cp.rackspace.com/customers/{customer_id}/domains/{domain_name}/dkim/enable</nowiki>

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

''Example'':
<pre>
POST '/customers/customer_id/domains/domain_name/dkim/enable'
</pre>

''Status Code 200 Result Example'':
<pre>
{
"hostedBy": "external",
"tatus": "pendingVerification",
"subdomain": "20170209._domainkey",
"dnsKey": "v=DKIM1; k=rsa; p=DNSKeyGoesHere"
}
</pre>

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

''URL'':

[GET] <nowiki>https://cp.rackspace.com/customers/{customer_id}/domains/{domain_name}/dkim/status</nowiki>

''Description'':

Returns the status of DKIM configuration for a domain.

''Parameters'':
{| class="wikitable"
!''Field Name''
!''Data Type''
!''Description''
|-
| customer_id
| string
| ID of customer who owns domain_name
|-
| domain_name
| string
| Domain to act on
|}

''Examples'':
<pre>
GET '/customers/customer_id/domains/domain_name/dkim/status'
</pre>

''Status Code 200 Result Example'':
<pre>
{
"hostedBy": "external",
"status": "pendingVerification",
"selector": "20170209",
"subdomain": "20170209._domainkey",
"publicKey": "-----BEGIN PUBLIC KEY-----PublicKeyGoesHere-----END PUBLIC KEY-----",
"dnsKey": "v=DKIM1; k=rsa; p=DNSKeyGoesHere"
}
</pre>

=== Disable DKIM on a Domain ===

''URL'':

[DELETE] <nowiki>https://cp.rackspace.com/customers/{customer_id}/domains/{domain_name}/dkim/disable</nowiki>

''Description'':

Disables DKIM for a domain by revoking all existing certificates.

''Parameters'':
{| class="wikitable"
!''Field Name''
!''Data Type''
!''Description''
|-
| customer_id
| string
| ID of customer who owns domain_name
|-
| domain_name
| string
| Domain to act on
|}

''Example'':
<pre>
DELETE '/customers/customer_id/domains/domain_name/dkim/disable',
</pre>

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

''URL'':

[POST] <nowiki>https://cp.rackspace.com/customers/{customer_id}/domains/{domain_name}/dkim/verification</nowiki>

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

''Example'':
<pre>
POST '/customers/customer_id/domains/domain_name/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>

DKIM (Rest API)

2019-02-07T13:55:57Z

SOADev:

__TOC__

== v1 - Current ==

=== Enable DKIM or Rotate Keys ===

''URL'':
[POST] <nowiki>https://dkimadminapicp.mlsrvr.com/customers/{customer_id}/domains/{domain_name}/dkim/enable</nowiki>

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

''Example'':
<pre>
POST'/dkimstatus/enable'
</pre>

''Status Code 200 Result Example'':
<pre>
{
"hostedBy": "external",
"tatus": "pendingVerification",
"subdomain": "20170209._domainkey",
"dnsKey": "v=DKIM1; k=rsa; p=DNSKeyGoesHere"
}
</pre>

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

''URL'':

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

''Description'':

Returns the status of DKIM configuration for a domain.

''Parameters'':
{| class="wikitable"
!''Field Name''
!''Data Type''
!''Description''
|-
| customer_id
| string
| ID of customer who owns domain_name
|-
| domain_name
| string
| Domain to act on
|}

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

''Status Code 200 Result Example'':
<pre>
{
"hostedBy": "external",
"status": "pendingVerification",
"selector": "20170209",
"subdomain": "20170209._domainkey",
"publicKey": "-----BEGIN PUBLIC KEY-----PublicKeyGoesHere-----END PUBLIC KEY-----",
"dnsKey": "v=DKIM1; k=rsa; p=DNSKeyGoesHere"
}
</pre>

=== Disable DKIM on a Domain ===

''URL'':

[DELETE] <nowiki>https://dkimadminapicp.mlsrvr.com/DkimServiceApi/v1/customers/{customer_id}/domains/{domain_name}/dkim/disable)</nowiki>

''Description'':

Disables DKIM for a domain by revoking all existing certificates.

''Parameters'':
{| class="wikitable"
!''Field Name''
!''Data Type''
!''Description''
|-
| customer_id
| string
| ID of customer who owns domain_name
|-
| domain_name
| string
| Domain to act on
|}

''Example'':
<pre>
DELETE '/dkimstatus/disable',
</pre>

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

''URL'':

[POST] <nowiki>https://dkimadminapicp.mlsrvr.com/DkimServiceApi/v1/customers/{customer_id}/domains/{domain_name}/dkim/verification</nowiki>

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

''Example'':
<pre>
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"
}
</pre>

DKIM (Rest API)

2019-02-07T13:24:11Z

SOADev:

__TOC__

== v1 - Current ==

=== Enable DKIM or Rotate Keys ===

''URL'':
[POST] <nowiki>https://dkimadminapicp.mlsrvr.com/dkimstatus/enable</nowiki>

''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'
</pre>

''Status Code 200 Result Example'':
<pre>
{
"hostedBy": "external",
"tatus": "pendingVerification",
"subdomain": "20170209._domainkey",
"dnsKey": "v=DKIM1; k=rsa; p=DNSKeyGoesHere"
}
</pre>

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

''URL'':

[GET] <nowiki>https://dkimadminapicp.mlsrvr.com/DkimServiceApi/v1/dkimstatus/status</nowiki>

''Description'':

Returns the status of DKIM configuration for a 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>
{
"hostedBy": "external",
"status": "pendingVerification",
"selector": "20170209",
"subdomain": "20170209._domainkey",
"publicKey": "-----BEGIN PUBLIC KEY-----PublicKeyGoesHere-----END PUBLIC KEY-----",
"dnsKey": "v=DKIM1; k=rsa; p=DNSKeyGoesHere"
}
</pre>

=== Disable DKIM on a Domain ===

''URL'':

[DELETE] <nowiki>https://dkimadminapicp.mlsrvr.com/DkimServiceApi/v1/dkimstatus/disable)</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'''
|}

''Example'':
<pre>
DELETE '/dkimstatus/disable',
</pre>

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

''URL'':

[POST] <nowiki>https://dkimadminapicp.mlsrvr.com/DkimServiceApi/v1/dkimstatus/verification</nowiki>

''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 '/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=DNSKEY"
}
</pre>

Main Page

2019-02-04T19:16:19Z

SOADev: /* Operations */

== Introduction ==

The Rackspace Email Rest API provides most of the functions of the Control Panel through a REST-based [http://en.wikipedia.org/wiki/Web_service web API]. Whether it is adding a new customer account, adding mailboxes, or any other of the supported features the API allows your application to administer the changes regardless of your application's language or nature. For more information on RESTful web services refer to the following sites:

[http://www.peej.co.uk/articles/restfully-delicious.html Paul James's Homepage: A RESTful Web service, an example]

[http://en.wikipedia.org/wiki/Representational_State_Transfer#External_links Wikipedia: Representational State Transfer - External Links]

The API is accessible to all with access to Control Panel, including resellers, business customers, enterprise customers, and indirect customers. However, not all operations are available to non-resellers. See the [[Rest_API#Operations|Operations]] section for more details.

The Rackspace Email Soap API Homepage has been moved to [[Soap_API| here]].

== Operations ==

The following pages detail the operations that the API supports. The operations are grouped into sections based on the entity/object types that each operation interacts with. Non-resellers do not have access to all functions.

{| class="wikitable"
!Resource
!Example URI
!Business User Access
|-
| [[Customer_(Rest_API)| Customer]]
| /customers/123456789
| [[Customer_(Rest_API)#Create_Login_Tokens | Create Login Tokens]]
|-
| [[Admin_(Rest_API)| Admin]]
| /customers/123456789/admins/my_admin
| All
|-
| [[Domain_(Rest_API)| Domain]]
| /customers/123456789/domains/example.com
| [[Domain_(Rest_API)#Index| Index]], [[Domain_(Rest_API)#Show| Show]], [[Domain_(Rest_API)#Split Domain Routing| Split Domain Routing]], [[Domain_(Rest_API)#Archiving SSO Login URL| Archiving SSO Login URL]], [[Domain_(Rest_API)#Domain_Public_Folders_.28Reseller_Only.29|Domain Public Folders]], [[Domain_(Rest_API)#Domain Email Everyone| Email Everyone ]], [[Domain_(Rest_API)#Show_Domain_Catch-All_Address | Catch-All Address]]
|-
| [[Domain_Spam_(Rest_API)| Domain Spam Settings]]
| /customers/123456789/domains/example.com/spam/settings
| All
|-
| [[Rackspace_Mailbox_(Rest_API)| Rackspace Email Mailbox]]
| /customers/123456789/domains/example.com/rs/mailboxes/john.smith
| All
|-
| [[Rackspace_Mailbox_Spam_(Rest_API)| Rackspace Email Mailbox Spam Settings]]
| /customers/123456789/domains/example.com/rs/mailboxes/john.smith/spam
| All
|-
| [[Rackspace_Storage_Notification_(Rest_API)| Rackspace Storage Notification Settings]]
| /customers/123456789/domains/example.com/rs/storageNotification
| All
|-
| [[Rackspace_Alias(Rest_API)| Rackspace Email Alias]]
| /customers/123456789/domains/example.com/rs/mailboxes/john.smith/alias
| All
|-
| [[Exchange_Mailbox_(Rest_API)| Exchange Mailbox]]
| /customers/123456789/domains/example.com/ex/mailboxes/john.smith
| All
|-
| [[Exchange_Mailbox_Spam_(Rest_API)| Exchange Mailbox Spam Settings]]
| /customers/123456789/domains/example.com/ex/mailboxes/john.smith/spam
| All
|-
| [[Exchange_Contact_(Rest_API)| Exchange Contact]]
| /customers/123456789/domains/example.com/ex/contacts/john.smith
| All
|-
| [[Exchange_Distribution_List_(Rest_API)| Exchange Distribution List]]
| /customers/123456789/domains/example.com/ex/distributionlists/group.name
| All
|-
| [[Exchange_Resource_Mailbox_(Rest_API)| Exchange Resource Mailbox]]
| /customers/123456789/domains/example.com/ex/resources/conference.room
| All
|-
| [[Exchange_Skype_For_Business_(Rest_API)| Exchange Skype For Business]]
| /customers/123456789/domains/example.com/ex/lync/users
| All
|-
| [[Exchange_Public_Folders_(Rest_API)| Exchange Public Folders]]
| /customers/123456789/domains/example.com/ex/publicFolders
| All
|-
| [[SharePoint_(Rest_API)| SharePoint]]
| /customers/123456789/sharepoint/settings
| [[SharePoint_(Rest_API)#Show | Show]]
|}

The examples shown in the operation pages are written in Ruby and extensively use the helper functions shown in the Ruby Examples below.

== Quick Start ==

'''What you need:'''
* A Rackspace Email and Apps Control Panel admin account
* A HTTP class library that supports TLS 1.2 or greater, and the HTTP methods: GET, POST, PUT, DELETE.

'''Making your first API call, an Show Customer request:'''
# Obtain your API keys
#:* Login to [https://cp.rackspace.com Control Panel]
#:* Click the drop down in the top right next to your admin id/account number.
#:* Click Admins & Contacts
#:* Click API Keys
# Set up your client's HTTP request
#:* Set up your client to make calls to a URL beginning with <nowiki>https://api.emailsrvr.com/v1</nowiki>.
#:* Populate the Accept, User-Agent and X-Api-Signature HTTP request headers correctly. This is explained in detail [[#HTTP Headers|here]].
# Make a GET request to /customers/me.
#:* The complete URI will be <nowiki>https://api.emailsrvr.com/v1/customers/me/domains</nowiki>. Use your HTTP library to retrieve the HTTP response code, 'x-error-message' HTTP response header and HTTP response body so that they may be displayed to help debug and determine success.
'''From here:'''
* Learn about the operations you'll be implementing at the subpages [[#Operations|here]].

== Accessing the API ==

Your application should need to make HTTP requests over TLS 1.2 or greater (HTTPS) to our API servers. Most programming languages have this functionality built into their core libraries. In addition to the common GET and POST HTTP methods, the library used will also need to support PUT and DELETE.

For some language's libraries, simply using an URL that starts with https:// will cause the library to use TLS. In some other libraries however some options specific to the library may have to be configured to utilize TLS.

All API calls should be directed to a URL in the following format:
<pre>https://api.emailsrvr.com/(version)/(resource)</pre>

Example:
<pre>https://api.emailsrvr.com/v1/customers/12345678/domains/customerbusiness.com</pre>

=== Versions ===

{| class="wikitable"
!''Supported Versions''
!''URL''
!''Version Documentation''
|-
| v1 (current)
| <nowiki>https://api.emailsrvr.com/v1/</nowiki>
| http://api-wiki.apps.rackspace.com/api-wiki/index.php/Main_Page
|}

The API version number is a component of the URL that is used to access the API. For example, to access the root of the API, the URL is https://api.emailsrvr.com/v1/. Bug fixes and minor non-breaking changes will be made without changing the version number. When major features or breaking changes are introduced, the version number will be incremented. It is not yet determined how many versions are going to be supported at any one time.

'''Using the discontinued v0 API?'''

* If your client consumes v0 of the Admin REST API for Exchange Distribution Lists or Exchange Resource Mailboxes routes, the client must be updated to consume the new behavior in v1.
* If your client does not consume the v0 Admin REST API for Exchange Distribution Lists and Exchange Resource Mailboxes, you simply need to update the base URL (i.e. https://api.emailsrvr.com/v0/…) from v0 to v1. There were no changes to the behavior of the other entities in the API, only their location changed.

{| class="wikitable"
!''Non-breaking Changes''
!''Breaking Changes''
|-
| Adding new fields or attributes to form fields sent
| Changing or deleting any fields in form fields sent
|-
| Adding fields in returned data
| Changing or removing fields in returned data
|-
|
| Changing the URI of any resource
|}

=== Authentication ===

To gain access to the API, your request must include a properly constructed X-Api-Signature HTTP header. Details on what to put in the header are below. To construct the header, you must have the following keys that are generated from the [https://cp.rackspace.com/MyAccount/Administrators/ApiKeys API Keys] page.

{| class="wikitable"
!Key Name
!Description
!Example
|-
| User Key
| A public key that corresponds to your admin id
| ''eGbq9/2hcZsRlr1JV1Pi''
|-
| Secret Key
| A shared secret key
| ''QHOvchm/40czXhJ1OxfxK7jDHr3t''
|}

An unsuccessful authentication will result in a 403 HTTP code.

==== X-Api-Signature Header ====

Format is as follows:
<'''User Key'''>:<'''Timestamp'''>:<'''SHA1 Hash'''> 
Example: ''eGbq9/2hcZsRlr1JV1Pi:20010317143725:46VIwd66mOFGG8IkbgnLlXnfnkU=''

Remember to include the colons between the data strings!

 
'''User Key''': 
This is the public key issued by the Control Panel browser interface.

 
'''Timestamp''': 
The format is YYYYMMDDHHmmss. All values besides year are zero-padded to two spaces. For example, March 08th 2001 at 2:37.25pm would be ''20010308143725''.

{| class="wikitable"
|YYYY
|Four-digit year
|-
| MM
| Month
|-
| DD
| Day
|-
| HH
| Hour in 24h format
|-
| mm
| Minute
|-
| ss
| Second
|}

'''SHA1 Hash''':

A SHA1 (Secure Hash Algorithm) hash must be applied to a string with the following information:

<'''User Key'''><'''User Agent'''><'''Timestamp'''><'''Secret Key'''>

Note that the 'User Agent' must be the exact same as what is specified in the User-Agent HTTP header. Using the above example data, the string before hashing is: ''eGbq9/2hcZsRlr1JV1PiRackspace Management Interface20010308143725QHOvchm/40czXhJ1OxfxK7jDHr3t''

Resulting base-64 SHA1 Hash: ''46VIwd66mOFGG8IkbgnLlXnfnkU=''

Be sure to encode the binary hash, not the hex hash, into base-64. The resulting string should be 28 characters long.

== Using the API ==

=== Requests ===

HTTP requests should be sent to the server with the correct URL, HTTP method, HTTP headers and form data (if needed). The URL specifies the resource, the HTTP method specifies what operation is done on the resource, and form data is used to specify the details of the resource when the resource is added or edited.

The URLs, corresponding HTTP methods, and necessary form data for the desired operations are detailed in the [[#Operations|operation pages]].

If you're getting the HTTP status code 417 see [[Handling HTTP code 417: Expectation failed]]

==== URL ====

The URLs are specifies the resource or resource collection. Objects are organized in a tree collection, starting with customers at the top, then domains, then domain objects next (such as mailboxes, contacts, and distribution lists) and so on. The URLs of the resources and collections accessible are found on the operation pages.

==== HTTP Method ====

It is the HTTP method that specifies what operation will be done on the resource. For example, to get the details of a mailbox a HTTP GET will be done on /customers/12345678/domains/example.com/ex/mailboxes/john.smith. If the mailbox does not exist, a HTTP POST to the same URL with the necessary form data will add the mailbox. Then, a HTTP PUT to the same URL will edit mailbox. And to delete the mailbox, an HTTP DELETE would be used.

The types of operations a certain method performs is outlined below.

{| class="wikitable"
!''HTTP Method''
!''Operations''
!''Response''
|-
|rowspan=2|GET
|Index - returns a list of the resources
|rowspan=2|XML or JSON formatted data
|-
|Show - returns the details of the resource
|-
|POST
|Add - adds a new resource
|rowspan=3|Response code and error message (if applicable) only
|-
|PUT
|Edit - changes the details of the resource
|-
|DELETE
|Delete - deletes the resource
|}

==== HTTP Headers ====

All requests to the API must then include HTTP headers with the following information:

{| class="wikitable"
!''Header Name''
!''Description''
!''Example Header Value''
|-
| Accept
| The requested content type (required for Index and Show actions). Fill this with either 'text/xml' or 'application/json'. See [[#Formats|Response Formats]]
| ''text/xml''
|-
| User-Agent
| An identifier you choose for your client software
| ''Rackspace Management Interface''
|-
| X-Api-Signature
| An authentication string explained in detail [[#X-Api-Signature_Header|here]]
| ''eGbq9/2hcZsRlr1JV1Pi:20010317143725:HKUn0aajpSDx7qqGK3vqzn3FglI=''
|}

==== Form Data ====

When using Add and Edit operations, the details of the resource are sent to the API server via HTTP form data. Your HTTP library should include methods for sending form data along with an HTTP request. The library should by default send the data in the HTTP request body using the 'application/x-www-form-urlencoded' data format.

==== Index Filter/Search ====

The results of Index actions can be filtered/searched. The index URLs can take either one of the query strings: "?startswith=xx" or "?contains=xx," where "xx" is the key word. If the request specifies more than one of these two query strings, a 400 HTTP error will be returned. Different fields will be searched depending on the resource type, see below.

Note that "0-9" is a reserved key word for query string "startswith." It represents any result starting with numbers.

{| class="wikitable"
!''Index Actions''
!''Where the key word will be searched''
|-
| Customer
| Customer name, account number, reference number
|-
| Domain
| Domain name
|-
| Mailbox
| Mailbox name, mailbox display name, custom ID field
|-
| Contact
| Contact display name, external email
|-
| Group
| Group name, group display name
|-
| Mobile Service
| Associated mailbox name, mailbox display name
|-
| Lync Users
| Mailbox name (NOTE: Does not support the startsWith search parameter)
|}

==== Throttling ====

The server limits the number of requests allowed per user in a certain period of time. The number of requests made are logged per minute. Calls that were made correctly with a user's API key, but not completed for any reason, including those exceeding the throttle limit, are included in this count.

If a user is over the throttling limit then a 403 HTTP code will be returned with an "Exceeded request limits" message.

{| class="wikitable"
!''Operation Category''
!''Request Limit''
|-
| GET
| 120 per minute
|-
| PUT, POST, DELETE
| 90 per minute
|-
| POST, PUT, DELETE on a domain
| 2 per minute
|-
| POST, DELETE on alternate domains
| 2 per minute
|-
| Enabling public folders for a domain
| 1 per 5 minutes
|}

==== Examples ====

Index of Exchange Mailboxes:
<pre>
Hypertext Transfer Protocol
GET /v1/customers/12345678/domains/example.com/ex/mailboxes?size=100&offset=100 HTTP/1.1
Host: api.emailsrvr.com
User-Agent: Rackspace Management Interface
X-Api-Signature: eGbq9/2hcZsRlr1JV1Pi:20010317143725:HKUn0aajpSDx7qqGK3vqzn3FglI=
Accept: text/xml
</pre>

Adding New Exchange Mailbox:
<pre>
Hypertext Transfer Protocol
POST /v1/customers/12345678/domains/example.com/ex/mailboxes/john.smith HTTP/1.1
Host: api.emailsrvr.com
User-Agent: Rackspace Management Interface
X-Api-Signature: eGbq9/2hcZsRlr1JV1Pi:20010317143725:HKUn0aajpSDx7qqGK3vqzn3FglI=
Content-Length: 53
[Content length: 53]
Content-Type: application/x-www-form-urlencoded

Line-based text data: application/x-www-form-urlencoded
size=2048&displayName=John%20Smith&password=abcABC123

</pre>

=== Responses ===

==== HTTP Status Code ====

On a successfully executed request, a 200 HTTP Code is returned. If the request was unsuccessful however, an HTTP error code in the 400s or 500s will be returned.

==== HTTP Response Body ====

If the request is an Index or Show request, the request data will be returned in the format specified in the HTTP Body.

===== Formats =====

Requests for data (index and show requests) are returned with XML or JSON data based on what your application populates the [[#HTTP_Headers|HTTP Accept headers]] with.

For XML, populate the header with 'text/xml' (ex: Headers!["Accept"] = "text/xml"). The XML document returned will conform to a published XSD (XML Schema Document). There are many ways to parse the data in an XML document, but we have found that the [http://www.w3schools.com/XPath/default.asp XPath] tree-style traversal has served our purposes. In any case, your application will likely need to use a class library for your chosen method.

For JSON, populate the header with 'application/json' (ex: Headers!["Accept"] = "application/json"). As with XML, a library will likely be needed to parse the data.

==== HTTP Headers ====

The only data returned in the header is the error message (if any).

{| class="wikitable"
!''Header Name''
!''Description''
!''Example Header Value''
|-
| x-error-message
| The error message. See [[#Errors|Errors]].
| Missing required field: name
|}

==== Errors ====

See [[Errors]].

==== Paging ====

The results of Index actions are split into pages to lessen potentially high resource usage. The index URLs have a query string with parameters in the format "?size=xx&offset=xx." If a query parameter is omitted, the default value is used.

{| class="wikitable"
!''Query Parameter''
!''Default''
!''Maximum''
!''Notes''
|-
| size
| 50
| 250
| This is the number of elements per page.
|-
| offset
| 0
| N/A
| This is the number of items to offset away from the first item in the list.
|}

===== Example =====

A PHP Example of paging can be found [[PHP_Examples_(Rest_API)| here]].

==== Examples ====

<pre>
HTTP/1.1 200 OK
Cache-Control: private
Content-Type: text/xml; charset=utf-8
Server: Microsoft-IIS/7.0
Date: Fri, 04 Dec 2009 19:08:11 GMT
Content-Length: 430

<?xml version="1.0" encoding="utf-8"?>
<domainList xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="urn:xml:domainList">
<offset>0</offset>
<size>50</size>
<total>1</total>
<domains>
<domain>
<name>customer.com</name>
<accountNumber>123456</accountNumber>
<serviceType>rsemail</serviceType>
</domain>
</domains>
</domainList>
</pre>

<pre>
HTTP/1.1 404 Not Found
Cache-Control: private
Server: Microsoft-IIS/7.0
x-error-message: Customer Not Found
Date: Fri, 04 Dec 2009 19:13:59 GMT
Content-Length: 0
</pre>

<pre>
HTTP/1.1 400 Bad Request
Cache-Control: private
Server: Microsoft-IIS/7.0
x-error-message: Missing required field: type
Date: Fri, 04 Dec 2009 19:17:29 GMT
Content-Length: 0
</pre>

== Examples ==

=== Ruby ===

This examples is written in [http://www.ruby-lang.org/en/ Ruby]. To make the examples shorter, helper methods have been written. These methods are part of a NetMethods module. The contents of the NetMethods module is listed below.

<pre>
require 'server.rb'

server = Server.new

response = server.get '/customers', server.xml_format

#fields = Hash['serviceType' => 'exchange', 'exchangeMaxNumMailboxes' => '4']
#response = server.post '/customers/me/domains/newdomain.com', fields

puts response.code
puts response['x-error-message']
puts response.body
</pre>

<pre>
require 'test/unit/assertions'
require 'net/http'
require 'date'
require 'date/format'
require 'digest/sha1'
require 'base64'
require 'time'

class Server
include Test::Unit::Assertions

def initialize(server='api.emailsrvr.com', version_prefix='/v1', user_key='xxxxxxxxxxxxxxxxxxxx', secret_hash='xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx')
@server = server
@version_prefix = version_prefix
@user_key = user_key
@secret_hash = secret_hash
end

# Response Type Enums

def xml_format
'text/xml'
end

def json_format
'application/json'
end

#
# HTTP Request Verbs
#
def get(url_string, format)
uri = full_uri(url_string)
headers = prepared_headers
headers['Accept'] = format
request = Net::HTTP::Get.new(request_uri(uri), headers)
http_response = make_request request, uri
end

def delete(url_string)
uri = full_uri(url_string)
request = Net::HTTP::Delete.new(request_uri(uri), prepared_headers)
http_response = make_request request, uri
end

def put(url_string, fields_hash)
uri = full_uri(url_string)
request = Net::HTTP::Put.new(request_uri(uri), prepared_headers)
request.set_form_data(fields_hash)
http_response = make_request request, uri
end

def post(url_string, fields_hash)
uri = full_uri(url_string)
request = Net::HTTP::Post.new(request_uri(uri), prepared_headers)
request.set_form_data(fields_hash)
http_response = make_request request, uri
end

#
# HTTP Request Helpers
#
def make_request request, uri
response = Net::HTTP::start(uri.host, uri.port) do |http|
http.request request
end

response
end

def full_uri url_string
URI.parse('http://' + @server + @version_prefix + url_string)
end

def request_uri uri
request = uri.path
if ! uri.query.nil?
request = request + '?' + uri.query
end
request
end

def prepared_headers
headers = Hash.new
headers.merge! headers_auth_creds(@user_key, @secret_hash)
headers['Accept'] = xml_format
headers
end

def headers_auth_creds apiKey, secretKey
userAgent = 'Ruby Test Client'
timestamp = DateTime.now.strftime('%Y%m%d%H%M%S')

data_to_sign = apiKey + userAgent + timestamp + secretKey

hash = Base64.encode64(Digest::SHA1.digest(data_to_sign))
signature = apiKey + ":" + timestamp + ":" + hash

headers = Hash['User-Agent' => userAgent, 'X-Api-Signature' => signature]
end
end
</pre>

=== C# ===

This examples is written in [http://msdn.microsoft.com/en-us/vcsharp/default.aspx C#].

<pre>
using System;
using System.IO;
using System.Net;
using System.Security.Cryptography;
using System.Text;

namespace RestApiClient
{
public class RestApiClient
{
private HttpWebRequest request;
private HttpWebResponse response;
private string baseUrl;
private string apiKey;
private string secretKey;

public RestApiClient(string baseUrl, string apiKey, string secretKey)
{
this.baseUrl = baseUrl;
this.apiKey = apiKey;
this.secretKey = secretKey;
}

public HttpWebResponse Get(string url, string format)
{
this.request = (System.Net.HttpWebRequest)HttpWebRequest.Create(this.baseUrl + url);
request.Method = "GET";
SignMessage();
AssignFormat(format);
return GetResponseContent();
}

public HttpWebResponse Post(string url, string data, string format)
{
this.request = (System.Net.HttpWebRequest)HttpWebRequest.Create(this.baseUrl + url);
request.Method = "POST";
SignMessage();
AssignFormat(format);
SendFormData(data);
return GetResponseContent();
}

public HttpWebResponse Put(string url, string data, string format)
{
this.request = (System.Net.HttpWebRequest)HttpWebRequest.Create(this.baseUrl + url);
request.Method = "PUT";
SignMessage();
AssignFormat(format);
SendFormData(data);
return GetResponseContent();
}

public HttpWebResponse Delete(string url, string format)
{
this.request = (System.Net.HttpWebRequest)HttpWebRequest.Create(this.baseUrl + url);
request.Method = "DELETE";
SignMessage();
AssignFormat(format);
return GetResponseContent();
}

private void SendFormData(string data)
{
UTF8Encoding encoding = new UTF8Encoding();
byte[] byteData = encoding.GetBytes(data);
this.request.ContentType = "application/x-www-form-urlencoded";
request.ContentLength = byteData.Length;
Stream requestStream = request.GetRequestStream();
requestStream.Write(byteData, 0, byteData.Length);
requestStream.Close();
}

private HttpWebResponse GetResponseContent()
{
try
{
return (HttpWebResponse)request.GetResponse();
}
catch (WebException e)
{
return (HttpWebResponse)e.Response;
}

}

private void SignMessage()
{
var userAgent = "C# Client Library";
this.request.UserAgent = userAgent;
var dateTime = DateTime.UtcNow.ToString("yyyyMMddHHmmss");
var dataToSign = apiKey + userAgent + dateTime + secretKey;
var hash = SHA1.Create();
var signedBytes = hash.ComputeHash(Encoding.UTF8.GetBytes(dataToSign));
var signature = Convert.ToBase64String(signedBytes);

request.Headers["X-Api-Signature"] = apiKey + ":" + dateTime + ":" + signature;
}

private void AssignFormat(string format)
{
this.request.Accept = format;
}
}
}
</pre>

=== PHP ===

The PHP Example can be found [[PHP_Examples_(Rest_API)| here]].

DKIM (Rest API)

2019-02-04T18:33:52Z

SOADev: Initial commit.

__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>