Containers are how you host websites on NodeHost, this is our main service.

The container locations range from n5 to n12 at this current time, and the site sizes are listed below.

Normal Plans
normal_s2_v0 (350MB Disk) - Teachers and students only
normal_s2_v1 (2GB Disk) - All users
normal_s2_v2 (4GB Disk) - All users
normal_s2_v3 (6GB Disk) - All users
normal_s2_v4 (8GB Disk) - All users
normal_s2_v5 (16GB Disk) - All users
normal_s2_v6 (24GB Disk) - All users
normal_s2_v7 (24GB Disk) - All users
normal_s2_v8 (24GB Disk) - All users
normal_s2_v9 (32GB Disk) - All users

Light Plans (No DB or Mail)
light_s2_v0 (50MB Disk) - All users (free micro container)
light_s2_v1 (1GB Disk) - All users
light_s2_v2 (2GB Disk) - All users
light_s2_v3 (4GB Disk) - All users
light_s2_v4 (6GB Disk) - All users
light_s2_v5 (8GB Disk) - All users

Plus Plans (Extra DB and Mail)
plus_s2_v1 (2GB Disk) - All users except students
plus_s2_v2 (4GB Disk) - All users except students
plus_s2_v3 (6GB Disk) - All users except students

Reseller Plans (Price per storage)
reseller_normal_s1_v1 (1GB Disk) - Reseller accounts only
reseller_normal_s1_v2 (2GB Disk) - Reseller accounts only
reseller_normal_s1_v3 (3GB Disk) - Reseller accounts only
reseller_normal_s1_v4 (4GB Disk) - Reseller accounts only
reseller_normal_s1_v5 (5GB Disk) - Reseller accounts only
reseller_normal_s1_v6 (6GB Disk) - Reseller accounts only
reseller_normal_s1_v7 (7GB Disk) - Reseller accounts only
reseller_normal_s1_v8 (8GB Disk) - Reseller accounts only
reseller_normal_s1_v9 (9GB Disk) - Reseller accounts only
reseller_normal_s1_v10 (10GB Disk) - Reseller accounts only
reseller_normal_s1_v11 (11GB Disk) - Reseller accounts only
reseller_normal_s1_v12 (12GB Disk) - Reseller accounts only
reseller_normal_s1_v13 (13GB Disk) - Reseller accounts only
reseller_normal_s1_v14 (14GB Disk) - Reseller accounts only
reseller_normal_s1_v15 (15GB Disk) - Reseller accounts only
reseller_normal_s1_v16 (16GB Disk) - Reseller accounts only
reseller_normal_s1_v17 (17GB Disk) - Reseller accounts only
reseller_normal_s1_v18 (18GB Disk) - Reseller accounts only
reseller_normal_s1_v19 (19GB Disk) - Reseller accounts only
reseller_normal_s1_v20 (20GB Disk) - Reseller accounts only
reseller_normal_s1_v21 (21GB Disk) - Reseller accounts only
reseller_normal_s1_v22 (22GB Disk) - Reseller accounts only
reseller_normal_s1_v23 (23GB Disk) - Reseller accounts only
reseller_normal_s1_v24 (24GB Disk) - Reseller accounts only
reseller_normal_s1_v25 (25GB Disk) - Reseller accounts only
reseller_normal_s1_v26 (26GB Disk) - Reseller accounts only
reseller_normal_s1_v27 (27GB Disk) - Reseller accounts only
reseller_normal_s1_v28 (28GB Disk) - Reseller accounts only
reseller_normal_s1_v29 (29GB Disk) - Reseller accounts only
reseller_normal_s1_v30 (30GB Disk) - Reseller accounts only

Quick jump to call

This will open the pages in a new tab.

GET / Containers List
POST / Create Container
POST / Destroy Container

Basic Info
GET / Container Info
GET / Container Usage
GET / Container SFTP
GET / Container Log Access
GET / Container Log Error

ZIP Deploy Rules
GET / Container ZIPS
POST / Container Create ZIP
POST / Container Destroy ZIP
POST / Container Run ZIP

Packages
POST / Container Package Install

Domains
POST / Container Create Domain
POST / Container Destroy Domain
POST / Container Create Domain Secondary - New as per March 29th
POST / Container Destroy Domain Secondary - New as per March 29th
POST / Container Create Domain Alias
POST / Container Destroy Domain Alias

Let's Encrypt
POST / Container Create Let's Encrypt
POST / Container Destroy Let's Encrypt

Backups
GET / Container Backups
POST / Container Create Backup - New as per March 29th
POST / Container Destroy Backup - New as per March 29th
POST / Container Restore Backup - New as per March 29th

Mail
GET / Container Mail

DNS
GET / Container DNS

Databases
GET / Container Databases


GET - Containers List
Returns a list of all containers with some basic information like the containers ID.

Request URL
https://api.nodehost.cloud/get_services_containers_list

Parameters
None

More info
None

Test URL
https://api.nodehost.cloud/get_services_containers_list

Response
{
"data": [
{
"id": "abiuueuzkwnc8o5qfcfvttuafsymol8ywr2",
"nickname": "Aardvark clam",
"node": "n9",
"date_created": "1540589906",
"status": "online",
"size": "750normal",
"domain": "mqefbn.n9.myws.ca",
"ssl": "1"
},
{
"id": "qufs5be1noatmopoauak8atzghfhlvvc0be",
"nickname": "My first container",
"node": "n7",
"date_created": "1538867898",
"status": "online",
"size": "750normal",
"domain": "dgaepe.n7.myws.ca",
"ssl": "0"
}
],
"system_connection": "true",
"system_version": "v_61_3b16c36",
"system_user_id": "1232",
"system_user_username": "apiuser"
}



POST - Create Container
It's easy to create a container, just give us a location and a size to use and we will create it for you.

Request URL
https://api.nodehost.cloud/post_services_container_create

Parameters
location - The location of the server using it's Node ID
size - The size of the container getting created

More info
Because of the delay in container creation you will get back SFTP login info and a contaner ID, but none of the details will work until the container is created. Creating a container takes around 30 seconds. Using this info and the container info API call you can easily check back with the ID to see if the container has been created yet.

Custom domain: You can also provide the variable domain. With domain you can provide a domain and we will auto add it when we create the container like testsite.n6.myws.ca.

Custom package: You can setup a custom package with the variable package. Package is the ID of the package you have created or we provide to also install, if the package is a payed package and you dont already own it the API will auto charge the user making the container.

Install LE: You can also auto run LE setup after container is launched by providing the url variable installssl with the value now to atempt setup in seconds, delay that will wait 60 seconds or longdelay to wait 2 minutes.

Setup with custom domain without www alias: By providing the varable alias with the value of none we will after setup remove the www alias (also before any LE commands run).

Random Locations: You can now auto pick a random location by using the location random or a random location from a country with the following location options random_usa, random_canada, random_germany, and random_nl.

Test URL
https://api.nodehost.cloud/post_services_container_create?location=n9&size=normal_s1_v1

Response

{
"data": {
"id": "mvxh1mmua3ivdve36yy8icjceoffakpxgne",
"node": "n9",
"node_location": "New York (USA)",
"node_hostname": "n9.nodehost.ca",
"node_version_php": 7.2,
"node_version_os": "Ubuntu 16.04 LTS",
"size": "750normal",
"sftp_username": "anufyp",
"sftp_password": "4ooDDY17ezWiF29ZqBTBdrhVh",
"dns_ns1": "lisa-n9.nodehost.ca",
"dns_ns2": "mike-n9.nodehost.ca"
},
"system_connection": "true",
"system_version": "v2_16_66e17b05078fc8540585d0d3d3bba8888959e604",
"system_user_id": 1232,
"system_user_username": "apiuser",
"system_process_id": 1103113,
"system_process_command": "services_container_create"
}



POST - Destroy Container
Destroy a container using the ID, keep in mind it takes 15 seconds to delete the container and you should check your container list to make sure it has been deleted.

Request URL
https://api.nodehost.cloud/post_services_container_destroy

Parameters
container - The ID of the container

More info
None

Test URL
https://api.nodehost.cloud/post_services_container_destroy?container=qufs5be1noatmopoauak8atzghfhlvvc0be

Response

{
"data": "Container getting destroyed",
"system_connection": "true",
"system_version": "v_64_4f621ca",
"system_user_id": "1232",
"system_user_username": "apiuser"
}



GET - Container Info
Get back info about the container based on it's ID.

Request URL
https://api.nodehost.cloud/get_services_container_info

Parameters
container - The container ID

More info
None

Test URL
https://api.nodehost.cloud/get_services_container_info?container=qufs5be1noatmopoauak8atzghfhlvvc0be

Response
{
"data": {
"id": "qufs5be1noatmopoauak8atzghfhlvvc0be",
"nickname": "My first container",
"node": "n7",
"date_created": 1538867898,
"status": "online",
"size": "750normal",
"domain": "dgaepe.n7.myws.ca",
"aliases": "www.dgaepe.n7.myws.ca",
"ssl": 0
},
"system_connection": "true",
"system_version": "v2_5_fac057bab419558eee7075685c3d35b4bb096d9c",
"system_user_id": 1232,
"system_user_username": "apiuser",
"system_process_id": "false",
"system_process_command": "false"
}



GET - Container Usage
Get back basic info about the usage of the container based on it's ID. The value for disk and bandwidth is returned in MB.

Request URL
https://api.nodehost.cloud/get_services_container_usage

Parameters
container - The container ID

More info
None

Test URL
https://api.nodehost.cloud/get_services_container_usage?container=qufs5be1noatmopoauak8atzghfhlvvc0be

Response
{
"data": {
"container": "qufs5be1noatmopoauak8atzghfhlvvc0be",
"date": "20181026161502",
"resource_disk": "2",
"resource_bandwidth": "0",
"resource_databases": "0",
"resource_aliases": "1",
"resource_mailaccounts": "0",
"resource_dns": "12"
},
"system_connection": "true",
"system_version": "v_63_3e1b9bc",
"system_user_id": "1232",
"system_user_username": "apiuser"
}



GET - Container SFTP
Get back the SFTP login info of the container based on it's ID.

Request URL
https://api.nodehost.cloud/get_services_container_sftp

Parameters
container - The container ID

More info
None

Test URL
https://api.nodehost.cloud/get_services_container_sftp?container=abiuueuzkwnc8o5qfcfvttuafsymol8ywr2

Response
{
"data": {
"sftp_username": "mqefbn",
"sftp_password": "f9mhoilk2oni7lk333f32",
"hostname": "n9.nodehost.ca"
},
"system_connection": "true",
"system_version": "v2_19_21e0c166e2328f7fd698f76e460ffb6fe6e84557",
"system_user_id": 1232,
"system_user_username": "apiuser",
"system_process_id": "false",
"system_process_command": "false"
}



GET - Container Log Access
Returns the last values of the web access log for the container based on it's ID.

Request URL
https://api.nodehost.cloud/get_services_container_log_access

Parameters
container - The container ID

More info
None

Test URL
https://api.nodehost.cloud/get_services_container_log_access?container=qufs5be1noatmopoauak8atzghfhlvvc0be

Response
{
"data": [
"207.102.56.42 - - [21/Feb/2020:23:45:38 +0000] "GET / HTTP/1.0" 200 888 "-" "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/13.0.2 Safari/605.1.15";",
"207.102.56.42 - - [21/Feb/2020:23:45:33 +0000] "GET /favicon.ico HTTP/1.0" 404 396 "http://dgaepe.n7.myws.ca/" "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/13.0.2 Safari/605.1.15";",
"207.102.56.42 - - [21/Feb/2020:23:45:32 +0000] "GET / HTTP/1.0" 200 888 "-" "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/13.0.2 Safari/605.1.15";",
"185.178.44.57 - - [21/Feb/2020:14:21:25 +0000] "GET /wp-login.php HTTP/1.0" 404 396 "-" "Mozilla/5.0 (X11; Ubuntu; Linux x86_64; rv:62.0) Gecko/20100101 Firefox/62.0";"
],
"system_connection": "true",
"system_version": "v2_146_0b883e4c6a90cabcce374b236a1430767d8da69d",
"system_user_id": 1232,
"system_user_username": "apiuser",
"system_process_id": "false",
"system_process_command": "false"
}



GET - Container Log Error
Returns the last values of the web error log for the container based on it's ID.

Request URL
https://api.nodehost.cloud/get_services_container_log_error

Parameters
container - The container ID

More info
None

Test URL
https://api.nodehost.cloud/get_services_container_log_error?container=qufs5be1noatmopoauak8atzghfhlvvc0be

Response
{
"data": [
"[Fri Feb 21 14:21:25.174891 2020] [php7:error] [pid 22206] [client 159.203.29.179:36568] script '/home/dgaepe/web/dgaepe.n7.myws.ca/public_html/wp-login.php' not found or unable to stat;"
],
"system_connection": "true",
"system_version": "v2_146_0b883e4c6a90cabcce374b236a1430767d8da69d",
"system_user_id": 1232,
"system_user_username": "apiuser",
"system_process_id": "false",
"system_process_command": "false"
}



GET - Container ZIPs
Gets back a list of zip deploy packages setup on a container using the container ID.

Request URL
https://api.nodehost.cloud/get_services_container_zips

Parameters
container - The container ID

More info
None

Test URL
https://api.nodehost.cloud/get_services_container_zips?container=qufs5be1noatmopoauak8atzghfhlvvc0be

Response
{
"data": [
{
"id": "695rsvnfmysdky3eksqqzyzopcwlsaxyk20",
"zipurl": "https://github.com/anthonyrossbach/default-project-template/archive/master.zip",
"zippath": "/"
},
{
"id": "aof3bypejuuaczogiknswkxqfbmt8qkipzl",
"zipurl": "https://github.com/anthonyrossbach/wordpress-database-recover/archive/master.zip",
"zippath": "/wp-content/"
}
],
"system_connection": "true",
"system_version": "v2_8_4b63dc0ad640d6963ecb223d4593a858531bc6ab",
"system_user_id": 1232,
"system_user_username": "apiuser",
"system_process_id": "false",
"system_process_command": "false"
}



POST - Container Create ZIP
Allows you to setup a easy to deploy ZIP rule you can run later, just provide a the container ID and the information needed like the ZIP URL (May need to be in URI encoded string).

Request URL
https://api.nodehost.cloud/post_services_container_create_zip

Parameters
container - The ID of the container
url - The URL of the zip
path - Path to install in, default will be /

More info
None

Test URL
https://api.nodehost.cloud/post_services_container_create_zip?container=qufs5be1noatmopoauak8atzghfhlvvc0be&url=https://github.com/anthonyrossbach/default-project-template/archive/master.zip&path=/folder/

Response

{
"data": "The ZIP deploy structure is getting created on the container",
"system_connection": "true",
"system_version": "v2_12_5f653d11990dcaba2c7362a6d7626cc4be8155b8",
"system_user_id": 1232,
"system_user_username": "apiuser",
"system_process_id": 1103113,
"system_process_command": "services_container_create_zip"
}



POST - Container Destroy ZIP
Allows you to remove a zip deploy rule.

Request URL
https://api.nodehost.cloud/post_services_container_destroy_zip

Parameters
container - The ID of the container
zip - The ID of the zip

More info
None

Test URL
https://api.nodehost.cloud/post_services_container_destroy_zip?container=qufs5be1noatmopoauak8atzghfhlvvc0be&zip=695rsvnfmysdky3eksqqzyzopcwlsaxyk20

Response

{
"data": "ZIP deploy rule is being destroyed",
"system_connection": "true",
"system_version": "v2_11_6217f87fe397a670314a74a8f78f953c0a85358e",
"system_user_id": 1232,
"system_user_username": "apiuser",
"system_process_id": 1103113,
"system_process_command": "services_container_destroy_zip"
}



POST - Container Run ZIP
Run a containers ZIP deploy rule using the container ID and the ID of the ZIP rule.

Request URL
https://api.nodehost.cloud/post_services_container_run_zip

Parameters
container - The ID of the container
zip - The ID of the zip

More info
None

Test URL
https://api.nodehost.cloud/post_services_container_run_zip?container=qufs5be1noatmopoauak8atzghfhlvvc0be&zip=695rsvnfmysdky3eksqqzyzopcwlsaxyk20

Response

{
"data": "ZIP deploy rule is running",
"system_connection": "true",
"system_function": "post_services_container_run_zip",
"system_runtime": 0,
"system_version": "pub_23",
"system_user_id": 1232,
"system_user_username": "apiuser",
"system_process_id": 1103113,
"system_process_command": "services_container_run_zip"
}



POST - Container Package Install
Installs a package when given the package ID on the container as long as it has a domain created.

Request URL
https://api.nodehost.cloud/post_services_container_package_install

Parameters
container - The ID of the container
package - The ID of the package

More info
Some packages may not be free and if so will be auto charged to the user installing the package.

Test URL
https://api.nodehost.cloud/post_services_container_package_install?container=qufs5be1noatmopoauak8atzghfhlvvc0be&package=9

Response

{
"data": "Package install is processing",
"system_connection": "true",
"system_version": "v_75_891a854",
"system_user_id": 1232,
"system_user_username": "apiuser",
"system_process_id": 1103120,
"system_process_command": "services_container_package_install"
}



POST - Container Create Domain
Allows you to setup the main domain on a container, just provide a the container ID and the domain you want to use.

Request URL
https://api.nodehost.cloud/post_services_container_create_domain

Parameters
container - The ID of the container
domain - The domain you want created

More info
None

Test URL
https://api.nodehost.cloud/post_services_container_create_domain?container=qufs5be1noatmopoauak8atzghfhlvvc0be&domain=example.com

Response

{
"data": "Container domain getting created",
"system_connection": "true",
"system_version": "v2_13_0479254b3b77f74b9f4ed2aa56a7514457000bd8",
"system_user_id": 1232,
"system_user_username": "apiuser",
"system_process_id": 1103113,
"system_process_command": "services_container_create_domain"
}



POST - Container Destroy Domain
Allows you to remove a domain from a container, just provide a the container ID and the domain you want to remove.

Request URL
https://api.nodehost.cloud/post_services_container_destroy_domain

Parameters
container - The ID of the container
domain - The domain you want removed (primary only)

More info
Keep in mind this will remove the main domain from the container resulting in all files getting deleted on the container in the web directory and all Mail related accounts and DNS.

Test URL
https://api.nodehost.cloud/post_services_container_destroy_domain?container=qufs5be1noatmopoauak8atzghfhlvvc0be&domain=example.com

Response

{
"data": "Container domain getting destroyed",
"system_connection": "true",
"system_version": "v2_13_0479254b3b77f74b9f4ed2aa56a7514457000bd8",
"system_user_id": 1232,
"system_user_username": "apiuser",
"system_process_id": 1103113,
"system_process_command": "services_container_destroy_domain"
}



POST - Container Create Domain Secondary
Allows you to setup the secondary domain on a container, just provide a the container ID and the domain you want to use.

Request URL
https://api.nodehost.cloud/post_services_container_create_domain_secondary

Parameters
container - The ID of the container
domain - The domain you want created

More info
Secondary domains get full a DNS zone that can be edited where aliases don't. As a note secondary domains do not get a new mail zone.

Test URL
https://api.nodehost.cloud/post_services_container_create_domain_secondary?container=qufs5be1noatmopoauak8atzghfhlvvc0be&domain=secondary.myws.ca

Response

{
"data": "Container secondary domain getting created",
"system_connection": "true",
"system_function": "post_services_container_create_domain_secondary",
"system_runtime": 0,
"system_version": "pub_23",
"system_user_id": 1232,
"system_user_username": "apiuser",
"system_process_id": 1103113,
"system_process_command": "services_container_create_domain_secondary"
}



POST - Container Destroy Domain Secondary
Allows you to remove the secondary domain on a container, just provide a the container ID and the domain.

Request URL
https://api.nodehost.cloud/post_services_container_destroy_domain_secondary

Parameters
container - The ID of the container
domain - The domain of the secondary domain

More info
None

Test URL
https://api.nodehost.cloud/post_services_container_destroy_domain_secondary?container=qufs5be1noatmopoauak8atzghfhlvvc0be&domain=secondary.myws.ca

Response

{
"data": "Container secondary domain getting destroyed",
"system_connection": "true",
"system_function": "post_services_container_destroy_domain_secondary",
"system_runtime": 0,
"system_version": "pub_23",
"system_user_id": 1232,
"system_user_username": "apiuser",
"system_process_id": 1103113,
"system_process_command": "services_container_destroy_domain_secondary"
}



POST - Container Create Domain Alias
Allows you to setup a domain alias, just provide a the container ID and the alias you want to use.

Request URL
https://api.nodehost.cloud/post_services_container_create_domain_alias

Parameters
container - The ID of the container
alias - The alias you want created

More info
None

Test URL
https://api.nodehost.cloud/post_services_container_create_domain_alias?container=qufs5be1noatmopoauak8atzghfhlvvc0be&alias=subdomain.example.com

Response

{
"data": "Container domain alias getting created",
"system_connection": "true",
"system_version": "v_72_6ce3c8b",
"system_user_id": 1232,
"system_user_username": "apiuser"
}



POST - Container Destroy Domain Alias
Allows you to remove a domain alias, just provide a the container ID and the alias you want to remove.

Request URL
https://api.nodehost.cloud/post_services_container_destroy_domain_alias

Parameters
container - The ID of the container
alias - The alias you want removed

More info
None

Test URL
https://api.nodehost.cloud/post_services_container_destroy_domain_alias?container=qufs5be1noatmopoauak8atzghfhlvvc0be&alias=subdomain.example.com

Response

{
"data": "Container domain alias getting destroyed",
"system_connection": "true",
"system_version": "v_73_8e345b7",
"system_user_id": 1232,
"system_user_username": "apiuser"
}



POST - Container Create Let's Encrypt
Allows you to setup Let's Encrypt automaticly, just provide a the container ID.

Request URL
https://api.nodehost.cloud/post_services_container_create_letsencrypt

Parameters
container - The ID of the container

More info
None

Test URL
https://api.nodehost.cloud/post_services_container_create_letsencrypt?container=qufs5be1noatmopoauak8atzghfhlvvc0be

Response

{
"data": "LE setup in progress",
"system_connection": "true",
"system_version": "v_67_a563469",
"system_user_id": "1232",
"system_user_username": "apiuser"
}



POST - Container Destroy Let's Encrypt
Allows you to remove a containers certificate, just provide a the container ID.

Request URL
https://api.nodehost.cloud/post_services_container_destroy_letsencrypt

Parameters
container - The ID of the container

More info
None

Test URL
https://api.nodehost.cloud/post_services_container_destroy_letsencrypt

Response

{
"data": "LE destroy in progress",
"system_connection": "true",
"system_version": "v_67_a563469",
"system_user_id": "1232",
"system_user_username": "apiuser"
}



GET - Container Backups
Gets a list of all backups available.

Request URL
https://api.nodehost.cloud/get_services_container_backups

Parameters
container - The container ID

More info
None

Test URL
https://api.nodehost.cloud/get_services_container_backups?container=qufs5be1noatmopoauak8atzghfhlvvc0be

Response
{
"data": [
{
"name": "dgaepe.2020-02-21_03-08-01.tar",
"size": 1,
"age_ago": "18 hours, 58 minutes, 4 seconds ago",
"restore": "true",
"delete": "true",
"download": "true",
"download_url": "https://internal-backups.nodehost.ca/storage/n7/backup/dgaepe.2020-02-21_03-08-01.tar"
},
{
"name": "dgaepe.2020-02-20_03-08-01.tar",
"size": 1,
"age_ago": "1 day, 18 hours, 58 minutes, 40 seconds ago",
"restore": "true",
"delete": "true",
"download": "true",
"download_url": "https://internal-backups.nodehost.ca/storage/n7/backup/dgaepe.2020-02-20_03-08-01.tar"
},
{
"name": "dgaepe.2020-02-19_03-07-01.tar",
"size": 1,
"age_ago": "2 days, 18 hours, 59 minutes, 21 seconds ago",
"restore": "true",
"delete": "true",
"download": "true",
"download_url": "https://internal-backups.nodehost.ca/storage/n7/backup/dgaepe.2020-02-19_03-07-01.tar"
},
{
"name": "dgaepe.2020-02-18_03-07-01.tar",
"size": 1,
"age_ago": "3 days, 18 hours, 59 minutes, 45 seconds ago",
"restore": "true",
"delete": "true",
"download": "true",
"download_url": "https://internal-backups.nodehost.ca/storage/n7/backup/dgaepe.2020-02-18_03-07-01.tar"
},
{
"name": "dgaepe.2020-02-17_03-06-01.tar",
"size": 1,
"age_ago": "4 days, 19 hours, 46 seconds ago",
"restore": "true",
"delete": "true",
"download": "true",
"download_url": "https://internal-backups.nodehost.ca/storage/n7/backup/dgaepe.2020-02-17_03-06-01.tar"
},
{
"name": "dgaepe.2020-02-16_03-06-02.tar",
"size": 1,
"age_ago": "5 days, 19 hours, 12 seconds ago",
"restore": "true",
"delete": "true",
"download": "true",
"download_url": "https://internal-backups.nodehost.ca/storage/n7/backup/dgaepe.2020-02-16_03-06-02.tar"
}
],
"system_connection": "true",
"system_version": "v2_121_a4eb04b4760af1097e1bfa254cc9d115d342c9f1",
"system_user_id": 1232,
"system_user_username": "apiuser",
"system_process_id": "false",
"system_process_command": "false"
}



POST - Container Create Backup
Create a backup on a container.

Request URL
https://api.nodehost.cloud/post_services_container_create_backup

Parameters
container - The ID of the container

More info
There will be no return for backup other than account notification due to this system being processed external from the container. To check if the job was processed you should pull a updated backup list and check.

Test URL
https://api.nodehost.cloud/post_services_container_create_backup?container=qufs5be1noatmopoauak8atzghfhlvvc0be

Response

{
"data": "Container backup is getting created",
"system_connection": "true",
"system_function": "post_services_container_create_backup",
"system_runtime": 0,
"system_version": "pub_23",
"system_user_id": 1232,
"system_user_username": "apiuser",
"system_process_id": 1103113,
"system_process_command": "services_container_create_backup"
}



POST - Container Destroy Backup
Destroy a backup on a container.

Request URL
https://api.nodehost.cloud/post_services_container_destroy_backup

Parameters
container - The ID of the container
backup - The file name of the backup

More info
There will be no return for backup other than account notification due to this system being processed external from the container. To check if the job was processed you should pull a updated backup list and check.

Test URL
https://api.nodehost.cloud/post_services_container_destroy_backup?container=qufs5be1noatmopoauak8atzghfhlvvc0be&backup=dgaepe.2020-02-17_03-06-01.tar

Response

{
"data": "Container backup is getting destroyed",
"system_connection": "true",
"system_function": "post_services_container_destroy_backup",
"system_runtime": 0,
"system_version": "pub_23",
"system_user_id": 1232,
"system_user_username": "apiuser",
"system_process_id": 1103113,
"system_process_command": "services_container_destroy_backup"
}



POST - Container Restore Backup
Restore a backup on a container.

Request URL
https://api.nodehost.cloud/post_services_container_restore_backup

Parameters
container - The ID of the container
backup - The file name of the backup

More info
There will be no return for backup other than account notification due to this system being processed external from the container. To check if the job was processed you should pull a updated backup list and check.

Test URL
https://api.nodehost.cloud/post_services_container_restore_backup?container=qufs5be1noatmopoauak8atzghfhlvvc0be&backup=dgaepe.2020-02-17_03-06-01.tar

Response

{
"data": "Container backup is getting restored",
"system_connection": "true",
"system_function": "post_services_container_restore_backup",
"system_runtime": 0,
"system_version": "pub_23",
"system_user_id": 1232,
"system_user_username": "apiuser",
"system_process_id": 1103113,
"system_process_command": "services_container_restore_backup"
}



GET - Container Mail
Gets a list of all mail accounts.

Request URL
https://api.nodehost.cloud/get_services_container_mail

Parameters
container - The container ID

More info
Unlike some other non user set inputs passwords for mail and databases are user given and as such are NOT stored on the system in any way.

Test URL
https://api.nodehost.cloud/get_services_container_mail?container=qufs5be1noatmopoauak8atzghfhlvvc0be

Response
{
"data": [
{
"address": "email@dgaepe.n7.myws.ca",
"disk": 0,
"alias": "alias,anotheralias",
"forward": "false",
"redirect_only": "false",
"auto_reply": "no"
}
],
"system_connection": "true",
"system_version": "v2_127_9ee1ad15587c7ad860818b8a0ba9f398979b2969",
"system_user_id": 1232,
"system_user_username": "apiuser",
"system_process_id": "false",
"system_process_command": "false"
}



GET - Container DNS
Gets a list of all dns records for any domains set.

Request URL
https://api.nodehost.cloud/get_services_container_dns

Parameters
container - The container ID

More info
None

Test URL
https://api.nodehost.cloud/get_services_container_dns?container=qufs5be1noatmopoauak8atzghfhlvvc0be

Response
{
"data": [
{
"domain": "dgaepe.n7.myws.ca",
"record": [
{
"id": 1,
"record": "@",
"type": "NS",
"priority": 10,
"value": "lisa-n7.myws.ca"
},
{
"id": 2,
"record": "@",
"type": "NS",
"priority": 10,
"value": "mike-n7.myws.ca"
},
{
"id": 9,
"record": "@",
"type": "A",
"priority": 10,
"value": "159.203.29.179"
},
{
"id": 10,
"record": "mail",
"type": "A",
"priority": 10,
"value": "159.203.29.179"
},
{
"id": 11,
"record": "www",
"type": "A",
"priority": 10,
"value": "159.203.29.179"
},
{
"id": 12,
"record": "pop",
"type": "A",
"priority": 10,
"value": "159.203.29.179"
},
{
"id": 13,
"record": "ftp",
"type": "A",
"priority": 10,
"value": "159.203.29.179"
},
{
"id": 14,
"record": "@",
"type": "MX",
"priority": 10,
"value": "mail.dgaepe.n7.myws.ca"
},
{
"id": 15,
"record": "@",
"type": "TXT",
"priority": 10,
"value": "v=spf1 a mx ip4:159.203.29.179 ?all"
},
{
"id": 16,
"record": "_dmarc",
"type": "TXT",
"priority": 10,
"value": "v=DMARC1; p=none"
},
{
"id": 17,
"record": "_domainkey",
"type": "TXT",
"priority": 10,
"value": "t=y; o=~;"
},
{
"id": 18,
"record": "mail._domainkey",
"type": "TXT",
"priority": 10,
"value": "v=DKIM1; k=rsa; p=MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQCbCTzyIZ0m6RVnmQOMwTwybZ8q4ufiaERW/j/olJ/f4Q6Iicbic/uqK/Zt7ApfhVhL4UHeWjIghsGlt4fdMxtNiTa5Bq/SehC4N2lBaX5LCzgfw3xTNEy8+kp6E4Oemq9OWvVgdjbtEoi/MseV/iaiBhthayNglDpCk4UGAyeRHQIDAQAB"
}
]
}
],
"system_connection": "true",
"system_version": "v2_129_26986406be0538ae846af83902d465884466b69f",
"system_user_id": 1232,
"system_user_username": "apiuser",
"system_process_id": "false",
"system_process_command": "false"
}



GET - Container Databases
Gets a list of all databases.

Request URL
https://api.nodehost.cloud/get_services_container_databases

Parameters
container - The container ID

More info
Unlike some other non user set inputs passwords for mail and databases are user given and as such are NOT stored on the system in any way.

Test URL
https://api.nodehost.cloud/get_services_container_databases?container=qufs5be1noatmopoauak8atzghfhlvvc0be

Response
{
"data": [
{
"database_name": "dgaepe_db",
"database_user": "dgaepe_db"
}
],
"system_connection": "true",
"system_version": "v2_132_0e6eb86b9c4e310bb4d687dd91ec1e79be266957",
"system_user_id": 1232,
"system_user_username": "apiuser",
"system_process_id": "false",
"system_process_command": "false"
}
Was this article helpful?
Cancel
Thank you!