v51

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-01960201.2 KB

Domains

Create domain

You may create your own domain using this action. It takes a JSON object containing a domain informations.

post/api/v1/add/domain

Request body

activeboolean

is domain active or not

aliasesnumber

limit count of aliases associated with this domain

backupmxboolean

relay domain or not

defquotanumber

predefined mailbox quota in add mailbox form

descriptionstring

Description of domain

domainstring

Fully qualified domain name

galboolean

is domain global address list active or not, it enables shared contacts accross domain in SOGo webmail

mailboxesnumber

limit count of mailboxes associated with this domain

maxquotanumber

maximum quota per mailbox

quotanumber

maximum quota for this domain (for all mailboxes in sum)

restart_sogonumber

restart SOGo to activate the domain in SOGo

relay_all_recipientsboolean

if not, them you have to create "dummy" mailbox for each address to relay

relay_unknown_onlyboolean

Relay non-existing mailboxes only. Existing mailboxes will be delivered locally.

rl_frame's' | 'm' | 'h' | 'd'

rl_valuenumber

rate limit value

tagsstring[]

tags for this Domain

Example request

{
  "active": "1",
  "aliases": "400",
  "backupmx": "0",
  "defquota": "3072",
  "description": "some decsription",
  "domain": "domain.tld",
  "mailboxes": "10",
  "maxquota": "10240",
  "quota": "10240",
  "relay_all_recipients": "0",
  "rl_frame": "s",
  "rl_value": "10",
  "restart_sogo": "10",
  "tags": [
    "tag1",
    "tag2"
  ]
}

Response

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