Accounts-account-email-domain-usernames-mailboxName-secrets:GET
From Hostway API Documentation
GET /accounts/{account}/email/{domain}/usernames/{maiboxName}/secrets
Retrieves a list of text keys for all mailbox(alias) secret questions.
Contents |
Request
GET /accounts/{account}/email/{domain}/usernames/{maiboxName}/secrets
Request Parameters
- account - string
- The user account owning the domain and the mailboxes
- 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
application/json; charset=UTF-8
Response
Status Code
- 200 OK
- Success
- 404 Not Found
- The domain name, mailbox or account does not exist.
Response Body
{
"list": [ "{tk}", "{tk}", "{tk}" ],
"links": [
{
"href": "https://api.hostway.com/accounts/{account}/email/{domain}/usernames/{maiboxName}/secrets",
"rel": "self"
}
]
}
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
GET /accounts/test-account123/email/test.com/usernames/test-mailbox/secrets
Response
{
"list": [ "tk1", "tk2", "tk3" ],
"links": [
{
"href": "https://api.hostway.com/accounts/test-account123/email/test.com/usernames/test-mailbox/secrets",
"rel": "self"
}
]
}
See also
