API Documentation/en

Aus EUserv Wiki

(Unterschied zwischen Versionen)
Wechseln zu: Navigation, Suche
(→CALL PARAMETERS)
 
(Der Versionsvergleich bezieht 343 dazwischenliegende Versionen mit ein.)
Zeile 1: Zeile 1:
-
{{Languages|EUserv Reseller API Developer Guide and Reference}}
+
{{Languages|API Documentation}}
 +
[[Kategorie:Server]]
[[Kategorie:Servers]]
[[Kategorie:Servers]]
 +
[[Kategorie:Domain]]
[[Kategorie:Domain/en]]
[[Kategorie:Domain/en]]
 +
__TOC__
__TOC__
Zeile 10: Zeile 13:
=== Technology ===
=== Technology ===
-
Our API is based on the XML-RPC protocol, which is a Remote Procedure Calling protocol that works over the Internet.
+
Our API is based on the XML-RPC protocol, which is a Remote Procedure Calling protocol that works via Internet.
XML-RPC messages are HTTP-POST requests in XML (Extensible Markup Language).
XML-RPC messages are HTTP-POST requests in XML (Extensible Markup Language).
Zeile 22: Zeile 25:
</div>
</div>
-
The live environment is available over HTTPS (HTTP over SSL, Port 443) at: <br>
+
The live environment is available via HTTPS (HTTP via SSL, Port 443) at: <br>
'''– https://api.euserv.net:443''' <br>
'''– https://api.euserv.net:443''' <br>
-
For developing/testing purposes, please use the sandbox environment, which is also available over HTTPS(Port 443) at: <br>
+
For developing/testing purposes, please use the sandbox environment, which is also available via HTTPS(Port 443) at: <br>
'''– https://api.test.euserv.net:443'''
'''– https://api.test.euserv.net:443'''
Zeile 33: Zeile 36:
http://phpxmlrpc.sourceforge.net/.
http://phpxmlrpc.sourceforge.net/.
-
{|width="100%" cellspacing="0" border="2px solid"
+
{|width="100%" style="border-color:rgb(230,230,230); background-color:white;" cellpadding="5" cellspacing="0" border="2px solid"
-
|colspan="2"|
+
|colspan="2" style="background-color:rgb(230,230,230)"|
 +
 
== History of Changes ==
== History of Changes ==
|-
|-
-
|'''Version'''                    ||'''Changes'''
+
|width="50%" background-color="rgb(230,230,230)"|'''Version'''                    ||width=50%;|'''Changes'''
|-
|-
|0.5.1                            ||- Add method 'server.ipaddr_get_reverse'<br> - Add method 'server.get_possible_server_items'<br> - Add method 'server.order_server'
|0.5.1                            ||- Add method 'server.ipaddr_get_reverse'<br> - Add method 'server.get_possible_server_items'<br> - Add method 'server.order_server'
Zeile 43: Zeile 47:
|0.5.2                            || - Update method 'server.get_possible_server_items'<br> - Update method 'server.order_server'
|0.5.2                            || - Update method 'server.get_possible_server_items'<br> - Update method 'server.order_server'
|-
|-
-
|0.5.3                            || - Add method 'domain.get_domain_orders'<br>- Add method'domain.get_domain_order_details'<br> - Add method 'domain.dns_create_record'<br>
+
|0.5.3                            || - Add method 'domain.get_domain_orders'<br>- Add method'domain.get_domain_order_details'<br> - Add method 'domain.dns_create_record'<br> - Add method 'domain.dns_delete_record'<br>- Add method 'domain.dns_update_record'<br>- Add method 'domain.dns_get_active_records'<br>- Add method 'domain.redirect_create_record'<br>- Add method 'domain.redirect_delete_record'<br>- Add method 'domain.redirect_update_record'<br>- Add method 'domain.redirect_get_active_records'<br>- Add internal methods<br>
-
- Add method 'domain.dns_delete_record'<br>
+
-
- Add method 'domain.dns_update_record'<br>
+
-
- Add method 'domain.dns_get_active_records'<br>
+
-
- Add method 'domain.redirect_create_record'<br>
+
-
- Add method 'domain.redirect_delete_record'<br>
+
-
- Add method 'domain.redirect_update_record'<br>
+
-
- Add method 'domain.redirect_get_active_records'<br>
+
-
- Add internal methods<br>
+
|-
|-
|0.5.4                              ||- Add method 'server.get_traffic_graph'<br> - Update internal methods   
|0.5.4                              ||- Add method 'server.get_traffic_graph'<br> - Update internal methods   
 +
 +
|-
 +
|0.5.5                              ||- Add/Update internal methods 
 +
 +
|-
 +
|0.5.6                              ||- Add method 'domain.check'<br> - Add method 'order_external.get_possible_items'  <br> - Add method 'order_external.create_order
 +
|-
 +
 +
|0.6.9                              ||- Add method 'vserver.list_vservers'<br>- Add method 'vserver.get_details'<br>- Add method 'vserver.reset'<br>- Add method 'server.get_possible_failover_servers'<br>- Add method 'server.get_ipaddr_inetnum_list'<br>- Add method 'server.get_ipaddr_list'<br>- Add method 'server.ipaddr_assign'<br>- Add method 'server.ipaddr_release'<br>- Add method 'server.ipaddr_assign_failover'<br>- Add method 'server.ipaddr_release_failover'<br>- Update method 'server.get_details'<br>- Add/Update internal methods<br>
 +
|}
|}
<br>
<br>
 +
= Method Specifications =
= Method Specifications =
----
----
Zeile 61: Zeile 68:
The following part contains information about method calls, method parameters and method return values.<br>
The following part contains information about method calls, method parameters and method return values.<br>
Generally, if a method call was completed successfully, the return message will include the following status code:<br>
Generally, if a method call was completed successfully, the return message will include the following status code:<br>
-
{|width="100%" cellspacing="0" border="2px solid"  
+
{|width="100%" style="border-color:rgb(230,230,230); background-color:white;" cellpadding="5" cellspacing="0" border="2px solid"
|-
|-
-
|'''Field''' ||'''Type''' || '''Value'''
+
|style="background-color:rgb(230,230,230)"|'''Field''' ||style="background-color:rgb(230,230,230)"|'''Type''' ||style="background-color:rgb(230,230,230)"| '''Value'''
|-
|-
|status      ||int        ||100
|status      ||int        ||100
Zeile 72: Zeile 79:
== API Debug/Testing Methods ==
== API Debug/Testing Methods ==
=== debug.get_api_version ===
=== debug.get_api_version ===
 +
----
 +
==== PURPOSE ====
==== PURPOSE ====
This Method returns the current API version.
This Method returns the current API version.
Zeile 79: Zeile 88:
==== RETURNS ====
==== RETURNS ====
-
{|width="100%" cellspacing="0" border="2px solid"  
+
{|width="100%" style="border-color:rgb(230,230,230); background-color:white;" cellpadding="5" cellspacing="0" border="2px solid"
|-
|-
-
|'''Field''' ||'''Type''' || '''Description'''
+
|width="25%" style="background-color:rgb(230,230,230)"|'''Field / Key Name''' ||width="25%" style="background-color:rgb(230,230,230)"|'''Type''' ||width="50%" style="background-color:rgb(230,230,230)"| '''Description'''
|-
|-
|api_version      ||string        ||Current API version
|api_version      ||string        ||Current API version
Zeile 87: Zeile 96:
==== PHP EXAMPLE ====
==== PHP EXAMPLE ====
-
  <nowiki>
+
[[API Documentation RunningExamples debug.get_api_version PHP]]
-
<?php
+
 
-
//includes the class library
+
-
include_once("lib/xmlrpc.inc");
+
-
$xmlrpc_internalencoding = 'UTF-8';
+
-
$host="api.test.euserv.net";
+
-
$port=443;
+
-
$username="<API_USER>";
+
-
$password="<API_USER_PASSWORD>";
+
-
$api_path="/";
+
-
//defines the function
+
-
function debug_get_api_version($host,$port,$username,$password,$api_path)
+
-
{
+
-
//creates the serverurl
+
-
$serverurl = 'https://'.$host.':'.$port.'/'.$api_path;
+
-
//----------creates the message which will be send to the server----------
+
-
//creates the request for the XML-RPC Server
+
-
$request = new xmlrpcmsg('debug.get_api_version');
+
-
//adds parameters to the request
+
-
$request->addParam
+
-
(
+
-
//creates a value of type struct which contains an array with the username and password
+
-
new xmlrpcval
+
-
(
+
-
array
+
-
(
+
-
//creates a value of type string which contains the "$username"
+
-
'login' => new xmlrpcval($username, 'string'),
+
-
//creates a value of type string which contains the "$password"
+
-
'password' => new xmlrpcval($password, 'string')
+
-
)
+
-
,'struct'
+
-
)
+
-
);
+
-
//----------creates the XML-RPC client which represent a client of an XML-RPC server----------
+
-
//creates the client
+
-
$client = new xmlrpc_client($serverurl);
+
-
//disable SSL Keycheck
+
-
$client->setSSLVerifyPeer(0);
+
-
//----------sends the request to the server and gets the response----------
+
-
//sends the request via https and writes it into $response. timeout is set to 0
+
-
$response = $client->send($request,0,'https');
+
-
//generates a storable representation of $response and writes it into $result_xml
+
-
//$result_xml = $response->serialize();
+
-
//checks the response. if the method "faultCode" returns zero, the response was succesfull
+
-
if (0==$response->faultCode())
+
-
{
+
-
//returns the value sent by the server
+
-
$value = $response->value();
+
-
//returns the actual PHP-language value of "value"
+
-
$result_obj = $value->scalarval();
+
-
//destroys "value"
+
-
unset($value);
+
-
}
+
-
else
+
-
{
+
-
//returns the faultCode and the faultString
+
-
return $error = array ( 'faultCode' => $response->faultCode(), 'faultString' => $response->faultString());
+
-
}
+
-
//destroys "client"
+
-
unset($client);
+
-
//destroys "response"
+
-
unset($response);
+
-
//----------reads the result_obj----------
+
-
//if result_obj is set then it returns the actual PHP-language value of "result_obj"
+
-
if (isset($result_obj['status']))
+
-
{
+
-
$value['status'] = $result_obj['status']->scalarval();
+
-
}
+
-
if (isset($result_obj['api_version']))
+
-
{
+
-
$value['api_version'] = $result_obj['api_version']->scalarval();
+
-
}
+
-
return $value;
+
-
}
+
-
//calls the function
+
-
$result = debug_get_api_version($host,$port,$username,$password,$api_path);
+
-
if(0==$result['faultCode'])
+
-
{
+
-
echo "Status: ".$result['status']." API-Version: ".$result['api_version'];
+
-
}
+
-
else
+
-
{
+
-
echo "faultCode: ".$result['faultCode']." faultString: ".$result['faultString'];
+
-
}
+
-
?>
+
-
  </nowiki>
+
=== debug.pingpong ===
=== debug.pingpong ===
 +
----
 +
==== PURPOSE ====
==== PURPOSE ====
This Method returns all the parameters, it was called with. You can use it to check the format of your call parameters. Notice that only supported parameter keys with correctly formatted values will be accepted!
This Method returns all the parameters, it was called with. You can use it to check the format of your call parameters. Notice that only supported parameter keys with correctly formatted values will be accepted!
Zeile 185: Zeile 111:
==== PHP EXAMPLE ====
==== PHP EXAMPLE ====
-
  <nowiki>
+
[[API Documentation RunningExamples debug.pingpong PHP]]
-
<?php
+
-
//includes the class library
+
-
include_once("lib/xmlrpc.inc");
+
-
$xmlrpc_internalencoding = 'UTF-8';
+
-
$host="api.test.euserv.net";
+
-
$port=443;
+
-
$username="<API_USER>";
+
-
$password="<API_USER_PASSWORD>";
+
-
$api_path="/";
+
-
$parameter="srv_id";
+
-
$wert = "1337";
+
-
//defines the function
+
-
function debug_pingpong($host,$port,$username,$password,$api_path,$parameter,$wert)
+
-
{
+
-
//creates the serverurl
+
-
$serverurl = 'https://'.$host.':'.$port.'/'.$api_path;
+
-
//----------creates the message which will be send to the server----------
+
-
//creates the request for the XML-RPC Server
+
-
$request = new xmlrpcmsg('debug.pingpong');
+
-
//adds parameters to the request
+
-
$request->addParam
+
-
(
+
-
//creates a value of type struct which contains an array with the username and password
+
-
new xmlrpcval
+
-
(
+
-
array
+
-
(
+
-
//creates a value of type string which contains the "$username"
+
-
'login' => new xmlrpcval($username, 'string'),
+
-
//creates a value of type string which contains the "$password"
+
-
'password' => new xmlrpcval($password, 'string'),
+
-
//creates a value of type string which contains the "$parameter"
+
-
$parameter => new xmlrpcval($wert)
+
-
)
+
-
,'struct'
+
-
)
+
-
);
+
-
//----------creates the XML-RPC client which represents a client of a XML-RPC server----------
+
-
//creates the client
+
-
$client = new xmlrpc_client($serverurl);
+
-
//disable SSL Keycheck
+
-
$client->setSSLVerifyPeer(0);
+
-
//----------sends the request to the server and gets the response----------
+
-
//sends the request via https and writes it into $response. timeout is set to 0
+
-
$response = $client->send($request,0,'https');
+
-
//generates a storable representation of $response and writes it into $result_xml
+
-
//$result_xml = $response->serialize();
+
-
//checks the response. if the method "faultCode" returns zero, the response was succesfull
+
-
if (0==$response->faultCode())
+
-
{
+
-
//returns the value sent by the server
+
-
$value = $response->value();
+
-
//returns the actual PHP-language value of "value"
+
-
$result_obj = $value->scalarval();
+
-
//destroys "value"
+
-
unset($value);
+
-
}
+
-
else
+
-
{
+
-
//returns the faultCode and the faultString
+
-
return $error = array ( 'faultCode' => $response->faultCode(), 'faultString' => $response->faultString());
+
-
}
+
-
//destroys "client"
+
-
unset($client);
+
-
//destroys "response"
+
-
unset($response);
+
-
//----------reads the result_obj----------
+
-
//if result_obj is set then it returns the actual PHP-language value of "result_obj"
+
-
if (isset($result_obj['status']))
+
-
{
+
-
$value['status'] = $result_obj['status']->scalarval();
+
-
}
+
-
if (isset($result_obj[$parameter]))
+
-
{
+
-
$value[$parameter] = $result_obj[$parameter]->scalarval();
+
-
}
+
-
return $value;
+
-
}
+
-
//calls the function
+
-
$result = debug_pingpong($host,$port,$username,$password,$api_path,$parameter,$wert);
+
-
if(!($result['faultCode']))
+
-
{
+
-
echo "Status: ".$result['status']." ".$parameter.": ".$result[$parameter];
+
-
}
+
-
else
+
-
{
+
-
echo "faultCode: ".$result['faultCode']." faultString: ".$result['faultString'];
+
-
}
+
-
?>
+
-
  </nowiki>
+
== API User-Management Methods ==
== API User-Management Methods ==
=== usermngt.create_acc ===
=== usermngt.create_acc ===
 +
----
 +
==== PURPOSE ====
==== PURPOSE ====
This Method is used to create new API user accounts
This Method is used to create new API user accounts
==== CALL PARAMETERS ====
==== CALL PARAMETERS ====
-
{|width="100%" cellspacing="0" border="2px solid"  
+
{|width="100%" style="border-color:rgb(230,230,230); background-color:white;" cellpadding="5" cellspacing="0" border="2px solid"
|-
|-
-
|'''Field / Key Name''' ||'''Type''' || '''Description'''
+
|width="25%" style="background-color:rgb(230,230,230)"|'''Field / Key Name''' ||width="25%" style="background-color:rgb(230,230,230)"|'''Type''' ||width="50%" style="background-color:rgb(230,230,230)"| '''Description'''
|-
|-
|acc_sub_id      ||string        ||Name of the new account; will be attached to management account's name separated by a point. (e.g. 'subacc' will become api123.subacc) Required are 3-8 chars [a-z] or [0-9]
|acc_sub_id      ||string        ||Name of the new account; will be attached to management account's name separated by a point. (e.g. 'subacc' will become api123.subacc) Required are 3-8 chars [a-z] or [0-9]
Zeile 292: Zeile 130:
|-
|-
|acc_allowed_groups (optional)||string||Method group memberships for this account. Management account needs permissions for every mentioned group. You can specify multiple
|acc_allowed_groups (optional)||string||Method group memberships for this account. Management account needs permissions for every mentioned group. You can specify multiple
 +
|}
 +
 +
==== RETURNS ====
 +
{|width="100%" style="border-color:rgb(230,230,230); background-color:white;" cellpadding="5" cellspacing="0" border="2px solid"
 +
|-
 +
|width="25%" style="background-color:rgb(230,230,230)"|'''Field / Key Name''' ||width="25%" style="background-color:rgb(230,230,230)"|'''Type''' ||width="50%" style="background-color:rgb(230,230,230)"| '''Description'''
 +
|-
 +
|acc_name || string || The complete name of the new account (e.g. 'api1234.subacc')
 +
|-
 +
|acc_added_ip_bindings || int || Number (amount) of added IP bindings
 +
|-
 +
|acc_added_groups ||int || Number (amount) of added group memberships
 +
|}
 +
 +
=== usermngt.modify_acc ===
 +
----
 +
 +
==== PURPOSE ====
 +
This Method is used to modify settings and/or permissions of API user accounts.
 +
 +
==== CALL PARAMETERS ====
 +
{|width="100%" style="border-color:rgb(230,230,230); background-color:white;" cellpadding="5" cellspacing="0" border="2px solid"
 +
|-
 +
|width="25%" style="background-color:rgb(230,230,230)"|'''Field / Key Name''' ||width="25%" style="background-color:rgb(230,230,230)"|'''Type''' ||width="50%" style="background-color:rgb(230,230,230)"| '''Description'''
 +
|-
 +
|acc_id || string || Complete name of the account which will be modified (e.g. 'acc_id' => 'api1234.subacc')
 +
|-
 +
|acc_passwd_base64 (optional)||string base64||New account password in base64-encoded format. Using this parameter will overwrite the old password.
 +
|-
 +
|acc_ipv4_bindings (optional)|| string || At least one allowed IPv4 address for using the new account. You can specify multiple values; each separated by a semicolon. Networkaddresses and IP-ranges will not work. You can specify multiple values, each separated by a semicolon. Using this parameter will overwrite old bindings.
 +
|-
 +
|acc_allowed_groups (optional)||string||This parameter will set method group memberships for the account and overwrite existing ones. Management account needs permissions for every mentioned group. You can specify multiple values, each separated by a semicolon. (e.g. 'acc_allowed_groups' => 'domain;server;vserver')
 +
|-
 +
|acc_status (optional)||string enum||Parameter to deactivate or to (re-)activate theParameter to deactivate or to (re-)activate the account Value must be “active” or “inactive”
 +
|}
 +
 +
==== RETURNS ====
 +
{|width="100%" style="border-color:rgb(230,230,230); background-color:white;" cellpadding="5" cellspacing="0" border="2px solid"
 +
|-
 +
|width="25%" style="background-color:rgb(230,230,230)"|'''Field / Key Name''' ||width="25%" style="background-color:rgb(230,230,230)"|'''Type''' ||width="50%" style="background-color:rgb(230,230,230)"| '''Description'''
 +
|-
 +
|acc_password_changed||bool||Shows if password has changed or not
 +
|-
 +
|acc_ip_bindings_changed||bool||Shows if IP bindings have changed or not
 +
|-
 +
|acc_groups_changed||bool||Shows if group memberships have changed or not
 +
|-
 +
|acc_status_changed||bool||Shows if account's status has changed or not (has set active or inactive)
 +
|}
 +
 +
=== usermngt.list_acc ===
 +
----
 +
 +
==== PURPOSE ====
 +
This Method is used to get all API user accounts and their settings/details
 +
 +
==== CALL PARAMETERS ====
 +
N/A
 +
 +
==== RETURNS ====
 +
{|width="100%" style="border-color:rgb(230,230,230); background-color:white;" cellpadding="5" cellspacing="0" border="2px solid"
 +
|-
 +
|width="25%" style="background-color:rgb(230,230,230)"|'''Field / Key Name''' ||width="25%" style="background-color:rgb(230,230,230)"|'''Type''' ||width="50%" style="background-color:rgb(230,230,230)"| '''Description'''
 +
|-
 +
|acc_list_count||int||Number (amount) of available API user accounts
 +
|-
 +
|acc_list_data||array asoc || Contains all the account data in a multidimensional, associative array. <br>
 +
 +
Array’s keys equals API user’s login names, e.g. $array ['api1234.subacc'] <br>
 +
 +
Values are contained in the second dimension, e.g. $array ['api1234.subacc'] ['status']
 +
|}
 +
 +
==== acc_list_data – Keys of second dimension ====
 +
{|width="100%" style="border-color:rgb(230,230,230); background-color:white;" cellpadding="5" cellspacing="0" border="2px solid"
 +
|-
 +
|width="25%" style="background-color:rgb(230,230,230)"|'''Field / Key Name''' ||width="25%" style="background-color:rgb(230,230,230)"|'''Type''' ||width="50%" style="background-color:rgb(230,230,230)"| '''Description'''
 +
|-
 +
|status||string||Account’s status, can be “active” or “inactive”
 +
|-
 +
|created||string||“Datetime” of account creation
 +
|-
 +
|lastchange||string||“Datetime” of account’s last change groups array Contains all active method group names (e.g. 0 => “server”, 1 => “vserver”)
 +
|-
 +
|ip_bindings||array||Contains all active IP bindings (IP restrictions)
 +
|}
 +
 +
== Server-related Methods ==
 +
=== server.list_servers ===
 +
----
 +
 +
==== PURPOSE ====
 +
This Method is used to get all manageable servers and basic details for further method calls. Only these servers which are manageable by the used API user will be returned.
 +
 +
==== CALL PARAMETERS ====
 +
N/A
 +
 +
==== RETURNS ====
 +
{|width="100%" style="border-color:rgb(230,230,230); background-color:white;" cellpadding="5" cellspacing="0" border="2px solid"
 +
|-
 +
|width="25%" style="background-color:rgb(230,230,230)"|'''Field / Key Name''' ||width="25%" style="background-color:rgb(230,230,230)"|'''Type''' ||width="50%" style="background-color:rgb(230,230,230)"| '''Description'''
 +
|-
 +
|server_list_count||int||Number (amount) of available servers
 +
|-
 +
|server_list_data||array asoc||Contains basic server details in a multidimensional, associative array. Keys of the first dimension equals the server order numbers: e.g. $array ['123456'] Values are contained in the second dimension: e.g. $array ['12345'] ['srv_main_ip'] returns the main
 +
|}
 +
 +
==== server_list_data – Keys of second dimension ====
 +
{|width="100%" style="border-color:rgb(230,230,230); background-color:white;" cellpadding="5" cellspacing="0" border="2px solid"
 +
|-
 +
|width="25%" style="background-color:rgb(230,230,230)"|'''Field / Key Name''' ||width="25%" style="background-color:rgb(230,230,230)"|'''Type''' ||width="50%" style="background-color:rgb(230,230,230)"| '''Description'''
 +
|-
 +
|order_desc||string||Description/Product name
 +
|-
 +
|srv_id||int||Server’s unique ID (required for further method calls)
 +
|-
 +
|srv_main_ip||string||Primary IP address
 +
|-
 +
|srv_name||string||Server name (for network settings)
 +
|-
 +
|status||string enum||Server or order status:<br> - “ready” means server can be used<br> - “in_rescue” means server can be used but it’s currently in rescue mode<br> - “in_process” means server is not available at present<br> - “locked” means server/order is locked by the provider
 +
|}
 +
 +
==== PHP EXAMPLE ====
 +
[[API Documentation RunningExamples server.list_servers PHP]]
 +
 +
=== server.get_details ===
 +
----
 +
 +
==== PURPOSE ====
 +
This Method is used to get all details of a manageable server. Only these servers are available, which are manageable by the used API.
 +
 +
==== CALL PARAMETERS ====
 +
{|width="100%" style="border-color:rgb(230,230,230); background-color:white;" cellpadding="5" cellspacing="0" border="2px solid"
 +
|-
 +
|width="25%" style="background-color:rgb(230,230,230)"|'''Field / Key Name''' ||width="25%" style="background-color:rgb(230,230,230)"|'''Type''' ||width="50%" style="background-color:rgb(230,230,230)"| '''Description'''
 +
|-
 +
|srv_id||int||Server's unique ID
 +
|}
 +
 +
====RETURNS ====
 +
{|width="100%" style="border-color:rgb(230,230,230); background-color:white;" cellpadding="5" cellspacing="0" border="2px solid"
 +
|-
 +
|width="25%" style="background-color:rgb(230,230,230)"|'''Field / Key Name''' ||width="25%" style="background-color:rgb(230,230,230)"|'''Type''' ||width="50%" style="background-color:rgb(230,230,230)"| '''Description'''
 +
|-
 +
|server_details||array (asoc)||Contains all server details in an associative array
 +
|}
 +
 +
==== server_details – Keys of second dimension ====
 +
{|width="100%" style="border-color:rgb(230,230,230); background-color:white;" cellpadding="5" cellspacing="0" border="2px solid"
 +
|-
 +
|width="25%" style="background-color:rgb(230,230,230)"|'''Key Name''' ||width="25%" style="background-color:rgb(230,230,230)"|'''Type''' ||width="50%" style="background-color:rgb(230,230,230)"| '''Description'''
 +
|-
 +
|order_no||int||Server contract’s order number
 +
|-
 +
|order_desc||string||Description/Product name
 +
|-
 +
|srv_id||int||Server’s unique ID (required for further method calls)
 +
|-
 +
|srv_main_ip||string||Primary IP address
 +
|-
 +
|srv_name||string||Server name (for network settings)
 +
|-
 +
|srv_netmask||string||Netmask for network / IP address setup
 +
|-
 +
|srv_broadcast||string||Broadcast address for network / IP address setup
 +
|-
 +
|srv_gateway||string||Gateway address for network / IP address setup
 +
|-
 +
|srv_status||string enum || Server or order status:<br>- “ready” means server can be used <br> - “in_rescue” means server is currently in rescue mode<br> - “in_process” means server is not available at present<br>- “locked” means server/order is locked by the provider
 +
|-
 +
|srv_default_pw||string||Default password for initial login or rescue usage
 +
|-
 +
|srv_mac||string||MAC-Address of server’s first network device
 +
|-
 +
|srv_mac2 (optional)||string||MAC-Address of server’s optional second network device
 +
|-
 +
|srv_cpu||string||Processor (Product) name / Description
 +
|-
 +
|srv_cpu_cores||int||Number of (available) CPU cores
 +
|-
 +
|srv_cpu_mhz||int||CPU clock rate in MHz srv_64bit_support bool CPU support for 64bit (true or false)
 +
|-
 +
|srv_ram_type||string||Type of used memory (e.g. DDR2-RAM)
 +
|-
 +
|srv_ram_size||int||Size of memory in MB
 +
|-
 +
|srv_hdd_type||string||Harddisk bus type (e.g. SATA)
 +
|-
 +
|srv_hdd_size||int||Size of each hdd (e.g. 250)
 +
|-
 +
|srv_hdd_count||int||Number of installed harddisks
 +
|-
 +
|srv_has_hwraid||bool||Hardware-RAID support (true or false)
 +
|-
 +
|srv_hwraid_level||string||Used Hardware-RAID level (“none” or level, e.g. “1”)
 +
|-
 +
|srv_os_id||int||ID of currently used OS image (for reinstall)
 +
|-
 +
|srv_os_name||string||Name/description of currently used OS image
 +
|-
 +
|srv_os_is_64bit||bool||OS image 64bit support (true or false)
 +
|-
 +
|srv_pro_option||int||Server Pro-Option on/off (1/0)
 +
|-
 +
|srv_features_prooption_possible||int||Support for Pro-Option (1/0)
 +
|-
 +
|srv_features_failover_ip||int||Failover ip feature support (1/0)
 +
|-
 +
|srv_features_create_compatible_mac||int||Support for vmware compatible mac addresses (1/0)
 +
|-
 +
|srv_ipaddresses_max_without_cost||int|| Maximum number of ip addresses without cost
 +
|-
 +
|srv_ipaddresses_max_with_cost||int|| Maximum number of ip addresses with cost
 +
|-
 +
|srv_ipaddresses_max_with||int|| Maximum number of ip addresses (without cost + with cost)
 +
|-
 +
|srv_ipaddresses_used_without_cost||int|| Used number of ip addresses without cost
 +
|-
 +
|srv_ipaddresses_used_with_cost||int|| Used number of ip addresses with cost
 +
|-
 +
|srv_ipaddresses_used_with||int|| Used number of ip addresses (without cost + with cost)
 +
|-
 +
|srv_ipaddresses_possible_without_cost||int|| Assignable number of ip addresses without cost
 +
|-
 +
|srv_ipaddresses_possible_with_cost||int|| Assignable number of ip addresses with cost
 +
|-
 +
|srv_ipaddresses_possible_with||int|| Assignable number of ip addresses (without cost + with cost)
 +
|}
 +
 +
==== PHP EXAMPLE ====
 +
[[API Documentation RunningExamples server.get_details PHP]]
 +
 +
=== server.get_possible_failover_servers ===
 +
----
 +
 +
==== PURPOSE ====
 +
This method is used to get all possible servers, which are applicable for failover ip assignments, i.e. which have the failover ip feature enabled. Only servers which are manageable by the used API user will be returned.
 +
 +
==== CALL PARAMETERS ====
 +
N/A
 +
 +
==== RETURNS ====
 +
{|width="100%" style="border-color:rgb(230,230,230); background-color:white;" cellpadding="5" cellspacing="0" border="2px solid"
 +
|-
 +
|width="25%" style="background-color:rgb(230,230,230)"|'''Field / Key Name''' ||width="25%" style="background-color:rgb(230,230,230)"|'''Type''' ||width="50%" style="background-color:rgb(230,230,230)"| '''Description'''
 +
|-
 +
|failover_server_list_count||int||Number (amount) of available servers, which are applicable for failover ip assignments
 +
|-
 +
|failover_server_list||array asoc||Contains basic server details in a multidimensional, associative array.
 +
|}
 +
 +
==== failover_server_list – Keys of second dimension ====
 +
{|width="100%" style="border-color:rgb(230,230,230); background-color:white;" cellpadding="5" cellspacing="0" border="2px solid"
 +
|-
 +
|width="25%" style="background-color:rgb(230,230,230)"|'''Key Name''' ||width="25%" style="background-color:rgb(230,230,230)"|'''Type''' ||width="50%" style="background-color:rgb(230,230,230)"| '''Description'''
 +
|-
 +
|ord_id||int||ID of the server order
 +
|-
 +
|item_description||string||Description/Product name
 +
|}
 +
 +
==== METHOD ERRORS ====
 +
{|width="100%" style="border-color:rgb(230,230,230); background-color:white;" cellpadding="5" cellspacing="0" border="2px solid"
 +
|-
 +
|width="25%" style="background-color:rgb(230,230,230)"|'''Code''' ||width="25%" style="background-color:rgb(230,230,230)"|'''Short Message''' ||width="50%" style="background-color:rgb(230,230,230)"| '''Description'''
 +
|-
 +
|1001||nothing found ||No possible failover servers found.
 +
|}
 +
 +
==== PHP EXAMPLE&nbsp; ====
 +
[[API Documentation RunningExamples server.get_possible_failover_servers PHP]]
 +
 +
=== server.get_possible_os_images ===
 +
----
 +
 +
==== PURPOSE ====
 +
This Method is used to get all possible OS images for a specific server ID. Only compatible and usable OS images will be returned here.
 +
 +
==== CALL PARAMETERS ====
 +
{|width="100%" style="border-color:rgb(230,230,230); background-color:white;" cellpadding="5" cellspacing="0" border="2px solid"
 +
|-
 +
|width="25%" style="background-color:rgb(230,230,230)"|'''Field / Key Name''' ||width="25%" style="background-color:rgb(230,230,230)"|'''Type''' ||width="50%" style="background-color:rgb(230,230,230)"| '''Description'''
 +
|-
 +
|srv_id || int|| Server's unique ID
 +
|}
 +
 +
==== RETURNS ====
 +
{|width="100%" style="border-color:rgb(230,230,230); background-color:white;" cellpadding="5" cellspacing="0" border="2px solid"
 +
|-
 +
|width="25%" style="background-color:rgb(230,230,230)"|'''Field / Key Name''' ||width="25%" style="background-color:rgb(230,230,230)"|'''Type''' ||width="50%" style="background-color:rgb(230,230,230)"| '''Description'''
 +
|-
 +
|os_images_asoc_array||array asoc||Contains details of every possible/available OS image in a multidimensional, associative array. Keys of the first dimension equals the OS image number, called “os_id”: e.g. $array ['240'] Values are contained in the second dimension: e.g. $array ['240'] ['os_name'] returns the name/description of OS image with ID 240.
 +
|}
 +
 +
==== os_images_asoc_array – Keys of second dimension ====
 +
{|width="100%" style="border-color:rgb(230,230,230); background-color:white;" cellpadding="5" cellspacing="0" border="2px solid"
 +
|-
 +
|width="25%" style="background-color:rgb(230,230,230)"|'''Key Name''' ||width="25%" style="background-color:rgb(230,230,230)"|'''Type''' ||width="50%" style="background-color:rgb(230,230,230)"| '''Description'''
 +
|-
 +
|os_id||int||ID of OS image (for reinstall)
 +
|-
 +
|os-status||string enum||Development-status of OS image: stable | stable | unstable | testing
 +
|-
 +
|os_name||string||Name/description of OS image
 +
|-
 +
|os_is_64bit||bool||OS image 64bit support (true or false)
 +
|-
 +
|os_raidlevel||int||Provided software RAID level or “-1” if none
 +
|}
 +
 +
====PHP EXAMPLE====
 +
[[API Documentation RunningExamples server.get_possible_os_images PHP]]
 +
 +
=== server.reset ===
 +
----
 +
 +
==== PURPOSE ====
 +
This Method is used to perform a hard server reset.
 +
 +
==== CALL PARAMETERS ====
 +
{|width="100%" style="border-color:rgb(230,230,230); background-color:white;" cellpadding="5" cellspacing="0" border="2px solid"
 +
|-
 +
|width="25%" style="background-color:rgb(230,230,230)"|'''Field / Key Name''' ||width="25%" style="background-color:rgb(230,230,230)"|'''Type''' ||width="50%" style="background-color:rgb(230,230,230)"| '''Description'''
 +
|-
 +
|srv_id||int||Server’s unique ID
 +
|}
 +
 +
====RETURNS====
 +
Only “status” = “100” if request was accepted
 +
 +
==== PHP EXAMPLE ====
 +
[[API Documentation RunningExamples server.reset PHP]]
 +
 +
=== server.autoreinstall ===
 +
----
 +
 +
==== PURPOSE ====
 +
This Method is used to perform an automatic server reinstall with a specified OS image ID. Only compatible images will be accepted – you can obtain a list of all compatible OS images by using the “server.get_possible_os_images” API method.
 +
 +
==== CALL PARAMETERS ====
 +
{|width="100%" style="border-color:rgb(230,230,230); background-color:white;" cellpadding="5" cellspacing="0" border="2px solid"
 +
|-
 +
|width="25%" style="background-color:rgb(230,230,230)"|'''Field / Key Name''' ||width="25%" style="background-color:rgb(230,230,230)"|'''Type''' ||width="50%" style="background-color:rgb(230,230,230)"| '''Description'''
 +
|-
 +
|srv_id||int||Server’s unique ID
 +
|-
 +
|srv_os_id||int||ID of target OS image
 +
|-
 +
|srv_perform_reset||bool||Perform automatic server reset, to start installation? (“true” or “false”) If you choose “false” here, you have to perform
 +
|}
 +
 +
==== RETURNS ====
 +
Only “status” = “100” if request was accepted
 +
 +
==== PHP EXAMPLE ====
 +
[[API Documentation RunningExamples server.autoreinstall PHP]]
 +
 +
=== server.rescue_activate ===
 +
----
 +
 +
==== PURPOSE ====
 +
This Method is used to activate a rescue system for a specified server, which will be started during next boot.
 +
 +
==== CALL PARAMETERS ====
 +
{|width="100%" style="border-color:rgb(230,230,230); background-color:white;" cellpadding="5" cellspacing="0" border="2px solid"
 +
|-
 +
|width="25%" style="background-color:rgb(230,230,230)"|'''Field / Key Name''' ||width="25%" style="background-color:rgb(230,230,230)"|'''Type''' ||width="50%" style="background-color:rgb(230,230,230)"| '''Description'''
 +
|-
 +
|srv_id||int||Server's unique ID
 +
|-
 +
|srv_perform_reset||bool||Perform automatic server reset, to start rescue system? (“true” or “false”)<br>If you choose “false” here, you have to perform a manual reboot via SSH to start the rescue system.
 +
|-
 +
|rescue_mode||int||{optional} the desired rescue mode (1 = enable default rescue, 2 = enable vKVM, 3 = enable Linux rescue 64 bit, 4 = enable rescue 32 bit (only old systems), 5 = enable FreeBSD rescue 64 bit, 6 = enable FreeBSD rescue 32 bit (only old systems), 7 = enable Windows rescue)
 +
|}
 +
 +
====RETURNS====
 +
Only “status” = “100” if request was accepted
 +
 +
====PHP EXAMPLE====
 +
[[API Documentation RunningExamples server.rescue_activate PHP]]
 +
 +
=== server.get_ipaddr_inetnum_list ===
 +
----
 +
 +
==== PURPOSE ====
 +
This method is used to get a list of available ip nets (inetnums). The returned data can be used to assign an ip from a specific range to a server.
 +
 +
==== CALL PARAMETERS ====
 +
N/A
 +
 +
==== RETURNS ====
 +
{|width="100%" style="border-color:rgb(230,230,230); background-color:white;" cellpadding="5" cellspacing="0" border="2px solid"
 +
|-
 +
|width="25%" style="background-color:rgb(230,230,230)"|'''Field / Key Name''' ||width="25%" style="background-color:rgb(230,230,230)"|'''Type''' ||width="50%" style="background-color:rgb(230,230,230)"| '''Description'''
 +
|-
 +
|inetnum_list_count||int||Number (amount) of found inetnums
 +
|-
 +
|inetnum_list||array asoc||Contains details of available ip nets (inetnums) in a multidimensional, associative array.
 +
|}
 +
 +
==== inetnum_list – Keys of second dimension ====
 +
{|width="100%" style="border-color:rgb(230,230,230); background-color:white;" cellpadding="5" cellspacing="0" border="2px solid"
 +
|-
 +
|width="25%" style="background-color:rgb(230,230,230)"|'''Key Name''' ||width="25%" style="background-color:rgb(230,230,230)"|'''Type''' ||width="50%" style="background-color:rgb(230,230,230)"| '''Description'''
 +
|-
 +
|ipinet_id||int||ID of the inetnum
 +
|-
 +
|ipinet_netip||string||The net ip (e.g. 81.7.17.0)
 +
|-
 +
|ipinet_broadcast||string||The broadcast address (e.g. 81.7.17.255)
 +
|}
 +
 +
==== METHOD ERRORS ====
 +
{|width="100%" style="border-color:rgb(230,230,230); background-color:white;" cellpadding="5" cellspacing="0" border="2px solid"
 +
|-
 +
|width="25%" style="background-color:rgb(230,230,230)"|'''Code''' ||width="25%" style="background-color:rgb(230,230,230)"|'''Short Message''' ||width="50%" style="background-color:rgb(230,230,230)"| '''Description'''
 +
|-
 +
|1001||c_id invalid ||Given customer ID is invalid.
 +
|-
 +
|1002||internal error ||Internal error, please contact the support!
 +
|-
 +
|1003||inetnum error ||Could not get inetnum list.
 +
|-
 +
|1004||ip data error ||Could not get ip data.
 +
|}
 +
 +
 +
==== PHP EXAMPLE&nbsp; ====
 +
[[API Documentation RunningExamples server.get_ipaddr_inetnum_list PHP]]
 +
 +
=== server.get_ipaddr_list ===
 +
----
 +
 +
==== PURPOSE ====
 +
This method is used to get a list of ip addresses, which are assigned to the given server order.
 +
 +
==== CALL PARAMETERS ====
 +
{|width="100%" style="border-color:rgb(230,230,230); background-color:white;" cellpadding="5" cellspacing="0" border="2px solid"
 +
|-
 +
|width="25%" style="background-color:rgb(230,230,230)"|'''Field / Key Name''' ||width="25%" style="background-color:rgb(230,230,230)"|'''Type''' ||width="50%" style="background-color:rgb(230,230,230)"| '''Description'''
 +
|-
 +
|srvord_id || int|| Server orders's unique ID
 +
|}
 +
 +
==== RETURNS ====
 +
{|width="100%" style="border-color:rgb(230,230,230); background-color:white;" cellpadding="5" cellspacing="0" border="2px solid"
 +
|-
 +
|width="25%" style="background-color:rgb(230,230,230)"|'''Field / Key Name''' ||width="25%" style="background-color:rgb(230,230,230)"|'''Type''' ||width="50%" style="background-color:rgb(230,230,230)"| '''Description'''
 +
|-
 +
|ipadd_list_count||int||Number (amount) of found ip addresses.
 +
|-
 +
|ipadd_list||array asoc||Contains ip data in a multidimensional, associative array.
 +
|}
 +
 +
==== ipadd_list – Keys of second dimension ====
 +
{|width="100%" style="border-color:rgb(230,230,230); background-color:white;" cellpadding="5" cellspacing="0" border="2px solid"
 +
|-
 +
|width="25%" style="background-color:rgb(230,230,230)"|'''Key Name''' ||width="25%" style="background-color:rgb(230,230,230)"|'''Type''' ||width="50%" style="background-color:rgb(230,230,230)"| '''Description'''
 +
|-
 +
|ipadd_id||int||ID of the ip address
 +
|-
 +
|ipadd_address||string||The ip address
 +
|-
 +
|ipinet_broadcast||string||The broadcast address
 +
|-
 +
|ipinet_netmask||string||The netmask
 +
|-
 +
|ipinet_gateway||string||The gateway address
 +
|-
 +
|mac_address||string||The mac address (if assigned)
 +
|-
 +
|failover_assigned_from_order||int||If this field is set, the ip is a failover ip, which was assigned from another server order.
 +
|-
 +
|failover_assigned_to_order_list||array asoc||This field contains a list of server contracts in a multidimensional, associative array. It is only set, if this ip was assigned as a failover ip to at least one other server order.
 +
|}
 +
 +
==== failover_assigned_to_order_list – Keys of third dimension ====
 +
{|width="100%" style="border-color:rgb(230,230,230); background-color:white;" cellpadding="5" cellspacing="0" border="2px solid"
 +
|-
 +
|width="25%" style="background-color:rgb(230,230,230)"|'''Key Name''' ||width="25%" style="background-color:rgb(230,230,230)"|'''Type''' ||width="50%" style="background-color:rgb(230,230,230)"| '''Description'''
 +
|-
 +
|ord_id||int||This field contains the unique order id of the server order, where this ip has been assigned as a failover ip
 +
|}
 +
 +
==== METHOD ERRORS ====
 +
{|width="100%" style="border-color:rgb(230,230,230); background-color:white;" cellpadding="5" cellspacing="0" border="2px solid"
 +
|-
 +
|width="25%" style="background-color:rgb(230,230,230)"|'''Code''' ||width="25%" style="background-color:rgb(230,230,230)"|'''Short Message''' ||width="50%" style="background-color:rgb(230,230,230)"| '''Description'''
 +
|-
 +
|1001||srvord_id not given ||The server order id was not given.
 +
|-
 +
|1002||no permission ||No permission for given server order.
 +
|-
 +
|1003||internal error ||Internal error, please contact the support!
 +
|-
 +
|1004||srvord_id invalid ||The given server order id is invalid
 +
|-
 +
|1005||internal error ||Internal error, please contact the support!
 +
|-
 +
|1006||internal error ||Internal error, please contact the support!
 +
|-
 +
|1007||internal error ||Internal error, please contact the support!
 +
|-
 +
|1008||server not ready ||The order of the given server is not ready.
 +
|-
 +
|1009||internal error ||Internal error, please contact the support!
 +
|-
 +
|1010||internal error ||Internal error, please contact the support!
 +
|-
 +
|1011||internal error ||Internal error, please contact the support!
 +
|}
 +
 +
 +
==== PHP EXAMPLE&nbsp; ====
 +
[[API Documentation RunningExamples server.get_ipaddr_list PHP]]
 +
 +
=== server.ipaddr_get_reverse ===
 +
----
 +
 +
==== PURPOSE ====
 +
This Method is used to get the current reverse DNS entry (PTR record) for a specified server IP address.
 +
 +
==== CALL PARAMETERS ====
 +
{|width="100%" style="border-color:rgb(230,230,230); background-color:white;" cellpadding="5" cellspacing="0" border="2px solid"
 +
|-
 +
|width="25%" style="background-color:rgb(230,230,230)"|'''Field / Key Name''' ||width="25%" style="background-color:rgb(230,230,230)"|'''Type''' ||width="50%" style="background-color:rgb(230,230,230)"| '''Description'''
 +
|-
 +
|srv_id||int||Server's unique ID
 +
|-
 +
|ip_address||string||IP address to get reverse entry for
 +
|}
 +
 +
==== RETURNS ====
 +
{|width="100%" style="border-color:rgb(230,230,230); background-color:white;" cellpadding="5" cellspacing="0" border="2px solid"
 +
|-
 +
|width="25%" style="background-color:rgb(230,230,230)"|'''Field / Key Name''' ||width="25%" style="background-color:rgb(230,230,230)"|'''Type''' ||width="50%" style="background-color:rgb(230,230,230)"| '''Description'''
 +
|-
 +
|ip_address||string||IP address for delivered record
 +
|-
 +
|ptr_reverse_record||string||Reverse entry (PTR record)
 +
|}
 +
 +
==== PHP EXAMPLE ====
 +
[[API Documentation RunningExamples server.ipaddr_get_reverse PHP]]
 +
 +
=== server.ipaddr_set_reverse ===
 +
----
 +
 +
==== PURPOSE ====
 +
This Method is used to set a reverse DNS entry for a specified server IP address.
 +
 +
==== CALL PARAMETERS ====
 +
{|width="100%" style="border-color:rgb(230,230,230); background-color:white;" cellpadding="5" cellspacing="0" border="2px solid"
 +
|-
 +
|width="25%" style="background-color:rgb(230,230,230)"|'''Field / Key Name''' ||width="25%" style="background-color:rgb(230,230,230)"|'''Type''' ||width="50%" style="background-color:rgb(230,230,230)"| '''Description'''
 +
|-
 +
|srv_id||int||Server's unique ID
 +
|-
 +
|ip_address||string||IP address to modify reverse entry
 +
|-
 +
|reverse_entry||string||Reverse entry for specified IP as hostname/
 +
|}
 +
 +
==== RETURNS ====
 +
Only “status” = “100” if request was accepted
 +
 +
==== PHP EXAMPLE ====
 +
[[API Documentation RunningExamples server.ipaddr_set_reverse PHP]]
 +
 +
=== server.ipaddr_assign ===
 +
----
 +
 +
==== PURPOSE ====
 +
This method is used to assign a coip to the given server.
 +
 +
==== CALL PARAMETERS ====
 +
{|width="100%" style="border-color:rgb(230,230,230); background-color:white;" cellpadding="5" cellspacing="0" border="2px solid"
 +
|-
 +
|width="25%" style="background-color:rgb(230,230,230)"|'''Field / Key Name''' ||width="25%" style="background-color:rgb(230,230,230)"|'''Type''' ||width="50%" style="background-color:rgb(230,230,230)"| '''Description'''
 +
|-
 +
|srvord_id||int||Server order's unique ID, where the ip address is assigned
 +
|-
 +
|ipinet_id(optional)||int||ID of the ip range (inetnum), from where the ip is assigned
 +
|-
 +
|mac_vmware_compatible(optional)||string||Use vmware compatible mac address off/on (0/1)
 +
|}
 +
 +
==== RETURNS ====
 +
{|width="100%" style="border-color:rgb(230,230,230); background-color:white;" cellpadding="5" cellspacing="0" border="2px solid"
 +
|-
 +
|width="25%" style="background-color:rgb(230,230,230)"|'''Field / Key Name''' ||width="25%" style="background-color:rgb(230,230,230)"|'''Type''' ||width="50%" style="background-color:rgb(230,230,230)"| '''Description'''
 +
|-
 +
|ipadd_id||int||Unique ID of the assigned ip address
 +
|}
 +
 +
==== METHOD ERRORS ====
 +
{|width="100%" style="border-color:rgb(230,230,230); background-color:white;" cellpadding="5" cellspacing="0" border="2px solid"
 +
|-
 +
|width="25%" style="background-color:rgb(230,230,230)"|'''Code''' ||width="25%" style="background-color:rgb(230,230,230)"|'''Short Message''' ||width="50%" style="background-color:rgb(230,230,230)"| '''Description'''
 +
|-
 +
|1001||srvord_id not given ||The server order id was not given.
 +
|-
 +
|1002||no permission ||No permission for given server order.
 +
|-
 +
|1003||internal error ||Internal error, please contact the support!
 +
|-
 +
|1004||srvord_id invalid ||The given server order id is invalid
 +
|-
 +
|1005||internal error ||Internal error, please contact the support!
 +
|-
 +
|1006||server not ready ||The order of the given server is not ready.
 +
|-
 +
|1007||internal error ||Internal error, please contact the support!
 +
|-
 +
|1008||c_id invalid ||Customer id is invalid.
 +
|-
 +
|1009||internal error ||Internal error, please contact the support!
 +
|-
 +
|1010||internal error ||Internal error, please contact the support!
 +
|-
 +
|1011||ipinet_id invalid ||The given ipinet_id is invalid.
 +
|-
 +
|1012||internal error ||Internal error, please contact the support!
 +
|-
 +
|1013||ip max reached ||The maximum number of ip addresses for the given server order is reached.
 +
|-
 +
|1014||internal error ||Internal error, please contact the support!
 +
|-
 +
|1015||internal error ||Internal error, please contact the support!
 +
|-
 +
|1016||internal error ||Internal error, please contact the support!
 +
|-
 +
|1017||internal error ||Internal error, please contact the support!
 +
|-
 +
|1018||internal error ||Internal error, please contact the support!
 +
|-
 +
|1019||internal error ||Internal error, please contact the support!
 +
|-
 +
|1020||internal error ||Internal error, please contact the support!
 +
|-
 +
|1021||internal error ||Internal error, please contact the support!
 +
|-
 +
|1022||internal error ||Internal error, please contact the support!
 +
|-
 +
|1023||internal error ||Internal error, please contact the support!
 +
|-
 +
|1024||internal error ||Internal error, please contact the support!
 +
|-
 +
|1025||internal error ||Internal error, please contact the support!
 +
|-
 +
|}
 +
 +
==== PHP EXAMPLE&nbsp; ====
 +
[[API Documentation RunningExamples server.ipaddr_assign PHP]]
 +
 +
=== server.ipaddr_release ===
 +
----
 +
 +
==== PURPOSE ====
 +
This method is used to release a coip from a server.
 +
 +
==== CALL PARAMETERS ====
 +
{|width="100%" style="border-color:rgb(230,230,230); background-color:white;" cellpadding="5" cellspacing="0" border="2px solid"
 +
|-
 +
|width="25%" style="background-color:rgb(230,230,230)"|'''Field / Key Name''' ||width="25%" style="background-color:rgb(230,230,230)"|'''Type''' ||width="50%" style="background-color:rgb(230,230,230)"| '''Description'''
 +
|-
 +
|ipadd_id||int||Unique ID of the ip address to release
 +
|}
 +
 +
==== RETURNS ====
 +
Only “status” = “100” if request was accepted
 +
 +
==== METHOD ERRORS ====
 +
{|width="100%" style="border-color:rgb(230,230,230); background-color:white;" cellpadding="5" cellspacing="0" border="2px solid"
 +
|-
 +
|width="25%" style="background-color:rgb(230,230,230)"|'''Code''' ||width="25%" style="background-color:rgb(230,230,230)"|'''Short Message''' ||width="50%" style="background-color:rgb(230,230,230)"| '''Description'''
 +
|-
 +
|1001||ipadd_id not given ||The ipadd_id was not given.
 +
|-
 +
|1002||ipadd_id invalid ||The given ipadd_id is invalid.
 +
|-
 +
|1003||ipadd_id invalid ||The given ipadd_id is invalid.
 +
|-
 +
|1004||ipadd_id invalid ||The given ipadd_id is invalid.
 +
|-
 +
|1005||already released ||The given ip is already released.
 +
|-
 +
|1006||internal error ||Internal error, please contact the support!
 +
|-
 +
|1007||server not ready ||The order of the given server is not ready.
 +
|-
 +
|1008||no permission ||No permission for server order.
 +
|-
 +
|1009||internal error ||Internal error, please contact the support!
 +
|-
 +
|1010||internal error ||Internal error, please contact the support!
 +
|-
 +
|1011||not releasable ||The given ip is not releasable.
 +
|-
 +
|1012||internal error ||Internal error, please contact the support!
 +
|-
 +
|1013||internal error ||Internal error, please contact the support!
 +
|-
 +
|1014||internal error ||Internal error, please contact the support!
 +
|-
 +
|1015||internal error ||Internal error, please contact the support!
 +
|-
 +
|1016||internal error ||Internal error, please contact the support!
 +
|}
 +
 +
==== PHP EXAMPLE&nbsp; ====
 +
[[API Documentation RunningExamples server.ipaddr_release PHP]]
 +
 +
=== server.ipaddr_assign_failover ===
 +
----
 +
 +
==== PURPOSE ====
 +
This method is used to assign a coip to the given server as a failover ip.
 +
 +
==== CALL PARAMETERS ====
 +
{|width="100%" style="border-color:rgb(230,230,230); background-color:white;" cellpadding="5" cellspacing="0" border="2px solid"
 +
|-
 +
|width="25%" style="background-color:rgb(230,230,230)"|'''Field / Key Name''' ||width="25%" style="background-color:rgb(230,230,230)"|'''Type''' ||width="50%" style="background-color:rgb(230,230,230)"| '''Description'''
 +
|-
 +
|ipadd_id||int||Unique ID of the ip address, used as a failover ip
 +
|-
 +
|srvord_id||int||Server order's unique ID, where the ip address is assigned
 +
|}
 +
 +
==== RETURNS ====
 +
Only “status” = “100” if request was accepted
 +
 +
==== METHOD ERRORS ====
 +
{|width="100%" style="border-color:rgb(230,230,230); background-color:white;" cellpadding="5" cellspacing="0" border="2px solid"
 +
|-
 +
|width="25%" style="background-color:rgb(230,230,230)"|'''Code''' ||width="25%" style="background-color:rgb(230,230,230)"|'''Short Message''' ||width="50%" style="background-color:rgb(230,230,230)"| '''Description'''
 +
|-
 +
|1001||ipadd_id not given ||The ipadd_id was not given.
 +
|-
 +
|1002||ipadd_id invalid ||The given ipadd_id is invalid.
 +
|-
 +
|1003||srvord_id not given ||The server order id for the failover server was not given.
 +
|-
 +
|1004||no permission ||No permission for the given failover server.
 +
|-
 +
|1005||internal error ||Internal error, please contact the support!
 +
|-
 +
|1006||server not ready ||The order of the given failover server is not ready.
 +
|-
 +
|1007||internal error ||Internal error, please contact the support!
 +
|-
 +
|1008||server not ready ||The given failover server is not ready.
 +
|-
 +
|1009||ipadd_id invalid ||The given ipadd_id is invalid.
 +
|-
 +
|1010||ipadd_id invalid ||The given ipadd_id is invalid.
 +
|-
 +
|1011||ipadd_id invalid ||The given ipadd_id is invalid.
 +
|-
 +
|1012||internal error ||Internal error, please contact the support!
 +
|-
 +
|1013||internal error ||Internal error, please contact the support!
 +
|-
 +
|1014||no permission ||No permission for the given server.
 +
|-
 +
|1015||internal error ||Internal error, please contact the support!
 +
|-
 +
|1016||server not ready ||The order of the given server is not ready.
 +
|-
 +
|1017||server order error ||The given server order and the server order of the given ipadd_id cannot be the same.
 +
|-
 +
|1018||internal error ||Internal error, please contact the support!
 +
|-
 +
|1019||internal error ||Internal error, please contact the support!
 +
|-
 +
|1020||feature unavailable ||On of the servers does not support the failover ip feature.
 +
|-
 +
|1021||already assigned ||The given ip is already assigned to the given failover server.
 +
|-
 +
|1022||already assigned ||The given ip cannot be assigned more than once without Pro-Option.
 +
|-
 +
|1023||internal error ||Internal error, please contact the support!
 +
|-
 +
|1024||internal error ||Internal error, please contact the support!
 +
|-
 +
|1025||internal error ||Internal error, please contact the support!
 +
|-
 +
|1026||internal error ||Internal error, please contact the support!
 +
|-
 +
|1027||internal error ||Internal error, please contact the support!
 +
|-
 +
|1028||internal error ||Internal error, please contact the support!
 +
|-
 +
|1029||internal error ||Internal error, please contact the support!
 +
|-
 +
|}
 +
 +
==== PHP EXAMPLE&nbsp; ====
 +
[[API Documentation RunningExamples server.ipaddr_assign_failover PHP]]
 +
 +
=== server.ipaddr_release_failover ===
 +
----
 +
 +
==== PURPOSE ====
 +
This method is used to release a failover coip from a server.
 +
 +
==== CALL PARAMETERS ====
 +
{|width="100%" style="border-color:rgb(230,230,230); background-color:white;" cellpadding="5" cellspacing="0" border="2px solid"
 +
|-
 +
|width="25%" style="background-color:rgb(230,230,230)"|'''Field / Key Name''' ||width="25%" style="background-color:rgb(230,230,230)"|'''Type''' ||width="50%" style="background-color:rgb(230,230,230)"| '''Description'''
 +
|-
 +
|ipadd_id||int||Unique ID of the failover ip address to release
 +
|-
 +
|srvord_id||int||Server order's unique ID, where the given ip address is assigned as a failover ip
 +
|}
 +
 +
==== RETURNS ====
 +
Only “status” = “100” if request was accepted
 +
 +
==== METHOD ERRORS ====
 +
{|width="100%" style="border-color:rgb(230,230,230); background-color:white;" cellpadding="5" cellspacing="0" border="2px solid"
 +
|-
 +
|width="25%" style="background-color:rgb(230,230,230)"|'''Code''' ||width="25%" style="background-color:rgb(230,230,230)"|'''Short Message''' ||width="50%" style="background-color:rgb(230,230,230)"| '''Description'''
 +
|-
 +
|1001||ipadd_id not given ||The ipadd_id was not given.
 +
|-
 +
|1002||ipadd_id invalid ||The given ipadd_id is invalid.
 +
|-
 +
|1003||srvord_id not given ||The server order id for the failover server was not given.
 +
|-
 +
|1004||internal error ||Internal error, please contact the support!
 +
|-
 +
|1005||internal error ||Internal error, please contact the support!
 +
|-
 +
|1006||internal error ||Internal error, please contact the support!
 +
|-
 +
|1007||internal error ||Internal error, please contact the support!
 +
|-
 +
|1008||ipadd_id invalid ||The given ipadd_id is invalid.
 +
|-
 +
|1009||ipadd_id invalid ||The given ipadd_id is invalid.
 +
|-
 +
|1010||internal error ||Internal error, please contact the support!
 +
|-
 +
|1011||server not ready ||The given server is not ready.
 +
|-
 +
|1012||no permission ||No permission for the given server.
 +
|-
 +
|1013||internal error ||Internal error, please contact the support!
 +
|-
 +
|1014||internal error ||Internal error, please contact the support!
 +
|-
 +
|1015||not assigned ||The given ip is not assigned to the given server.
 +
|-
 +
|1016||internal error ||Internal error, please contact the support!
 +
|-
 +
|1017||internal error ||Internal error, please contact the support!
 +
|-
 +
|1018||internal error ||Internal error, please contact the support!
 +
|-
 +
|1019||internal error ||Internal error, please contact the support!
 +
|-
 +
|}
 +
 +
==== PHP EXAMPLE&nbsp; ====
 +
[[API Documentation RunningExamples server.ipaddr_release_failover PHP]]
 +
 +
=== server.ipv6addr_set_main ===
 +
----
 +
 +
==== PURPOSE - (server.ipv6addr_set_main) ====
 +
Creates a IPv6 address for the server.
 +
 +
==== CALL PARAMETERS - (server.ipv6addr_set_main) ====
 +
{|width="100%" style="border-color:rgb(230,230,230); background-color:white;" cellpadding="5" cellspacing="0" border="2px solid"
 +
|-
 +
|width="25%" style="background-color:rgb(230,230,230)"|'''Field / Key Name''' ||width="25%" style="background-color:rgb(230,230,230)"|'''Type''' ||width="50%" style="background-color:rgb(230,230,230)"| '''Description'''
 +
|-
 +
|srv_id||int||Server's unique ID/
 +
|}
 +
 +
==== RETURNS - (server.ipv6addr_set_main) ====
 +
{|width="100%" style="border-color:rgb(230,230,230); background-color:white;" cellpadding="5" cellspacing="0" border="2px solid"
 +
|-
 +
|width="25%" style="background-color:rgb(230,230,230)"|'''Field / Key Name''' ||width="25%" style="background-color:rgb(230,230,230)"|'''Type''' ||width="50%" style="background-color:rgb(230,230,230)"| '''Description'''
 +
|-
 +
|srv_main_ipv6||string||New IPv6 address
 +
|}
 +
 +
==== METHOD ERRORS - (server.ipv6addr_set_main) ====
 +
{|width="100%" style="border-color:rgb(230,230,230); background-color:white;" cellpadding="5" cellspacing="0" border="2px solid"
 +
|-
 +
|width="25%" style="background-color:rgb(230,230,230)"|'''Code''' ||width="25%" style="background-color:rgb(230,230,230)"|'''Short Message''' ||width="50%" style="background-color:rgb(230,230,230)"| '''Description'''
 +
|-
 +
|1001||ipv6 address already exist ||The main IPv6 address is already set.
 +
|-
 +
|1002||can not find ipv6prefix ||The IPv6 prefix can not be found.
 +
|-
 +
|1003||can not find ipv4 adress ||The server is not ready yet.
 +
|-
 +
|1004||can not generade ipv6 address||Internal error. Please contact the support!
 +
|}
 +
 +
==== PHP EXAMPLE - (server.ipv6addr_set_main) ====
 +
[[API Documentation RunningExamples server.ipv6addr_set_main PHP]]
 +
 +
=== server.ipv6addr_get_reverse ===
 +
----
 +
 +
==== PURPOSE - (server.ipv6addr_get_reverse) ====
 +
This Method is used to get the current reverse DNS entry (PTR record) for a specified server IPv6 address.
 +
 +
==== CALL PARAMETERS - (server.ipv6addr_get_reverse) ====
 +
{|width="100%" style="border-color:rgb(230,230,230); background-color:white;" cellpadding="5" cellspacing="0" border="2px solid"
 +
|-
 +
|width="25%" style="background-color:rgb(230,230,230)"|'''Field / Key Name''' ||width="25%" style="background-color:rgb(230,230,230)"|'''Type''' ||width="50%" style="background-color:rgb(230,230,230)"| '''Description'''
 +
|-
 +
|srv_id||int||Server's unique ID
 +
|-
 +
|ipv6_address||string||IPv6 address to get reverse entry for
 +
|}
 +
 +
==== RETURNS - (server.ipv6addr_get_reverse) ====
 +
{|width="100%" style="border-color:rgb(230,230,230); background-color:white;" cellpadding="5" cellspacing="0" border="2px solid"
 +
|-
 +
|width="25%" style="background-color:rgb(230,230,230)"|'''Field / Key Name''' ||width="25%" style="background-color:rgb(230,230,230)"|'''Type''' ||width="50%" style="background-color:rgb(230,230,230)"| '''Description'''
 +
|-
 +
|ipv6_address||string||IPv6 address for delivered record
 +
|-
 +
|reverse_entry||string||Reverse entry (PTR record)
 +
|}
 +
 +
==== METHOD ERRORS - (server.ipv6addr_get_reverse) ====
 +
{|width="100%" style="border-color:rgb(230,230,230); background-color:white;" cellpadding="5" cellspacing="0" border="2px solid"
 +
|-
 +
|width="25%" style="background-color:rgb(230,230,230)"|'''Code''' ||width="25%" style="background-color:rgb(230,230,230)"|'''Short Message''' ||width="50%" style="background-color:rgb(230,230,230)"| '''Description'''
 +
|-
 +
|1001||ipv6address not linked to srv_id ||The given IPv6 address is not linked to the Server.                           
 +
|-
 +
|1002||no reverse-entry linked||There is no reverse_entry linked to the IPv6 address.
 +
|}
 +
 +
==== PHP EXAMPLE - (server.ipv6addr_get_reverse) ====
 +
[[API Documentation RunningExamples server.ipv6addr_get_reverse PHP]]
 +
 +
=== server.ipv6addr_set_reverse ===
 +
----
 +
 +
==== PURPOSE - (server.ipv6addr_set_reverse) ====
 +
This Method is used to set a reverse DNS entry for a specified server IPv6 address.
 +
 +
==== CALL PARAMETERS - (server.ipv6addr_set_reverse) ====
 +
{|width="100%" style="border-color:rgb(230,230,230); background-color:white;" cellpadding="5" cellspacing="0" border="2px solid"
 +
|-
 +
|width="25%" style="background-color:rgb(230,230,230)"|'''Field / Key Name''' ||width="25%" style="background-color:rgb(230,230,230)"|'''Type''' ||width="50%" style="background-color:rgb(230,230,230)"| '''Description'''
 +
|-
 +
|srv_id||int||Server's unique ID
 +
|-
 +
|ipv6_address||string||IPv6 address to modify reverse entry
 +
|-
 +
|reverse_entry||string||Reverse entry for specified IP as hostname/
 +
|}
 +
 +
==== RETURNS - (server.ipv6addr_set_reverse) ====
 +
{|width="100%" style="border-color:rgb(230,230,230); background-color:white;" cellpadding="5" cellspacing="0" border="2px solid"
 +
|-
 +
|width="25%" style="background-color:rgb(230,230,230)"|'''Field / Key Name''' ||width="25%" style="background-color:rgb(230,230,230)"|'''Type''' ||width="50%" style="background-color:rgb(230,230,230)"| '''Description'''
 +
|-
 +
|ipv6_address||string||IPv6 address for delivered record
 +
|-
 +
|reverse_entry||string||Reverse entry (PTR record)
 +
|}
 +
 +
==== METHOD ERRORS - (server.ipv6addr_set_reverse) ====
 +
{|width="100%" style="border-color:rgb(230,230,230); background-color:white;" cellpadding="5" cellspacing="0" border="2px solid"
 +
|-
 +
|width="25%" style="background-color:rgb(230,230,230)"|'''Code''' ||width="25%" style="background-color:rgb(230,230,230)"|'''Short Message''' ||width="50%" style="background-color:rgb(230,230,230)"| '''Description'''
 +
|-
 +
|1001||ipv6address not linked to srv_id ||The given IPv6 address is not linked to the Server.
 +
|-
 +
|1002||internal error ||Internal error. Please contact the support!
 +
|-
 +
|1003||internal error||Internal error. Please contact the support!
 +
|-
 +
|1004||internal error||Internal error. Please contact the support!
 +
|-
 +
|1005||no reverse_entry linked||There is no reverse_entry linked to ipv6 address  function.
 +
|}
 +
 +
==== PHP EXAMPLE - (server.ipv6addr_set_reverse) ====
 +
[[API Documentation RunningExamples server.ipv6addr_set_reverse PHP]]
 +
 +
=== server.get_possible_server_items ===
 +
----
 +
 +
==== PURPOSE ====
 +
This Method is used to display all possible server-items you can order. Please note that this function only available for Reseller.
 +
 +
==== CALL PARAMETERS ====
 +
N/A
 +
 +
==== RETURNS ====
 +
{|width="100%" style="border-color:rgb(230,230,230); background-color:white;" cellpadding="5" cellspacing="0" border="2px solid"
 +
|-
 +
|width="25%" style="background-color:rgb(230,230,230)"|'''Field / Key Name''' ||width="25%" style="background-color:rgb(230,230,230)"|'''Type''' ||width="50%" style="background-color:rgb(230,230,230)"| '''Description'''
 +
|-
 +
|possible_server_items||array (asoc)||Contains all possible serveritems in a associative array
 +
|}
 +
 +
==== possible_server_items - Keys of second dimension ====
 +
{|width="100%" style="border-color:rgb(230,230,230); background-color:white;" cellpadding="5" cellspacing="0" border="2px solid"
 +
|-
 +
|width="25%" style="background-color:rgb(230,230,230)"|'''Key Name''' ||width="25%" style="background-color:rgb(230,230,230)"|'''Type''' ||width="50%" style="background-color:rgb(230,230,230)"| '''Description'''
 +
|-
 +
|item_id||int||Server-item unique ID
 +
|-
 +
|item_name||string||The name of the server-item
 +
|-
 +
|item_net_amount||string||The net amount of the serveritem (per billing period)
 +
|-
 +
|item_gross_amount||string||The gross amount of the serveritem (per billing period)
 +
|-
 +
|item_net_setup_fee||string||The net setup fee (unique) of the server-item
 +
|-
 +
|item_gross_setup_fee||string||The gross setup fee (unique) of the server-item
 +
|-
 +
|item_billing_period||int||The period you have to pay for your server (in months)
 +
|-
 +
|item_contract_running_time||int||The running time of the contract
 +
|}
 +
 +
==== METHOD ERRORS ====
 +
{|width="100%" style="border-color:rgb(230,230,230); background-color:white;" cellpadding="5" cellspacing="0" border="2px solid"
 +
|-
 +
|width="25%" style="background-color:rgb(230,230,230)"|'''Code''' ||width="25%" style="background-color:rgb(230,230,230)"|'''Short Message''' ||width="50%" style="background-color:rgb(230,230,230)"| '''Description'''
 +
|-
 +
|1001||can not load customer_id||Error while loading the customer_id from api-user. Please contact the support!
 +
|-
 +
|1002||can not load as_id||Error while loading the as_id from api-user. Please contact the support!
 +
|-
 +
|1003||internal error||Internal error. Please contact the support!
 +
|-
 +
|1004||no possible items found||There are no possible serveritems you can order.
 +
|-
 +
|1005||this function is only available for reseller||You are not a reseller, you can not use this function.
 +
|}
 +
 +
==== PHP EXAMPLE ====
 +
[[API Documentation RunningExamples server.get_possible_server_items PHP]]
 +
 +
=== server.order_server ===
 +
----
 +
 +
==== PURPOSE ====
 +
This method is used to order some server. Please note that this function only available for Reseller.
 +
 +
==== CALL PARAMETERS ====
 +
{|width="100%" style="border-color:rgb(230,230,230); background-color:white;" cellpadding="5" cellspacing="0" border="2px solid"
 +
|-
 +
|width="25%" style="background-color:rgb(230,230,230)"|'''Field / Key Name''' ||width="25%" style="background-color:rgb(230,230,230)"|'''Type''' ||width="50%" style="background-color:rgb(230,230,230)"| '''Description'''
 +
|-
 +
|<item_id>||int||Use the item_id of the serveritem you want to order as a key and the quantity of the server as the value eg. '11716' => '1' (order one server with the item_id '11716')
 +
|-
 +
|accept_terms_and_conditions||bool||Set this flag to accept the terms and conditions(0 = NO, 1= YES). If you don't accept the terms and conditions, you can't order server. The terms and conditions can be found here:<br>http://euserv.de/unternehmen/agb.php
 +
|-
 +
|accept_special_terms_and_conditions_rootserver||bool||Set this flag to accept the spezial terms and conditions rootserver(0 = NO, 1= YES). If you don't accept the spezial terms and conditions rootserver, you can't order server. The spezial terms and conditions rootserver can be found here:<br>http://euserv.de/produkte/server/tosfdrs.php
 +
|}
 +
 +
==== RETURNS ====
 +
{|width="100%" style="border-color:rgb(230,230,230); background-color:white;" cellpadding="5" cellspacing="0" border="2px solid"
 +
|-
 +
|width="25%" style="background-color:rgb(230,230,230)"|'''Field / Key Name''' ||width="25%" style="background-color:rgb(230,230,230)"|'''Type''' ||width="50%" style="background-color:rgb(230,230,230)"| '''Description'''
 +
|-
 +
|total_amount||string||The total amount for the server you have ordered
 +
|}
 +
 +
==== METHOD ERRORS ====
 +
{|width="100%" style="border-color:rgb(230,230,230); background-color:white;" cellpadding="5" cellspacing="0" border="2px solid"
 +
|-
 +
|width="25%" style="background-color:rgb(230,230,230)"|'''Code''' ||width="25%" style="background-color:rgb(230,230,230)"|'''Short Message''' ||width="50%" style="background-color:rgb(230,230,230)"| '''Description'''
 +
|-
 +
|1001||can not load customer_id||Error while loading the customer_id from api-user. Please contact the support!
 +
|-
 +
|1002||can not load a_id||Error while laoding the as_id from api-user. Please contact the support!
 +
|-
 +
|1003||terms and conditions must be accepted||To order server you must accept the terms and conditions.
 +
|-
 +
|1004||special terms and conditions rootserver must be accepted||To order server you must accept the spezial terms and conditions rootserver.
 +
|-
 +
|1005||internal error||Internal error. Please contact the support!
 +
|-
 +
|1006||no items found||No items found. Please check your request.
 +
|-
 +
|1007||internal error||Internal error. Please contact the support!
 +
|-
 +
|1008||invalid item_id found||One of your item-ids is invalid. Please check your request.
 +
|-
 +
|1009||internal error||Internal error. Please contact the support!
 +
|-
 +
|1010||this function is only available for reseller||You are not a reseller, you can not use this function.
 +
|}
 +
 +
====PHP EXAMPLE ====
 +
[[API Documentation RunningExamples server.order_server PHP]]
 +
 +
=== server.get_traffic_graph ===
 +
----
 +
 +
==== PURPOSE ====
 +
This method is used to get a traffic-graph for your server.
 +
 +
==== CALL PARAMETERS ====
 +
{|width="100%" style="border-color:rgb(230,230,230); background-color:white;" cellpadding="5" cellspacing="0" border="2px solid"
 +
|-
 +
|width="25%" style="background-color:rgb(230,230,230)"|'''Field / Key Name''' ||width="25%" style="background-color:rgb(230,230,230)"|'''Type''' ||width="50%" style="background-color:rgb(230,230,230)"| '''Description'''
 +
|-
 +
|srv_id||int||The id of the server for which you want to get a traffic-graph.
 +
|-
 +
|graph_mode(optional)||int||The mode of the graph you want to get (0 = LAST DAY, 1 = LAST WEEK,2 = LAST MONTH,3 = LAST YEAR).
 +
|-
 +
|graph_language(optional)||string||The language of the graph you want to get (ISO Country Code, lower case). Possible types are 'en', 'de'. Default is 'en'.
 +
|}
 +
 +
====RETURNS====
 +
{|width="100%" style="border-color:rgb(230,230,230); background-color:white;" cellpadding="5" cellspacing="0" border="2px solid"
 +
|-
 +
|width="25%" style="background-color:rgb(230,230,230)"|'''Field / Key Name''' ||width="25%" style="background-color:rgb(230,230,230)"|'''Type''' ||width="50%" style="background-color:rgb(230,230,230)"| '''Description'''
 +
|-
 +
|traffic_graph||string||The base64 encoded data of the graph you want to get.
 +
|}
 +
 +
==== METHOD ERRORS ====
 +
{|width="100%" style="border-color:rgb(230,230,230); background-color:white;" cellpadding="5" cellspacing="0" border="2px solid"
 +
|-
 +
|width="25%" style="background-color:rgb(230,230,230)"|'''Code''' ||width="25%" style="background-color:rgb(230,230,230)"|'''Short Message''' ||width="50%" style="background-color:rgb(230,230,230)"| '''Description'''
 +
|-
 +
|1001||srv_id not given||The srv_id was not given.
 +
|-
 +
|1002||srv_graph_mode not valid||The given srv_graph_mode is not valid.
 +
|-
 +
|1003||can not load portdata||Cannot load portdata, please contact the support!
 +
|-
 +
|1004||can not load portdata||Cannot load portdata, please contact the support!
 +
|-
 +
|1005||can not load portdata||Cannot load portdata, please contact the support!
 +
|}
 +
 +
==== PHP EXAMPLE ====
 +
[[API Documentation RunningExamples server.get_traffic_graph PHP]]
 +
 +
=== server.get_traffic ===
 +
----
 +
 +
==== PURPOSE ====
 +
This method reads the traffic of the submitted srvord_id and returns this.
 +
 +
==== CALL PARAMETERS ====
 +
{|width="100%" style="border-color:rgb(230,230,230); background-color:white;" cellpadding="5" cellspacing="0" border="2px solid"
 +
|-
 +
|width="25%" style="background-color:rgb(230,230,230)"|'''Field / Key Name''' ||width="25%" style="background-color:rgb(230,230,230)"|'''Type''' ||width="50%" style="background-color:rgb(230,230,230)"| '''Description'''
 +
|-
 +
|srvord_id||int||The srvord_id od the desired server.
 +
|-
 +
|startdate(optional)||string||The startdate, format YYYY-mm-dd, if start date and end date are not specified the actual month is shown.
 +
|-
 +
|enddate(optional)||string||The end date, format YYYY-mm-dd, if start date and end date are not specified the actual month is shown.
 +
|-
 +
|date_format(optional)||string||The format in which the date should be issued, DEFAULT YYYY-mm-dd, details: HERE
 +
|-
 +
|unit_type(optional)||int||The desired unit in which all be returned, possible values 1 = Kilobyte, 2 = Megabyte, 3 = Gigabyte, DEFAULT byte 
 +
|}
 +
 +
====RETURNS====
 +
{|width="100%" style="border-color:rgb(230,230,230); background-color:white;" cellpadding="5" cellspacing="0" border="2px solid"
 +
|-
 +
|width="25%" style="background-color:rgb(230,230,230)"|'''Field / Key Name''' ||width="25%" style="background-color:rgb(230,230,230)"|'''Type''' ||width="50%" style="background-color:rgb(230,230,230)"| '''Description'''
 +
|-
 +
|status||int||100 (everything ok - traffic has been read)
 +
|-
 +
|traffic_data||array_asoc||A href of traffic data in which element ID is a sequential number (start = 0, end = traffic_data_count - 1)
 +
|-
 +
|traffic_data_count||int||The number of elements in traffic_data
 +
|-
 +
|traffic_sum||float||The number of the traffic over the desired period of time
 +
|}
 +
 +
==== traffic_data – Keys of second dimension ====
 +
{|width="100%" style="border-color:rgb(230,230,230); background-color:white;" cellpadding="5" cellspacing="0" border="2px solid"
 +
|-
 +
|width="25%" style="background-color:rgb(230,230,230)"|'''Key Name''' ||width="25%" style="background-color:rgb(230,230,230)"|'''Type''' ||width="50%" style="background-color:rgb(230,230,230)"| '''Description'''
 +
|-
 +
|Element ID||array_asoc||the id of the element in the array
 +
|}
 +
 +
==== traffic_data – Keys of third dimension ====
 +
{|width="100%" style="border-color:rgb(230,230,230); background-color:white;" cellpadding="5" cellspacing="0" border="2px solid"
 +
|-
 +
|width="25%" style="background-color:rgb(230,230,230)"|'''Key Name''' ||width="25%" style="background-color:rgb(230,230,230)"|'''Type''' ||width="50%" style="background-color:rgb(230,230,230)"| '''Description'''
 +
|-
 +
|date||string||The date of the entry in the desired format
 +
|-
 +
|in||float||the incoming traffic in the desired format
 +
|-
 +
|out||float||the outgoing traffic in the desired format
 +
|-
 +
|sum||float||the entire traffic in the desired format
 +
|}
 +
 +
== Domain-related Methods ==
 +
=== domain.get_domain_orders ===
 +
----
 +
 +
==== PURPOSE ====
 +
This method is used to give you an overview of your domain orders an their features.
 +
 +
==== CALL PARAMETERS ====
 +
N/A
 +
 +
==== RETURNS ====
 +
{|width="100%" style="border-color:rgb(230,230,230); background-color:white;" cellpadding="5" cellspacing="0" border="2px solid"
 +
|-
 +
|width="25%" style="background-color:rgb(230,230,230)"|'''Field / Key Name''' ||width="25%" style="background-color:rgb(230,230,230)"|'''Type''' ||width="50%" style="background-color:rgb(230,230,230)"| '''Description'''
 +
|-
 +
|domain_orders||array asoc ||Contains domain order data
 +
|}
 +
 +
==== Keys of the second dimension ====
 +
{|width="100%" style="border-color:rgb(230,230,230); background-color:white;" cellpadding="5" cellspacing="0" border="2px solid"
 +
|-
 +
|width="25%" style="background-color:rgb(230,230,230)"|'''Field / Key Name''' ||width="25%" style="background-color:rgb(230,230,230)"|'''Type''' ||width="50%" style="background-color:rgb(230,230,230)"| '''Description'''
 +
|-
 +
|<order_id> || array asoc ||Contains domain order data
 +
|}
 +
 +
==== Key of the third dimension ====
 +
{|width="100%" style="border-color:rgb(230,230,230); background-color:white;" cellpadding="5" cellspacing="0" border="2px solid"
 +
|-
 +
|width="25%" style="background-color:rgb(230,230,230)"|'''Field / Key Name''' ||width="25%" style="background-color:rgb(230,230,230)"|'''Type''' ||width="50%" style="background-color:rgb(230,230,230)"| '''Description'''
 +
|-
 +
|domain_id||int||The id of the current domain.
 +
|-
 +
|domain_name||string||The name of the current domain.
 +
|-
 +
|domain_name_idn||string||The name idn of the current domain.
 +
|-
 +
|feature_redirect||int||Tells you, if the redirect feature is disabled or enabled(0/1).
 +
|-
 +
|feature_dns||int||Tells you, if the redirect feature is disabled or enabled(0/1).
 +
|}
 +
 +
==== METHOD ERRORS ====
 +
{|width="100%" style="border-color:rgb(230,230,230); background-color:white;" cellpadding="5" cellspacing="0" border="2px solid"
 +
|-
 +
|width="25%" style="background-color:rgb(230,230,230)"|'''Code''' ||width="25%" style="background-color:rgb(230,230,230)"|'''Short Message''' ||width="50%" style="background-color:rgb(230,230,230)"| '''Description'''
 +
|-
 +
|1001||can not load customer data||Error while loading the customer data. Please contact the support!
 +
|-
 +
|1002||no domain orders found||No domain orders can be found.
 +
|}
 +
 +
==== PHP EXAMPLE ====
 +
[[API Documentation RunningExamples domain.get_domain_orders PHP]]
 +
 +
=== domain.get_domain_order_details ===
 +
----
 +
 +
==== PURPOSE ====
 +
This method is used to get the details of the domain order.
 +
 +
==== CALL PARAMETERS ====
 +
{|width="100%" style="border-color:rgb(230,230,230); background-color:white;" cellpadding="5" cellspacing="0" border="2px solid"
 +
|-
 +
|width="25%" style="background-color:rgb(230,230,230)"|'''Field / Key Name''' ||width="25%" style="background-color:rgb(230,230,230)"|'''Type''' ||width="50%" style="background-color:rgb(230,230,230)"| '''Description'''
 +
|-
 +
|order_id||int||The order id of that order you want to see the details.
 +
|}
 +
 +
==== RETURNS ====
 +
{|width="100%" style="border-color:rgb(230,230,230); background-color:white;" cellpadding="5" cellspacing="0" border="2px solid"
 +
|-
 +
|width="25%" style="background-color:rgb(230,230,230)"|'''Field / Key Name''' ||width="25%" style="background-color:rgb(230,230,230)"|'''Type''' ||width="50%" style="background-color:rgb(230,230,230)"| '''Description'''
 +
|-
 +
|domain_order_details||array asoc||Contains domain order details.
 +
|}
 +
 +
==== domain_order_details - Keys of the second dimension ====
 +
{|width="100%" style="border-color:rgb(230,230,230); background-color:white;" cellpadding="5" cellspacing="0" border="2px solid"
 +
|-
 +
|width="25%" style="background-color:rgb(230,230,230)"|'''Field / Key Name''' ||width="25%" style="background-color:rgb(230,230,230)"|'''Type''' ||width="50%" style="background-color:rgb(230,230,230)"| '''Description'''
 +
|-
 +
|order_id||array asoc||Contains domain order details.
 +
|}
 +
 +
==== <order_id> - Keys of the third dimension ====
 +
{|width="100%" style="border-color:rgb(230,230,230); background-color:white;" cellpadding="5" cellspacing="0" border="2px solid"
 +
|-
 +
|width="25%" style="background-color:rgb(230,230,230)"|'''Field / Key Name''' ||width="25%" style="background-color:rgb(230,230,230)"|'''Type''' ||width="50%" style="background-color:rgb(230,230,230)"| '''Description'''
 +
|-
 +
|order_status||int||The current order status(1 = ready, 3 = in process, 11 = transfer in process, 12 = waiting)
 +
|-
 +
|domain_id||int||The domain id of the current domain.
 +
|-
 +
|domain_name||string||The domain name of the current domain.
 +
|-
 +
|domain_name_idn||string||The domain name of the current domain.
 +
|-
 +
|dns_record_type||array asoc||An array asoc of available dns record types and there data .(A, AAAA, MX, AFSDB, CERT, CNAME, DNSKEY, DS, HINFO, KEY, LOC, NAPTR, NSEC, RP, RRSIG, SPF, SSHFP, SRV, TXT)
 +
|-
 +
|redirect_record_type||array asoc||An array asoc of available redirect record types(frameredirect, headerredirect)
 +
|-
 +
|redirect_record_max||int||The maximum of redirect records you can create.
 +
|-
 +
|redirect_record_used||int||The count of used redirect records.
 +
|-
 +
|redirect_record_free||int||The count of free redirect records.
 +
|}
 +
 +
==== dns_record_type - Keys of the fourth dimension ====
 +
{|width="100%" style="border-color:rgb(230,230,230); background-color:white;" cellpadding="5" cellspacing="0" border="2px solid"
 +
|-
 +
|width="25%" style="background-color:rgb(230,230,230)"|'''Field / Key Name''' ||width="25%" style="background-color:rgb(230,230,230)"|'''Type''' ||width="50%" style="background-color:rgb(230,230,230)"| '''Description'''
 +
|-
 +
|<dns_record_type>||array asoc||An array asoc of the current dns record type data.
 +
|}
 +
 +
==== <dns_record_type> - Keys of the fifth dimension ====
 +
{|width="100%" style="border-color:rgb(230,230,230); background-color:white;" cellpadding="5" cellspacing="0" border="2px solid"
 +
|-
 +
|width="25%" style="background-color:rgb(230,230,230)"|'''Field / Key Name''' ||width="25%" style="background-color:rgb(230,230,230)"|'''Type''' ||width="50%" style="background-color:rgb(230,230,230)"| '''Description'''
 +
|-
 +
|dns_record_max||int||The maximum of dns records you can create.
 +
|-
 +
|dns_record_used||int||The count of dns records you have already used.
 +
|-
 +
|dns_record_free||int||The count of free dns records.
 +
|}
 +
 +
==== redirect_record_type – Keys of the fourth dimension ====
 +
{|width="100%" style="border-color:rgb(230,230,230); background-color:white;" cellpadding="5" cellspacing="0" border="2px solid"
 +
|-
 +
|width="25%" style="background-color:rgb(230,230,230)"|'''Field / Key Name''' ||width="25%" style="background-color:rgb(230,230,230)"|'''Type''' ||width="50%" style="background-color:rgb(230,230,230)"| '''Description'''
 +
|-
 +
|<redirect_record_type>||int||A flag that tells you if the redirect_record_type is available.
 +
|}
 +
 +
==== METHOD ERRORS ====
 +
{|width="100%" style="border-color:rgb(230,230,230); background-color:white;" cellpadding="5" cellspacing="0" border="2px solid"
 +
|-
 +
|width="25%" style="background-color:rgb(230,230,230)"|'''Code''' ||width="25%" style="background-color:rgb(230,230,230)"|'''Short Message''' ||width="50%" style="background-color:rgb(230,230,230)"| '''Description'''
 +
|-
 +
|1001||order_id is invalid||The given order id is invalid
 +
|-
 +
|1002||order_id is not managed by api user||The given order id is not managed by you
 +
|-
 +
|1003||domain order not found||The given domain order was not found.
 +
|-
 +
|1004||internal error||Internal error, please contact the support!
 +
|}
 +
 +
==== PHP EXAMPLE ====
 +
[[API Documentation RunningExample domain.get_domain_order_details PHP]]
 +
 +
=== domain.dns_create_record ===
 +
----
 +
 +
==== PURPOSE ====
 +
This method is used to create an dns record for your domain.
 +
 +
==== CALL PARAMETERS ====
 +
{|width="100%" style="border-color:rgb(230,230,230); background-color:white;" cellpadding="5" cellspacing="0" border="2px solid"
 +
|-
 +
|width="25%" style="background-color:rgb(230,230,230)"|'''Field / Key Name''' ||width="25%" style="background-color:rgb(230,230,230)"|'''Type''' ||width="50%" style="background-color:rgb(230,230,230)"| '''Description'''
 +
|-
 +
|domain_id||int||The domain id of the domain you want to create a dns record.
 +
|-
 +
|dns_record_subdomain (optional)||string||The subdomain of the dns record you want to create.
 +
|-
 +
|dns_record_type||string||The type of the dns record you want to create. Possible Types are A, AAAA, MX, AFSDB, CERT, CNAME, DNSKEY, DS, HINFO, KEY, LOC, NAPTR, NSEC, RP, RRSIG, SPF, SSHFP, SRV, TXT
 +
|-
 +
|dns_record_value||string||The value of the dns record you want to create ( e.g euserv.de).
 +
|-
 +
|dns_record_prio (optional)||int||The record prio of the dns record you want to create(only essential for mx records).
 +
|-
 +
|dns_record_ttl||int||The ttl of the dns record you want to create. At least 43200.
 +
|}
 +
 +
==== RETURNS ====
 +
{|width="100%" style="border-color:rgb(230,230,230); background-color:white;" cellpadding="5" cellspacing="0" border="2px solid"
 +
|-
 +
|width="25%" style="background-color:rgb(230,230,230)"|'''Field / Key Name''' ||width="25%" style="background-color:rgb(230,230,230)"|'''Type''' ||width="50%" style="background-color:rgb(230,230,230)"| '''Description'''
 +
|-
 +
|dns_record_id||int||The id of the dns record you have created.
 +
|}
 +
 +
==== METHOD ERRORS ====
 +
{|width="100%" style="border-color:rgb(230,230,230); background-color:white;" cellpadding="5" cellspacing="0" border="2px solid"
 +
|-
 +
|width="25%" style="background-color:rgb(230,230,230)"|'''Code''' ||width="25%" style="background-color:rgb(230,230,230)"|'''Short Message''' ||width="50%" style="background-color:rgb(230,230,230)"| '''Description'''
 +
|-
 +
|1001||domain_id not given||The domain_id was not given.
 +
|-
 +
|1002||dns_record_subdomain invalid||The given dns_record_subdomain is invalid.
 +
|-
 +
|1003||dns_record_type not given||The dns_record_type was not given.
 +
|-
 +
|1004||dns_record_type not valid||The given dns_record_type is not valid.
 +
|-
 +
|1005||dns_record_value not given||The dns_record_value was not given.
 +
|-
 +
|1006||dns_record_value not valid||The given dns_record_value is not valid.
 +
|-
 +
|1007||dns_record_prio not given||You want to create an mx record and no dns_record_prio was given.
 +
|-
 +
|1008||dns_record_ttl not given or to low||The dns_record_ttl was not given or lower then 43200.
 +
|-
 +
|1009||domain not found ||There are no domain found for domain_id.
 +
|-
 +
|1010||order not ready||The domain order is not ready so you can't create dns records.
 +
|-
 +
|1011||domain not managed by customer||The domain of the given domain_id was not managed by you.
 +
|-
 +
|1012||internal error||Internal error, please contact the support!
 +
|-
 +
|1013||can not load domain data||Cannot load domain data, please contact the support!
 +
|-
 +
|1014||internal error||Cannot load domain data, please contact the support!
 +
|-
 +
|1015||dns_record_type not possible in this order||The given dns_record_type is not available in your domain order.
 +
|-
 +
|1016||dns_record limit reached||The dns record limit has been reached.
 +
|-
 +
|1017||internal error||Internal error, please contact the support!
 +
|-
 +
|1018||dns_record already exits||The dns record you want to create already exits.
 +
|-
 +
|1019||internal error||Internal error, please contact the support!
 +
|}
 +
 +
==== PHP EXAMPLE ====
 +
[[API Documentation RunningExamples domain.dns_create_record PHP]]
 +
 +
=== domain.dns_delete_record ===
 +
----
 +
 +
==== PURPOSE ====
 +
This method is used create a dns record of your domain.
 +
 +
==== CALL PARAMETERS ====
 +
{|width="100%" style="border-color:rgb(230,230,230); background-color:white;" cellpadding="5" cellspacing="0" border="2px solid"
 +
|-
 +
|width="25%" style="background-color:rgb(230,230,230)"|'''Field / Key Name''' ||width="25%" style="background-color:rgb(230,230,230)"|'''Type''' ||width="50%" style="background-color:rgb(230,230,230)"| '''Description'''
 +
|-
 +
|dns_record_id || int||The id of the dns record you want to delete.
 +
|}
 +
 +
==== RETURNS ====
 +
Only 'status' = '100' if request was accepted.
 +
 +
==== METHOD ERRORS ====
 +
{|width="100%" style="border-color:rgb(230,230,230); background-color:white;" cellpadding="5" cellspacing="0" border="2px solid"
 +
|-
 +
|width="25%" style="background-color:rgb(230,230,230)"|'''Code''' ||width="25%" style="background-color:rgb(230,230,230)"|'''Short Message''' ||width="50%" style="background-color:rgb(230,230,230)"| '''Description'''
 +
|-
 +
|1001||customer_id not given||Internal error, please contact the support!
 +
|-
 +
|1002||dns_record_id not given||There are no dns_record_id given.
 +
|-
 +
|1003||dns_record not found||No dns record found for dns_record_id.
 +
|-
 +
|1004||order not ready||The order of the dns_record_id is not ready.
 +
|-
 +
|1005||dns_record not managed by customer||The dns record is not managed by you.
 +
|}
 +
 +
==== PHP EXAMPLE ====
 +
[[API Documentation RunningExamples domain.dns_delete_record PHP]]
 +
 +
=== domain.dns_update_record ===
 +
----
 +
 +
==== PURPOSE ====
 +
This method is used to update a dns record for your domain.
 +
 +
==== CALL PARAMETERS ====
 +
{|width="100%" style="border-color:rgb(230,230,230); background-color:white;" cellpadding="5" cellspacing="0" border="2px solid"
 +
|-
 +
|width="25%" style="background-color:rgb(230,230,230)"|'''Field / Key Name''' ||width="25%" style="background-color:rgb(230,230,230)"|'''Type''' ||width="50%" style="background-color:rgb(230,230,230)"| '''Description'''
 +
|-
 +
|dns_record_id||int||The id of the dns record you want to update.
 +
|-
 +
|dns_record_value(optional)||string||The new dns record value of the dns record you want to update
 +
|-
 +
|dns_record_prio(optional)||int||The new prio of the dns_record you want to update (only essential for mx records).
 +
|-
 +
|dns_record_ttl(optional)||int||The new ttl of the dns record you want to update. At least 43200.
 +
|}
 +
 +
==== RETURNS ====
 +
Only 'status' = '100' if request was accepted.
 +
 +
==== METHOD ERRORS ====
 +
{|width="100%" style="border-color:rgb(230,230,230); background-color:white;" cellpadding="5" cellspacing="0" border="2px solid"
 +
|-
 +
|width="25%" style="background-color:rgb(230,230,230)"|'''Code''' ||width="25%" style="background-color:rgb(230,230,230)"|'''Short Message''' ||width="50%" style="background-color:rgb(230,230,230)"| '''Description'''
 +
|-
 +
|1001||nothing to do||There is nothing to do! You send an empty request.
 +
|-
 +
|1002||dns_record_id not given||The dns_record_id was not given.
 +
|-
 +
|1003||dns_record_id not valid||The given dns_record_id is not valid.
 +
|-
 +
|1004||internal error||Internal error, please contact the support!
 +
|-
 +
|1005||dns_record_type not valid||Internal error, please contact the support!
 +
|-
 +
|1006||dns_record_value not valid||The given dns_record_value is not valid.
 +
|-
 +
|1007||dns_record_type not accept dns_record_prio||You send dns_record_prio but the current dns_record_type does not accept dns_record_prio.
 +
|-
 +
|1008||dns_record_ttl to low||The given dns_record_ttl is lower 43200.
 +
|-
 +
|1009||dns_record not found||No dns record found for dns_record_id.
 +
|-
 +
|1010||order not ready||The Domainorder is not in the status 'ready'.
 +
|-
 +
|1011||dns_record not managed by customer||The dns_record of the given dns_record_id is not managed by you.
 +
|-
 +
|1012||internal error||Internal error, please contact the support!
 +
|-
 +
|1013||internal error||Internal error, please contact the support!
 +
|-
 +
|1014||internal error||Internal error, please contact the support!
 +
|}
 +
 +
==== PHP EXAMPLE ====
 +
[[API Documentation RunningExamples domain.dns_update_record PHP]]
 +
 +
=== domain.dns_get_active_records ===
 +
----
 +
 +
==== PURPOSE ====
 +
This method is used to show all activ dns records.
 +
 +
==== CALL PARAMETERS ====
 +
{|width="100%" style="border-color:rgb(230,230,230); background-color:white;" cellpadding="5" cellspacing="0" border="2px solid"
 +
|-
 +
|width="25%" style="background-color:rgb(230,230,230)"|'''Field / Key Name''' ||width="25%" style="background-color:rgb(230,230,230)"|'''Type''' ||width="50%" style="background-color:rgb(230,230,230)"| '''Description'''
 +
|-
 +
|domain_id||int||The domain_id of the domain for which you want to see all the dns records.
 +
|}
 +
 +
==== RETURNS ====
 +
{|width="100%" style="border-color:rgb(230,230,230); background-color:white;" cellpadding="5" cellspacing="0" border="2px solid"
 +
|-
 +
|width="25%" style="background-color:rgb(230,230,230)"|'''Field / Key Name''' ||width="25%" style="background-color:rgb(230,230,230)"|'''Type''' ||width="50%" style="background-color:rgb(230,230,230)"| '''Description'''
 +
|-
 +
|dns_records||array asoc||An array asoc of all activ dns records for your domain.
 +
|}
 +
 +
==== dns_records - Keys of the second dimension. ====
 +
{|width="100%" style="border-color:rgb(230,230,230); background-color:white;" cellpadding="5" cellspacing="0" border="2px solid"
 +
|-
 +
|width="25%" style="background-color:rgb(230,230,230)"|'''Field / Key Name''' ||width="25%" style="background-color:rgb(230,230,230)"|'''Type''' ||width="50%" style="background-color:rgb(230,230,230)"| '''Description'''
 +
|-
 +
|<dns_record_id>||array asoc||An array asoc with all data of the dns record.
 +
|}
 +
 +
==== <dns_record_id> - Keys of the third dimension ====
 +
{|width="100%" style="border-color:rgb(230,230,230); background-color:white;" cellpadding="5" cellspacing="0" border="2px solid"
 +
|-
 +
|width="25%" style="background-color:rgb(230,230,230)"|'''Field / Key Name''' ||width="25%" style="background-color:rgb(230,230,230)"|'''Type''' ||width="50%" style="background-color:rgb(230,230,230)"| '''Description'''
 +
|-
 +
|dns_record_name||string||The full name of the current dns record.
 +
|-
 +
|dns_record_type||string||The type of the current dns record.
 +
|-
 +
|dns_record_content||string||The content of the current dns record.
 +
|-
 +
|dns_record_ttl||int||The ttl of the current dns record.
 +
|-
 +
|dns_record_prio||int||The prio of the current dns record(only on mx records).
 +
|}
 +
 +
==== METHOD ERRORS ====
 +
{|width="100%" style="border-color:rgb(230,230,230); background-color:white;" cellpadding="5" cellspacing="0" border="2px solid"
 +
|-
 +
|width="25%" style="background-color:rgb(230,230,230)"|'''Code''' ||width="25%" style="background-color:rgb(230,230,230)"|'''Short Message''' ||width="50%" style="background-color:rgb(230,230,230)"| '''Description'''
 +
|-
 +
|1001||customer_id not given||Internal error, please contact the support!
 +
|-
 +
|1002||domain_id not given||There is no domain_id given.
 +
|-
 +
|1003||domain not found||No domain found for domain_id.
 +
|-
 +
|1004||order not ready||The order of the domain_id is not ready.
 +
|-
 +
|1005||domain not managed by customer||domain not managed by customer
 +
|-
 +
|1006||no dns_record found||No dns records found for domain.
 +
|}
 +
 +
==== PHP EXAMPLE ====
 +
[[API Documentation RunningExamples domain.dns_get_active_records PHP]]
 +
 +
=== domain.redirect_create_record ===
 +
----
 +
 +
==== PURPOSE ====
 +
This method is used to create a redirect record.
 +
 +
==== CALL PARAMETERS ====
 +
{|width="100%" style="border-color:rgb(230,230,230); background-color:white;" cellpadding="5" cellspacing="0" border="2px solid"
 +
|-
 +
|width="25%" style="background-color:rgb(230,230,230)"|'''Field / Key Name''' ||width="25%" style="background-color:rgb(230,230,230)"|'''Type''' ||width="50%" style="background-color:rgb(230,230,230)"| '''Description'''
 +
|-
 +
|domain_id||int||The domain_id of the domain you want to create a redirect record for.
 +
|-
 +
|redirect_record_type||string||The type of redirect record you want to create. Possible types are frameredirect or headerredirect
 +
|-
 +
|redirect_record_subdomain (optional)||string||The subdomain of the redirect record you want to create.
 +
|-
 +
|redirect_record_location||string||The location of the redirect_record. Only URL start with http:// OR https://).
 +
|-
 +
|redirect_record_status_code (optional)||int||An webserver status code that describes the type of redirection(Only for redirect_record_type headerredirect). Available codes are 301, 302 and 307.
 +
|-
 +
|redirect_record_title (optional)||string||The title of your redirect record (Only for frameredirect).
 +
|-
 +
|redirect_record_description (optional)||string||The description of you redirect record (Only for frameredirect).
 +
|-
 +
|redirect_record_author (optional)||string||The description of you redirect record (Only for frameredirect).
 +
|-
 +
|redirect_record_keywords (optional)||string||The keywords of your redirect record (Only for frameredirect).
 +
|-
 +
|redirect_record_robots (optional)||string||The robot description of your redirect_record (Only for frameredirect).
 +
|-
 +
|redirect_record_favicon (optional)||string||The favicon url of your redirect_record (Only for frameredirect).
 +
|}
 +
 +
==== RETURNS ====
 +
{|width="100%" style="border-color:rgb(230,230,230); background-color:white;" cellpadding="5" cellspacing="0" border="2px solid"
 +
|-
 +
|width="25%" style="background-color:rgb(230,230,230)"|'''Field / Key Name''' ||width="25%" style="background-color:rgb(230,230,230)"|'''Type''' ||width="50%" style="background-color:rgb(230,230,230)"| '''Description'''
 +
|-
 +
|redirect_record_id||int||The id of the redirect record you have created.
 +
|}
 +
 +
==== METHOD ERRORS ====
 +
{|width="100%" style="border-color:rgb(230,230,230); background-color:white;" cellpadding="5" cellspacing="0" border="2px solid"
 +
|-
 +
|width="25%" style="background-color:rgb(230,230,230)"|'''Code''' ||width="25%" style="background-color:rgb(230,230,230)"|'''Short Message''' ||width="50%" style="background-color:rgb(230,230,230)"| '''Description'''
 +
|-
 +
|1001||domain_id not given||The domain_id was not given.
 +
|-
 +
|1002||redirect_record_type not given||The redirect_record_type was not given
 +
|-
 +
|1003||parameter redirect_record_title, redirect_record_description, redirect_record_author, redirect_record_keywords, redirect_record_robots, redirect_record_favicon not available for redirect_record_type||You send invalid parameter for headerredirect.
 +
|-
 +
|1004||redirect_record_location not given||The redirect_record_location was not given.
 +
|-
 +
|1005||redirect_record_status_code not given||The redirect_record_status_code was not given.
 +
|-
 +
|1006||parameter redirect_record_status_code not available for redirect_record_type||You send invalid parameter for frameredirect.
 +
|-
 +
|1007||redirect_record_location not valid||The given redirect_record_location is not valid.
 +
|-
 +
|1008||domain not found||No domain found for domain_id.
 +
|-
 +
|1009||order not ready||The domain order is not ready so you cannot create redirect records.
 +
|-
 +
|1010||domain not managed by customer||The domain of the given domain_id was not managed by you.
 +
|-
 +
|1011||internal error||Internal error, please contact the support!
 +
|-
 +
|1012||internal error||Internal error, please contact the support!
 +
|-
 +
|1013||internal error||Internal error, please contact the support!
 +
|-
 +
|1014||redirect is not available||The redirect feature is not available for this domain.
 +
|-
 +
|1015||<redirect_record_type> is not available||<redirect_record_type> is not available in this order.
 +
|-
 +
|1016||redirect limit reached||The redirect limit has reached.
 +
|-
 +
|1017||redirect_record_wildcard is not available||You want to set an wildcard and wildcard is not available for your order.
 +
|-
 +
|1018||internal error||Internal error, please contact the support!
 +
|-
 +
|1019||redirect_record already exits||The redirect record you want to create already exits.
 +
|}
 +
 +
==== PHP EXAMPLE ====
 +
[[API Documentation RunningExamples domain.redirect_create_record PHP]]
 +
 +
===domain.redirect_delete_record===
 +
----
 +
 +
====PURPOSE====
 +
This method is used to delete a redirect record.
 +
 +
====CALL PARAMETERS ====
 +
{|width="100%" style="border-color:rgb(230,230,230); background-color:white;" cellpadding="5" cellspacing="0" border="2px solid"
 +
|-
 +
|width="25%" style="background-color:rgb(230,230,230)"|'''Field / Key Name''' ||width="25%" style="background-color:rgb(230,230,230)"|'''Type''' ||width="50%" style="background-color:rgb(230,230,230)"| '''Description'''
 +
|-
 +
|redirect_record_id||int||The id of the redirect record you want to delete.
 +
|}
 +
 +
==== RETURNS ====
 +
Only 'status' = '100' if request was accepted.
 +
 +
==== METHOD ERRORS ====
 +
{|width="100%" style="border-color:rgb(230,230,230); background-color:white;" cellpadding="5" cellspacing="0" border="2px solid"
 +
|-
 +
|width="25%" style="background-color:rgb(230,230,230)"|'''Code''' ||width="25%" style="background-color:rgb(230,230,230)"|'''Short Message''' ||width="50%" style="background-color:rgb(230,230,230)"| '''Description'''
 +
|-
 +
|1001||customer_id not given||Internal error, please contact the support!
 +
|-
 +
|1002||redirect_record_id not given||Internal error, please contact the support!
 +
|-
 +
|1003||redirect_record not found||No redirect record found for redirect_record id.
 +
|-
 +
|1004||order not ready||The order of the redirect record id is not ready.
 +
|-
 +
|1005||redirect_record not managed by customer||The redirect record is not managed by you.
 +
|}
 +
 +
==== PHP EXAMPLE ====
 +
[[API Documentation RunningExamples domain.redirect_delete_record PHP]]
 +
 +
=== domain.redirect_update_record ===
 +
----
 +
 +
==== PURPOSE ====
 +
This method is used to update a redirect record.
 +
 +
==== CALL PARAMETERS ====
 +
{|width="100%" style="border-color:rgb(230,230,230); background-color:white;" cellpadding="5" cellspacing="0" border="2px solid"
 +
|-
 +
|width="25%" style="background-color:rgb(230,230,230)"|'''Field / Key Name''' ||width="25%" style="background-color:rgb(230,230,230)"|'''Type''' ||width="50%" style="background-color:rgb(230,230,230)"| '''Description'''
 +
|-
 +
|redirect_record_id||int||The id of the redirect record you want to update.
 +
|-
 +
|redirect_record_location (optional)||string||The location of the redirect record you want to update. Only URL start with http:// OR https://).
 +
|-
 +
|redirect_record_status_code (optional)||int||An webserver status code that describes the type of redirection (Only for redirect_record_type headerredirect). Available codes are 301, 302 and 307.
 +
|-
 +
|redirect_record_title (optional)||string||The title of your redirect record (Only for frameredirect).
 +
|-
 +
|redirect_record_description (optional)||string||The description of you redirect record (Only for frameredirect).
 +
|-
 +
|redirect_record_author (optional)||string||The description of you redirect record (Only for frameredirect).
 +
|-
 +
|redirect_record_keywords (optional)||string||The robots description of your redirect_record (Only for frameredirect).
 +
|-
 +
|redirect_record_favicon (optional)||string||The favicon url of your redirect_record (Only for frameredirect).
 +
|}
 +
 +
==== RETURNS ====
 +
Only 'status' = '100' if request was accepted.
 +
 +
==== METHOD ERRORS ====
 +
{|width="100%" style="border-color:rgb(230,230,230); background-color:white;" cellpadding="5" cellspacing="0" border="2px solid"
 +
|-
 +
|width="25%" style="background-color:rgb(230,230,230)"|'''Code''' ||width="25%" style="background-color:rgb(230,230,230)"|'''Short Message''' ||width="50%" style="background-color:rgb(230,230,230)"| '''Description'''
 +
|-
 +
|1001||redirect_record_id not given ||The redirect_record_id was not given.
 +
|-
 +
|1002 ||redirect_record not found ||No redirect record found for redirect_record id.
 +
|-
 +
|1003 ||order not ready ||The order of the redirect record id is not ready.
 +
|-
 +
|1004 || redirect_record not managed by customer ||The redirect record is not managed by you.
 +
|-
 +
|1005 ||internal error ||Internal error, please contact the support!
 +
|-
 +
|1006 ||internal error ||Internal error, please contact the support!
 +
|-
 +
|1007 ||redirect_record_type not valid ||Internal error, please contact the support!
 +
|-
 +
|1008 ||parameter redirect_record_title, redirect_record_description, redirect_record_author, redirect_record_keywords, redirect_record_robots, redirect_record_favicon not available for redirect_record_type || The current redirect record is a headerredirect and you send invalid parameter.
 +
|-
 +
|1009 ||nothing to do|| There is nothing to do.
 +
|-
 +
|1010 ||parameter redirect_record_status_code not available for redirect_record_type||The current redirect record is a frameredirect and you send invalid parameter.
 +
|-
 +
|1011 || nothing to do ||There is nothing to do.
 +
|-
 +
|1012 ||internal error ||Internal error, please contact the support!
 +
|-
 +
|1013 || internal error || Internal error,please contact the support!
 +
|}
 +
 +
====PHP EXAMPLE ====
 +
[[API Documentation RunningExamples domain.redirect_update_record PHP]]
 +
 +
=== domain.redirect_get_active_records ===
 +
----
 +
 +
==== PURPOSE ====
 +
This method is used to show all activ redirect records.
 +
 +
==== CALL PARAMETERS ====
 +
{|width="100%" style="border-color:rgb(230,230,230); background-color:white;" cellpadding="5" cellspacing="0" border="2px solid"
 +
|-
 +
|width="25%" style="background-color:rgb(230,230,230)"|'''Field / Key Name''' ||width="25%" style="background-color:rgb(230,230,230)"|'''Type''' ||width="50%" style="background-color:rgb(230,230,230)"| '''Description'''
 +
|-
 +
|domain_id ||int||The domain_id of the domain for which you want to see all the redirect records.
 +
|}
 +
 +
====RETURNS====
 +
{|width="100%" style="border-color:rgb(230,230,230); background-color:white;" cellpadding="5" cellspacing="0" border="2px solid"
 +
|-
 +
|width="25%" style="background-color:rgb(230,230,230)"|'''Field / Key Name''' ||width="25%" style="background-color:rgb(230,230,230)"|'''Type''' ||width="50%" style="background-color:rgb(230,230,230)"| '''Description'''
 +
|-
 +
|redirect_records||array asoc||An array asoc of all activ redirect records for your domain.
 +
|}
 +
 +
==== redirect_records - Keys of the second dimension ====
 +
{|width="100%" style="border-color:rgb(230,230,230); background-color:white;" cellpadding="5" cellspacing="0" border="2px solid"
 +
|-
 +
|width="25%" style="background-color:rgb(230,230,230)"|'''Field / Key Name''' ||width="25%" style="background-color:rgb(230,230,230)"|'''Type''' ||width="50%" style="background-color:rgb(230,230,230)"| '''Description'''
 +
|-
 +
|<redirect_record_id>||array asoc||An array asoc with all data of the redirect record.
 +
|}
 +
 +
==== <redirect_record_id> - Keys of the third dimension ====
 +
{|width="100%" style="border-color:rgb(230,230,230); background-color:white;" cellpadding="5" cellspacing="0" border="2px solid"
 +
|-
 +
|width="25%" style="background-color:rgb(230,230,230)"|'''Field / Key Name''' ||width="25%" style="background-color:rgb(230,230,230)"|'''Type''' ||width="50%" style="background-color:rgb(230,230,230)"| '''Description'''
 +
|-
 +
|redirect_record_type||string||The type of the current redirect record.
 +
|-
 +
|redirect_record_status_code|| int|| The Webserver status code of the current redirect record. (only on headerredirect records)
 +
|-
 +
|redirect_record_name|| string || The name of the current redirect record.
 +
|-
 +
|redirect_record_location ||string|| The location of the current redirect record.
 +
|-
 +
|redirect_record_title || string || The title of the current redirect record (only on frameredirect records).
 +
|-
 +
|redirect_record_description || string || The description of the current redirect record (only on frameredirect records).
 +
|-
 +
|redirect_record_author ||string|| The author of the current redirect record (only on frameredirect records).
 +
|-
 +
|redirect_record_keywords ||string|| The keywords of the current redirect record (only on frameredirect records).
 +
|-
 +
|redirect_record_robots|| string ||The robots description of the current redirect record (only on frameredirect records).
 +
|-
 +
|redirect_record_favicon ||string ||The favicon url of the current redirect record (only on frameredirect records).
 +
|}
 +
 +
==== METHOD ERRORS ====
 +
{|width="100%" style="border-color:rgb(230,230,230); background-color:white;" cellpadding="5" cellspacing="0" border="2px solid"
 +
|-
 +
|width="25%" style="background-color:rgb(230,230,230)"|'''Code''' ||width="25%" style="background-color:rgb(230,230,230)"|'''Short Message''' ||width="50%" style="background-color:rgb(230,230,230)"| '''Description'''
 +
|-
 +
|1001 ||customer_id not given|| Internal error, please contact the support!
 +
|-
 +
|1002 ||domain_id not given|| There is no domain_id given.
 +
|-
 +
|1003 || domain not found || No domain found for domain id.
 +
|-
 +
|1004 || order not ready || The order of the domain id is not ready.
 +
|-
 +
|1005 ||domain not managed by customer|| The domain is not managed by you.
 +
|-
 +
|1006 || no redirect records found || No redirect records found for domain.
 +
|}
 +
 +
==== PHP EXAMPLE ====
 +
[[API Documentation RunningExamples domain.redirect_get_active_records PHP]]
 +
 +
=== domain.check ===
 +
----
 +
 +
==== PURPOSE ====
 +
This method is used for a short check if the domain is available.
 +
 +
==== CALL PARAMETERS ====
 +
{|width="100%" style="border-color:rgb(230,230,230); background-color:white;" cellpadding="5" cellspacing="0" border="2px solid"
 +
|-
 +
|width="25%" style="background-color:rgb(230,230,230)"|'''Field / Key Name''' ||width="25%" style="background-color:rgb(230,230,230)"|'''Type''' ||width="50%" style="background-color:rgb(230,230,230)"| '''Description'''
 +
|-
 +
|domain_name ||string||The name of the domain you want to check.
 +
|}
 +
 +
====RETURNS====
 +
{|width="100%" style="border-color:rgb(230,230,230); background-color:white;" cellpadding="5" cellspacing="0" border="2px solid"
 +
|-
 +
|width="25%" style="background-color:rgb(230,230,230)"|'''Field / Key Name''' ||width="25%" style="background-color:rgb(230,230,230)"|'''Type''' ||width="50%" style="background-color:rgb(230,230,230)"| '''Description'''
 +
|-
 +
|is_available||int||0(domain is not available) or 1 (domain is available)
 +
|}
 +
 +
==== PHP EXAMPLE ====
 +
[[API Documentation RunningExamples domain.check PHP]]
 +
 +
== Order-related Methods ==
 +
 +
=== order_external.get_possible_items ===
 +
----
 +
 +
==== PURPOSE ====
 +
This method is used to get a list of items that can be ordered.
 +
 +
==== CALL PARAMETERS ====
 +
{|width="100%" style="border-color:rgb(230,230,230); background-color:white;" cellpadding="5" cellspacing="0" border="2px solid"
 +
|-
 +
|width="25%" style="background-color:rgb(230,230,230)"|'''Field / Key Name''' ||width="25%" style="background-color:rgb(230,230,230)"|'''Type''' ||width="50%" style="background-color:rgb(230,230,230)"| '''Description'''
 +
|-
 +
|item_group ||string||The item group you want to show. Possible item groups are server, vserver, cloud, hosting, mail or domain.
 +
|-
 +
|item_name_regexp (optional) ||string|| A regex to limit the result by item_name
 +
|}
 +
 +
====RETURNS====
 +
{|width="100%" style="border-color:rgb(230,230,230); background-color:white;" cellpadding="5" cellspacing="0" border="2px solid"
 +
|-
 +
|width="25%" style="background-color:rgb(230,230,230)"|'''Field / Key Name''' ||width="25%" style="background-color:rgb(230,230,230)"|'''Type''' ||width="50%" style="background-color:rgb(230,230,230)"| '''Description'''
 +
|-
 +
|item_list||array asoc||A list of all possible items.
 +
|-
 +
|item_list_count||int||The count of the itemlist .
 +
|}
 +
 +
==== item_list - Keys of the second dimension ====
 +
{|width="100%" style="border-color:rgb(230,230,230); background-color:white;" cellpadding="5" cellspacing="0" border="2px solid"
 +
|-
 +
|width="25%" style="background-color:rgb(230,230,230)"|'''Field / Key Name''' ||width="25%" style="background-color:rgb(230,230,230)"|'''Type''' ||width="50%" style="background-color:rgb(230,230,230)"| '''Description'''
 +
|-
 +
|<item_list_id>||array asoc||An array asoc with all data of the item.
 +
|}
 +
 +
==== <item_list_id> - Keys of the third dimension ====
 +
{|width="100%" style="border-color:rgb(230,230,230); background-color:white;" cellpadding="5" cellspacing="0" border="2px solid"
 +
|-
 +
|width="25%" style="background-color:rgb(230,230,230)"|'''Field / Key Name''' ||width="25%" style="background-color:rgb(230,230,230)"|'''Type''' ||width="50%" style="background-color:rgb(230,230,230)"| '''Description'''
 +
|-
 +
|item_id||int||The id of the item.
 +
|-
 +
|item_name|| string|| The name of the item.
 +
|-
 +
|item_billing_period|| int || The billing period of the item.
 +
|-
 +
|item_contract_period|| int || The contract period of the item.
 +
|-
 +
|item_mrc||string|| Monthly recurring costs of the item.
 +
|-
 +
|item_nrc|| string ||  Non recurring costs of the item.
 +
|-
 +
|item_nrc_sale|| string ||  Non recurring costs of the item if sale is active(only present if sale is active for this item).
 +
 +
|}
 +
 +
==== METHOD ERRORS ====
 +
{|width="100%" style="border-color:rgb(230,230,230); background-color:white;" cellpadding="5" cellspacing="0" border="2px solid"
 +
|-
 +
|width="25%" style="background-color:rgb(230,230,230)"|'''Code''' ||width="25%" style="background-color:rgb(230,230,230)"|'''Short Message''' ||width="50%" style="background-color:rgb(230,230,230)"| '''Description'''
 +
|-
 +
|1001 ||internal error|| Internal error, please contact the support!
 +
|-
 +
|1002 ||item_group not given|| There is no item group given.
 +
|-
 +
|1003 ||item_group invalid|| The item group is not valid.
 +
|-
 +
|101004 ||pg_id invalid|| Internal error, please contact the support!
 +
|-
 +
|101005 ||can not load data|| Item data can not be load.
 +
|}
 +
 +
==== PHP EXAMPLE ====
 +
[[API Documentation RunningExamples order_external.get_possible_items PHP]]
 +
 +
=== order_external.create_order ===
 +
----
 +
==== PURPOSE ====
 +
This method is used for to create orders.
 +
 +
==== CALL PARAMETERS ====
 +
{|width="100%" style="border-color:rgb(230,230,230); background-color:white;" cellpadding="5" cellspacing="0" border="2px solid"
 +
|-
 +
|width="25%" style="background-color:rgb(230,230,230)"|'''Field / Key Name''' ||width="25%" style="background-color:rgb(230,230,230)"|'''Type''' ||width="50%" style="background-color:rgb(230,230,230)"| '''Description'''
 +
|-
 +
|item_id ||int||The item id of your destination item.
 +
|-
 +
|domain_name (optional) ||string||The domain name for your order need for item group domain, hosting and mail.
 +
|-
 +
|domain_authcode (optional) ||string||The authcode for your domain if your domain is not free.
 +
 +
|}
 +
 +
====RETURNS====
 +
{|width="100%" style="border-color:rgb(230,230,230); background-color:white;" cellpadding="5" cellspacing="0" border="2px solid"
 +
|-
 +
|width="25%" style="background-color:rgb(230,230,230)"|'''Field / Key Name''' ||width="25%" style="background-color:rgb(230,230,230)"|'''Type''' ||width="50%" style="background-color:rgb(230,230,230)"| '''Description'''
 +
|-
 +
|total_amount_formatted||string||The amount of your order in format '0,00'.
 +
|-
 +
|total_amount||float||The amount of your order in float format ('0.00').
 +
 +
|}
 +
 +
==== METHOD ERRORS ====
 +
{|width="100%" style="border-color:rgb(230,230,230); background-color:white;" cellpadding="5" cellspacing="0" border="2px solid"
 +
|-
 +
|width="25%" style="background-color:rgb(230,230,230)"|'''Code''' ||width="25%" style="background-color:rgb(230,230,230)"|'''Short Message''' ||width="50%" style="background-color:rgb(230,230,230)"| '''Description'''
 +
|-
 +
|1001 ||internal error|| Internal error, please contact the support!
 +
|-
 +
|1002 ||tac not accepted|| Tac not accepted, please accept tac!
 +
|-
 +
|1003 ||item_id not given|| The item id has not been given!
 +
|-
 +
|1004 ||item_id invalid|| The item id is invalid.
 +
|-
 +
|1005 ||item_id invalid|| The item id is invalid.
 +
|-
 +
|1006 ||item_id invalid|| The item id is invalid.
 +
|-
 +
|1007 ||item_id invalid|| The item id is invalid.
 +
|-
 +
|1008 ||item_id invalid|| The item id is invalid.
 +
|-
 +
|1009 ||internal error|| Internal error, please contact the support!
 +
|-
 +
|1010 ||domain_name not given|| Domain name needed but not given.
 +
|-
 +
|1011 ||domain_name invalid|| Domain name is not valid.
 +
|-
 +
|1012 ||domain_name not possible for item_id|| Domain name is not valid for this item id.
 +
|-
 +
|1013 ||domain_name invalid|| Domain name is not valid.
 +
|-
 +
|1014 ||internal error|| Internal error, please contact the support!
 +
|-
 +
|1015 ||internal error|| Internal error, please contact the support!
 +
|-
 +
|1016 ||domain_authcode not given|| Domain authcode needed but not given.
 +
|-
 +
|1017 ||internal error|| Internal error, please contact the support!
 +
|-
 +
|1018 ||internal error|| Internal error, please contact the support!
 +
|-
 +
|1019 ||internal error|| Internal error, please contact the support!
 +
 +
|}
 +
 +
==== PHP EXAMPLE ====
 +
[[API Documentation RunningExamples order external.create_order PHP]]
 +
 +
== vServer-related Methods ==
 +
=== vserver.list_vservers ===
 +
----
 +
 +
==== PURPOSE ====
 +
This Method is used to get all manageable vServers and basic details for further method calls. Only these vServers which are manageable by the used API user will be returned.
 +
 +
==== CALL PARAMETERS ====
 +
N/A
 +
 +
==== RETURNS ====
 +
{|width="100%" style="border-color:rgb(230,230,230); background-color:white;" cellpadding="5" cellspacing="0" border="2px solid"
 +
|-
 +
|width="25%" style="background-color:rgb(230,230,230)"|'''Field / Key Name''' ||width="25%" style="background-color:rgb(230,230,230)"|'''Type''' ||width="50%" style="background-color:rgb(230,230,230)"| '''Description'''
 +
|-
 +
|vserver_list_count||int||Number (amount) of available vservers
 +
|-
 +
|vserver_list_data||array asoc||Contains basic vserver details in a multidimensional, associative array. Keys of the first dimension equals the vserver order numbers: e.g. $array ['123456'] Values are contained in the second dimension: e.g. $array ['12345'] ['vsrv_main_ip'] returns the main
 +
|}
 +
 +
==== vserver_list_data – Keys of second dimension ====
 +
{|width="100%" style="border-color:rgb(230,230,230); background-color:white;" cellpadding="5" cellspacing="0" border="2px solid"
 +
|-
 +
|width="25%" style="background-color:rgb(230,230,230)"|'''Field / Key Name''' ||width="25%" style="background-color:rgb(230,230,230)"|'''Type''' ||width="50%" style="background-color:rgb(230,230,230)"| '''Description'''
 +
|-
 +
|order_desc||string||Description/Product name
 +
|-
 +
|vsrvord_id||int||vServer’s unique ID (required for further method calls)
 +
|-
 +
|vsrv_main_ip||string||Primary IP address
 +
|-
 +
|vsrv_name||string||vServer name (for network settings)
 +
|-
 +
|status||string enum||vServer or order status:<br> - “ready” means vserver can be used<br> - “in_rescue” means vserver can be used but it’s currently in rescue mode<br> - “in_process” means vserver is not available at present<br> - “locked” means vserver/order is locked by the provider
 +
|}
 +
 +
==== PHP EXAMPLE ====
 +
[[API_Documentation_RunningExamples_vserver.list_vservers_PHP]]
 +
 +
=== vserver.get_details ===
 +
----
 +
 +
==== PURPOSE ====
 +
This Method is used to get all details of a manageable vserver. Only these vservers are available, which are manageable by the used API.
 +
 +
==== CALL PARAMETERS ====
 +
{|width="100%" style="border-color:rgb(230,230,230); background-color:white;" cellpadding="5" cellspacing="0" border="2px solid"
 +
|-
 +
|width="25%" style="background-color:rgb(230,230,230)"|'''Field / Key Name''' ||width="25%" style="background-color:rgb(230,230,230)"|'''Type''' ||width="50%" style="background-color:rgb(230,230,230)"| '''Description'''
 +
|-
 +
|vsrvord_id||int||vServer's unique ID
 +
|}
 +
 +
====RETURNS ====
 +
{|width="100%" style="border-color:rgb(230,230,230); background-color:white;" cellpadding="5" cellspacing="0" border="2px solid"
 +
|-
 +
|width="25%" style="background-color:rgb(230,230,230)"|'''Field / Key Name''' ||width="25%" style="background-color:rgb(230,230,230)"|'''Type''' ||width="50%" style="background-color:rgb(230,230,230)"| '''Description'''
 +
|-
 +
|vserver_details||array (asoc)||Contains all vserver details in an associative array
 +
|}
 +
 +
==== vserver_details – Keys of second dimension ====
 +
{|width="100%" style="border-color:rgb(230,230,230); background-color:white;" cellpadding="5" cellspacing="0" border="2px solid"
 +
|-
 +
|width="25%" style="background-color:rgb(230,230,230)"|'''Key Name''' ||width="25%" style="background-color:rgb(230,230,230)"|'''Type''' ||width="50%" style="background-color:rgb(230,230,230)"| '''Description'''
 +
|-
 +
|order_no||int||vServer contract’s order number
 +
|-
 +
|order_desc||string||Description/Product name
 +
|-
 +
|vsrvord_id||int||vServer’s unique ID (required for further method calls)
 +
|-
 +
|vsrv_main_ip||string||Primary IP address
 +
|-
 +
|vsrv_name||string||vServer name (for network settings)
 +
|-
 +
|vsrv_name_reverse||string||vServer reversename (for network settings)
 +
|-
 +
|vsrv_netmask||string||Netmask for network / IP address setup
 +
|-
 +
|vsrv_broadcast||string||Broadcast address for network / IP address setup
 +
|-
 +
|vsrv_gateway||string||Gateway address for network / IP address setup
 +
|-
 +
|vsrv_status||string enum || vServer or order status:<br>- “ready” means vserver can be used <br> - “in_rescue” means vserver is currently in rescue mode<br> - “in_process” means vserver is not available at present<br>- “locked” means vserver/order is locked by the provider
 +
|-
 +
|vsrv_default_pw||string||Default password for initial login or rescue usage
 +
|-
 +
|vsrv_os_id||int||ID of currently used OS image (for reinstall)
 +
|-
 +
|vsrv_os_name||string||Name/description of currently used OS image
 +
|-
 +
|vsrv_os_is_64bit||bool||OS image 64bit support (true or false)
 +
|}
 +
 +
==== METHOD ERRORS ====
 +
{|width="100%" style="border-color:rgb(230,230,230); background-color:white;" cellpadding="5" cellspacing="0" border="2px solid"
 +
|-
 +
|width="25%" style="background-color:rgb(230,230,230)"|'''Code''' ||width="25%" style="background-color:rgb(230,230,230)"|'''Short Message''' ||width="50%" style="background-color:rgb(230,230,230)"| '''Description'''
 +
|-
 +
|1001 ||vsrvord_id not valid|| The vsrvord_id is not valid.
 +
|-
 +
|1002 ||vsrvord_id not valid|| The vsrvord_id is not valid.
 +
|-
 +
|1003 ||vsrvord_id not valid|| The vsrvord_id is not valid.
 +
|-
 +
|1004 ||vsrvord_id not assigned to customer|| The vsrvord_id is not assigned to your customer account.
 +
|-
 +
|1005 ||internal error|| Internal error, please contact the support!
 +
|-
 +
|1006 ||internal error|| Internal error, please contact the support!
 +
|-
 +
|1007 ||internal error|| Internal error, please contact the support!
 +
|-
 +
|1008 ||internal error|| Internal error, please contact the support!
 +
|-
 +
|1009 ||internal error|| Internal error, please contact the support!
 +
|-
 +
|1010 ||internal error|| Internal error, please contact the support!
 +
|-
 +
|1011 ||internal error|| Internal error, please contact the support!
 +
|}
 +
 +
==== PHP EXAMPLE ====
 +
[[API_Documentation_RunningExamples_vserver.get_details_PHP]]
 +
 +
=== vserver.reset ===
 +
----
 +
 +
==== PURPOSE ====
 +
This Method is used to perform a vserver reset.
 +
 +
==== CALL PARAMETERS ====
 +
{|width="100%" style="border-color:rgb(230,230,230); background-color:white;" cellpadding="5" cellspacing="0" border="2px solid"
 +
|-
 +
|width="25%" style="background-color:rgb(230,230,230)"|'''Field / Key Name''' ||width="25%" style="background-color:rgb(230,230,230)"|'''Type''' ||width="50%" style="background-color:rgb(230,230,230)"| '''Description'''
 +
|-
 +
|vsrvord_id||int||vServer’s unique ID
 +
|}
 +
 +
====RETURNS====
 +
Only “status” = “100” if request was accepted
 +
 +
==== METHOD ERRORS ====
 +
{|width="100%" style="border-color:rgb(230,230,230); background-color:white;" cellpadding="5" cellspacing="0" border="2px solid"
 +
|-
 +
|width="25%" style="background-color:rgb(230,230,230)"|'''Code''' ||width="25%" style="background-color:rgb(230,230,230)"|'''Short Message''' ||width="50%" style="background-color:rgb(230,230,230)"| '''Description'''
 +
|-
 +
|1001 ||vsrvord_id not valid|| The vsrvord_id is not valid.
 +
|-
 +
|1002 ||vsrvord_id not valid|| The vsrvord_id is not valid.
 +
|-
 +
|1003 ||vsrvord_id not valid|| The vsrvord_id is not valid.
 +
|-
 +
|1004 ||vsrvord_id not assigned to customer|| The vsrvord_id is not valid.
 +
|-
 +
|1005 ||internal error|| Internal error, please contact the support!
 +
|-
 +
|1006 ||internal error|| Internal error, please contact the support!
 +
|-
 +
|1007 ||internal error|| Internal error, please contact the support!
 +
|-
 +
|1008 ||internal error|| Internal error, please contact the support!
 +
|-
 +
|1009 ||internal error|| Internal error, please contact the support!
 +
|-
 +
|1010 ||internal error|| Internal error, please contact the support!
 +
|-
 +
|1011 ||internal error|| Internal error, please contact the support!
 +
|}
 +
 +
==== PHP EXAMPLE ====
 +
[[API_Documentation_RunningExamples_vserver.reset_PHP]]
 +
 +
= XML Fault-Codes (Error Messages) =
 +
----
 +
 +
{|width="100%" style="border-color:rgb(230,230,230); background-color:white;" cellpadding="5" cellspacing="0" border="2px solid"
 +
|colspan="3" style="background-color:rgb(230,230,230)"|
 +
==Internal Errors ==
 +
|-
 +
|width="25%"|'''Code''' ||width="25%"|'''Short Message''' ||width="50%"| '''Description'''
 +
|-
 +
|10001 ||Service temporary not available ||Service temporary not available. Try again later.
 +
|-
 +
|10021 ||Internal database error ||Error while connecting to internal database. Please contact the support!
 +
|-
 +
|10022 ||Internal database error ||Error while execute SQL-Query. Please contact the support!
 +
|-
 +
|10041 ||No such method: <method name> ||The requested method does not exist.
 +
|-
 +
|10042 ||Method temporary locked: <method name> ||The requested method is locked at present. Try again later.
 +
|-
 +
|10043 ||Internal error in method: <method name>||No return from called method. Please contact the support!
 +
|-
 +
|10044|| Internal error in method: <method name>||<Method returned an (internal) error.
 +
|}
 +
 +
 +
 +
{|width="100%" style="border-color:rgb(230,230,230); background-color:white;" cellpadding="5" cellspacing="0" border="2px solid"
 +
|colspan="3" style="background-color:rgb(230,230,230)"|
 +
== Request Errors / Sanity Check Errors ==
 +
|-
 +
|width="25%"|'''Code''' ||width="25%"|'''Short Message''' ||width="50%"| '''Description'''
 +
|-
 +
|10002 ||Wrong HTTP-Header ||HTTP-Header error: No 'method' declared
 +
|-
 +
|10003 ||Wrong HTTP-Header ||HTTP-Header error: 'method' must be 'POST'
 +
|-
 +
|10004 ||Wrong HTTP-Header ||HTTP-Header error: No 'contenttype' declared
 +
|-
 +
|10005 ||Wrong HTTP-Header ||HTTP-Header error: 'contenttype' must be 'text/xml'
 +
|-
 +
|10006 ||Wrong HTTP-Header ||HTTP-Header error: 'contentlength' required
 +
|-
 +
|10007 ||Wrong HTTP-Header ||HTTP-Header error: 'contentlength' cannot be zero
 +
|-
 +
|10008 ||Request error: length mismatch ||Length of request does not match with notation in header. See 'content-length' in header.
 +
|-
 +
|10009 ||Request is too large|| Exceeding of maximum request length
 +
|-
 +
|10010 ||Missing required parameter: <parameter> ||Given parameter is required by called method but it is missing.
 +
|-
 +
|10011 ||Wrong parameter format: <parameter>||Given parameter is in a wrong format. Please check api documentation.
 +
|-
 +
|10012 ||Unknown value for parameter <param> : <value> ||Given value for mentioned key is unknown or incorrect. Maybe a typo?
 +
|-
 +
|10013|| Unknown parameter: <parameter>||Given parameter is unknown. Maybe a typo?
 +
|}
 +
 +
 +
 +
{|width="100%" style="border-color:rgb(230,230,230); background-color:white;" cellpadding="5" cellspacing="0" border="2px solid"
 +
|colspan="3" style="background-color:rgb(230,230,230)"|
 +
== Authentication Errors ==
 +
|-
 +
|width="25%"|'''Code''' ||width="25%"|'''Short Message''' ||width="50%"| '''Description'''
 +
|-
 +
|10031 ||Authentication failed ||Authentication failed: empty username
 +
|-
 +
|10032 ||Authentication failed ||Authentication failed: empty passphrase
 +
|-
 +
|10033 ||Authentication failed ||Authentication failed: no such user / wrong password / account locked / no permission
 +
|-
 +
|10034 ||Authentication failed ||IP address restriction: remote address does not match.
 +
|-
 +
|10035 ||Authentication failed ||Error in user accounting settings, no main account specified. Please contact support.
 +
|-
 +
|10036 ||Authentication failed ||Responsible management account is locked.
 +
|-
 +
|10039 ||Permission denied. ||User has no permission for called method.
 +
|}
 +
 +
 +
 +
{|width="100%" style="border-color:rgb(230,230,230); background-color:white;" cellpadding="5" cellspacing="0" border="2px solid"
 +
|colspan="3" style="background-color:rgb(230,230,230)"|
 +
== API User-Management Errors ==
 +
|-
 +
|width="25%"|'''Code''' ||width="25%"|'''Short Message''' ||width="50%"| '''Description'''
 +
|-
 +
|11001 ||Name/ID not available ||Provided acc_sub_id is not available for creation or already exists.
 +
|-
 +
|11002 ||Internal error while creating subaccount.|| Internal error, please contact support.
 +
|-
 +
|11003 ||No permission for group <group>|| Main account has no permission for mentioned group.
 +
|-
 +
|11006 ||Max. user accounts reached ||Unable to create a new user account due max. user account restriction. Please contact support for further capability!
 +
|-
 +
|11010 ||Unable to modify account: <acc_id>||Provided acc_sub_id does not exist or permission was denied.
|}
|}

Aktuelle Version vom 09:08, 11. Sep. 2019

Languages: 

Deutsch Image:Deutsch.png • English Image:English.png


Inhaltsverzeichnis


EUserv Reseller API

Introduction

Technology

Our API is based on the XML-RPC protocol, which is a Remote Procedure Calling protocol that works via Internet.

XML-RPC messages are HTTP-POST requests in XML (Extensible Markup Language).

A “method call” will be executed on the server and will produce a response, which is also formatted in XML and which can be decoded into several variables.
Method call parameters and returned variables can be strings, integers (numbers) and also complex types like arrays and hashes. Required parameters and return values are method-specific. Some parameters or return values are marked as “optional”; all other values/parameters are required.

API Servers

Please note that both servers currently use self-signed SSL certificates! It is possible, that you have to disable “peer verifying” to connect!

The live environment is available via HTTPS (HTTP via SSL, Port 443) at:
– https://api.euserv.net:443
For developing/testing purposes, please use the sandbox environment, which is also available via HTTPS(Port 443) at:
– https://api.test.euserv.net:443

The sandbox environment is a virtual environment for testing and developing. All data/values/servers/orders will be copied into the sandbox environment every night, excepting the API user accounts. That means you have to create separate API user accounts within the sandbox environment. Assigned tasks, e.g. server resets or reinstallations, will automatically marked as done every 5 minutes.

PHP Examples

We have added PHP examples to show you, how you can use our API with PHP. In our examples, we use 'XML-RPC for PHP' as the core libary. You can find this libary here:
http://phpxmlrpc.sourceforge.net/.

History of Changes

Version Changes
0.5.1 - Add method 'server.ipaddr_get_reverse'
- Add method 'server.get_possible_server_items'
- Add method 'server.order_server'
0.5.2 - Update method 'server.get_possible_server_items'
- Update method 'server.order_server'
0.5.3 - Add method 'domain.get_domain_orders'
- Add method'domain.get_domain_order_details'
- Add method 'domain.dns_create_record'
- Add method 'domain.dns_delete_record'
- Add method 'domain.dns_update_record'
- Add method 'domain.dns_get_active_records'
- Add method 'domain.redirect_create_record'
- Add method 'domain.redirect_delete_record'
- Add method 'domain.redirect_update_record'
- Add method 'domain.redirect_get_active_records'
- Add internal methods
0.5.4 - Add method 'server.get_traffic_graph'
- Update internal methods
0.5.5 - Add/Update internal methods
0.5.6 - Add method 'domain.check'
- Add method 'order_external.get_possible_items'
- Add method 'order_external.create_order
0.6.9 - Add method 'vserver.list_vservers'
- Add method 'vserver.get_details'
- Add method 'vserver.reset'
- Add method 'server.get_possible_failover_servers'
- Add method 'server.get_ipaddr_inetnum_list'
- Add method 'server.get_ipaddr_list'
- Add method 'server.ipaddr_assign'
- Add method 'server.ipaddr_release'
- Add method 'server.ipaddr_assign_failover'
- Add method 'server.ipaddr_release_failover'
- Update method 'server.get_details'
- Add/Update internal methods


Method Specifications

Introduction

The following part contains information about method calls, method parameters and method return values.
Generally, if a method call was completed successfully, the return message will include the following status code:

Field Type Value
status int 100

If a method call was failed, a XML-Fault message with “Fault-Code” and “Fault-String” will be returned.(See also chapter “XML Fault-Codes”)

API Debug/Testing Methods

debug.get_api_version

PURPOSE

This Method returns the current API version.

CALL PARAMETERS

N/A

RETURNS

Field / Key Name Type Description
api_version string Current API version

PHP EXAMPLE

API Documentation RunningExamples debug.get_api_version PHP

debug.pingpong

PURPOSE

This Method returns all the parameters, it was called with. You can use it to check the format of your call parameters. Notice that only supported parameter keys with correctly formatted values will be accepted!

CALL PARAMETERS

Every supported parameter key; see parameters of other methods.

RETURNS

Every committed parameter with its committed value.

PHP EXAMPLE

API Documentation RunningExamples debug.pingpong PHP

API User-Management Methods

usermngt.create_acc

PURPOSE

This Method is used to create new API user accounts

CALL PARAMETERS

Field / Key Name Type Description
acc_sub_id string Name of the new account; will be attached to management account's name separated by a point. (e.g. 'subacc' will become api123.subacc) Required are 3-8 chars [a-z] or [0-9]
acc_passwd_base64 string base64 Password for the new account (has to be base64-encoded) acc_ipv4_bindings string At least one allowed IPv4 address for using the new account. You can specify multiple values; each separated by a semicolon. Network-addresses and IPranges will not work.
acc_allowed_groups (optional)stringMethod group memberships for this account. Management account needs permissions for every mentioned group. You can specify multiple

RETURNS

Field / Key Name Type Description
acc_name string The complete name of the new account (e.g. 'api1234.subacc')
acc_added_ip_bindings int Number (amount) of added IP bindings
acc_added_groups int Number (amount) of added group memberships

usermngt.modify_acc

PURPOSE

This Method is used to modify settings and/or permissions of API user accounts.

CALL PARAMETERS

Field / Key Name Type Description
acc_id string Complete name of the account which will be modified (e.g. 'acc_id' => 'api1234.subacc')
acc_passwd_base64 (optional)string base64New account password in base64-encoded format. Using this parameter will overwrite the old password.
acc_ipv4_bindings (optional) string At least one allowed IPv4 address for using the new account. You can specify multiple values; each separated by a semicolon. Networkaddresses and IP-ranges will not work. You can specify multiple values, each separated by a semicolon. Using this parameter will overwrite old bindings.
acc_allowed_groups (optional)stringThis parameter will set method group memberships for the account and overwrite existing ones. Management account needs permissions for every mentioned group. You can specify multiple values, each separated by a semicolon. (e.g. 'acc_allowed_groups' => 'domain;server;vserver')
acc_status (optional)string enumParameter to deactivate or to (re-)activate theParameter to deactivate or to (re-)activate the account Value must be “active” or “inactive”

RETURNS

Field / Key Name Type Description
acc_password_changedboolShows if password has changed or not
acc_ip_bindings_changedboolShows if IP bindings have changed or not
acc_groups_changedboolShows if group memberships have changed or not
acc_status_changedboolShows if account's status has changed or not (has set active or inactive)

usermngt.list_acc

PURPOSE

This Method is used to get all API user accounts and their settings/details

CALL PARAMETERS

N/A

RETURNS

Field / Key Name Type Description
acc_list_countintNumber (amount) of available API user accounts
acc_list_dataarray asoc Contains all the account data in a multidimensional, associative array.

Array’s keys equals API user’s login names, e.g. $array ['api1234.subacc']

Values are contained in the second dimension, e.g. $array ['api1234.subacc'] ['status']

acc_list_data – Keys of second dimension

Field / Key Name Type Description
statusstringAccount’s status, can be “active” or “inactive”
createdstring“Datetime” of account creation
lastchangestring“Datetime” of account’s last change groups array Contains all active method group names (e.g. 0 => “server”, 1 => “vserver”)
ip_bindingsarrayContains all active IP bindings (IP restrictions)

Server-related Methods

server.list_servers

PURPOSE

This Method is used to get all manageable servers and basic details for further method calls. Only these servers which are manageable by the used API user will be returned.

CALL PARAMETERS

N/A

RETURNS

Field / Key Name Type Description
server_list_countintNumber (amount) of available servers
server_list_dataarray asocContains basic server details in a multidimensional, associative array. Keys of the first dimension equals the server order numbers: e.g. $array ['123456'] Values are contained in the second dimension: e.g. $array ['12345'] ['srv_main_ip'] returns the main

server_list_data – Keys of second dimension

Field / Key Name Type Description
order_descstringDescription/Product name
srv_idintServer’s unique ID (required for further method calls)
srv_main_ipstringPrimary IP address
srv_namestringServer name (for network settings)
statusstring enumServer or order status:
- “ready” means server can be used
- “in_rescue” means server can be used but it’s currently in rescue mode
- “in_process” means server is not available at present
- “locked” means server/order is locked by the provider

PHP EXAMPLE

API Documentation RunningExamples server.list_servers PHP

server.get_details

PURPOSE

This Method is used to get all details of a manageable server. Only these servers are available, which are manageable by the used API.

CALL PARAMETERS

Field / Key Name Type Description
srv_idintServer's unique ID

RETURNS

Field / Key Name Type Description
server_detailsarray (asoc)Contains all server details in an associative array

server_details – Keys of second dimension

Key Name Type Description
order_nointServer contract’s order number
order_descstringDescription/Product name
srv_idintServer’s unique ID (required for further method calls)
srv_main_ipstringPrimary IP address
srv_namestringServer name (for network settings)
srv_netmaskstringNetmask for network / IP address setup
srv_broadcaststringBroadcast address for network / IP address setup
srv_gatewaystringGateway address for network / IP address setup
srv_statusstring enum Server or order status:
- “ready” means server can be used
- “in_rescue” means server is currently in rescue mode
- “in_process” means server is not available at present
- “locked” means server/order is locked by the provider
srv_default_pwstringDefault password for initial login or rescue usage
srv_macstringMAC-Address of server’s first network device
srv_mac2 (optional)stringMAC-Address of server’s optional second network device
srv_cpustringProcessor (Product) name / Description
srv_cpu_coresintNumber of (available) CPU cores
srv_cpu_mhzintCPU clock rate in MHz srv_64bit_support bool CPU support for 64bit (true or false)
srv_ram_typestringType of used memory (e.g. DDR2-RAM)
srv_ram_sizeintSize of memory in MB
srv_hdd_typestringHarddisk bus type (e.g. SATA)
srv_hdd_sizeintSize of each hdd (e.g. 250)
srv_hdd_countintNumber of installed harddisks
srv_has_hwraidboolHardware-RAID support (true or false)
srv_hwraid_levelstringUsed Hardware-RAID level (“none” or level, e.g. “1”)
srv_os_idintID of currently used OS image (for reinstall)
srv_os_namestringName/description of currently used OS image
srv_os_is_64bitboolOS image 64bit support (true or false)
srv_pro_optionintServer Pro-Option on/off (1/0)
srv_features_prooption_possibleintSupport for Pro-Option (1/0)
srv_features_failover_ipintFailover ip feature support (1/0)
srv_features_create_compatible_macintSupport for vmware compatible mac addresses (1/0)
srv_ipaddresses_max_without_costint Maximum number of ip addresses without cost
srv_ipaddresses_max_with_costint Maximum number of ip addresses with cost
srv_ipaddresses_max_withint Maximum number of ip addresses (without cost + with cost)
srv_ipaddresses_used_without_costint Used number of ip addresses without cost
srv_ipaddresses_used_with_costint Used number of ip addresses with cost
srv_ipaddresses_used_withint Used number of ip addresses (without cost + with cost)
srv_ipaddresses_possible_without_costint Assignable number of ip addresses without cost
srv_ipaddresses_possible_with_costint Assignable number of ip addresses with cost
srv_ipaddresses_possible_withint Assignable number of ip addresses (without cost + with cost)

PHP EXAMPLE

API Documentation RunningExamples server.get_details PHP

server.get_possible_failover_servers

PURPOSE

This method is used to get all possible servers, which are applicable for failover ip assignments, i.e. which have the failover ip feature enabled. Only servers which are manageable by the used API user will be returned.

CALL PARAMETERS

N/A

RETURNS

Field / Key Name Type Description
failover_server_list_countintNumber (amount) of available servers, which are applicable for failover ip assignments
failover_server_listarray asocContains basic server details in a multidimensional, associative array.

failover_server_list – Keys of second dimension

Key Name Type Description
ord_idintID of the server order
item_descriptionstringDescription/Product name

METHOD ERRORS

Code Short Message Description
1001nothing found No possible failover servers found.

PHP EXAMPLE 

API Documentation RunningExamples server.get_possible_failover_servers PHP

server.get_possible_os_images

PURPOSE

This Method is used to get all possible OS images for a specific server ID. Only compatible and usable OS images will be returned here.

CALL PARAMETERS

Field / Key Name Type Description
srv_id int Server's unique ID

RETURNS

Field / Key Name Type Description
os_images_asoc_arrayarray asocContains details of every possible/available OS image in a multidimensional, associative array. Keys of the first dimension equals the OS image number, called “os_id”: e.g. $array ['240'] Values are contained in the second dimension: e.g. $array ['240'] ['os_name'] returns the name/description of OS image with ID 240.

os_images_asoc_array – Keys of second dimension

Key Name Type Description
os_idintID of OS image (for reinstall)
os-statusstring enum stable | unstable | testing
os_namestringName/description of OS image
os_is_64bitboolOS image 64bit support (true or false)
os_raidlevelintProvided software RAID level or “-1” if none

PHP EXAMPLE

API Documentation RunningExamples server.get_possible_os_images PHP

server.reset

PURPOSE

This Method is used to perform a hard server reset.

CALL PARAMETERS

Field / Key Name Type Description
srv_idintServer’s unique ID

RETURNS

Only “status” = “100” if request was accepted

PHP EXAMPLE

API Documentation RunningExamples server.reset PHP

server.autoreinstall

PURPOSE

This Method is used to perform an automatic server reinstall with a specified OS image ID. Only compatible images will be accepted – you can obtain a list of all compatible OS images by using the “server.get_possible_os_images” API method.

CALL PARAMETERS

Field / Key Name Type Description
srv_idintServer’s unique ID
srv_os_idintID of target OS image
srv_perform_resetboolPerform automatic server reset, to start installation? (“true” or “false”) If you choose “false” here, you have to perform

RETURNS

Only “status” = “100” if request was accepted

PHP EXAMPLE

API Documentation RunningExamples server.autoreinstall PHP

server.rescue_activate

PURPOSE

This Method is used to activate a rescue system for a specified server, which will be started during next boot.

CALL PARAMETERS

Field / Key Name Type Description
srv_idintServer's unique ID
srv_perform_resetboolPerform automatic server reset, to start rescue system? (“true” or “false”)
If you choose “false” here, you have to perform a manual reboot via SSH to start the rescue system.
rescue_modeint{optional} the desired rescue mode (1 = enable default rescue, 2 = enable vKVM, 3 = enable Linux rescue 64 bit, 4 = enable rescue 32 bit (only old systems), 5 = enable FreeBSD rescue 64 bit, 6 = enable FreeBSD rescue 32 bit (only old systems), 7 = enable Windows rescue)

RETURNS

Only “status” = “100” if request was accepted

PHP EXAMPLE

API Documentation RunningExamples server.rescue_activate PHP

server.get_ipaddr_inetnum_list

PURPOSE

This method is used to get a list of available ip nets (inetnums). The returned data can be used to assign an ip from a specific range to a server.

CALL PARAMETERS

N/A

RETURNS

Field / Key Name Type Description
inetnum_list_countintNumber (amount) of found inetnums
inetnum_listarray asocContains details of available ip nets (inetnums) in a multidimensional, associative array.

inetnum_list – Keys of second dimension

Key Name Type Description
ipinet_idintID of the inetnum
ipinet_netipstringThe net ip (e.g. 81.7.17.0)
ipinet_broadcaststringThe broadcast address (e.g. 81.7.17.255)

METHOD ERRORS

Code Short Message Description
1001c_id invalid Given customer ID is invalid.
1002internal error Internal error, please contact the support!
1003inetnum error Could not get inetnum list.
1004ip data error Could not get ip data.


PHP EXAMPLE 

API Documentation RunningExamples server.get_ipaddr_inetnum_list PHP

server.get_ipaddr_list

PURPOSE

This method is used to get a list of ip addresses, which are assigned to the given server order.

CALL PARAMETERS

Field / Key Name Type Description
srvord_id int Server orders's unique ID

RETURNS

Field / Key Name Type Description
ipadd_list_countintNumber (amount) of found ip addresses.
ipadd_listarray asocContains ip data in a multidimensional, associative array.

ipadd_list – Keys of second dimension

Key Name Type Description
ipadd_idintID of the ip address
ipadd_addressstringThe ip address
ipinet_broadcaststringThe broadcast address
ipinet_netmaskstringThe netmask
ipinet_gatewaystringThe gateway address
mac_addressstringThe mac address (if assigned)
failover_assigned_from_orderintIf this field is set, the ip is a failover ip, which was assigned from another server order.
failover_assigned_to_order_listarray asocThis field contains a list of server contracts in a multidimensional, associative array. It is only set, if this ip was assigned as a failover ip to at least one other server order.

failover_assigned_to_order_list – Keys of third dimension

Key Name Type Description
ord_idintThis field contains the unique order id of the server order, where this ip has been assigned as a failover ip

METHOD ERRORS

Code Short Message Description
1001srvord_id not given The server order id was not given.
1002no permission No permission for given server order.
1003internal error Internal error, please contact the support!
1004srvord_id invalid The given server order id is invalid
1005internal error Internal error, please contact the support!
1006internal error Internal error, please contact the support!
1007internal error Internal error, please contact the support!
1008server not ready The order of the given server is not ready.
1009internal error Internal error, please contact the support!
1010internal error Internal error, please contact the support!
1011internal error Internal error, please contact the support!


PHP EXAMPLE 

API Documentation RunningExamples server.get_ipaddr_list PHP

server.ipaddr_get_reverse

PURPOSE

This Method is used to get the current reverse DNS entry (PTR record) for a specified server IP address.

CALL PARAMETERS

Field / Key Name Type Description
srv_idintServer's unique ID
ip_addressstringIP address to get reverse entry for

RETURNS

Field / Key Name Type Description
ip_addressstringIP address for delivered record
ptr_reverse_recordstringReverse entry (PTR record)

PHP EXAMPLE

API Documentation RunningExamples server.ipaddr_get_reverse PHP

server.ipaddr_set_reverse

PURPOSE

This Method is used to set a reverse DNS entry for a specified server IP address.

CALL PARAMETERS

Field / Key Name Type Description
srv_idintServer's unique ID
ip_addressstringIP address to modify reverse entry
reverse_entrystringReverse entry for specified IP as hostname/

RETURNS

Only “status” = “100” if request was accepted

PHP EXAMPLE

API Documentation RunningExamples server.ipaddr_set_reverse PHP

server.ipaddr_assign

PURPOSE

This method is used to assign a coip to the given server.

CALL PARAMETERS

Field / Key Name Type Description
srvord_idintServer order's unique ID, where the ip address is assigned
ipinet_id(optional)intID of the ip range (inetnum), from where the ip is assigned
mac_vmware_compatible(optional)stringUse vmware compatible mac address off/on (0/1)

RETURNS

Field / Key Name Type Description
ipadd_idintUnique ID of the assigned ip address

METHOD ERRORS

Code Short Message Description
1001srvord_id not given The server order id was not given.
1002no permission No permission for given server order.
1003internal error Internal error, please contact the support!
1004srvord_id invalid The given server order id is invalid
1005internal error Internal error, please contact the support!
1006server not ready The order of the given server is not ready.
1007internal error Internal error, please contact the support!
1008c_id invalid Customer id is invalid.
1009internal error Internal error, please contact the support!
1010internal error Internal error, please contact the support!
1011ipinet_id invalid The given ipinet_id is invalid.
1012internal error Internal error, please contact the support!
1013ip max reached The maximum number of ip addresses for the given server order is reached.
1014internal error Internal error, please contact the support!
1015internal error Internal error, please contact the support!
1016internal error Internal error, please contact the support!
1017internal error Internal error, please contact the support!
1018internal error Internal error, please contact the support!
1019internal error Internal error, please contact the support!
1020internal error Internal error, please contact the support!
1021internal error Internal error, please contact the support!
1022internal error Internal error, please contact the support!
1023internal error Internal error, please contact the support!
1024internal error Internal error, please contact the support!
1025internal error Internal error, please contact the support!

PHP EXAMPLE 

API Documentation RunningExamples server.ipaddr_assign PHP

server.ipaddr_release

PURPOSE

This method is used to release a coip from a server.

CALL PARAMETERS

Field / Key Name Type Description
ipadd_idintUnique ID of the ip address to release

RETURNS

Only “status” = “100” if request was accepted

METHOD ERRORS

Code Short Message Description
1001ipadd_id not given The ipadd_id was not given.
1002ipadd_id invalid The given ipadd_id is invalid.
1003ipadd_id invalid The given ipadd_id is invalid.
1004ipadd_id invalid The given ipadd_id is invalid.
1005already released The given ip is already released.
1006internal error Internal error, please contact the support!
1007server not ready The order of the given server is not ready.
1008no permission No permission for server order.
1009internal error Internal error, please contact the support!
1010internal error Internal error, please contact the support!
1011not releasable The given ip is not releasable.
1012internal error Internal error, please contact the support!
1013internal error Internal error, please contact the support!
1014internal error Internal error, please contact the support!
1015internal error Internal error, please contact the support!
1016internal error Internal error, please contact the support!

PHP EXAMPLE 

API Documentation RunningExamples server.ipaddr_release PHP

server.ipaddr_assign_failover

PURPOSE

This method is used to assign a coip to the given server as a failover ip.

CALL PARAMETERS

Field / Key Name Type Description
ipadd_idintUnique ID of the ip address, used as a failover ip
srvord_idintServer order's unique ID, where the ip address is assigned

RETURNS

Only “status” = “100” if request was accepted

METHOD ERRORS

Code Short Message Description
1001ipadd_id not given The ipadd_id was not given.
1002ipadd_id invalid The given ipadd_id is invalid.
1003srvord_id not given The server order id for the failover server was not given.
1004no permission No permission for the given failover server.
1005internal error Internal error, please contact the support!
1006server not ready The order of the given failover server is not ready.
1007internal error Internal error, please contact the support!
1008server not ready The given failover server is not ready.
1009ipadd_id invalid The given ipadd_id is invalid.
1010ipadd_id invalid The given ipadd_id is invalid.
1011ipadd_id invalid The given ipadd_id is invalid.
1012internal error Internal error, please contact the support!
1013internal error Internal error, please contact the support!
1014no permission No permission for the given server.
1015internal error Internal error, please contact the support!
1016server not ready The order of the given server is not ready.
1017server order error The given server order and the server order of the given ipadd_id cannot be the same.
1018internal error Internal error, please contact the support!
1019internal error Internal error, please contact the support!
1020feature unavailable On of the servers does not support the failover ip feature.
1021already assigned The given ip is already assigned to the given failover server.
1022already assigned The given ip cannot be assigned more than once without Pro-Option.
1023internal error Internal error, please contact the support!
1024internal error Internal error, please contact the support!
1025internal error Internal error, please contact the support!
1026internal error Internal error, please contact the support!
1027internal error Internal error, please contact the support!
1028internal error Internal error, please contact the support!
1029internal error Internal error, please contact the support!

PHP EXAMPLE 

API Documentation RunningExamples server.ipaddr_assign_failover PHP

server.ipaddr_release_failover

PURPOSE

This method is used to release a failover coip from a server.

CALL PARAMETERS

Field / Key Name Type Description
ipadd_idintUnique ID of the failover ip address to release
srvord_idintServer order's unique ID, where the given ip address is assigned as a failover ip

RETURNS

Only “status” = “100” if request was accepted

METHOD ERRORS

Code Short Message Description
1001ipadd_id not given The ipadd_id was not given.
1002ipadd_id invalid The given ipadd_id is invalid.
1003srvord_id not given The server order id for the failover server was not given.
1004internal error Internal error, please contact the support!
1005internal error Internal error, please contact the support!
1006internal error Internal error, please contact the support!
1007internal error Internal error, please contact the support!
1008ipadd_id invalid The given ipadd_id is invalid.
1009ipadd_id invalid The given ipadd_id is invalid.
1010internal error Internal error, please contact the support!
1011server not ready The given server is not ready.
1012no permission No permission for the given server.
1013internal error Internal error, please contact the support!
1014internal error Internal error, please contact the support!
1015not assigned The given ip is not assigned to the given server.
1016internal error Internal error, please contact the support!
1017internal error Internal error, please contact the support!
1018internal error Internal error, please contact the support!
1019internal error Internal error, please contact the support!

PHP EXAMPLE 

API Documentation RunningExamples server.ipaddr_release_failover PHP

server.ipv6addr_set_main

PURPOSE - (server.ipv6addr_set_main)

Creates a IPv6 address for the server.

CALL PARAMETERS - (server.ipv6addr_set_main)

Field / Key Name Type Description
srv_idintServer's unique ID/

RETURNS - (server.ipv6addr_set_main)

Field / Key Name Type Description
srv_main_ipv6stringNew IPv6 address

METHOD ERRORS - (server.ipv6addr_set_main)

Code Short Message Description
1001ipv6 address already exist The main IPv6 address is already set.
1002can not find ipv6prefix The IPv6 prefix can not be found.
1003can not find ipv4 adress The server is not ready yet.
1004can not generade ipv6 addressInternal error. Please contact the support!

PHP EXAMPLE - (server.ipv6addr_set_main)

API Documentation RunningExamples server.ipv6addr_set_main PHP

server.ipv6addr_get_reverse

PURPOSE - (server.ipv6addr_get_reverse)

This Method is used to get the current reverse DNS entry (PTR record) for a specified server IPv6 address.

CALL PARAMETERS - (server.ipv6addr_get_reverse)

Field / Key Name Type Description
srv_idintServer's unique ID
ipv6_addressstringIPv6 address to get reverse entry for

RETURNS - (server.ipv6addr_get_reverse)

Field / Key Name Type Description
ipv6_addressstringIPv6 address for delivered record
reverse_entrystringReverse entry (PTR record)

METHOD ERRORS - (server.ipv6addr_get_reverse)

Code Short Message Description
1001ipv6address not linked to srv_id The given IPv6 address is not linked to the Server.
1002no reverse-entry linkedThere is no reverse_entry linked to the IPv6 address.

PHP EXAMPLE - (server.ipv6addr_get_reverse)

API Documentation RunningExamples server.ipv6addr_get_reverse PHP

server.ipv6addr_set_reverse

PURPOSE - (server.ipv6addr_set_reverse)

This Method is used to set a reverse DNS entry for a specified server IPv6 address.

CALL PARAMETERS - (server.ipv6addr_set_reverse)

Field / Key Name Type Description
srv_idintServer's unique ID
ipv6_addressstringIPv6 address to modify reverse entry
reverse_entrystringReverse entry for specified IP as hostname/

RETURNS - (server.ipv6addr_set_reverse)

Field / Key Name Type Description
ipv6_addressstringIPv6 address for delivered record
reverse_entrystringReverse entry (PTR record)

METHOD ERRORS - (server.ipv6addr_set_reverse)

Code Short Message Description
1001ipv6address not linked to srv_id The given IPv6 address is not linked to the Server.
1002internal error Internal error. Please contact the support!
1003internal errorInternal error. Please contact the support!
1004internal errorInternal error. Please contact the support!
1005no reverse_entry linkedThere is no reverse_entry linked to ipv6 address function.

PHP EXAMPLE - (server.ipv6addr_set_reverse)

API Documentation RunningExamples server.ipv6addr_set_reverse PHP

server.get_possible_server_items

PURPOSE

This Method is used to display all possible server-items you can order. Please note that this function only available for Reseller.

CALL PARAMETERS

N/A

RETURNS

Field / Key Name Type Description
possible_server_itemsarray (asoc)Contains all possible serveritems in a associative array

possible_server_items - Keys of second dimension

Key Name Type Description
item_idintServer-item unique ID
item_namestringThe name of the server-item
item_net_amountstringThe net amount of the serveritem (per billing period)
item_gross_amountstringThe gross amount of the serveritem (per billing period)
item_net_setup_feestringThe net setup fee (unique) of the server-item
item_gross_setup_feestringThe gross setup fee (unique) of the server-item
item_billing_periodintThe period you have to pay for your server (in months)
item_contract_running_timeintThe running time of the contract

METHOD ERRORS

Code Short Message Description
1001can not load customer_idError while loading the customer_id from api-user. Please contact the support!
1002can not load as_idError while loading the as_id from api-user. Please contact the support!
1003internal errorInternal error. Please contact the support!
1004no possible items foundThere are no possible serveritems you can order.
1005this function is only available for resellerYou are not a reseller, you can not use this function.

PHP EXAMPLE

API Documentation RunningExamples server.get_possible_server_items PHP

server.order_server

PURPOSE

This method is used to order some server. Please note that this function only available for Reseller.

CALL PARAMETERS

Field / Key Name Type Description
<item_id>intUse the item_id of the serveritem you want to order as a key and the quantity of the server as the value eg. '11716' => '1' (order one server with the item_id '11716')
accept_terms_and_conditionsboolSet this flag to accept the terms and conditions(0 = NO, 1= YES). If you don't accept the terms and conditions, you can't order server. The terms and conditions can be found here:
http://euserv.de/unternehmen/agb.php
accept_special_terms_and_conditions_rootserverboolSet this flag to accept the spezial terms and conditions rootserver(0 = NO, 1= YES). If you don't accept the spezial terms and conditions rootserver, you can't order server. The spezial terms and conditions rootserver can be found here:
http://euserv.de/produkte/server/tosfdrs.php

RETURNS

Field / Key Name Type Description
total_amountstringThe total amount for the server you have ordered

METHOD ERRORS

Code Short Message Description
1001can not load customer_idError while loading the customer_id from api-user. Please contact the support!
1002can not load a_idError while laoding the as_id from api-user. Please contact the support!
1003terms and conditions must be acceptedTo order server you must accept the terms and conditions.
1004special terms and conditions rootserver must be acceptedTo order server you must accept the spezial terms and conditions rootserver.
1005internal errorInternal error. Please contact the support!
1006no items foundNo items found. Please check your request.
1007internal errorInternal error. Please contact the support!
1008invalid item_id foundOne of your item-ids is invalid. Please check your request.
1009internal errorInternal error. Please contact the support!
1010this function is only available for resellerYou are not a reseller, you can not use this function.

PHP EXAMPLE

API Documentation RunningExamples server.order_server PHP

server.get_traffic_graph

PURPOSE

This method is used to get a traffic-graph for your server.

CALL PARAMETERS

Field / Key Name Type Description
srv_idintThe id of the server for which you want to get a traffic-graph.
graph_mode(optional)intThe mode of the graph you want to get (0 = LAST DAY, 1 = LAST WEEK,2 = LAST MONTH,3 = LAST YEAR).
graph_language(optional)stringThe language of the graph you want to get (ISO Country Code, lower case). Possible types are 'en', 'de'. Default is 'en'.

RETURNS

Field / Key Name Type Description
traffic_graphstringThe base64 encoded data of the graph you want to get.

METHOD ERRORS

Code Short Message Description
1001srv_id not givenThe srv_id was not given.
1002srv_graph_mode not validThe given srv_graph_mode is not valid.
1003can not load portdataCannot load portdata, please contact the support!
1004can not load portdataCannot load portdata, please contact the support!
1005can not load portdataCannot load portdata, please contact the support!

PHP EXAMPLE

API Documentation RunningExamples server.get_traffic_graph PHP

server.get_traffic

PURPOSE

This method reads the traffic of the submitted srvord_id and returns this.

CALL PARAMETERS

Field / Key Name Type Description
srvord_idintThe srvord_id od the desired server.
startdate(optional)stringThe startdate, format YYYY-mm-dd, if start date and end date are not specified the actual month is shown.
enddate(optional)stringThe end date, format YYYY-mm-dd, if start date and end date are not specified the actual month is shown.
date_format(optional)stringThe format in which the date should be issued, DEFAULT YYYY-mm-dd, details: HERE
unit_type(optional)intThe desired unit in which all be returned, possible values 1 = Kilobyte, 2 = Megabyte, 3 = Gigabyte, DEFAULT byte

RETURNS

Field / Key Name Type Description
statusint100 (everything ok - traffic has been read)
traffic_dataarray_asocA href of traffic data in which element ID is a sequential number (start = 0, end = traffic_data_count - 1)
traffic_data_countintThe number of elements in traffic_data
traffic_sumfloatThe number of the traffic over the desired period of time

traffic_data – Keys of second dimension

Key Name Type Description
Element IDarray_asocthe id of the element in the array

traffic_data – Keys of third dimension

Key Name Type Description
datestringThe date of the entry in the desired format
infloatthe incoming traffic in the desired format
outfloatthe outgoing traffic in the desired format
sumfloatthe entire traffic in the desired format

Domain-related Methods

domain.get_domain_orders

PURPOSE

This method is used to give you an overview of your domain orders an their features.

CALL PARAMETERS

N/A

RETURNS

Field / Key Name Type Description
domain_ordersarray asoc Contains domain order data

Keys of the second dimension

Field / Key Name Type Description
<order_id> array asoc Contains domain order data

Key of the third dimension

Field / Key Name Type Description
domain_idintThe id of the current domain.
domain_namestringThe name of the current domain.
domain_name_idnstringThe name idn of the current domain.
feature_redirectintTells you, if the redirect feature is disabled or enabled(0/1).
feature_dnsintTells you, if the redirect feature is disabled or enabled(0/1).

METHOD ERRORS

Code Short Message Description
1001can not load customer dataError while loading the customer data. Please contact the support!
1002no domain orders foundNo domain orders can be found.

PHP EXAMPLE

API Documentation RunningExamples domain.get_domain_orders PHP

domain.get_domain_order_details

PURPOSE

This method is used to get the details of the domain order.

CALL PARAMETERS

Field / Key Name Type Description
order_idintThe order id of that order you want to see the details.

RETURNS

Field / Key Name Type Description
domain_order_detailsarray asocContains domain order details.

domain_order_details - Keys of the second dimension

Field / Key Name Type Description
order_idarray asocContains domain order details.

<order_id> - Keys of the third dimension

Field / Key Name Type Description
order_statusintThe current order status(1 = ready, 3 = in process, 11 = transfer in process, 12 = waiting)
domain_idintThe domain id of the current domain.
domain_namestringThe domain name of the current domain.
domain_name_idnstringThe domain name of the current domain.
dns_record_typearray asocAn array asoc of available dns record types and there data .(A, AAAA, MX, AFSDB, CERT, CNAME, DNSKEY, DS, HINFO, KEY, LOC, NAPTR, NSEC, RP, RRSIG, SPF, SSHFP, SRV, TXT)
redirect_record_typearray asocAn array asoc of available redirect record types(frameredirect, headerredirect)
redirect_record_maxintThe maximum of redirect records you can create.
redirect_record_usedintThe count of used redirect records.
redirect_record_freeintThe count of free redirect records.

dns_record_type - Keys of the fourth dimension

Field / Key Name Type Description
<dns_record_type>array asocAn array asoc of the current dns record type data.

<dns_record_type> - Keys of the fifth dimension

Field / Key Name Type Description
dns_record_maxintThe maximum of dns records you can create.
dns_record_usedintThe count of dns records you have already used.
dns_record_freeintThe count of free dns records.

redirect_record_type – Keys of the fourth dimension

Field / Key Name Type Description
<redirect_record_type>intA flag that tells you if the redirect_record_type is available.

METHOD ERRORS

Code Short Message Description
1001order_id is invalidThe given order id is invalid
1002order_id is not managed by api userThe given order id is not managed by you
1003domain order not foundThe given domain order was not found.
1004internal errorInternal error, please contact the support!

PHP EXAMPLE

API Documentation RunningExample domain.get_domain_order_details PHP

domain.dns_create_record

PURPOSE

This method is used to create an dns record for your domain.

CALL PARAMETERS

Field / Key Name Type Description
domain_idintThe domain id of the domain you want to create a dns record.
dns_record_subdomain (optional)stringThe subdomain of the dns record you want to create.
dns_record_typestringThe type of the dns record you want to create. Possible Types are A, AAAA, MX, AFSDB, CERT, CNAME, DNSKEY, DS, HINFO, KEY, LOC, NAPTR, NSEC, RP, RRSIG, SPF, SSHFP, SRV, TXT
dns_record_valuestringThe value of the dns record you want to create ( e.g euserv.de).
dns_record_prio (optional)intThe record prio of the dns record you want to create(only essential for mx records).
dns_record_ttlintThe ttl of the dns record you want to create. At least 43200.

RETURNS

Field / Key Name Type Description
dns_record_idintThe id of the dns record you have created.

METHOD ERRORS

Code Short Message Description
1001domain_id not givenThe domain_id was not given.
1002dns_record_subdomain invalidThe given dns_record_subdomain is invalid.
1003dns_record_type not givenThe dns_record_type was not given.
1004dns_record_type not validThe given dns_record_type is not valid.
1005dns_record_value not givenThe dns_record_value was not given.
1006dns_record_value not validThe given dns_record_value is not valid.
1007dns_record_prio not givenYou want to create an mx record and no dns_record_prio was given.
1008dns_record_ttl not given or to lowThe dns_record_ttl was not given or lower then 43200.
1009domain not found There are no domain found for domain_id.
1010order not readyThe domain order is not ready so you can't create dns records.
1011domain not managed by customerThe domain of the given domain_id was not managed by you.
1012internal errorInternal error, please contact the support!
1013can not load domain dataCannot load domain data, please contact the support!
1014internal errorCannot load domain data, please contact the support!
1015dns_record_type not possible in this orderThe given dns_record_type is not available in your domain order.
1016dns_record limit reachedThe dns record limit has been reached.
1017internal errorInternal error, please contact the support!
1018dns_record already exitsThe dns record you want to create already exits.
1019internal errorInternal error, please contact the support!

PHP EXAMPLE

API Documentation RunningExamples domain.dns_create_record PHP

domain.dns_delete_record

PURPOSE

This method is used create a dns record of your domain.

CALL PARAMETERS

Field / Key Name Type Description
dns_record_id intThe id of the dns record you want to delete.

RETURNS

Only 'status' = '100' if request was accepted.

METHOD ERRORS

Code Short Message Description
1001customer_id not givenInternal error, please contact the support!
1002dns_record_id not givenThere are no dns_record_id given.
1003dns_record not foundNo dns record found for dns_record_id.
1004order not readyThe order of the dns_record_id is not ready.
1005dns_record not managed by customerThe dns record is not managed by you.

PHP EXAMPLE

API Documentation RunningExamples domain.dns_delete_record PHP

domain.dns_update_record

PURPOSE

This method is used to update a dns record for your domain.

CALL PARAMETERS

Field / Key Name Type Description
dns_record_idintThe id of the dns record you want to update.
dns_record_value(optional)stringThe new dns record value of the dns record you want to update
dns_record_prio(optional)intThe new prio of the dns_record you want to update (only essential for mx records).
dns_record_ttl(optional)intThe new ttl of the dns record you want to update. At least 43200.

RETURNS

Only 'status' = '100' if request was accepted.

METHOD ERRORS

Code Short Message Description
1001nothing to doThere is nothing to do! You send an empty request.
1002dns_record_id not givenThe dns_record_id was not given.
1003dns_record_id not validThe given dns_record_id is not valid.
1004internal errorInternal error, please contact the support!
1005dns_record_type not validInternal error, please contact the support!
1006dns_record_value not validThe given dns_record_value is not valid.
1007dns_record_type not accept dns_record_prioYou send dns_record_prio but the current dns_record_type does not accept dns_record_prio.
1008dns_record_ttl to lowThe given dns_record_ttl is lower 43200.
1009dns_record not foundNo dns record found for dns_record_id.
1010order not readyThe Domainorder is not in the status 'ready'.
1011dns_record not managed by customerThe dns_record of the given dns_record_id is not managed by you.
1012internal errorInternal error, please contact the support!
1013internal errorInternal error, please contact the support!
1014internal errorInternal error, please contact the support!

PHP EXAMPLE

API Documentation RunningExamples domain.dns_update_record PHP

domain.dns_get_active_records

PURPOSE

This method is used to show all activ dns records.

CALL PARAMETERS

Field / Key Name Type Description
domain_idintThe domain_id of the domain for which you want to see all the dns records.

RETURNS

Field / Key Name Type Description
dns_recordsarray asocAn array asoc of all activ dns records for your domain.

dns_records - Keys of the second dimension.

Field / Key Name Type Description
<dns_record_id>array asocAn array asoc with all data of the dns record.

<dns_record_id> - Keys of the third dimension

Field / Key Name Type Description
dns_record_namestringThe full name of the current dns record.
dns_record_typestringThe type of the current dns record.
dns_record_contentstringThe content of the current dns record.
dns_record_ttlintThe ttl of the current dns record.
dns_record_priointThe prio of the current dns record(only on mx records).

METHOD ERRORS

Code Short Message Description
1001customer_id not givenInternal error, please contact the support!
1002domain_id not givenThere is no domain_id given.
1003domain not foundNo domain found for domain_id.
1004order not readyThe order of the domain_id is not ready.
1005domain not managed by customerdomain not managed by customer
1006no dns_record foundNo dns records found for domain.

PHP EXAMPLE

API Documentation RunningExamples domain.dns_get_active_records PHP

domain.redirect_create_record

PURPOSE

This method is used to create a redirect record.

CALL PARAMETERS

Field / Key Name Type Description
domain_idintThe domain_id of the domain you want to create a redirect record for.
redirect_record_typestringThe type of redirect record you want to create. Possible types are frameredirect or headerredirect
redirect_record_subdomain (optional)stringThe subdomain of the redirect record you want to create.
redirect_record_locationstringThe location of the redirect_record. Only URL start with http:// OR https://).
redirect_record_status_code (optional)intAn webserver status code that describes the type of redirection(Only for redirect_record_type headerredirect). Available codes are 301, 302 and 307.
redirect_record_title (optional)stringThe title of your redirect record (Only for frameredirect).
redirect_record_description (optional)stringThe description of you redirect record (Only for frameredirect).
redirect_record_author (optional)stringThe description of you redirect record (Only for frameredirect).
redirect_record_keywords (optional)stringThe keywords of your redirect record (Only for frameredirect).
redirect_record_robots (optional)stringThe robot description of your redirect_record (Only for frameredirect).
redirect_record_favicon (optional)stringThe favicon url of your redirect_record (Only for frameredirect).

RETURNS

Field / Key Name Type Description
redirect_record_idintThe id of the redirect record you have created.

METHOD ERRORS

Code Short Message Description
1001domain_id not givenThe domain_id was not given.
1002redirect_record_type not givenThe redirect_record_type was not given
1003parameter redirect_record_title, redirect_record_description, redirect_record_author, redirect_record_keywords, redirect_record_robots, redirect_record_favicon not available for redirect_record_typeYou send invalid parameter for headerredirect.
1004redirect_record_location not givenThe redirect_record_location was not given.
1005redirect_record_status_code not givenThe redirect_record_status_code was not given.
1006parameter redirect_record_status_code not available for redirect_record_typeYou send invalid parameter for frameredirect.
1007redirect_record_location not validThe given redirect_record_location is not valid.
1008domain not foundNo domain found for domain_id.
1009order not readyThe domain order is not ready so you cannot create redirect records.
1010domain not managed by customerThe domain of the given domain_id was not managed by you.
1011internal errorInternal error, please contact the support!
1012internal errorInternal error, please contact the support!
1013internal errorInternal error, please contact the support!
1014redirect is not availableThe redirect feature is not available for this domain.
1015<redirect_record_type> is not available<redirect_record_type> is not available in this order.
1016redirect limit reachedThe redirect limit has reached.
1017redirect_record_wildcard is not availableYou want to set an wildcard and wildcard is not available for your order.
1018internal errorInternal error, please contact the support!
1019redirect_record already exitsThe redirect record you want to create already exits.

PHP EXAMPLE

API Documentation RunningExamples domain.redirect_create_record PHP

domain.redirect_delete_record

PURPOSE

This method is used to delete a redirect record.

CALL PARAMETERS

Field / Key Name Type Description
redirect_record_idintThe id of the redirect record you want to delete.

RETURNS

Only 'status' = '100' if request was accepted.

METHOD ERRORS

Code Short Message Description
1001customer_id not givenInternal error, please contact the support!
1002redirect_record_id not givenInternal error, please contact the support!
1003redirect_record not foundNo redirect record found for redirect_record id.
1004order not readyThe order of the redirect record id is not ready.
1005redirect_record not managed by customerThe redirect record is not managed by you.

PHP EXAMPLE

API Documentation RunningExamples domain.redirect_delete_record PHP

domain.redirect_update_record

PURPOSE

This method is used to update a redirect record.

CALL PARAMETERS

Field / Key Name Type Description
redirect_record_idintThe id of the redirect record you want to update.
redirect_record_location (optional)stringThe location of the redirect record you want to update. Only URL start with http:// OR https://).
redirect_record_status_code (optional)intAn webserver status code that describes the type of redirection (Only for redirect_record_type headerredirect). Available codes are 301, 302 and 307.
redirect_record_title (optional)stringThe title of your redirect record (Only for frameredirect).
redirect_record_description (optional)stringThe description of you redirect record (Only for frameredirect).
redirect_record_author (optional)stringThe description of you redirect record (Only for frameredirect).
redirect_record_keywords (optional)stringThe robots description of your redirect_record (Only for frameredirect).
redirect_record_favicon (optional)stringThe favicon url of your redirect_record (Only for frameredirect).

RETURNS

Only 'status' = '100' if request was accepted.

METHOD ERRORS

Code Short Message Description
1001redirect_record_id not given The redirect_record_id was not given.
1002 redirect_record not found No redirect record found for redirect_record id.
1003 order not ready The order of the redirect record id is not ready.
1004 redirect_record not managed by customer The redirect record is not managed by you.
1005 internal error Internal error, please contact the support!
1006 internal error Internal error, please contact the support!
1007 redirect_record_type not valid Internal error, please contact the support!
1008 parameter redirect_record_title, redirect_record_description, redirect_record_author, redirect_record_keywords, redirect_record_robots, redirect_record_favicon not available for redirect_record_type The current redirect record is a headerredirect and you send invalid parameter.
1009 nothing to do There is nothing to do.
1010 parameter redirect_record_status_code not available for redirect_record_typeThe current redirect record is a frameredirect and you send invalid parameter.
1011 nothing to do There is nothing to do.
1012 internal error Internal error, please contact the support!
1013 internal error Internal error,please contact the support!

PHP EXAMPLE

API Documentation RunningExamples domain.redirect_update_record PHP

domain.redirect_get_active_records

PURPOSE

This method is used to show all activ redirect records.

CALL PARAMETERS

Field / Key Name Type Description
domain_id intThe domain_id of the domain for which you want to see all the redirect records.

RETURNS

Field / Key Name Type Description
redirect_recordsarray asocAn array asoc of all activ redirect records for your domain.

redirect_records - Keys of the second dimension

Field / Key Name Type Description
<redirect_record_id>array asocAn array asoc with all data of the redirect record.

<redirect_record_id> - Keys of the third dimension

Field / Key Name Type Description
redirect_record_typestringThe type of the current redirect record.
redirect_record_status_code int The Webserver status code of the current redirect record. (only on headerredirect records)
redirect_record_name string The name of the current redirect record.
redirect_record_location string The location of the current redirect record.
redirect_record_title string The title of the current redirect record (only on frameredirect records).
redirect_record_description string The description of the current redirect record (only on frameredirect records).
redirect_record_author string The author of the current redirect record (only on frameredirect records).
redirect_record_keywords string The keywords of the current redirect record (only on frameredirect records).
redirect_record_robots string The robots description of the current redirect record (only on frameredirect records).
redirect_record_favicon string The favicon url of the current redirect record (only on frameredirect records).

METHOD ERRORS

Code Short Message Description
1001 customer_id not given Internal error, please contact the support!
1002 domain_id not given There is no domain_id given.
1003 domain not found No domain found for domain id.
1004 order not ready The order of the domain id is not ready.
1005 domain not managed by customer The domain is not managed by you.
1006 no redirect records found No redirect records found for domain.

PHP EXAMPLE

API Documentation RunningExamples domain.redirect_get_active_records PHP

domain.check

PURPOSE

This method is used for a short check if the domain is available.

CALL PARAMETERS

Field / Key Name Type Description
domain_name stringThe name of the domain you want to check.

RETURNS

Field / Key Name Type Description
is_availableint0(domain is not available) or 1 (domain is available)

PHP EXAMPLE

API Documentation RunningExamples domain.check PHP

Order-related Methods

order_external.get_possible_items

PURPOSE

This method is used to get a list of items that can be ordered.

CALL PARAMETERS

Field / Key Name Type Description
item_group stringThe item group you want to show. Possible item groups are server, vserver, cloud, hosting, mail or domain.
item_name_regexp (optional) string A regex to limit the result by item_name

RETURNS

Field / Key Name Type Description
item_listarray asocA list of all possible items.
item_list_countintThe count of the itemlist .

item_list - Keys of the second dimension

Field / Key Name Type Description
<item_list_id>array asocAn array asoc with all data of the item.

<item_list_id> - Keys of the third dimension

Field / Key Name Type Description
item_idintThe id of the item.
item_name string The name of the item.
item_billing_period int The billing period of the item.
item_contract_period int The contract period of the item.
item_mrcstring Monthly recurring costs of the item.
item_nrc string Non recurring costs of the item.
item_nrc_sale string Non recurring costs of the item if sale is active(only present if sale is active for this item).

METHOD ERRORS

Code Short Message Description
1001 internal error Internal error, please contact the support!
1002 item_group not given There is no item group given.
1003 item_group invalid The item group is not valid.
101004 pg_id invalid Internal error, please contact the support!
101005 can not load data Item data can not be load.

PHP EXAMPLE

API Documentation RunningExamples order_external.get_possible_items PHP

order_external.create_order

PURPOSE

This method is used for to create orders.

CALL PARAMETERS

Field / Key Name Type Description
item_id intThe item id of your destination item.
domain_name (optional) stringThe domain name for your order need for item group domain, hosting and mail.
domain_authcode (optional) stringThe authcode for your domain if your domain is not free.

RETURNS

Field / Key Name Type Description
total_amount_formattedstringThe amount of your order in format '0,00'.
total_amountfloatThe amount of your order in float format ('0.00').

METHOD ERRORS

Code Short Message Description
1001 internal error Internal error, please contact the support!
1002 tac not accepted Tac not accepted, please accept tac!
1003 item_id not given The item id has not been given!
1004 item_id invalid The item id is invalid.
1005 item_id invalid The item id is invalid.
1006 item_id invalid The item id is invalid.
1007 item_id invalid The item id is invalid.
1008 item_id invalid The item id is invalid.
1009 internal error Internal error, please contact the support!
1010 domain_name not given Domain name needed but not given.
1011 domain_name invalid Domain name is not valid.
1012 domain_name not possible for item_id Domain name is not valid for this item id.
1013 domain_name invalid Domain name is not valid.
1014 internal error Internal error, please contact the support!
1015 internal error Internal error, please contact the support!
1016 domain_authcode not given Domain authcode needed but not given.
1017 internal error Internal error, please contact the support!
1018 internal error Internal error, please contact the support!
1019 internal error Internal error, please contact the support!

PHP EXAMPLE

API Documentation RunningExamples order external.create_order PHP

vServer-related Methods

vserver.list_vservers

PURPOSE

This Method is used to get all manageable vServers and basic details for further method calls. Only these vServers which are manageable by the used API user will be returned.

CALL PARAMETERS

N/A

RETURNS

Field / Key Name Type Description
vserver_list_countintNumber (amount) of available vservers
vserver_list_dataarray asocContains basic vserver details in a multidimensional, associative array. Keys of the first dimension equals the vserver order numbers: e.g. $array ['123456'] Values are contained in the second dimension: e.g. $array ['12345'] ['vsrv_main_ip'] returns the main

vserver_list_data – Keys of second dimension

Field / Key Name Type Description
order_descstringDescription/Product name
vsrvord_idintvServer’s unique ID (required for further method calls)
vsrv_main_ipstringPrimary IP address
vsrv_namestringvServer name (for network settings)
statusstring enumvServer or order status:
- “ready” means vserver can be used
- “in_rescue” means vserver can be used but it’s currently in rescue mode
- “in_process” means vserver is not available at present
- “locked” means vserver/order is locked by the provider

PHP EXAMPLE

API_Documentation_RunningExamples_vserver.list_vservers_PHP

vserver.get_details

PURPOSE

This Method is used to get all details of a manageable vserver. Only these vservers are available, which are manageable by the used API.

CALL PARAMETERS

Field / Key Name Type Description
vsrvord_idintvServer's unique ID

RETURNS

Field / Key Name Type Description
vserver_detailsarray (asoc)Contains all vserver details in an associative array

vserver_details – Keys of second dimension

Key Name Type Description
order_nointvServer contract’s order number
order_descstringDescription/Product name
vsrvord_idintvServer’s unique ID (required for further method calls)
vsrv_main_ipstringPrimary IP address
vsrv_namestringvServer name (for network settings)
vsrv_name_reversestringvServer reversename (for network settings)
vsrv_netmaskstringNetmask for network / IP address setup
vsrv_broadcaststringBroadcast address for network / IP address setup
vsrv_gatewaystringGateway address for network / IP address setup
vsrv_statusstring enum vServer or order status:
- “ready” means vserver can be used
- “in_rescue” means vserver is currently in rescue mode
- “in_process” means vserver is not available at present
- “locked” means vserver/order is locked by the provider
vsrv_default_pwstringDefault password for initial login or rescue usage
vsrv_os_idintID of currently used OS image (for reinstall)
vsrv_os_namestringName/description of currently used OS image
vsrv_os_is_64bitboolOS image 64bit support (true or false)

METHOD ERRORS

Code Short Message Description
1001 vsrvord_id not valid The vsrvord_id is not valid.
1002 vsrvord_id not valid The vsrvord_id is not valid.
1003 vsrvord_id not valid The vsrvord_id is not valid.
1004 vsrvord_id not assigned to customer The vsrvord_id is not assigned to your customer account.
1005 internal error Internal error, please contact the support!
1006 internal error Internal error, please contact the support!
1007 internal error Internal error, please contact the support!
1008 internal error Internal error, please contact the support!
1009 internal error Internal error, please contact the support!
1010 internal error Internal error, please contact the support!
1011 internal error Internal error, please contact the support!

PHP EXAMPLE

API_Documentation_RunningExamples_vserver.get_details_PHP

vserver.reset

PURPOSE

This Method is used to perform a vserver reset.

CALL PARAMETERS

Field / Key Name Type Description
vsrvord_idintvServer’s unique ID

RETURNS

Only “status” = “100” if request was accepted

METHOD ERRORS

Code Short Message Description
1001 vsrvord_id not valid The vsrvord_id is not valid.
1002 vsrvord_id not valid The vsrvord_id is not valid.
1003 vsrvord_id not valid The vsrvord_id is not valid.
1004 vsrvord_id not assigned to customer The vsrvord_id is not valid.
1005 internal error Internal error, please contact the support!
1006 internal error Internal error, please contact the support!
1007 internal error Internal error, please contact the support!
1008 internal error Internal error, please contact the support!
1009 internal error Internal error, please contact the support!
1010 internal error Internal error, please contact the support!
1011 internal error Internal error, please contact the support!

PHP EXAMPLE

API_Documentation_RunningExamples_vserver.reset_PHP

XML Fault-Codes (Error Messages)

Internal Errors

Code Short Message Description
10001 Service temporary not available Service temporary not available. Try again later.
10021 Internal database error Error while connecting to internal database. Please contact the support!
10022 Internal database error Error while execute SQL-Query. Please contact the support!
10041 No such method: <method name> The requested method does not exist.
10042 Method temporary locked: <method name> The requested method is locked at present. Try again later.
10043 Internal error in method: <method name>No return from called method. Please contact the support!
10044 Internal error in method: <method name><Method returned an (internal) error.


Request Errors / Sanity Check Errors

Code Short Message Description
10002 Wrong HTTP-Header HTTP-Header error: No 'method' declared
10003 Wrong HTTP-Header HTTP-Header error: 'method' must be 'POST'
10004 Wrong HTTP-Header HTTP-Header error: No 'contenttype' declared
10005 Wrong HTTP-Header HTTP-Header error: 'contenttype' must be 'text/xml'
10006 Wrong HTTP-Header HTTP-Header error: 'contentlength' required
10007 Wrong HTTP-Header HTTP-Header error: 'contentlength' cannot be zero
10008 Request error: length mismatch Length of request does not match with notation in header. See 'content-length' in header.
10009 Request is too large Exceeding of maximum request length
10010 Missing required parameter: <parameter> Given parameter is required by called method but it is missing.
10011 Wrong parameter format: <parameter>Given parameter is in a wrong format. Please check api documentation.
10012 Unknown value for parameter <param> : <value> Given value for mentioned key is unknown or incorrect. Maybe a typo?
10013 Unknown parameter: <parameter>Given parameter is unknown. Maybe a typo?


Authentication Errors

Code Short Message Description
10031 Authentication failed Authentication failed: empty username
10032 Authentication failed Authentication failed: empty passphrase
10033 Authentication failed Authentication failed: no such user / wrong password / account locked / no permission
10034 Authentication failed IP address restriction: remote address does not match.
10035 Authentication failed Error in user accounting settings, no main account specified. Please contact support.
10036 Authentication failed Responsible management account is locked.
10039 Permission denied. User has no permission for called method.


API User-Management Errors

Code Short Message Description
11001 Name/ID not available Provided acc_sub_id is not available for creation or already exists.
11002 Internal error while creating subaccount. Internal error, please contact support.
11003 No permission for group <group> Main account has no permission for mentioned group.
11006 Max. user accounts reached Unable to create a new user account due max. user account restriction. Please contact support for further capability!
11010 Unable to modify account: <acc_id>Provided acc_sub_id does not exist or permission was denied.
Von „https://www.euserv.com/wiki/index.php/API_Documentation/en“