MAmailcow
Aliases

Create time limited alias

Changed on

You may create a time limited alias using this action. It takes a JSON object containing a domain and mailbox informations. Mailcow will generate a random alias.

post/api/v1/add/time_limited_alias

Request

  • Base URL
    / (relative, and the document was published on a file host, not at the API’s origin)
  • Auth
    API key in header X-API-Key

Request body

usernamestring

the mailbox an alias should be created for

domainstring

the domain

descriptionstring

a description for the alias, defaults to an empty string

validityinteger

how many hours the alias stays valid, 1 to 87600, defaults to 8760 (one year)

permanentboolean

keep the alias after it expired, defaults to false

Example request

{
  "username": "info@domain.tld",
  "domain": "domain.tld",
  "description": "my time limited alias",
  "validity": 8760,
  "permanent": false
}

Response

OK

type'success' | 'danger' | 'error'

Changes

  • ae01d1d7886aRevision changes
    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

  • 50e1d81e874cRevision changes
    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the request property