Skip to content

Download a mail setup profile

GET /api/v2/mail-profiles/{token}

Download the Apple Mail setup profile behind a link from POST /api/v2/shared-hosting/{accountId}/email-accounts/{address}/actions/mail-profile-link. The link works without an API key or a login. It can be opened on a phone that is not signed in. The response is the profile file (application/x-apple-aspen-config), not JSON. It holds the mail servers, ports and the mailbox address. It never holds a password.

A link is valid for 30 minutes. An expired or invalid link returns 410 link_expired. Create a new link to continue.

Authentication: None. Anyone can call it.

Request

Path parameters

tokenstringrequired
The token from the url the mail-profile-link action returned.

Example

GET /api/v2/mail-profiles/{token}
curl "https://cloud.hostup.se/api/v2/mail-profiles/id_01hxa3b4c5d6e7f8g9h0j1k2m3"

Responses

200 The setup profile file for the mailbox.

Content type: application/x-apple-aspen-config

Errors

Errors are Problem Details with a stable code. Branch on the code, not on the text.

400Invalid request. The response body is an RFC 7807 Problem Details document.
410The link has expired or is invalid. Create a new link.
429Rate limited. Retry after the limit resets. 429 responses include Retry-After seconds plus X-RateLimit-* headers.
500Internal error. Retry later or contact support if the issue persists.