Rackspace Alias(Rest API) - Revision history

Appscp: remove accept header from examples to avoid confusion

2017-01-12T21:46:50Z

remove accept header from examples to avoid confusion

Appscp: /* v1 - Current */

2016-03-01T15:45:12Z

‎v1 - Current

Appscp at 18:48, 23 September 2014

2014-09-23T18:48:04Z

Appscp: /* Bulk Modify Alias List */

2014-04-17T15:57:55Z

‎Bulk Modify Alias List

Appscp: v1 documentation

2013-12-04T22:23:59Z

v1 documentation

Appscp: /* Show */

2013-07-25T14:36:22Z

‎Show

Appscp: /* Show */

2013-07-25T14:30:57Z

‎Show

Appscp: /* Index */

2013-07-25T14:30:47Z

‎Index

Subir.jolly at 16:24, 11 August 2011

2011-08-11T16:24:46Z

Zhen.wei: add rsemail alias page

2010-06-21T02:16:46Z

add rsemail alias page

New page

__TOC__

== Index ==

''URL'':

<nowiki>[GET] http://api.emailsrvr.com/v0/customers/(customer account number)/domains/(domain name)
/rs/aliases/</nowiki>

''Description'':

Shows a list of aliases for the Rackspace domain.

''Remarks'':

The show operation only supports the GET HTTP verb. For .xml format refer to the following schema document: [http://api.emailsrvr.com/v0/Schemas/RSAliasList.xsd RSAliasList.xsd]

''Example'':
<pre>
get '/customers/12345678/domains/example.com/rs/aliases', 'text/xml'
</pre>

''XML Result Example'':
<pre>
<?xml version="1.0" encoding="utf-8"?>
<aliasList xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="urn:xml:aliasList">
<aliases>
<alias>
<name>alias1</name>
<numberOfMembers>3</numberOfMembers>
</alias>
</aliases>
</aliasList>
</pre>

''Json Result Example'':
<pre>
{"aliases":[{"name":"alias1","numberOfMembers":3}]}
</pre>

== Add ==

''URL'':

<nowiki>[POST] http://api.emailsrvr.com/v0/customers/(customer account number)/domains/(domain name)
/rs/aliases/(alias name)</nowiki>

''Description'':

Create an alias.

{| class="wikitable"
!''Field Name''
!''Description''
|-
| aliasEmails
| Comma separated list of domain and non-domain emails.
|}

''Example'':
<pre>
post '/customers/100018/domains/resellerallservices.net/rs/aliases/alias1',
{'aliasEmails'=>'jane.doe@resellerallservices.net, joe.schmoe@resellerallservices.net,e1@yahoo.com, e2@gmail.com'
},
Formats.xml
</pre>

''Remarks'':
Currently there is a limit of 50 on domain emails and 4 on non-domain emails.

''Errors'':

{| class="wikitable"
!''Description''
!''HTTP Response Code''
!''Sample Message''
|-
| Non-existent domain email address.
| 400
| An alias must point to a valid email address. The following email addresses do not exist: a@resellerallservices.net
|-
| Empty domain email list and non-domain email list.
| 400
| An alias must point to a valid email address.
|-
| More than four non-domain email addresses specified.
| 400
| Max number of non-local email recipients reached.
|-
|}

== Show ==

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

''Description'':

The show operation will return detailed information about the specified alias.

''Remarks'':

The show operation only supports the GET HTTP verb. For .xml format refer to the following schema document: [http://api.emailsrvr.com/v0/Schemas/RSAlias.xsd RSAlias.xsd]

''Example'':
<pre>
get '/customers/100018/domains/resellerallservices.net/rs/aliases/alias1', Formats.xml
</pre>

''XML Result Example'':

<pre>
<?xml version="1.0" encoding="utf-8"?>
<alias xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="urn:xml:alias">
<name>alias1</name>
<emailAddressList>
<emailAddress>jane.doe@resellerallservices.net</emailAddress>
<emailAddress>e3@yahoo.com</emailAddress>
</emailAddressList>
</alias>
</pre>

''Json Result Example'':

{"emailAddressList":{"emailAddress":["jane.doe@resellerallservices.net","e3@yahoo.com"]},"name":"alias3"}

''Errors'':

{| class="wikitable"
!''Description''
!''HTTP Response Code''
!''Sample Message''
|-
| Non-existent alias.
| 404
| Resource not found.
|-
|}

== Delete ==

''URL'':
<nowiki>[DELETE] https://api.emailsrvr.com/v0/customers/(customer account number)/domains/(domain name)
/rs/aliases/(alias name)</nowiki>

''Description'':

Deletes the alias.

''Example'':
<pre>
delete '/customers/100018/domains/resellerallservices.net/rs/aliases/alias1', Formats.xml
</pre>

''Errors'':

{| class="wikitable"
!''Description''
!''HTTP Response Code''
!''Sample Message''
|-
| Non-existent alias.
| 404
| Resource not found.
|-
|}

== Add Email Address to Alias List ==

''URL'':
<nowiki>Adding an email address to a alias.
[POST] https://api.emailsrvr.com/v0/customers/(customer account number)/domains/(domain name)
/rs/aliases/(alias name)/(email address)
</nowiki>

''Description'':

Adds an email address to the domain email list or to the non-domain email list.

''Example'':
<pre>
post '/customers/100018/domains/resellerallservices.net/rs/aliases/alias1/joe.schmoe@resellerallservices.net', {}, Formats.xml

</pre>

''Errors'':

{| class="wikitable"
!''Description''
!''HTTP Response Code''
!''Sample Message''
|-
| Non-existent email address in the alias.
| 400
| An alias must point to a valid email address. The following email addresses do not exist: a@resellerallservices.net
|-
| More than four non-domain email addresses specified.
| 400
| Max number of non-local email recipients reached.
|-
| Non existent alias.
| 404
| Resource not found.
|-
|}

== Delete Email Address From Alias List ==

''URL'':
<nowiki>Deleting an email address from an alias.
[DELETE] https://api.emailsrvr.com/v0/customers/(customer account number)/domains/(domain name)
/rs/aliases/(alias name)/(email address)
</nowiki>

''Description'':

Deletes an email address from the domain email list or from the non-domain email list.

''Example'':
<pre>
delete '/customers/100018/domains/resellerallservices.net/rs/aliases/alias1/joe.schmoe@resellerallservices.net', {}, Formats.xml
</pre>

''Errors'':

{| class="wikitable"
!''Description''
!''HTTP Response Code''
!''Sample Message''
|-
| Non existent alias.
| 404
| Resource not found.
|-
| Non existent email address in the alias.
| 404
| Email address jane.doe@resellerallservices.net does not exist in alias alias1.
|-
|}

← Older revision		Revision as of 14:36, 25 July 2013
Line 106:		Line 106:
	''Remarks'':		''Remarks'':

−	The show operation only supports the GET HTTP verb. For .xml format refer to the following schema document: [http://api.emailsrvr.com/Schemas/~~RSAliasInfo~~.xsd ~~RSAliasInfo~~.xsd]	+	The show operation only supports the GET HTTP verb. For .xml format refer to the following schema document: [http://api.emailsrvr.com/Schemas/RSAlias.xsd RSAlias.xsd]

← Older revision		Revision as of 14:30, 25 July 2013
Line 106:		Line 106:
	''Remarks'':		''Remarks'':

−	The show operation only supports the GET HTTP verb. For .xml format refer to the following schema document: [http://api.emailsrvr.com~~/v0~~/Schemas/RSAliasInfo.xsd RSAliasInfo.xsd]	+	The show operation only supports the GET HTTP verb. For .xml format refer to the following schema document: [http://api.emailsrvr.com/Schemas/RSAliasInfo.xsd RSAliasInfo.xsd]

← Older revision		Revision as of 14:30, 25 July 2013
Line 16:		Line 16:
	''Remarks'':		''Remarks'':

−	The show operation only supports the GET HTTP verb. For .xml format refer to the following schema document: [http://api.emailsrvr.com~~/v0~~/Schemas/RSAliasList.xsd RSAliasList.xsd]	+	The show operation only supports the GET HTTP verb. For .xml format refer to the following schema document: [http://api.emailsrvr.com/Schemas/RSAliasList.xsd RSAliasList.xsd]

@@ Line 23: / Line 23: @@
 ''Example'':
 <pre>
-get '/customers/12345678/domains/example.com/rs/aliases', 'text/xml'
+get '/customers/12345678/domains/example.com/rs/aliases'
 </pre>
@@ Line 68: / Line 68: @@
 post '/customers/100018/domains/resellerallservices.net/rs/aliases/alias1',
 {'aliasEmails'=>'jane.doe@resellerallservices.net, joe.schmoe@resellerallservices.net,e1@yahoo.com, e2@gmail.com'
-},
 </pre>
@@ Line 113: / Line 112: @@
 ''Example'':
 <pre>
-get '/customers/100018/domains/resellerallservices.net/rs/aliases/alias1', Formats.xml
+get '/customers/100018/domains/resellerallservices.net/rs/aliases/alias1'
 </pre>
@@ Line 159: / Line 158: @@
 ''Example'':
 <pre>
-delete '/customers/100018/domains/resellerallservices.net/rs/aliases/alias1', Formats.xml
+delete '/customers/100018/domains/resellerallservices.net/rs/aliases/alias1'
 </pre>
@@ Line 189: / Line 188: @@
 ''Example'':
 <pre>
-post '/customers/100018/domains/resellerallservices.net/rs/aliases/alias1/joe.schmoe@resellerallservices.net', {}, Formats.xml
+post '/customers/100018/domains/resellerallservices.net/rs/aliases/alias1/joe.schmoe@resellerallservices.net', {}
 </pre>
@@ Line 228: / Line 227: @@
 ''Example'':
 <pre>
-delete '/customers/100018/domains/resellerallservices.net/rs/aliases/alias1/joe.schmoe@resellerallservices.net', {}, Formats.xml
+delete '/customers/100018/domains/resellerallservices.net/rs/aliases/alias1/joe.schmoe@resellerallservices.net', {}
 </pre>
@@ Line 282: / Line 281: @@
 <pre>
 put '/customers/100487/domains/testdomain.com/rs/aliases/alias_name',
-     { aliasEmails=email@outsider.com,abc@yahoo.com,user1@domain.com, user2@domain.com },
+     { aliasEmails=email@outsider.com,abc@yahoo.com,user1@domain.com, user2@domain.com }
 </pre>

@@ Line 18: / Line 18: @@
 ''Remarks'':
-The show operation only supports the GET HTTP verb. For .xml format refer to the following schema document: [http://api.emailsrvr.com/Schemas/RSAliasList.xsd RSAliasList.xsd]
+The show operation only supports the GET HTTP verb.
@@ Line 108: / Line 108: @@
 ''Remarks'':
-The show operation only supports the GET HTTP verb. For .xml format refer to the following schema document: [http://api.emailsrvr.com/Schemas/RSAlias.xsd RSAlias.xsd]
+The show operation only supports the GET HTTP verb.

@@ Line 1: / Line 1: @@
 __TOC__
-== v0 - Current ==
+== v1 - Current ==
 === Index ===
@@ Line 7: / Line 7: @@
 ''URL'':
-  <nowiki>[GET] http://api.emailsrvr.com/v0/customers/(customer account number)/domains/(domain name)
+  <nowiki>[GET] http://api.emailsrvr.com/v1/customers/(customer account number)/domains/(domain name)
          /rs/aliases/</nowiki>
@@ Line 49: / Line 49: @@
 ''URL'':
-  <nowiki>[POST] http://api.emailsrvr.com/v0/customers/(customer account number)/domains/(domain name)
+  <nowiki>[POST] http://api.emailsrvr.com/v1/customers/(customer account number)/domains/(domain name)
          /rs/aliases/(alias name)</nowiki>
@@ Line 99: / Line 99: @@
 ''URL'':
-  <nowiki>[GET] https://api.emailsrvr.com/v0/customers/(customer account number)/domains/(domain name)
+  <nowiki>[GET] https://api.emailsrvr.com/v1/customers/(customer account number)/domains/(domain name)
          /rs/mailboxes/(mailbox name)/alias/(alias name)</nowiki>
@@ Line 150: / Line 150: @@
 ''URL'':
-  <nowiki>[DELETE] https://api.emailsrvr.com/v0/customers/(customer account number)/domains/(domain name)
+  <nowiki>[DELETE] https://api.emailsrvr.com/v1/customers/(customer account number)/domains/(domain name)
              /rs/aliases/(alias name)</nowiki>
@@ Line 179: / Line 179: @@
 ''URL'':
   <nowiki>Adding an email address to a alias.
-[POST] https://api.emailsrvr.com/v0/customers/(customer account number)/domains/(domain name)
+[POST] https://api.emailsrvr.com/v1/customers/(customer account number)/domains/(domain name)
          /rs/aliases/(alias name)/(email address)
 </nowiki>
@@ Line 218: / Line 218: @@
 ''URL'':
   <nowiki>Deleting an email address from an alias.
-[DELETE] https://api.emailsrvr.com/v0/customers/(customer account number)/domains/(domain name)
+[DELETE] https://api.emailsrvr.com/v1/customers/(customer account number)/domains/(domain name)
          /rs/aliases/(alias name)/(email address)
 </nowiki>
@@ Line 252: / Line 252: @@
 ''URL'':
   <nowiki>
-[PUT] https://api.emailsrvr.com/v0/customers/(account number)/domains/(domain name)/rs/aliases/(alias name)
+[PUT] https://api.emailsrvr.com/v1/customers/(account number)/domains/(domain name)/rs/aliases/(alias name)
 </nowiki>
@@ Line 273: / Line 273: @@
 !''Description''
 |-
-| aliasEmails
+| aliasEmail
 | string
 | A comma separated list of email addresses.

@@ Line 1: / Line 1: @@
 __TOC__
-== Index ==
+== v0 - Current ==
 ''URL'':
@@ Line 43: / Line 45: @@
 </pre>
-== Add ==
+=== Add ===
 ''URL'':
@@ Line 94: / Line 96: @@
 |}
-== Show ==
+=== Show ===
 ''URL'':
@@ Line 145: / Line 147: @@
 |}
-== Delete ==
+=== Delete ===
 ''URL'':
@@ Line 173: / Line 175: @@
 |}
-== Add Email Address to Alias List ==
+=== Add Email Address to Alias List ===
 ''URL'':
@@ Line 212: / Line 214: @@
 |}
-== Delete Email Address From Alias List ==
+=== Delete Email Address From Alias List ===
 ''URL'':
@@ Line 246: / Line 248: @@
 |}
-== Bulk Modify Alias List ==
+=== Bulk Modify Alias List ===
 ''URL'':

@@ Line 52: / Line 52: @@
 ''Description'':
-Create an alias.
+Creates an alias.
 {| class="wikitable"
@@ Line 71: / Line 71: @@
 ''Remarks'':
-Currently there is a limit of 50 on domain emails and 4 on non-domain emails.
+Currently there is a limit of 50 domain emails and 4 non-domain emails.
 ''Errors'':
@@ Line 102: / Line 102: @@
 ''Description'':
-The show operation will return detailed information about the specified alias.
+Returns detailed information about the specified alias.
 ''Remarks'':
-The show operation only supports the GET HTTP verb. For .xml format refer to the following schema document: [http://api.emailsrvr.com/v0/Schemas/RSAlias.xsd RSAlias.xsd]
+The show operation only supports the GET HTTP verb. For .xml format refer to the following schema document: [http://api.emailsrvr.com/v0/Schemas/RSAliasInfo.xsd RSAliasInfo.xsd]
@@ Line 244: / Line 244: @@
 | Email address jane.doe@resellerallservices.net does not exist in alias alias1.
 |-
 |}