Delete alias

Delete an alias

  • HTTP Method: DELETE
  • URL: https://example.domain.tld/api/v1/aliases/
  • Require authentication: Yes
  • Permission level required: MasterAdmin / DomainAdmin

Request parameters

Parameter Type Description Required
alias str Alias address Required

Response

HTTP 204 NO CONTENT (empty string)

Example request (Python)

import requests
import json
from pprint import pprint

url = "https://example.domain.tld/api/v1/aliases/"
data = {
"alias" : "alias@vonmail.com"
}
r = requests.delete(url, json=data, auth=("admin","long-auth_token-here"))
try:
    pprint(r.json())
except:
    print(r.text)
print(r.status_code)

Example response (text)


204