Mike.robski: 1 revision: Release 98

2014-09-15T13:53:38Z

1 revision: Release 98

Jerry.dimitrov: /* Status Code */

2014-09-02T17:00:00Z

Status Code

New page

= GET /email/{domain}/usernames/{mailboxName}/secrets =
Retrieves a list of text keys for all mailbox(alias) secret questions.
__TOC__

== Request ==
<code>GET /email/{domain}/usernames/{mailboxName}/secrets</code>

==== Request Parameters ====
; domain - ''string''
: The specific domain for which the call will retrieve the list
; maiboxName - ''string''
: The name of the mailbox

=== Request Headers ===

; Content-Type
: Required. Set this header to <code>application/json; charset=UTF-8</code>

== Response ==

=== Status Code ===
; 200 OK
: Success

; 404 Not Found
: The domain name or mailbox does not exist.

=== Response Body ===
<nowiki>
{
"list": [ "{tk}", "{tk}", "{tk}" ],
"links": [
{
"href": "</nowiki>{{APIBaseURL}}<nowiki>/email/{domain}/usernames/{mailboxName}/secrets",
"rel": "self"
}
]
}
</nowiki>

==== Parameters ====
; list - 'list'
: A list of secret questions of the account
:; tk - ''string'' (Unique)
:: Unique secret question text key.
; links - 'list'
:[[Hypermedia]] to the account secret questions resource

== Examples ==

=== Success scenario ===
'''Request'''
<nowiki>
GET /email/test.com/usernames/test-mailbox/secrets
</nowiki>

'''Response'''
<nowiki>
{
"list": [ "tk1", "tk2", "tk3" ],
"links": [
{
"href": "</nowiki>{{APIBaseURL}}<nowiki>/email/test.com/usernames/test-mailbox/secrets",
"rel": "self"
}
]
}
</nowiki>

== See also ==
* [[Email API|Email API]]

{{disqus}}
[[Category:Hostway API]]
[[Category:Email API]]

Email-domain-usernames-mailboxName-secrets:GET - Revision history

Mike.robski: 1 revision: Release 98

Jerry.dimitrov: /* Status Code */