Site methods.
| Service.Site | Site methods. |
| Functions | |
| create | Create a site. |
| destroy | Delete a Site |
| update | Update the site details. |
| find | Search for a site. |
| getSettings | get all the settings associated with the site |
| setSettings | set a list of settings on the site |
| getAliases | get all aliases associated with the site |
| addAlias | Add an alias to a site. |
| destroyAlias | Remove an alias from a site |
| getAddress | fetch the address for this site |
| updateAddress | Associate an address with the site |
| assignCertificate | Assign an SSL certificate with the site. |
| getLoadBalancerStatus | Fetch the current site status |
Create a site. Note that the hostname must not already be in use or an InvalidArguments will be thrown.
| customerId | no docs (idx: 1, type: Types.CustomerId) |
| name | a friendly name for the site (for your use) (idx: 2, type: Types.SiteName) |
| hostname | a fully qualified domain name (fqdn) (idx: 3, type: Types.Hostname) |
| environmentName | the name of the Environment to create (idx: 4, type: Types.EnvironmentName) |
| environmentType | no docs (idx: 9, type: Types.ContainerTypeId) |
| address | the ip address that the site should be bound to (idx: 5, type: Types.IPAddress, optional) |
| ssl | reserve SSL for the SiteAddress (idx: 6, type: Thrift.bool, optional) |
| containers | a list of container ids that the site environment will be configured on (idx: 7, type: Thrift.list (Types.ContainerId)) |
| aliases | no docs (idx: 8, type: Thrift.list (Types.SiteAlias), optional) |
| createDNS | if true, DNS records will be created for the new site and aliases (idx: 10, type: Thrift.bool, optional) |
Types.SiteId the newly created id of the site
Exceptions.InvalidArguments (idx: 1)
Delete a Site
| id | the id of the site (idx: 1, type: Types.SiteId) |
Exceptions.InvalidArguments (idx: 1)
Update the site details. Provide ‘name’ and/or ‘hostname’. Note that, if changing the hostname, the new hostname must not already be in use or an InvalidArguments will be thrown.
| id | no docs (idx: 1, type: Types.SiteId) |
| name | no docs (idx: 2, type: Types.SiteName, optional) |
| hostname | no docs (idx: 3, type: Types.Hostname, optional) |
| updateDNS | no docs (idx: 4, type: Thrift.bool, optional) |
Exceptions.InvalidArguments (idx: 1)
Search for a site.
| customerId | no docs (idx: 1, type: Types.CustomerId, optional) |
| name | no docs (idx: 2, type: Types.SiteName, optional) |
| hostname | no docs (idx: 3, type: Types.Hostname, optional) |
| address | no docs (idx: 4, type: Types.IPAddress, optional) |
| id | no docs (idx: 5, type: Types.SiteId, optional) |
| isSSLAssignable | no docs (idx: 6, type: Thrift.bool, optional) |
Thrift.list (Types.SiteDetails)
Exceptions.InvalidArguments (idx: 1)
get all the settings associated with the site
| id | the id of the site (idx: 1, type: Types.SiteId) |
Exceptions.InvalidArguments (idx: 1)
set a list of settings on the site
| id | the id of the site (idx: 1, type: Types.SiteId) |
| settings | a list of the settings (idx: 2, type: Types.SettingList) |
Exceptions.InvalidArguments (idx: 1)
get all aliases associated with the site
| id | the id of the site (idx: 1, type: Types.SiteId) |
Types.SiteAliasList a list of sitealiases
Exceptions.InvalidArguments (idx: 1)
Add an alias to a site. Note that the alias must not already be in use or an InvalidArguments will be thrown.
| id | the id of the site to which you want to add an alias (idx: 1, type: Types.SiteId) |
| aliases | list of aliases (idx: 4, type: Thrift.list (Types.SiteAlias)) |
| createDNS | no docs (idx: 3, type: Thrift.bool, optional) |
Thrift.list (Types.SiteAliasId)
Exceptions.InvalidArguments (idx: 1)
Remove an alias from a site
| id | the id of the alias to destroy (idx: 1, type: Types.SiteAliasId) |
Exceptions.InvalidArguments (idx: 1)
fetch the address for this site
| id | no docs (idx: 1, type: Types.SiteId) |
Exceptions.InvalidArguments (idx: 1)
Associate an address with the site
| id | no docs (idx: 1, type: Types.SiteId) |
| address | If left empty, and if not createNewAddress, it will default to the currently assigned address (idx: 2, type: Types.IPAddress, optional) |
| isSSLReserved | no docs (idx: 3, type: Thrift.bool, optional) |
| createNewAddress | no docs (idx: 4, type: Thrift.bool, optional) |
| updateDNS | no docs (idx: 5, type: Thrift.bool, optional) |
Exceptions.InvalidArguments (idx: 1)
Assign an SSL certificate with the site. If there was a previous certificate, it will be replace.
| siteId | no docs (idx: 1, type: Types.SiteId) |
| certificateId | If left blank, unassigns the certificate (idx: 2, type: Types.CertificateId, optional) |
Exceptions.InvalidArguments (idx: 1)
Fetch the current site status
| siteId | no docs (idx: 1, type: Types.SiteId) |
| time | If present, will search for closest record to this time (backwards); otherwise, defaults to latest status (idx: 2, type: Types.UnixTime, optional) |
Exceptions.InvalidArguments (idx: 1)