Added documentation for version 1.5 of the SiteHost API. All endpoints which
formerly returned job IDs under the job_id key now return an object job
with two keys: id and type.
For example, the response from the /server/change_state endpoint will now
look like
{
"return": {
"job": {
"type": "scheduler",
"id": 7319505
}
},
"msg": "Successful",
"status": true
}rather than
{
"return": {
"job_id": 7319505
},
"msg": "Successful",
"status": true
}This matches the parameters required by /job/get.json and thus removes the
need to guess or otherwise infer the type of a job as a user of the API.
/server/firewall/get and /server/firewall/update endpoints/server/firewall/security_groups /add, /get, /list_all, /update and
/delete endpoints/accounts/client/list_sub_accounts endpoint/cloud/image/version/list_all.json not showing pagination options or the response structure./cloud/volume/list_all.json not showing pagination options.mount and update_mounts add and remove arguments were not fully accurate.updated_since filter to /server/list_servers.json. This will cause only items which have been modified on
of after the specified date to be returned./server/list_servers.json now returns date_updated values.cloud/volume/add.json, cloud/volume/mount.json, cloud/volume/update_mounts.json, cloud/volume/get.json, cloud/volume/list_all.json, and cloud/volume/delete.json endpoints for managing volumes. This allows for the creation and management of volumes for Cloud Containers.cloud/ssh/user/add.json and cloud/ssh/user/update.json to use a params array instead of specific params for each item.cloud/ssh/user/add.json, cloud/ssh/user/list_all.json, and cloud/ssh/user/update.json to include volume parameters.updated_since filter to: /cloud/server/list_all.json, /cloud/stack/list_all.json,
and /cloud/stack/image/list_all.json. This will cause only items which have been modified on
of after the specified date to be returned./cloud/server/list_all.json now returns created and date_updated values./ssh/key/get.json to include the users associated with the key./srs/create_contact.json with new extension parameters for all phone types, plus the addition of postal_address2./srs/create_domain.json with a new billing_contact_id parameter./srs/transfer_domain.json with an entirely new parameter structure which better suits the optional parameters this function has./srs/update_domain_contacts.json with a new billing_contact_id parameter./srs/update_contact.json with new extension parameters for all phone types, plus the addition of postal_address2./cloud/stack/copy.json that allows you to clone a Cloud Container./cloud/stack/overwrite.json that allows you to overwrite a Cloud Container./dns/create_domain.json to indicate if a zone migration has taken place./redirect/list_redirects.json to include the source URL's path in the key of the returned objects./cloud/server/get_update_window.json that allows you to see when your managed server’s update window is./cloud/server/set_update_window.json that allows you to set your managed server’s update window./cloud/server/update_minimum_tls_version.json that allows setting a minimum TLS version for your server./cloud/stack/environment/{delete, get, update}.json endpoints for getting and manipulating Cloud Container environment variables./redirect/list_redirects to get a list of redirects that have been set up./cloud/db, cloud/db/grant, and cloud/db/user endpoints so you can now specify MySql Host version, as it is now required to create/modify/remove Databases, their grants, and users./cloud/db/list_all.json so you can filter by MySql Host version when listing databases./cloud/db/user/list_all.json so you can filter by MySql Host version when listing database users./dns/list_domains.json to paginate the response, allow sorting, and allow filtering domains that contain a substring./dns/list_ips.json to paginate the response, and allow sorting.