Introduction
Our HTTP REST API allows you to manage vital details of your account and services in client portal. JSON is used for all API returns
Use left menu to browse trough available methods, use right menu to check required parameters, data to post and code samples in various languages.
Swagger Doc: You can download or display the JSON to generate documentation in Swagger.
Authentication
Basic Authentication
# pass the correct header with each request (-u option)
curl 'https://hosting.mybizcloud.at/api/details' \
-u "username:password"
use GuzzleHttp\Client;
$client = new Client([
'base_uri' => 'https://hosting.mybizcloud.at/api/',
'auth' => ['username', 'password']
]);
$resp = $client->get('details');
# python requests module handles basic authentication if provided with auth parameter
payload = username
req = requests.get('https://hosting.mybizcloud.at/api/details', auth=('username', 'password'))
print(req.json())
Make sure to replace
usernameandpasswordwith your client area details.
This authentication method requires that you send your client area username (email address) and password with each request.
API calls that require authentication expect a header in the form of
Authorization: Basic <credentials>, where credentials is the Base64 encoding
of username and password joined by a single colon :.
For example:
Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==
You can find more info on this authentication method here: Basic HTTP Authentication
Clientarea
Login
Generate new authorization token
POST_DATA="{
\"username\": \"user@example.com\",
\"password\": \"secret\"
}"
curl -X POST "https://hosting.mybizcloud.at/api/login" \
-H "Content-Type: application/json" \
-d "${POST_DATA}"
use GuzzleHttp\Client;
$client = new Client([
'base_uri' => 'https://hosting.mybizcloud.at/api/',
]);
$options = [
'json' => [
"username" => "user@example.com",
"password" => "secret"
]
]
$resp = $client->post('login', $options);
echo $resp->getBody();
payload = {
'username': "user@example.com",
'password': "secret"
}
req = requests.post('https://hosting.mybizcloud.at/api/login', json=payload)
print(req.json())
Example Response:
{
"token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJpc3MiOiJodHRw(...)5lZ9T79ft9uwOkqRRmIBbtR51_w",
"refresh": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiIzMD(...)ChwIAb3zvxBu6kvULa2AwAt9U-I"
}
HTTP Request
POST /login
Query Parameters
| Parameter | Type | Description |
|---|---|---|
| username | string |
Your acount email address |
| password | string |
Account password |
Logout
Invalidate authorization token
curl -X POST "https://hosting.mybizcloud.at/api/logout" \
-u user:pass
use GuzzleHttp\Client;
$client = new Client([
'base_uri' => 'https://hosting.mybizcloud.at/api/',
'auth' => ['username', 'password']
]);
$resp = $client->post('logout');
echo $resp->getBody();
auth=('username', 'password')
req = requests.post('https://hosting.mybizcloud.at/api/logout', auth=auth)
print(req.json())
Example Response:
{
"status": true
}
HTTP Request
POST /logout
Refresh Token
Generate new authorization token using refresh token
POST_DATA="{
\"refresh_token\": \"refresh_tokenValue\"
}"
curl -X POST "https://hosting.mybizcloud.at/api/token" \
-H "Content-Type: application/json" \
-d "${POST_DATA}"
use GuzzleHttp\Client;
$client = new Client([
'base_uri' => 'https://hosting.mybizcloud.at/api/',
]);
$options = [
'json' => [
"refresh_token" => "refresh_tokenValue"
]
]
$resp = $client->post('token', $options);
echo $resp->getBody();
payload = {
'refresh_token': "refresh_tokenValue"
}
req = requests.post('https://hosting.mybizcloud.at/api/token', json=payload)
print(req.json())
Example Response:
{
"token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJpc3MiOiJodHR(...)vY2xlYiHGvauCWZD9B0VwXgHEzXDllqY",
"refresh": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJBQ(...)Rmivc_u3YA_kgDqOPtUuGNXOzueXYtZw"
}
HTTP Request
POST /token
Query Parameters
| Parameter | Type | Description |
|---|---|---|
| refresh_token | string |
Refresh token previously obtained from |
Revoke Token
Invalidate authorization and refresh token. Pass refresh token or call this method with valid access token
POST_DATA="{
\"refresh_token\": \"refresh_tokenValue\"
}"
curl -X POST "https://hosting.mybizcloud.at/api/revoke" \
-H "Content-Type: application/json" \
-d "${POST_DATA}"
use GuzzleHttp\Client;
$client = new Client([
'base_uri' => 'https://hosting.mybizcloud.at/api/',
]);
$options = [
'json' => [
"refresh_token" => "refresh_tokenValue"
]
]
$resp = $client->post('revoke', $options);
echo $resp->getBody();
payload = {
'refresh_token': "refresh_tokenValue"
}
req = requests.post('https://hosting.mybizcloud.at/api/revoke', json=payload)
print(req.json())
Example Response:
{
"status": true
}
HTTP Request
POST /revoke
Query Parameters
| Parameter | Type | Description |
|---|---|---|
| refresh_token | string |
User Details
Return registration details for my account
curl -X GET "https://hosting.mybizcloud.at/api/details" \
-u user:pass
use GuzzleHttp\Client;
$client = new Client([
'base_uri' => 'https://hosting.mybizcloud.at/api/',
'auth' => ['username', 'password']
]);
$resp = $client->get('details');
echo $resp->getBody();
auth=('username', 'password')
req = requests.get('https://hosting.mybizcloud.at/api/details', auth=auth)
print(req.json())
Example Response:
{
"client": {
"id": "26",
"email": "api@example.com",
"lastlogin": "2016-12-30 12:24:28",
"ip": "172.100.2.1",
"host": "hostname",
"firstname": "Joe",
"lastname": "Doe",
"companyname": "",
"address1": "Pretty View Lane",
"address2": "3294",
"city": "Santa Rosa",
"state": "California",
"postcode": "95401",
"country": "US",
"phonenumber": "+1.24123123"
}
}
HTTP Request
GET /details
Update User Details
Update registration details under my account
POST_DATA="{
\"email\": \"emailValue\",
\"firstname\": \"firstnameValue\",
\"lastname\": \"lastnameValue\",
\"companyname\": \"companynameValue\",
\"address1\": \"address1Value\",
\"address2\": \"address2Value\",
\"city\": \"cityValue\",
\"state\": \"stateValue\",
\"postcode\": \"postcodeValue\",
\"country\": \"countryValue\",
\"phonenumber\": \"phonenumberValue\",
\"type\": \"typeValue\"
}"
curl -X PUT "https://hosting.mybizcloud.at/api/details" \
-u user:pass \
-H "Content-Type: application/json" \
-d "${POST_DATA}"
use GuzzleHttp\Client;
$client = new Client([
'base_uri' => 'https://hosting.mybizcloud.at/api/',
'auth' => ['username', 'password']
]);
$options = [
'json' => [
"email" => "emailValue",
"firstname" => "firstnameValue",
"lastname" => "lastnameValue",
"companyname" => "companynameValue",
"address1" => "address1Value",
"address2" => "address2Value",
"city" => "cityValue",
"state" => "stateValue",
"postcode" => "postcodeValue",
"country" => "countryValue",
"phonenumber" => "phonenumberValue",
"type" => "typeValue"
]
]
$resp = $client->put('details', $options);
echo $resp->getBody();
payload = {
'email': "emailValue",
'firstname': "firstnameValue",
'lastname': "lastnameValue",
'companyname': "companynameValue",
'address1': "address1Value",
'address2': "address2Value",
'city': "cityValue",
'state': "stateValue",
'postcode': "postcodeValue",
'country': "countryValue",
'phonenumber': "phonenumberValue",
'type': "typeValue"
}
auth=('username', 'password')
req = requests.put('https://hosting.mybizcloud.at/api/details', json=payload, auth=auth)
print(req.json())
Example Response:
{
"client": {
"id": "26",
"email": "api@example.com",
"lastlogin": "2016-12-30 12:34:20",
"ip": "172.100.2.1",
"host": "hostname",
"firstname": "Joe",
"lastname": "Doe",
"companyname": "",
"address1": "Pretty View Lane",
"address2": "3194",
"city": "Santa Rosa",
"state": "California",
"postcode": "95401",
"country": "US",
"phonenumber": "+1.24123123"
},
"info": [
"client_info_updated"
]
}
HTTP Request
PUT /details
Query Parameters
| Parameter | Type | Description |
|---|---|---|
string |
Email Address |
|
| firstname | string |
First Name |
| lastname | string |
Last Name |
| companyname | string |
Organization |
| address1 | string |
Address 1 |
| address2 | string |
Address 2 |
| city | string |
City |
| state | string |
State |
| postcode | string |
Post code |
| country | string |
Country |
| phonenumber | string |
Phone |
| type | string |
Account Type
Available values:
|
User Logs
Returns logs from history
curl -X GET "https://hosting.mybizcloud.at/api/logs" \
-u user:pass
use GuzzleHttp\Client;
$client = new Client([
'base_uri' => 'https://hosting.mybizcloud.at/api/',
'auth' => ['username', 'password']
]);
$resp = $client->get('logs');
echo $resp->getBody();
auth=('username', 'password')
req = requests.get('https://hosting.mybizcloud.at/api/logs', auth=auth)
print(req.json())
HTTP Request
GET /logs
List contacts
Return a list of contacts on this account
curl -X GET "https://hosting.mybizcloud.at/api/contact" \
-u user:pass
use GuzzleHttp\Client;
$client = new Client([
'base_uri' => 'https://hosting.mybizcloud.at/api/',
'auth' => ['username', 'password']
]);
$resp = $client->get('contact');
echo $resp->getBody();
auth=('username', 'password')
req = requests.get('https://hosting.mybizcloud.at/api/contact', auth=auth)
print(req.json())
Example Response:
{
"contacts": [
{
"email": "mary@example.com",
"id": "49",
"firstname": "Mary",
"lastname": "Sue",
"companyname": "",
"company": "0",
"lastlogin": "0000-00-00 00:00:00"
}
]
}
HTTP Request
GET /contact
Add contact
Create new contact account, if password is provided you can use provided email addres to login as that contact.
POST_DATA="{
\"password\": \"passwordValue\",
\"privileges\": \"privilegesValue\",
\"email\": \"emailValue\",
\"firstname\": \"firstnameValue\",
\"lastname\": \"lastnameValue\",
\"companyname\": \"companynameValue\",
\"address1\": \"address1Value\",
\"address2\": \"address2Value\",
\"city\": \"cityValue\",
\"state\": \"stateValue\",
\"postcode\": \"postcodeValue\",
\"country\": \"countryValue\",
\"phonenumber\": \"phonenumberValue\",
\"type\": \"typeValue\"
}"
curl -X POST "https://hosting.mybizcloud.at/api/contact" \
-u user:pass \
-H "Content-Type: application/json" \
-d "${POST_DATA}"
use GuzzleHttp\Client;
$client = new Client([
'base_uri' => 'https://hosting.mybizcloud.at/api/',
'auth' => ['username', 'password']
]);
$options = [
'json' => [
"password" => "passwordValue",
"privileges" => "privilegesValue",
"email" => "emailValue",
"firstname" => "firstnameValue",
"lastname" => "lastnameValue",
"companyname" => "companynameValue",
"address1" => "address1Value",
"address2" => "address2Value",
"city" => "cityValue",
"state" => "stateValue",
"postcode" => "postcodeValue",
"country" => "countryValue",
"phonenumber" => "phonenumberValue",
"type" => "typeValue"
]
]
$resp = $client->post('contact', $options);
echo $resp->getBody();
payload = {
'password': "passwordValue",
'privileges': "privilegesValue",
'email': "emailValue",
'firstname': "firstnameValue",
'lastname': "lastnameValue",
'companyname': "companynameValue",
'address1': "address1Value",
'address2': "address2Value",
'city': "cityValue",
'state': "stateValue",
'postcode': "postcodeValue",
'country': "countryValue",
'phonenumber': "phonenumberValue",
'type': "typeValue"
}
auth=('username', 'password')
req = requests.post('https://hosting.mybizcloud.at/api/contact', json=payload, auth=auth)
print(req.json())
Example Response:
{
"contact_id": "1",
"info": [
"profile_added"
]
}
HTTP Request
POST /contact
Query Parameters
| Parameter | Type | Description |
|---|---|---|
| password | string |
Optional, allows you to login as contact |
| privileges | array |
Array with privileges that you want to enable. Formatted the same way as output from |
string |
Email Address |
|
| firstname | string |
First Name |
| lastname | string |
Last Name |
| companyname | string |
Organization |
| address1 | string |
Address 1 |
| address2 | string |
Address 2 |
| city | string |
City |
| state | string |
State |
| postcode | string |
Post code |
| country | string |
Country |
| phonenumber | string |
Phone |
| type | string |
Account Type
Available values:
|
Contact privileges
List possible contact privileges.
Each domain and service may list additional privileges, depending on available features.
curl -X GET "https://hosting.mybizcloud.at/api/contact/privileges" \
-u user:pass
use GuzzleHttp\Client;
$client = new Client([
'base_uri' => 'https://hosting.mybizcloud.at/api/',
'auth' => ['username', 'password']
]);
$resp = $client->get('contact/privileges');
echo $resp->getBody();
auth=('username', 'password')
req = requests.get('https://hosting.mybizcloud.at/api/contact/privileges', auth=auth)
print(req.json())
Example Response:
{
"privileges": {
"billing": [
"emails", // Receive billing notifications
"payinvoice", // Allow to view/pay invoices
"orders", // Allow to place new orders
"balance", // View account balance
"addfunds", // Add account funds
"creditcard" // Edit Credit Card details
],
"support": [
"newticket", // Open new tickets
"tickets", // View all tickets
"closeticket", // Close tickets
"emails" // Receive email notifications from support
],
"misc": [
"editmain", // Modify main profile details
"emails", // View emails history
"editipaccess", // Edit allowed IP access
"manageprofiles", // Add / Edit contacts
"affiliates" // Access affiliates section
],
"services": {
"full": 1, // Full control over services
"332": [
"basic", // View basic details
"billing", // View billing info
"cancelation", // Request cancellation
"upgrade", // Upgrade / Downgrade
"notify", // Receive related email notifications
(...)
"logindetails"
]
},
"domains": {
"full": 1, // Full control over domains
"523": [
"basic", // View basic details
"renew", // Renew domain
"notify", // Receive related email notifications
"contactinfo", // Contact Information
(...)
"nameservers" // Manage Nameservers
]
}
}
}
HTTP Request
GET /contact/privileges
Get contacts details
Return array with contact details
curl -X GET "https://hosting.mybizcloud.at/api/contact/@id" \
-u user:pass
use GuzzleHttp\Client;
$client = new Client([
'base_uri' => 'https://hosting.mybizcloud.at/api/',
'auth' => ['username', 'password']
]);
$resp = $client->get('contact/@id');
echo $resp->getBody();
auth=('username', 'password')
req = requests.get('https://hosting.mybizcloud.at/api/contact/@id', auth=auth)
print(req.json())
Example Response:
{
"contact": {
"id": "49",
"email": "mary@example.com",
"firstname": "Mary",
"lastname": "Sue",
"companyname": "",
"address1": "Pretty View Lane",
"address2": "3194",
"city": "Santa Rosa",
"state": "California",
"postcode": "95401",
"country": "US",
"phonenumber": "+1.24123123",
"type": "Private",
"privileges" : {
"support" : ["tickets", "newticket"]
}
}
}
HTTP Request
GET /contact/@id
Query Parameters
| Parameter | Type | Description |
|---|---|---|
| id | int |
Contact ID |
Edit contact
Change contact details`
POST_DATA="{
\"id\": \"idValue\",
\"privileges\": \"privilegesValue\",
\"email\": \"emailValue\",
\"firstname\": \"firstnameValue\",
\"lastname\": \"lastnameValue\",
\"companyname\": \"companynameValue\",
\"address1\": \"address1Value\",
\"address2\": \"address2Value\",
\"city\": \"cityValue\",
\"state\": \"stateValue\",
\"postcode\": \"postcodeValue\",
\"country\": \"countryValue\",
\"phonenumber\": \"phonenumberValue\",
\"type\": \"typeValue\"
}"
curl -X PUT "https://hosting.mybizcloud.at/api/contact/@id" \
-u user:pass \
-H "Content-Type: application/json" \
-d "${POST_DATA}"
use GuzzleHttp\Client;
$client = new Client([
'base_uri' => 'https://hosting.mybizcloud.at/api/',
'auth' => ['username', 'password']
]);
$options = [
'json' => [
"id" => "idValue",
"privileges" => "privilegesValue",
"email" => "emailValue",
"firstname" => "firstnameValue",
"lastname" => "lastnameValue",
"companyname" => "companynameValue",
"address1" => "address1Value",
"address2" => "address2Value",
"city" => "cityValue",
"state" => "stateValue",
"postcode" => "postcodeValue",
"country" => "countryValue",
"phonenumber" => "phonenumberValue",
"type" => "typeValue"
]
]
$resp = $client->put('contact/@id', $options);
echo $resp->getBody();
payload = {
'id': "idValue",
'privileges': "privilegesValue",
'email': "emailValue",
'firstname': "firstnameValue",
'lastname': "lastnameValue",
'companyname': "companynameValue",
'address1': "address1Value",
'address2': "address2Value",
'city': "cityValue",
'state': "stateValue",
'postcode': "postcodeValue",
'country': "countryValue",
'phonenumber': "phonenumberValue",
'type': "typeValue"
}
auth=('username', 'password')
req = requests.put('https://hosting.mybizcloud.at/api/contact/@id', json=payload, auth=auth)
print(req.json())
Example Response:
{
"info": [
"profile_updated"
]
}
HTTP Request
PUT /contact/@id
Query Parameters
| Parameter | Type | Description |
|---|---|---|
| id | int |
Contact ID |
| privileges | array |
Array with privileges that you want to enable. Formatted the same way as output from |
string |
Email Address |
|
| firstname | string |
First Name |
| lastname | string |
Last Name |
| companyname | string |
Organization |
| address1 | string |
Address 1 |
| address2 | string |
Address 2 |
| city | string |
City |
| state | string |
State |
| postcode | string |
Post code |
| country | string |
Country |
| phonenumber | string |
Phone |
| type | string |
Account Type
Available values:
|
Domains
List Domains
List domains under your account
curl -X GET "https://hosting.mybizcloud.at/api/domain" \
-u user:pass
use GuzzleHttp\Client;
$client = new Client([
'base_uri' => 'https://hosting.mybizcloud.at/api/',
'auth' => ['username', 'password']
]);
$resp = $client->get('domain');
echo $resp->getBody();
auth=('username', 'password')
req = requests.get('https://hosting.mybizcloud.at/api/domain', auth=auth)
print(req.json())
Example Response:
{
"domains": [
{
"id": "47",
"name": "testname.com",
"expires": "2017-12-30",
"recurring_amount": "15.00",
"date_created": "2016-12-30",
"status": "Active",
"period": "1",
"autorenew": "1",
"daytoexpire": "365"
}
]
}
HTTP Request
GET /domain
Domain details
Get domain details
curl -X GET "https://hosting.mybizcloud.at/api/domain/@id" \
-u user:pass
use GuzzleHttp\Client;
$client = new Client([
'base_uri' => 'https://hosting.mybizcloud.at/api/',
'auth' => ['username', 'password']
]);
$resp = $client->get('domain/@id');
echo $resp->getBody();
auth=('username', 'password')
req = requests.get('https://hosting.mybizcloud.at/api/domain/@id', auth=auth)
print(req.json())
Example Response:
{
"details": {
"id": "47",
"name": "testname.com",
"date_created": "2016-12-30",
"firstpayment": "10.00",
"recurring_amount": "15.00",
"period": "1",
"expires": "2017-12-30",
"status": "Active",
"next_due": "2017-12-30",
"next_invoice": "2017-11-30",
"idprotection": "0",
"nameservers": [
"ns1.example.com",
"ns2.example.com",
"ns3.example.com",
"ns4.example.com"
],
"autorenew": "1"
}
}
HTTP Request
GET /domain/@id
Query Parameters
| Parameter | Type | Description |
|---|---|---|
| id | int |
Domain id |
Domain details by name
Get domain details by name
curl -X GET "https://hosting.mybizcloud.at/api/domain/name/@name" \
-u user:pass
use GuzzleHttp\Client;
$client = new Client([
'base_uri' => 'https://hosting.mybizcloud.at/api/',
'auth' => ['username', 'password']
]);
$resp = $client->get('domain/name/@name');
echo $resp->getBody();
auth=('username', 'password')
req = requests.get('https://hosting.mybizcloud.at/api/domain/name/@name', auth=auth)
print(req.json())
Example Response:
{
"details": [
{
"id": "47",
"name": "testname.com",
"date_created": "2016-12-30",
"firstpayment": "10.00",
"recurring_amount": "15.00",
"period": "1",
"expires": "2017-12-30",
"status": "Active",
"next_due": "2017-12-30",
"next_invoice": "2017-11-30",
"idprotection": "0",
"nameservers": [
"ns1.example.com",
"ns2.example.com",
"ns3.example.com",
"ns4.example.com"
],
"autorenew": "1"
},
{
"id": "48",
"name": "testname.com",
"date_created": "2016-05-30",
"firstpayment": "10.00",
"recurring_amount": "15.00",
"period": "1",
"expires": "2017-05-30",
"status": "Expired",
"next_due": "2017-05-30",
"next_invoice": "2017-04-30",
"idprotection": "0",
"nameservers": [
"ns1.example.com",
"ns2.example.com",
"ns3.example.com",
"ns4.example.com"
],
"autorenew": "1"
},
]
}
HTTP Request
GET /domain/name/@name
Query Parameters
| Parameter | Type | Description |
|---|---|---|
| name | string |
Domain name |
Get domain nameservers
curl -X GET "https://hosting.mybizcloud.at/api/domain/@id/ns" \
-u user:pass
use GuzzleHttp\Client;
$client = new Client([
'base_uri' => 'https://hosting.mybizcloud.at/api/',
'auth' => ['username', 'password']
]);
$resp = $client->get('domain/@id/ns');
echo $resp->getBody();
auth=('username', 'password')
req = requests.get('https://hosting.mybizcloud.at/api/domain/@id/ns', auth=auth)
print(req.json())
HTTP Request
GET /domain/@id/ns
Query Parameters
| Parameter | Type | Description |
|---|---|---|
| id | int |
Domain id |
Update domain nameservers
Change domain nameservers, if $nameservers is left empty, default namesevers will be used
POST_DATA="{
\"id\": \"idValue\",
\"nameservers\": \"nameserversValue\"
}"
curl -X PUT "https://hosting.mybizcloud.at/api/domain/@id/ns" \
-u user:pass \
-H "Content-Type: application/json" \
-d "${POST_DATA}"
use GuzzleHttp\Client;
$client = new Client([
'base_uri' => 'https://hosting.mybizcloud.at/api/',
'auth' => ['username', 'password']
]);
$options = [
'json' => [
"id" => "idValue",
"nameservers" => "nameserversValue"
]
]
$resp = $client->put('domain/@id/ns', $options);
echo $resp->getBody();
payload = {
'id': "idValue",
'nameservers': "nameserversValue"
}
auth=('username', 'password')
req = requests.put('https://hosting.mybizcloud.at/api/domain/@id/ns', json=payload, auth=auth)
print(req.json())
Example Response:
{
"info": [
"success_changes_save"
]
}
HTTP Request
PUT /domain/@id/ns
Query Parameters
| Parameter | Type | Description |
|---|---|---|
| id | int |
Domain id |
| nameservers | array |
List of nameservers to use |
Register domain nameservers
POST_DATA="{
\"id\": \"idValue\"
}"
curl -X POST "https://hosting.mybizcloud.at/api/domain/@id/reg" \
-u user:pass \
-H "Content-Type: application/json" \
-d "${POST_DATA}"
use GuzzleHttp\Client;
$client = new Client([
'base_uri' => 'https://hosting.mybizcloud.at/api/',
'auth' => ['username', 'password']
]);
$options = [
'json' => [
"id" => "idValue"
]
]
$resp = $client->post('domain/@id/reg', $options);
echo $resp->getBody();
payload = {
'id': "idValue"
}
auth=('username', 'password')
req = requests.post('https://hosting.mybizcloud.at/api/domain/@id/reg', json=payload, auth=auth)
print(req.json())
HTTP Request
POST /domain/@id/reg
Query Parameters
| Parameter | Type | Description |
|---|---|---|
| id | int |
Domain id |
DNS Records DNS Records
List DNS records
curl -X GET "https://hosting.mybizcloud.at/api/domain/@id/dns" \
-u user:pass
use GuzzleHttp\Client;
$client = new Client([
'base_uri' => 'https://hosting.mybizcloud.at/api/',
'auth' => ['username', 'password']
]);
$resp = $client->get('domain/@id/dns');
echo $resp->getBody();
auth=('username', 'password')
req = requests.get('https://hosting.mybizcloud.at/api/domain/@id/dns', auth=auth)
print(req.json())
Example Response:
{
"records": [
{
"id": 1,
"name": "test",
"ttl": 0,
"priority": 0,
"type": "A",
"content": "100.100.10.1"
}
]
}
HTTP Request
GET /domain/@id/dns
Query Parameters
| Parameter | Type | Description |
|---|---|---|
| id | int |
Domain id |
Create DNS Records
Add a new DNS record
POST_DATA="{
\"id\": \"idValue\",
\"name\": \"nameValue\",
\"type\": \"typeValue\",
\"priority\": \"priorityValue\",
\"content\": \"contentValue\"
}"
curl -X POST "https://hosting.mybizcloud.at/api/domain/@id/dns" \
-u user:pass \
-H "Content-Type: application/json" \
-d "${POST_DATA}"
use GuzzleHttp\Client;
$client = new Client([
'base_uri' => 'https://hosting.mybizcloud.at/api/',
'auth' => ['username', 'password']
]);
$options = [
'json' => [
"id" => "idValue",
"name" => "nameValue",
"type" => "typeValue",
"priority" => "priorityValue",
"content" => "contentValue"
]
]
$resp = $client->post('domain/@id/dns', $options);
echo $resp->getBody();
payload = {
'id': "idValue",
'name': "nameValue",
'type': "typeValue",
'priority': "priorityValue",
'content': "contentValue"
}
auth=('username', 'password')
req = requests.post('https://hosting.mybizcloud.at/api/domain/@id/dns', json=payload, auth=auth)
print(req.json())
Example Response:
{
"info": [
"DNS Management updated successfully"
]
}
HTTP Request
POST /domain/@id/dns
Query Parameters
| Parameter | Type | Description |
|---|---|---|
| id | int |
Domain id |
| name | string |
Reord name |
| type | string |
Reord type |
| priority | string |
Reord priority |
| content | string |
Reord content eg. IP addres for A records |
Update DNS Records
Change a DNS record
POST_DATA="{
\"id\": \"idValue\",
\"record_id\": \"record_idValue\",
\"name\": \"nameValue\",
\"type\": \"typeValue\",
\"priority\": \"priorityValue\",
\"content\": \"contentValue\"
}"
curl -X PUT "https://hosting.mybizcloud.at/api/domain/@id/dns/@index" \
-u user:pass \
-H "Content-Type: application/json" \
-d "${POST_DATA}"
use GuzzleHttp\Client;
$client = new Client([
'base_uri' => 'https://hosting.mybizcloud.at/api/',
'auth' => ['username', 'password']
]);
$options = [
'json' => [
"id" => "idValue",
"record_id" => "record_idValue",
"name" => "nameValue",
"type" => "typeValue",
"priority" => "priorityValue",
"content" => "contentValue"
]
]
$resp = $client->put('domain/@id/dns/@index', $options);
echo $resp->getBody();
payload = {
'id': "idValue",
'record_id': "record_idValue",
'name': "nameValue",
'type': "typeValue",
'priority': "priorityValue",
'content': "contentValue"
}
auth=('username', 'password')
req = requests.put('https://hosting.mybizcloud.at/api/domain/@id/dns/@index', json=payload, auth=auth)
print(req.json())
Example Response:
{
"info": [
"DNS Management updated successfully"
]
}
HTTP Request
PUT /domain/@id/dns/@index
Query Parameters
| Parameter | Type | Description |
|---|---|---|
| id | int |
Domain id |
| record_id | int |
Recod index |
| name | string |
Record name |
| type | string |
Record type |
| priority | string |
Record priority |
| content | string |
Record content eg. IP address for A records |
Remove DNS Records
Remove a DNS record
curl -X DELETE "https://hosting.mybizcloud.at/api/domain/@id/dns/@index" \
-u user:pass
use GuzzleHttp\Client;
$client = new Client([
'base_uri' => 'https://hosting.mybizcloud.at/api/',
'auth' => ['username', 'password']
]);
$resp = $client->delete('domain/@id/dns/@index');
echo $resp->getBody();
auth=('username', 'password')
req = requests.delete('https://hosting.mybizcloud.at/api/domain/@id/dns/@index', auth=auth)
print(req.json())
Example Response:
{
"info": [
"DNS Management updated successfully"
]
}
HTTP Request
DELETE /domain/@id/dns/@index
Query Parameters
| Parameter | Type | Description |
|---|---|---|
| id | int |
Domain id |
| record_id | int |
Recod index |
DNS Records Types
List supported records type
curl -X GET "https://hosting.mybizcloud.at/api/domain/@id/dns/types" \
-u user:pass
use GuzzleHttp\Client;
$client = new Client([
'base_uri' => 'https://hosting.mybizcloud.at/api/',
'auth' => ['username', 'password']
]);
$resp = $client->get('domain/@id/dns/types');
echo $resp->getBody();
auth=('username', 'password')
req = requests.get('https://hosting.mybizcloud.at/api/domain/@id/dns/types', auth=auth)
print(req.json())
Example Response:
{
"types": [
"A",
"CNAME",
"URL",
"FRAME",
"MX",
"MXE",
"TXT"
]
}
HTTP Request
GET /domain/@id/dns/types
Query Parameters
| Parameter | Type | Description |
|---|---|---|
| id | int |
Domain id |
Synchronize domain
curl -X GET "https://hosting.mybizcloud.at/api/domain/@id/sync" \
-u user:pass
use GuzzleHttp\Client;
$client = new Client([
'base_uri' => 'https://hosting.mybizcloud.at/api/',
'auth' => ['username', 'password']
]);
$resp = $client->get('domain/@id/sync');
echo $resp->getBody();
auth=('username', 'password')
req = requests.get('https://hosting.mybizcloud.at/api/domain/@id/sync', auth=auth)
print(req.json())
HTTP Request
GET /domain/@id/sync
Query Parameters
| Parameter | Type | Description |
|---|---|---|
| id | int |
Domain id |
Get domain lock
curl -X GET "https://hosting.mybizcloud.at/api/domain/@id/reglock" \
-u user:pass
use GuzzleHttp\Client;
$client = new Client([
'base_uri' => 'https://hosting.mybizcloud.at/api/',
'auth' => ['username', 'password']
]);
$resp = $client->get('domain/@id/reglock');
echo $resp->getBody();
auth=('username', 'password')
req = requests.get('https://hosting.mybizcloud.at/api/domain/@id/reglock', auth=auth)
print(req.json())
HTTP Request
GET /domain/@id/reglock
Query Parameters
| Parameter | Type | Description |
|---|---|---|
| id | int |
Domain id |
Update domain lock
POST_DATA="{
\"id\": \"idValue\",
\"switch\": true
}"
curl -X PUT "https://hosting.mybizcloud.at/api/domain/@id/reglock" \
-u user:pass \
-H "Content-Type: application/json" \
-d "${POST_DATA}"
use GuzzleHttp\Client;
$client = new Client([
'base_uri' => 'https://hosting.mybizcloud.at/api/',
'auth' => ['username', 'password']
]);
$options = [
'json' => [
"id" => "idValue",
"switch" => TRUE
]
]
$resp = $client->put('domain/@id/reglock', $options);
echo $resp->getBody();
payload = {
'id': "idValue",
'switch': true
}
auth=('username', 'password')
req = requests.put('https://hosting.mybizcloud.at/api/domain/@id/reglock', json=payload, auth=auth)
print(req.json())
HTTP Request
PUT /domain/@id/reglock
Query Parameters
| Parameter | Type | Description |
|---|---|---|
| id | int |
Domain id |
| switch | bool |
Enable or disable domain lock, use true to enable. |
Update domain ID Protection
POST_DATA="{
\"id\": \"idValue\",
\"switch\": true
}"
curl -X PUT "https://hosting.mybizcloud.at/api/domain/@id/idprotection" \
-u user:pass \
-H "Content-Type: application/json" \
-d "${POST_DATA}"
use GuzzleHttp\Client;
$client = new Client([
'base_uri' => 'https://hosting.mybizcloud.at/api/',
'auth' => ['username', 'password']
]);
$options = [
'json' => [
"id" => "idValue",
"switch" => TRUE
]
]
$resp = $client->put('domain/@id/idprotection', $options);
echo $resp->getBody();
payload = {
'id': "idValue",
'switch': true
}
auth=('username', 'password')
req = requests.put('https://hosting.mybizcloud.at/api/domain/@id/idprotection', json=payload, auth=auth)
print(req.json())
HTTP Request
PUT /domain/@id/idprotection
Query Parameters
| Parameter | Type | Description |
|---|---|---|
| id | int |
Domain id |
| switch | bool |
Enable or disable ID orotection, use true to enable. |
Get domain contact info
curl -X GET "https://hosting.mybizcloud.at/api/domain/@id/contact" \
-u user:pass
use GuzzleHttp\Client;
$client = new Client([
'base_uri' => 'https://hosting.mybizcloud.at/api/',
'auth' => ['username', 'password']
]);
$resp = $client->get('domain/@id/contact');
echo $resp->getBody();
auth=('username', 'password')
req = requests.get('https://hosting.mybizcloud.at/api/domain/@id/contact', auth=auth)
print(req.json())
Example Response:
{
"success": true,
"domain_id": "428",
"contact_info": {
"registrant": {
"firstname": "",
"lastname": "",
"companyname": "",
"email": "",
"phonenumber": "",
"address1": "",
"address2": "",
"city": "",
"state": "",
"postcode": "",
"country": ""
},
"tech": {
"firstname": "",
"lastname": "",
"companyname": "",
"email": "",
"phonenumber": "",
"address1": "",
"address2": "",
"city": "",
"state": "",
"postcode": "",
"country": ""
},
"admin": {
"firstname": "",
"lastname": "",
"companyname": "",
"email": "",
"phonenumber": "",
"address1": "",
"address2": "",
"city": "",
"state": "",
"postcode": "",
"country": ""
},
"billing": {
"firstname": "",
"lastname": "",
"companyname": "",
"email": "",
"phonenumber": "",
"address1": "",
"address2": "",
"city": "",
"state": "",
"postcode": "",
"country": ""
}
}
}
HTTP Request
GET /domain/@id/contact
Query Parameters
| Parameter | Type | Description |
|---|---|---|
| id | int |
Domain id |
Update domain contact info
POST_DATA="{
\"id\": \"idValue\",
\"contact_info\": \"contact_infoValue\"
}"
curl -X PUT "https://hosting.mybizcloud.at/api/domain/@id/contact" \
-u user:pass \
-H "Content-Type: application/json" \
-d "${POST_DATA}"
use GuzzleHttp\Client;
$client = new Client([
'base_uri' => 'https://hosting.mybizcloud.at/api/',
'auth' => ['username', 'password']
]);
$options = [
'json' => [
"id" => "idValue",
"contact_info" => "contact_infoValue"
]
]
$resp = $client->put('domain/@id/contact', $options);
echo $resp->getBody();
payload = {
'id': "idValue",
'contact_info': "contact_infoValue"
}
auth=('username', 'password')
req = requests.put('https://hosting.mybizcloud.at/api/domain/@id/contact', json=payload, auth=auth)
print(req.json())
Example Response:
{
"success": true,
"domain_id": "428",
"info": [
"request_contacts_sent"
]
}
HTTP Request
PUT /domain/@id/contact
Query Parameters
| Parameter | Type | Description |
|---|---|---|
| id | int |
Domain id |
| contact_info | array |
Get email forwarding
curl -X GET "https://hosting.mybizcloud.at/api/domain/@id/emforwarding" \
-u user:pass
use GuzzleHttp\Client;
$client = new Client([
'base_uri' => 'https://hosting.mybizcloud.at/api/',
'auth' => ['username', 'password']
]);
$resp = $client->get('domain/@id/emforwarding');
echo $resp->getBody();
auth=('username', 'password')
req = requests.get('https://hosting.mybizcloud.at/api/domain/@id/emforwarding', auth=auth)
print(req.json())
HTTP Request
GET /domain/@id/emforwarding
Query Parameters
| Parameter | Type | Description |
|---|---|---|
| id | int |
Domain id |
Update email forwarding
POST_DATA="{
\"id\": \"idValue\",
\"from\": \"info@domain.com\",
\"to\": \"destination@domain.com\"
}"
curl -X PUT "https://hosting.mybizcloud.at/api/domain/@id/emforwarding" \
-u user:pass \
-H "Content-Type: application/json" \
-d "${POST_DATA}"
use GuzzleHttp\Client;
$client = new Client([
'base_uri' => 'https://hosting.mybizcloud.at/api/',
'auth' => ['username', 'password']
]);
$options = [
'json' => [
"id" => "idValue",
"from" => "info@domain.com",
"to" => "destination@domain.com"
]
]
$resp = $client->put('domain/@id/emforwarding', $options);
echo $resp->getBody();
payload = {
'id': "idValue",
'from': "info@domain.com",
'to': "destination@domain.com"
}
auth=('username', 'password')
req = requests.put('https://hosting.mybizcloud.at/api/domain/@id/emforwarding', json=payload, auth=auth)
print(req.json())
HTTP Request
PUT /domain/@id/emforwarding
Query Parameters
| Parameter | Type | Description |
|---|---|---|
| id | int |
Domain id |
| from | string |
Email address that you want to forward |
| to | string |
Email address that will receive forwarded emails |
Update domain forwarding
POST_DATA="{
\"id\": \"idValue\"
}"
curl -X PUT "https://hosting.mybizcloud.at/api/domain/@id/forwarding" \
-u user:pass \
-H "Content-Type: application/json" \
-d "${POST_DATA}"
use GuzzleHttp\Client;
$client = new Client([
'base_uri' => 'https://hosting.mybizcloud.at/api/',
'auth' => ['username', 'password']
]);
$options = [
'json' => [
"id" => "idValue"
]
]
$resp = $client->put('domain/@id/forwarding', $options);
echo $resp->getBody();
payload = {
'id': "idValue"
}
auth=('username', 'password')
req = requests.put('https://hosting.mybizcloud.at/api/domain/@id/forwarding', json=payload, auth=auth)
print(req.json())
HTTP Request
PUT /domain/@id/forwarding
Query Parameters
| Parameter | Type | Description |
|---|---|---|
| id | int |
Domain id |
Get domain autorenew
curl -X GET "https://hosting.mybizcloud.at/api/domain/@id/autorenew" \
-u user:pass
use GuzzleHttp\Client;
$client = new Client([
'base_uri' => 'https://hosting.mybizcloud.at/api/',
'auth' => ['username', 'password']
]);
$resp = $client->get('domain/@id/autorenew');
echo $resp->getBody();
auth=('username', 'password')
req = requests.get('https://hosting.mybizcloud.at/api/domain/@id/autorenew', auth=auth)
print(req.json())
Example Response:
{
"success": true,
"autorenew": null
}
HTTP Request
GET /domain/@id/autorenew
Query Parameters
| Parameter | Type | Description |
|---|---|---|
| id | int |
Domain id |
Enable/disable domain autorenew
POST_DATA="{
\"id\": \"idValue\",
\"autorenew\": \"autorenewValue\"
}"
curl -X PUT "https://hosting.mybizcloud.at/api/domain/@id/autorenew" \
-u user:pass \
-H "Content-Type: application/json" \
-d "${POST_DATA}"
use GuzzleHttp\Client;
$client = new Client([
'base_uri' => 'https://hosting.mybizcloud.at/api/',
'auth' => ['username', 'password']
]);
$options = [
'json' => [
"id" => "idValue",
"autorenew" => "autorenewValue"
]
]
$resp = $client->put('domain/@id/autorenew', $options);
echo $resp->getBody();
payload = {
'id': "idValue",
'autorenew': "autorenewValue"
}
auth=('username', 'password')
req = requests.put('https://hosting.mybizcloud.at/api/domain/@id/autorenew', json=payload, auth=auth)
print(req.json())
Example Response:
{
"success": true,
"info": [
"success_changes_save"
]
}
HTTP Request
PUT /domain/@id/autorenew
Query Parameters
| Parameter | Type | Description |
|---|---|---|
| id | int |
Domain id |
| autorenew | bool |
Returns the available flags
curl -X GET "https://hosting.mybizcloud.at/api/domain/@id/dnssec/flags" \
-u user:pass
use GuzzleHttp\Client;
$client = new Client([
'base_uri' => 'https://hosting.mybizcloud.at/api/',
'auth' => ['username', 'password']
]);
$resp = $client->get('domain/@id/dnssec/flags');
echo $resp->getBody();
auth=('username', 'password')
req = requests.get('https://hosting.mybizcloud.at/api/domain/@id/dnssec/flags', auth=auth)
print(req.json())
HTTP Request
GET /domain/@id/dnssec/flags
Query Parameters
| Parameter | Type | Description |
|---|---|---|
| id | int |
Domain id |
Returns the list of DNSSEC keys
curl -X GET "https://hosting.mybizcloud.at/api/domain/@id/dnssec" \
-u user:pass
use GuzzleHttp\Client;
$client = new Client([
'base_uri' => 'https://hosting.mybizcloud.at/api/',
'auth' => ['username', 'password']
]);
$resp = $client->get('domain/@id/dnssec');
echo $resp->getBody();
auth=('username', 'password')
req = requests.get('https://hosting.mybizcloud.at/api/domain/@id/dnssec', auth=auth)
print(req.json())
HTTP Request
GET /domain/@id/dnssec
Query Parameters
| Parameter | Type | Description |
|---|---|---|
| id | int |
Domain id |
Adds the DNSSEC key
POST_DATA="{
\"id\": \"idValue\"
}"
curl -X PUT "https://hosting.mybizcloud.at/api/domain/@id/dnssec" \
-u user:pass \
-H "Content-Type: application/json" \
-d "${POST_DATA}"
use GuzzleHttp\Client;
$client = new Client([
'base_uri' => 'https://hosting.mybizcloud.at/api/',
'auth' => ['username', 'password']
]);
$options = [
'json' => [
"id" => "idValue"
]
]
$resp = $client->put('domain/@id/dnssec', $options);
echo $resp->getBody();
payload = {
'id': "idValue"
}
auth=('username', 'password')
req = requests.put('https://hosting.mybizcloud.at/api/domain/@id/dnssec', json=payload, auth=auth)
print(req.json())
HTTP Request
PUT /domain/@id/dnssec
Query Parameters
| Parameter | Type | Description |
|---|---|---|
| id | int |
Domain id |
curl -X DELETE "https://hosting.mybizcloud.at/api/domain/@id/dnssec/@key" \
-u user:pass
use GuzzleHttp\Client;
$client = new Client([
'base_uri' => 'https://hosting.mybizcloud.at/api/',
'auth' => ['username', 'password']
]);
$resp = $client->delete('domain/@id/dnssec/@key');
echo $resp->getBody();
auth=('username', 'password')
req = requests.delete('https://hosting.mybizcloud.at/api/domain/@id/dnssec/@key', auth=auth)
print(req.json())
HTTP Request
DELETE /domain/@id/dnssec/@key
Query Parameters
| Parameter | Type | Description |
|---|---|---|
| id | int |
Domain id |
Services
List services
List all services under your account
curl -X GET "https://hosting.mybizcloud.at/api/service" \
-u user:pass
use GuzzleHttp\Client;
$client = new Client([
'base_uri' => 'https://hosting.mybizcloud.at/api/',
'auth' => ['username', 'password']
]);
$resp = $client->get('service');
echo $resp->getBody();
auth=('username', 'password')
req = requests.get('https://hosting.mybizcloud.at/api/service', auth=auth)
print(req.json())
Example Response:
{
"services": [
{
"id": "301",
"domain": "examplename.com",
"total": "9.99",
"status": "Pending",
"billingcycle": "Monthly",
"next_due": "2017-12-30",
"category": "Hosting",
"category_url": "hosting",
"name": "Starter Hosting"
}
]
}
HTTP Request
GET /service
Service details
Return details for service @id
curl -X GET "https://hosting.mybizcloud.at/api/service/@id" \
-u user:pass
use GuzzleHttp\Client;
$client = new Client([
'base_uri' => 'https://hosting.mybizcloud.at/api/',
'auth' => ['username', 'password']
]);
$resp = $client->get('service/@id');
echo $resp->getBody();
auth=('username', 'password')
req = requests.get('https://hosting.mybizcloud.at/api/service/@id', auth=auth)
print(req.json())
Example Response:
{
"service": {
"id": "301",
"date_created": "2016-12-30",
"domain": "examplename.com",
"firstpayment": "9.99",
"total": "9.99",
"billingcycle": "Monthly",
"next_due": "2017-12-30",
"next_invoice": "2017-01-27",
"status": "Active",
"label": "",
"username": "examplen",
"password": "pdtzc",
"name": "Starter Hosting"
}
}
HTTP Request
GET /service/@id
Query Parameters
| Parameter | Type | Description |
|---|---|---|
| id | int |
Service id |
List service methods
List methods available for service
curl -X GET "https://hosting.mybizcloud.at/api/service/@id/methods" \
-u user:pass
use GuzzleHttp\Client;
$client = new Client([
'base_uri' => 'https://hosting.mybizcloud.at/api/',
'auth' => ['username', 'password']
]);
$resp = $client->get('service/@id/methods');
echo $resp->getBody();
auth=('username', 'password')
req = requests.get('https://hosting.mybizcloud.at/api/service/@id/methods', auth=auth)
print(req.json())
Example Response:
{
"methods": [
{
"name": "Upgrade Request",
"method": "POST",
"route": "\/service\/@id\/upgrade"
},
{
"name": "Upgrade Options",
"method": "GET",
"route": "\/service\/@id\/upgrade"
},
{
"name": "Change service label",
"method": "POST",
"route": "\/service\/@id\/label"
},
{
"name": "Service label",
"method": "GET",
"route": "\/service\/@id\/label"
},
{
"name": "Cancel Service",
"method": "POST",
"route": "\/service\/@id\/cancel"
}
]
}
HTTP Request
GET /service/@id/methods
Service label
Show current service label
curl -X GET "https://hosting.mybizcloud.at/api/service/@id/label" \
-u user:pass
use GuzzleHttp\Client;
$client = new Client([
'base_uri' => 'https://hosting.mybizcloud.at/api/',
'auth' => ['username', 'password']
]);
$resp = $client->get('service/@id/label');
echo $resp->getBody();
auth=('username', 'password')
req = requests.get('https://hosting.mybizcloud.at/api/service/@id/label', auth=auth)
print(req.json())
Example Response:
{
"label": "example"
}
HTTP Request
GET /service/@id/label
Query Parameters
| Parameter | Type | Description |
|---|---|---|
| id | int |
Service id |
Change service label
Set new custom label to identify this service
POST_DATA="{
\"id\": \"idValue\",
\"label\": \"labelValue\"
}"
curl -X POST "https://hosting.mybizcloud.at/api/service/@id/label" \
-u user:pass \
-H "Content-Type: application/json" \
-d "${POST_DATA}"
use GuzzleHttp\Client;
$client = new Client([
'base_uri' => 'https://hosting.mybizcloud.at/api/',
'auth' => ['username', 'password']
]);
$options = [
'json' => [
"id" => "idValue",
"label" => "labelValue"
]
]
$resp = $client->post('service/@id/label', $options);
echo $resp->getBody();
payload = {
'id': "idValue",
'label': "labelValue"
}
auth=('username', 'password')
req = requests.post('https://hosting.mybizcloud.at/api/service/@id/label', json=payload, auth=auth)
print(req.json())
Example Response:
{
"success": true,
"info": [
"label_updated"
]
}
HTTP Request
POST /service/@id/label
Query Parameters
| Parameter | Type | Description |
|---|---|---|
| id | int |
Service id |
| label | string |
New label |
List Billing Cycle
Get recurring billing cycle options
curl -X GET "https://hosting.mybizcloud.at/api/service/@id/cycle" \
-u user:pass
use GuzzleHttp\Client;
$client = new Client([
'base_uri' => 'https://hosting.mybizcloud.at/api/',
'auth' => ['username', 'password']
]);
$resp = $client->get('service/@id/cycle');
echo $resp->getBody();
auth=('username', 'password')
req = requests.get('https://hosting.mybizcloud.at/api/service/@id/cycle', auth=auth)
print(req.json())
Example Response:
{
"current": "m",
"cycles": {
"m": "14.95",
"a": "179.40",
"b": "358.80"
}
}
HTTP Request
GET /service/@id/cycle
Query Parameters
| Parameter | Type | Description |
|---|---|---|
| id | int |
Service id |
Cart
Most of API methods found here will require service @id, you can lookup your service ids with /service method
List product categories
Return a list of product categories.
curl -X GET "https://hosting.mybizcloud.at/api/category" \
-u user:pass
use GuzzleHttp\Client;
$client = new Client([
'base_uri' => 'https://hosting.mybizcloud.at/api/',
'auth' => ['username', 'password']
]);
$resp = $client->get('category');
echo $resp->getBody();
auth=('username', 'password')
req = requests.get('https://hosting.mybizcloud.at/api/category', auth=auth)
print(req.json())
Example Response:
{
"categories": [
{
"id": "10",
"name": "Hosting",
"description": "",
"slug": "hosting"
},
{
"id": "6",
"name": "Domains",
"description": "",
"slug": "domains"
},
{
"id": "16",
"name": "Dedicated",
"description": "",
"slug": "dedicated"
}
]
}
HTTP Request
GET /category
List products in category
Return a list of product available for purchase under requested category
curl -X GET "https://hosting.mybizcloud.at/api/category/@category_id/product" \
-u user:pass
use GuzzleHttp\Client;
$client = new Client([
'base_uri' => 'https://hosting.mybizcloud.at/api/',
'auth' => ['username', 'password']
]);
$resp = $client->get('category/@category_id/product');
echo $resp->getBody();
auth=('username', 'password')
req = requests.get('https://hosting.mybizcloud.at/api/category/@category_id/product', auth=auth)
print(req.json())
Example Response:
{
"products": [
{
"id": "333",
"type": "1",
"name": "Starter Hosting",
"stock": false,
"paytype": "Regular",
"description": "Disk:10GB
Memory:2GB
MySql:10 DB
Email:100 Users
",
"qty": "0",
"tags": [
],
"periods": [
{
"title": "m",
"value": "m",
"price": 9.99,
"setup": 0,
"selected": true
},
{
"title": "a",
"value": "a",
"price": 109.89,
"setup": 0,
"selected": false
},
{
"title": "b",
"value": "b",
"price": 199.8,
"setup": 0,
"selected": false
},
{
"title": "t",
"value": "t",
"price": 299.7,
"setup": 0,
"selected": false
}
]
},
(...)
]
}
HTTP Request
GET /category/@category_id/product
Query Parameters
| Parameter | Type | Description |
|---|---|---|
| category_id | int |
Category ID |
Get product configuration details
Return product details with form configuration, addons and subproducts if available.
curl -X GET "https://hosting.mybizcloud.at/api/order/@product_id" \
-u user:pass
use GuzzleHttp\Client;
$client = new Client([
'base_uri' => 'https://hosting.mybizcloud.at/api/',
'auth' => ['username', 'password']
]);
$resp = $client->get('order/@product_id');
echo $resp->getBody();
auth=('username', 'password')
req = requests.get('https://hosting.mybizcloud.at/api/order/@product_id', auth=auth)
print(req.json())
Example Response:
{
"product": {
"id": "333",
"category_name": "Hosting",
"category_id": "49",
"name": "Starter Hosting",
"price": 9.99,
"recurring": "m",
"setup": 0,
"config": {
"product": [
{
"type": "select",
"title": "pickcycle",
"id": "cycle",
"name": "cycle",
"items": [
{
"title": "m",
"value": "m",
"price": 9.99,
"setup": 0,
"selected": true
},
{
"title": "a",
"value": "a",
"price": 109.89,
"setup": 0,
"selected": false
},
{
"title": "b",
"value": "b",
"price": 199.8,
"setup": 0,
"selected": false
},
{
"title": "t",
"value": "t",
"price": 299.7,
"setup": 0,
"selected": false
}
],
"value": "m",
"price": 9.99,
"setup": 0
},
{
"type": "input",
"title": "domain",
"id": "domain",
"name": "domain",
"value": null
}
],
"forms": [
{
"type": "select",
"title": "Disk Size",
"id": "1618",
"firstItemId": 10330,
"description": "",
"name": "custom[1618]",
"required": false,
"multiple": false,
"config": {
"conditionals": []
},
"value": [],
"textvalue": [],
"price": 0,
"recurring_price": 0,
"setup": 0,
"prorata_date": null,
"items": [
{
"title": "512MB",
"value": 1,
"id": 10330,
"price": 0,
"setup": 0,
"selected": false
},
{
"title": "1GB",
"value": 1,
"id": 10331,
"price": 0,
"setup": 0,
"selected": false
},
{
"title": "2GB",
"value": 1,
"id": 10332,
"price": 0,
"setup": 0,
"selected": false
}
]
},
(...)
],
"addons": [
{
"type": "subitem",
"title": "Cpanel2: Add Extra IP",
"id": "31",
"value": null,
"description": "Automatically adds IP address to account",
"config": [
{
"type": "checkbox",
"title": "add",
"name": "addon[31]",
"checked": false
},
{
"type": "select",
"title": "billingcycle",
"name": "addon_cycles[31]",
"items": [
{
"title": "m",
"value": "m",
"price": 5,
"setup": 0,
"selected": true
},
{
"title": "q",
"value": "q",
"price": 20,
"setup": 0,
"selected": false
},
{
"title": "a",
"value": "a",
"price": 50,
"setup": 0,
"selected": false
}
]
}
],
"price": 0,
"recurring_price": 0,
"setup": 0,
"prorata_date": null
},
(...)
],
"subproducts": []
},
"recurring_price": 9.99,
"prorata_date": null
}
}
HTTP Request
GET /order/@product_id
Query Parameters
| Parameter | Type | Description |
|---|---|---|
| product_id | int |
Product ID |
DNS
List DNS
Returns a list of all DNS
curl -X GET "https://hosting.mybizcloud.at/api/dns" \
-u user:pass
use GuzzleHttp\Client;
$client = new Client([
'base_uri' => 'https://hosting.mybizcloud.at/api/',
'auth' => ['username', 'password']
]);
$resp = $client->get('dns');
echo $resp->getBody();
auth=('username', 'password')
req = requests.get('https://hosting.mybizcloud.at/api/dns', auth=auth)
print(req.json())
Example Response:
{
"service_ids": [
"10",
"20"
],
"zones": [
{
"domain_id": "60",
"name": "qwerty.com",
"service_id": "10"
},
{
"domain_id": "61",
"name": "bgg12ooble.com",
"service_id": "20"
}
]
}
HTTP Request
GET /dns
Add DNS Zone
Creates a new DNS zone
POST_DATA="{
\"service_id\": \"service_idValue\",
\"name\": \"testzone.com\"
}"
curl -X POST "https://hosting.mybizcloud.at/api/service/@service_id/dns" \
-u user:pass \
-H "Content-Type: application/json" \
-d "${POST_DATA}"
use GuzzleHttp\Client;
$client = new Client([
'base_uri' => 'https://hosting.mybizcloud.at/api/',
'auth' => ['username', 'password']
]);
$options = [
'json' => [
"service_id" => "service_idValue",
"name" => "testzone.com"
]
]
$resp = $client->post('service/@service_id/dns', $options);
echo $resp->getBody();
payload = {
'service_id': "service_idValue",
'name': "testzone.com"
}
auth=('username', 'password')
req = requests.post('https://hosting.mybizcloud.at/api/service/@service_id/dns', json=payload, auth=auth)
print(req.json())
Example Response:
{
"info": [
"Domain zone testzone.com was created successfully."
]
}
HTTP Request
POST /service/@service_id/dns
Query Parameters
| Parameter | Type | Description |
|---|---|---|
| service_id | int |
Service ID |
| name | string |
Zone name |
List DNS for service
Returns a list of DNS zones under the service
curl -X GET "https://hosting.mybizcloud.at/api/service/@service_id/dns" \
-u user:pass
use GuzzleHttp\Client;
$client = new Client([
'base_uri' => 'https://hosting.mybizcloud.at/api/',
'auth' => ['username', 'password']
]);
$resp = $client->get('service/@service_id/dns');
echo $resp->getBody();
auth=('username', 'password')
req = requests.get('https://hosting.mybizcloud.at/api/service/@service_id/dns', auth=auth)
print(req.json())
Example Response:
{
"error": [
"invalid method"
]
}
HTTP Request
GET /service/@service_id/dns
Query Parameters
| Parameter | Type | Description |
|---|---|---|
| service_id | int |
Service ID |
Get DNS details
Returns details of the DNS zone
curl -X GET "https://hosting.mybizcloud.at/api/service/@service_id/dns/@zone_id" \
-u user:pass
use GuzzleHttp\Client;
$client = new Client([
'base_uri' => 'https://hosting.mybizcloud.at/api/',
'auth' => ['username', 'password']
]);
$resp = $client->get('service/@service_id/dns/@zone_id');
echo $resp->getBody();
auth=('username', 'password')
req = requests.get('https://hosting.mybizcloud.at/api/service/@service_id/dns/@zone_id', auth=auth)
print(req.json())
Example Response:
{
"service_id": 10,
"name": "qwerty.com",
"records": [
{
"id":"10",
"name":"qwerty",
"ttl":1800,
"priority":0,
"content":"127.0.0.1",
"type":"A"
},
{
"id":"11",
"name":"qwerty",
"ttl":1800,
"priority":0,
"content":"ns1.qwerty.com",
"type":"NS"
}
]
}
HTTP Request
GET /service/@service_id/dns/@zone_id
Query Parameters
| Parameter | Type | Description |
|---|---|---|
| service_id | int |
Service ID |
| zone_id | int |
Zone ID |
Remove DNS zone
Deletes the selected DNS zone
curl -X DELETE "https://hosting.mybizcloud.at/api/service/@service_id/dns/@zone_id" \
-u user:pass
use GuzzleHttp\Client;
$client = new Client([
'base_uri' => 'https://hosting.mybizcloud.at/api/',
'auth' => ['username', 'password']
]);
$resp = $client->delete('service/@service_id/dns/@zone_id');
echo $resp->getBody();
auth=('username', 'password')
req = requests.delete('https://hosting.mybizcloud.at/api/service/@service_id/dns/@zone_id', auth=auth)
print(req.json())
Example Response:
{
"info": [
"Domain zone testzone.com was deleted successfully."
]
}
HTTP Request
DELETE /service/@service_id/dns/@zone_id
Query Parameters
| Parameter | Type | Description |
|---|---|---|
| service_id | int |
Service ID |
| zone_id | int |
Zone ID |
Add DNS Record
Creates a new record in the DNS zone
POST_DATA="{
\"service_id\": \"service_idValue\",
\"zone_id\": \"zone_idValue\",
\"name\": \"example.com\",
\"ttl\": 3600,
\"priority\": 10,
\"type\": \"A\",
\"content\": \"192.168.1.2\"
}"
# OR ...
POST_DATA="{
\"service_id\": \"service_idValue\",
\"zone_id\": \"zone_idValue\",
\"name\": \"_sip._tcp.example.com\",
\"ttl\": 3600,
\"priority\": 10,
\"type\": \"SRV\",
\"content\": [
10,
5060,
\"vc01.example.com\"
]
}"
curl -X POST "https://hosting.mybizcloud.at/api/service/@service_id/dns/@zone_id/records" \
-u user:pass \
-H "Content-Type: application/json" \
-d "${POST_DATA}"
use GuzzleHttp\Client;
$client = new Client([
'base_uri' => 'https://hosting.mybizcloud.at/api/',
'auth' => ['username', 'password']
]);
$options = [
'json' => [
"service_id" => "service_idValue",
"zone_id" => "zone_idValue",
"name" => "example.com",
"ttl" => 3600,
"priority" => 10,
"type" => "A",
"content" => "192.168.1.2"
]
]);
// OR ...
$options = [
'json' => [
"service_id" => "service_idValue",
"zone_id" => "zone_idValue",
"name" => "_sip._tcp.example.com",
"ttl" => 3600,
"priority" => 10,
"type" => "SRV",
"content" => [
10,
5060,
"vc01.example.com"
]
]
]);
$resp = $client->post('service/@service_id/dns/@zone_id/records', $options);
echo $resp->getBody();
payload = {
'service_id': "service_idValue",
'zone_id': "zone_idValue",
'name': "example.com",
'ttl': 3600,
'priority': 10,
'type': "A",
'content': "192.168.1.2"
}
# OR ...
payload = {
'service_id': "service_idValue",
'zone_id': "zone_idValue",
'name': "_sip._tcp.example.com",
'ttl': 3600,
'priority': 10,
'type': "SRV",
'content': [
10,
5060,
"vc01.example.com"
]
}
auth=('username', 'password')
req = requests.post('https://hosting.mybizcloud.at/api/service/@service_id/dns/@zone_id/records', json=payload, auth=auth)
print(req.json())
Example Response:
{
"record": {
"name": "_sip._tcp.example.com",
"type": "SRV",
"ttl": "3600",
"priority": "10",
"content": [
10,
5060,
"vc01.example.com"
]
},
"info": [
"dnsnewrecordadded",
"SRV"
]
}
HTTP Request
POST /service/@service_id/dns/@zone_id/records
Query Parameters
| Parameter | Type | Description |
|---|---|---|
| service_id | int |
Service ID |
| zone_id | int |
Zone ID |
| name | string |
Record name |
| ttl | int |
Record ttl |
| priority | int |
Priority of the record |
| type | string |
Record type |
| content | string |
Contents of the record |
Edit DNS Record
Edits the selected DNS zone record
POST_DATA="{
\"service_id\": \"service_idValue\",
\"zone_id\": \"zone_idValue\",
\"record_id\": \"record_idValue\",
\"name\": \"example.com\",
\"ttl\": 3600,
\"priority\": 10,
\"type\": \"A\",
\"content\": \"192.168.1.2\"
}"
curl -X PUT "https://hosting.mybizcloud.at/api/service/@service_id/dns/@zone_id/records/@record_id" \
-u user:pass \
-H "Content-Type: application/json" \
-d "${POST_DATA}"
use GuzzleHttp\Client;
$client = new Client([
'base_uri' => 'https://hosting.mybizcloud.at/api/',
'auth' => ['username', 'password']
]);
$options = [
'json' => [
"service_id" => "service_idValue",
"zone_id" => "zone_idValue",
"record_id" => "record_idValue",
"name" => "example.com",
"ttl" => 3600,
"priority" => 10,
"type" => "A",
"content" => "192.168.1.2"
]
]
$resp = $client->put('service/@service_id/dns/@zone_id/records/@record_id', $options);
echo $resp->getBody();
payload = {
'service_id': "service_idValue",
'zone_id': "zone_idValue",
'record_id': "record_idValue",
'name': "example.com",
'ttl': 3600,
'priority': 10,
'type': "A",
'content': "192.168.1.2"
}
auth=('username', 'password')
req = requests.put('https://hosting.mybizcloud.at/api/service/@service_id/dns/@zone_id/records/@record_id', json=payload, auth=auth)
print(req.json())
Example Response:
{
"record": {
"id": "55",
"type": "A",
"ttl": "3600",
"name": "test",
"priority": 0,
"content": "192.168.1.2"
},
"info": [
"The record was updated successfully."
]
}
HTTP Request
PUT /service/@service_id/dns/@zone_id/records/@record_id
Query Parameters
| Parameter | Type | Description |
|---|---|---|
| service_id | int |
Service ID |
| zone_id | int |
Zone ID |
| record_id | int |
Record ID |
| name | string |
Record name |
| ttl | int |
Record ttl |
| priority | int |
Priority of the record |
| type | string |
Record type |
| content | string |
Contents of the record |
Remove DNS Record
Removes the selected DNS zone record
curl -X DELETE "https://hosting.mybizcloud.at/api/service/@service_id/dns/@zone_id/records/@record_id" \
-u user:pass
use GuzzleHttp\Client;
$client = new Client([
'base_uri' => 'https://hosting.mybizcloud.at/api/',
'auth' => ['username', 'password']
]);
$resp = $client->delete('service/@service_id/dns/@zone_id/records/@record_id');
echo $resp->getBody();
auth=('username', 'password')
req = requests.delete('https://hosting.mybizcloud.at/api/service/@service_id/dns/@zone_id/records/@record_id', auth=auth)
print(req.json())
HTTP Request
DELETE /service/@service_id/dns/@zone_id/records/@record_id
Query Parameters
| Parameter | Type | Description |
|---|---|---|
| service_id | int |
Service ID |
| zone_id | int |
Zone ID |
| record_id | int |
Record ID |
Support
List all knowledgebase categories
Returns list all knowledgebase categories
curl -X GET "https://hosting.mybizcloud.at/api/knowledgebase" \
-u user:pass
use GuzzleHttp\Client;
$client = new Client([
'base_uri' => 'https://hosting.mybizcloud.at/api/',
'auth' => ['username', 'password']
]);
$resp = $client->get('knowledgebase');
echo $resp->getBody();
auth=('username', 'password')
req = requests.get('https://hosting.mybizcloud.at/api/knowledgebase', auth=auth)
print(req.json())
HTTP Request
GET /knowledgebase
Get knowledgebase category details
Returns subcategories and articles of the knowledgebase category
curl -X GET "https://hosting.mybizcloud.at/api/knowledgebase/@category_id" \
-u user:pass
use GuzzleHttp\Client;
$client = new Client([
'base_uri' => 'https://hosting.mybizcloud.at/api/',
'auth' => ['username', 'password']
]);
$resp = $client->get('knowledgebase/@category_id');
echo $resp->getBody();
auth=('username', 'password')
req = requests.get('https://hosting.mybizcloud.at/api/knowledgebase/@category_id', auth=auth)
print(req.json())
HTTP Request
GET /knowledgebase/@category_id
Get knowledgebase article
Returns an article details
curl -X GET "https://hosting.mybizcloud.at/api/knowledgebase/article/@article_id" \
-u user:pass
use GuzzleHttp\Client;
$client = new Client([
'base_uri' => 'https://hosting.mybizcloud.at/api/',
'auth' => ['username', 'password']
]);
$resp = $client->get('knowledgebase/article/@article_id');
echo $resp->getBody();
auth=('username', 'password')
req = requests.get('https://hosting.mybizcloud.at/api/knowledgebase/article/@article_id', auth=auth)
print(req.json())
HTTP Request
GET /knowledgebase/article/@article_id