Note

You are viewing the documentation for an older release of Interworx (8.1). To see documentation for the current generally available release of Interworx, click here: 8.2.

Controller: /siteworx/domains/advanced

Required Permissions

SLAVEDOMS

Action: edit

Added in Version

8.0.3-2553

Description

Edit advanced options for a domain

Input Parameters

Name

Type

Required?

Example Values

Default Values

Notes

domain

string

Yes

example.com, secondary.com

logging_enabled

integer

No*

1, 0

1

This option can enable/disable access and error logging for the domain.

server_aliases

struct (string)

No

Additional server aliases to setup for the domain. Input in this form is limited to subdomains of domains in the account. Wilcards are allowed.

extra_ips_http

struct (string)

No

Additional IPs that should be added to the domain’s vhost.

extra_ips_https

struct (string)

No

Additional IPs that should be added to the domain’s vhost.

* indicates that it’s actually required, but probably already has a valid default value.

Action: fail

Added in Version

8.0.3-2553

Description

Magic function - test for failure mechanism.

Action: queryEdit

Added in Version

8.0.3-2553

Description

Displays the information available to the action “edit”

Input Parameters

Name

Type

Required?

Example Values

Default Values

Notes

domain

string

Yes

example.com, secondary.com

logging_enabled

integer

No*

1, 0

1

This option can enable/disable access and error logging for the domain.

server_aliases

struct (string)

No

Additional server aliases to setup for the domain. Input in this form is limited to subdomains of domains in the account. Wilcards are allowed.

extra_ips_http

struct (string)

No

Additional IPs that should be added to the domain’s vhost.

extra_ips_https

struct (string)

No

Additional IPs that should be added to the domain’s vhost.

* indicates that it’s actually required, but probably already has a valid default value.

Action: reroute

Added in Version

8.0.3-2553

Description

Action to re-route from the current controller to a different one.

Input Parameters

Name

Type

Required?

Example Values

Default Values

Notes

controller

string

Yes

Index, Overview, Email, EmailBox, EmailAlias, EmailGroup, EmailAutorespond, DomainsManage, DomainsPointer, DomainsSub, DomainsPhp, Dns, DomainsAdvanced, Ssl, SslKey, SslChain, SslCrt, SslCsr, Ftp, FtpSessions, MysqlDb, MysqlUser, MysqlPerms, Cron, Htaccess, Softaculous, Users, Logs, Twofactorauth, EmailRemotesetup, EmailFilters, EmailSpf, EmailDomainkeys, EmailDmarc, Backup, BackupSchedule, Prefs, Notice, Logout

Action: wait

Added in Version

8.1.3-2998

Description

Magic function - used to simulate a long-running process

Action: win

Added in Version

8.0.3-2553

Description

Magic function - test for testing success mechanism.