Sign in
Aliases

Create time limited alias

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 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

Changed in 4 of the 51 revisions of this API.134

  • 50e1d81e874c3See the full diff
    • ●

      removed the request property description

      request-property-removed

    • ●

      removed the request property permanent

      request-property-removed

    • ●

      removed the request property validity

      request-property-removed

  • a51b72968d1e3See the full diff
    • ○

      added the new optional request property description

      new-optional-request-property

    • ○

      added the new optional request property permanent

      new-optional-request-property

    • ○

      added the new optional request property validity

      new-optional-request-property

  • 161884929ef01See the full diff
    • ○

      endpoint added

      endpoint-added

  • 47523aca063a1See the full diff
    • ▲

      api path removed without deprecation

      api-path-removed-without-deprecation