Controller: DomainsSub
| API Controller | /siteworx/domains/sub |
| Required Permissions | ["SUBDOMAINS"] |
| Required Options | Subdomains |
| Action | Description |
| add | Add a subdomain. |
| delete | Delete a subdomain. |
list | List subdomains. DEPRECATED in version 4.8.0-393 |
| listSubdomains | List subdomains. |
Action: add
Add a subdomain.
Input Parameters
| Name | Type | Notes | Required? |
| prefix | string | | Yes |
Action: delete
Delete a subdomain.
Input Parameters
| Name | Type | Notes | Required? |
| prefix | struct (string) | Example Values
sub | Yes |
Action: list
This action has been deprecated as of version 4.8.0-393.
MESSAGE: 2010-11-18 use listSubdomains instead.
List subdomains.
Example Output
array (
'status' => 0,
'payload' =>
array (
0 =>
array (
0 => 'sub',
1 => 'sub.example.com',
),
),
)
Action: listSubdomains (Added in version 4.8.0-393)
List subdomains.
Example Output
array (
'status' => 0,
'payload' =>
array (
0 =>
array (
'domain' => 'sub.example.com',
'prefix' => 'sub',
),
),
)
Controller: DomainsSub
listAction: add
Add a subdomain.
Input Parameters
Action: delete
Delete a subdomain.
Input Parameters
sub
Action: list
MESSAGE: 2010-11-18 use listSubdomains instead.
List subdomains.
Example Output
array ( 'status' => 0, 'payload' => array ( 0 => array ( 0 => 'sub', 1 => 'sub.example.com', ), ), )Action: listSubdomains (Added in version 4.8.0-393)
List subdomains.
Example Output
array ( 'status' => 0, 'payload' => array ( 0 => array ( 'domain' => 'sub.example.com', 'prefix' => 'sub', ), ), )