API documentation

General

API allows user to automate most actions that can be done using Artnet Customers Panel.
Connection to API is made by connecting to artnet.pl server using HTTPS protocol. Each command has its own URL path and it has to be called using POST request with command parameters given as POST variables. Request sended to server should looks like it was send from the POST HTML form. Server response is allways JSON object.

Connection

URL address to connect to API: https://panel.artnet.pl/api/COMMAND/NAME
String /COMMAND/NAME is a command name to call according to "API commands" section of this documentation.

Authorization

Authorization credentials have to be sent in each requst as command parameters (i.e. POST variables) id (customer ID) and api_key (API authorization key). Customer ID (id) is a number and it is the one using to login to Customers Panel. API key (api_key) is alphanumeric string that can be taken from Customers Panel - select "Customer" from menu, then from the "Utilities" sections choose "Manage API access". If API access is disabled, please enable it - new API key will be generated then.

Request example

Example request for getting detailed informations about specified service usign /services/details command can be as following:
POST /panel/api/services/details HTTP/1.1 Host: artnet.pl Cache-Control: no-cache Content-Type: application/x-www-form-urlencoded api_key=XXXXXXXXXXXXXXX&id=19052&service_id=12345


Servers response

Server`s response is allways an JSON object. Every response will contain field success (boolen), which value determines wheter command execution was successful. If error occures, success will be false and response will contain error object describing error. If command was successful response can be simply only success or can contain another fields according to what described in "API commands" section.

Response example

Example error response:
{ "success": false, "error": { "code": "unknown-command", "description": { "pl": "Nieznane polecenie", "en": "Unknown command" } } }
Example successful response (command: /services/details):
{ "service": { "id": 12345, "type": "dedicated", "name": "HP DL120 G7 123.123.123.123", "custom_description": null, "expiration_time": 1481213614, "payment_details": { "price": 527, "price_brutto": 648.21, "currency": "EUR", "payment_period": "1" }, "parent_service_id": 0, "ip": "123.123.123.123" }, "success": true }


Services types

  • dedicated -
  • colocation -
  • vps -
  • domain -
  • additional-ip -
  • avx -
  • easyisp -
  • hosting-artnet -
  • foip -
  • link -
  • software -
  • ssl -
  • other -


API commands

Module: customer Customer`s infomrations management. /customer/regenerate-api-key - generation of new API key Generation of new API key. Command returns new api_key value in response. After calling this command old API key in no longer valid. All feture requests have to use new API key to authorize. Response:
  • api_key (string) - newly generated API key
Error codes:
  • internal-update-error
/customer/emails-list - sended emails list List of lately sended email messages. Headers are sorted in descending order by date. Parameters:
  • limit (number) - maximal number of headers to fetch
  • offset (number) - offset of first record to fetch
Response:
  • emails_list (objects-list) - headers list
    • id (number) - unique ID of the email
    • time (timestamp) - time of sending the email
    • subject (string) - email subject
Error codes:
/customer/email-details - sended emails details Returns details of email message. Parameters:
  • email_id (number) - ID of email message
Response:
  • email (object) - email details
    • id (number) - unique ID of the email
    • time (timestamp) - time of sending the email
    • address (string) - address to which email was sent
    • subject (string) - email subject
    • body (string) - email body
Error codes:
  • invalid-id
/customer/change-language - change language Changes default language used in emails and Customers Panel. Parameters:
  • language (string) - language name
Error codes:
  • incorrect-param-value
/customer/get-language - fetch language Returns current language (for email messages and Customer Panel). Response:
  • language (string) - language name
/customer/details - customer details Returns details of customer. Response:
  • customer (object) - customer details
    • id (number) - unique ID
    • name (string) - customer name
    • nip (string) - VAT identification number
    • regon (string) - PESEL or REGON number (polish company or personal identification number)
    • street (string) - customer address - street
    • postcode (string) - customer address - postcode
    • city (string) - customer address - city
    • country_code (string) - customer address - country code
    • country_label (string) - customer address - country name
    • tel (string) - phone number
    • fax (string) - fax number
    • email (string) - email address
    • email_tech (string) - technical email address
    • email_invoice (string) - invoicing email address (for sending eInvoices)
    • correspondence_name (string) - correspondence address - receiver name
    • correspondence_street (string) - correspondence address - street
    • correspondence_postcode (string) - correspondence address - postcode
    • correspondence_city (string) - correspondence address - city
    • business (boolean) - legal form (true - business, false - individual person)
    • language (string) - language
    • currency (string) - default currency code
Error codes:
  • invalid-id
/customer/edit - edit customer details Edits details of customer. Allow edit customer and contact details. All parameters are optional. Only given parameters will be saved. Parameters:
  • customer[name] (string) - customer name
  • customer[nip] (string) - VAT identification number
  • customer[regon] (string) - PESEL or REGON number (polish company or personal identification number)
  • customer[street] (string) - customer address - street
  • customer[postcode] (string) - customer address - postcode
  • customer[city] (string) - customer address - city
  • customer[country_code] (string) - customer address - country code
  • customer[tel] (string) - phone number
  • customer[fax] (string) - fax number
  • customer[email] (string) - email address
  • customer[email_tech] (string) - technical email address
  • customer[email_invoice] (string) - invoicing email address (for sending eInvoices)
  • customer[correspondence_name] (string) - correspondence address - receiver name
  • customer[correspondence_street] (string) - correspondence address - street
  • customer[correspondence_postcode] (string) - correspondence address - postcode
  • customer[correspondence_city] (string) - correspondence address - city
  • customer[business] (string) - legal form (true - business, false - individual person)
Error codes:
  • incorrect-param-value
Module: services Services list and basic services management. /services/list - services list List of customer services. If optional parameter service_type is given list can be filtered by type. Parameters:
  • limit (number) - maximal number of records to fetch
  • offset (number) - offset of first record to fetch
  • service_type (string) - service_type (if given only services of given type will be returned)
  • parent_service_id (number) - parent service ID (if given and non-zero only child services of specified parent service will be returned)
Response:
  • services_list (objects-list) - services-list
    • id (number) - unique service ID
    • type (string) - service type
    • name (string) - service identification name (ea. domain name, hosting account login, etc..) or service name
    • custom_description (string) - custom (setted by customer) description of service
    • expiration_time (timestamp) - service expiration time
    • payment_details (object) - pricing and payment details
      • price (number) - price for payment period (VAT excluded)
      • price_brutto (number) - price for payment period (VAT included)
      • currency (string) - currency code (like PLN, USD, EUR)
      • payment_period (number) - payment period in months
    • parent_service_id (number) - parent service ID (if service has parent service) or 0
    • ip (string) - IP address, if applicable
Error codes:
/services/details - service details Returns details of selected service. Parameters:
  • service_id (number) - service ID
Response:
  • service (object) - service details
    • id (number) - unique service ID
    • type (string) - service type
    • name (string) - service identification name (ea. domain name, hosting account login, etc..) or service name
    • custom_description (string) - custom (setted by customer) description of service
    • expiration_time (timestamp) - service expiration time
    • payment_details (object) - pricing and payment details
      • price (number) - price for payment period (VAT excluded)
      • price_brutto (number) - price for payment period (VAT included)
      • currency (string) - currency code (like PLN, USD, EUR)
      • payment_period (number) - payment period in months
    • parent_service_id (number) - parent service ID (if service has parent service) or 0
    • ip (string) - IP address, if applicable
Error codes:
  • authorization-failed
Module: domain Services list and basic services management. /domain/list - domains list Returns list of all customer's domains. Command is literally the same as calling /services/list with parameter service_type=domain. /domain/details - domain details Returns details of domain. Parameters:
  • service_id (number) - service ID
Response:
  • service_details (object) - domain details
    • id (number) - unique service ID
    • domain_name (string) - domain name
    • manageable (boolean) - information on possibility to automatically changing DNS servers (if this field is false then you have to contact Customer Service)
    • dns_servers (ordered-list) - list of DNS servers of the domain (order is significant); if there is no information is Artnet internal system this field will not be present
Error codes:
  • authorization-failed
/domain/edit-dns-servers - edit DNS servers of domain Changes domain DNS delegation. Parameters:
  • service_id (number) - service ID
  • dns_servers (list) - multiple DNS hostnames as elements of the list (order is significant)
Error codes:
  • invalid-service-type
  • incorrect-param-value
  • dns-servers-insufficient
  • edit-dns-error
Module: easyisp List of hosting (EasyISP brand) services. /easyisp/list - services list Returns list of all customer's EasyISP hosting services. Command is literally the same as calling /services/list with parameter service_type=easyisp. /easyisp/details - EasyISP hosting details Returns details of EasyISP hosting. Parameters:
  • service_id (number) - service ID
Response:
  • service_details (object) - details
    • id (number) - unique service ID
    • login (string) - account login
    • package (string) - resources package name
Error codes:
  • authorization-failed
Module: avx List of hosting (AVX brand) services. /avx/list - services list Returns list of all customer's AVX hosting services. Command is literally the same as calling /services/list with parameter service_type=avx. /avx/details - AVX hosting details Returns details of AVX hosting. Parameters:
  • service_id (number) - service ID
Response:
  • service_details (object) - details
    • id (number) - unique service ID
    • login (string) - account login
    • package (string) - resources package name
Error codes:
  • authorization-failed
Module: hosting-artnet List of hosting (Artnet brand) services. /hosting-artnet/list - services list Returns list of all customer's Artnet branded hosting services. Command is literally the same as calling /services/list with parameter service_type=hosting-artnet. /hosting-artnet/details - hosting details Returns details of hosting. Parameters:
  • service_id (number) - service ID
Response:
  • service_details (object) - details
    • id (number) - unique service ID
    • login (string) - account login
    • package (string) - resources package name
Error codes:
  • authorization-failed
Module: ssl List of SSL certificates. /ssl/list - services list Returns list of all customer's Artnet branded hosting services. Command is literally the same as calling /services/list with parameter service_type=ssl. /ssl/details - SSL certificate details Returns details. Parameters:
  • service_id (number) - service ID
Response:
  • service_details (object) - details
    • id (number) - unique service ID
    • domain (string) - name of domain associated with the SSL certificate
    • certificate (object) - object describing certificate name
      • pl (string) - certificate name in polish
      • en (string) - certificate name in english
Error codes:
  • authorization-failed
Module: software List of software licences. /software/list - services list Returns list of all customer's software licences. Command is literally the same as calling /services/list with parameter service_type=software. /software/details - licence details Returns software licence details. Parameters:
  • service_id (number) - service ID
Response:
  • service_details (object) - details
    • id (number) - unique service ID
    • licence (object) - licence details
      • name (string) - software nad licence name
      • licences_number (number) - number of licences in this service
Error codes:
  • authorization-failed
Module: link-service List of internet connection services. /link-service/list - services list Returns list of all customer's internet connections. Command is literally the same as calling /services/list with parameter service_type=link. /link-service/details - Internet connection details Returns details about internet connection service. Parameters:
  • service_id (number) - service ID
Response:
  • service_details (object) - details
    • id (number) - unique service ID
    • bandwidth (object) - Bandwidth details.
      • up (number) - Bandwidth for outgoing traffic [Mbps].
      • down (number) - Bandwidth for incoming traffic [Mbps].
    • network_configuration (object) - Network configuration.
      • ip (string) - IP address
      • mask (string) - subnetwork mask
      • mask_short (string) - subnetwork mask short (like "\32")
Error codes:
  • authorization-failed
Module: fail-over-ip Fail-over IP services management. /fail-over-ip/list - services list Returns list of all customer's IP fail-over services. Command is literally the same as calling /services/list with parameter service_type=foip. /fail-over-ip/details - service details Returns details about IP fail-over service. Parameters:
  • service_id (number) - service ID
Response:
  • service_details (object) - details
    • id (number) - unique service ID
    • virtual_ip (string) - Virtual static external IP address.
    • real_ip (string) - The actual IP address on which traffic is routed currently or false if service is not active.
    • real_ips_allowed_list (strings-list) - List of IP addresses traffic can be switched to.
Error codes:
  • authorization-failed
/fail-over-ip/switch - switches real IP address Switches target (real) IP address on which traffic from external (virtual) IP address is routed. Parameters:
  • service_id (number) - service ID
  • real_ip (string) - new target address (have to be on the list of allowed addresses)
Error codes:
  • authorization-failed
  • invalid-service-type
  • incorrect-param-value
  • ip-not-allowed
  • internal-fail-over-ip-error
Module: additional-ip Additioanl IP services management. This kind of service allow list and order new IP addresses to data center services (dedicated server, colocation, VPS). /additional-ip/list - services list Returns list of all customer's additional IP services. Command is literally the same as calling /services/list with parameter service_type=additional-ip. /additional-ip/details - service details Returns details about additional IP service. Parameters:
  • service_id (number) - service ID
Response:
  • service_details (object) - details
    • id (number) - unique service ID
    • subnetworks (objects-list) - subnetworks list
      • id (number) - unique subnetwork ID number
      • ip (string) - subnetwork address
      • mask (string) - subnetwork's mask
      • mask_short (string) - mask short (in notation like '/29')
      • type (string) - subnetwork type (IPv4 / IPv6)
Error codes:
  • authorization-failed
/additional-ip/order-info - prices / informations about ordering new IP addresses Gives you informations about ordering new additional IP addresses. Additional IPs order is allways binded with data center service (dedicated server, colocation, VPS) and payment period and currency for IP addresses is determined by payment details of server. This command gives you information about price of ONE IP address for specified server. Price for higher number of IP addresses is calculated as price for one IP multiplied by number of IP addresses ordered. Prices are calculated for full payment period of server and aftrer placing an order will be added to price of server. This command will also give you information about maximum number of IP addresses that can be currently order. Parameters:
  • parent_service_id (number) - service ID of server for which additional IP price you want to be calculated
Response:
  • order_info (object) -
    • maximum_ips_number (number) - maximum number of IP addresses that can be currently order
    • one_ip_payment_details (object) - an object describing calculated payment details for ONE additional IP address
      • price (number) - price for ONE additional IP (VAT excluded)
      • price_brutto (number) - price for ONE additional IP (VAT included)
      • currency (string) - currency code (like PLN, EUR, USD)
      • payment_period (number) - payment period in months
Error codes:
  • invalid-parent-service-type
/additional-ip/order - order new additional IP addresses Makes an order for new IP addresses for specified data center service (dedicated server, colocation, VPS). After placing an order price for additional IP addresses (price of single IP address multiplied by number of addresses) is added to the price of parent service. New IP addresses are listed in order result and are immediately ready for configuration on your server (each address with mask 255.255.255.255). Price for one IP address for specified server can be checked by usign command /additional-ip/order-info Parameters:
  • parent_service_id (number) - service ID of server to which you want to assigns new IP addresses
  • ips_number (number) - number of new IP addresses to assign
Response:
  • order_details (object) - details of placed order
    • service_id (number) - unique ID of newly created additional IP addresses service
    • ips_number (number) - number of assigned IP addresses
    • ips_configuration (objects-list) - list of objects describing configuration of assigned addresses
      • ip (string) - IP address
      • mask (string) - IP mask that should be used to configure IP on the server
Error codes:
  • invalid-parent-service-type
  • invalid-ips-number
  • internal-service-create-error
  • internal-service-update-error
  • internal-additional-ip-error
Module: vps List of VPS servers. /vps/list - services list Returns list of all customer's VPS server services. Command is literally the same as calling /services/list with parameter service_type=vps. /vps/details - VPS server details Returns details of VPS server. Parameters:
  • service_id (number) - service ID
Response:
  • service_details (object) - details
    • id (number) - unique service ID
    • newtwork_configuration (object) - network configuration of VPS server
      • ip (string) - main IP address of VPS server
      • additional_ips_list (strings-list) - list of additional IP addresses
    • features (object) - features allowed for this server
      • power_management (boolean) - if it's true you can manage pawer of this VPS
    • power_state (string) - describses VPS power state ("unknown", "on" or "off")
    • active (boolean) - determines whether the server is active (true) or locked (false)
Error codes:
  • authorization-failed
/vps/power-on - change power-state to: ON Changes power-state of VPS server to: ON. Parameters:
  • service_id (number) - service ID
  • confirm (string) - value of this field has to be "confirm"
Error codes:
  • invalid-service-type
  • service-suspended
  • unsupported-feature
  • unconfirmed
  • internal-operation-error
/vps/power-off - change power-state to: OFF Changes power-state of VPS server to: OFF. Parameters:
  • service_id (number) - service ID
  • confirm (string) - value of this field has to be "confirm"
Error codes:
  • invalid-service-type
  • service-suspended
  • unsupported-feature
  • unconfirmed
  • internal-operation-error
/vps/power-restart - restart VPS Restarts VPS server power. Its acoomplished by sequentially turning server OFF and then ON again. Parameters:
  • service_id (number) - service ID
  • confirm (string) - value of this field has to be "confirm"
Error codes:
  • invalid-service-type
  • unsupported-feature
  • service-suspended
  • unconfirmed
  • internal-operation-error
Module: dedicated Management of dedicated server services. /dedicated/list - dedicated servers list Returns list of customer's dedicated servers. Command is literally the same as calling /services/list with parameter service_type=dedicated. /dedicated/details - dedicated server details Returns details of dedicated server. Parameters:
  • service_id (number) - service ID
Response:
  • service_details (object) - server details
    • id (number) - unique service ID
    • hardware_configuration (object) - hardwer resources details
      • server (object) - server details
        • vendor (string) - vendor
        • model (string) - model name
      • cpu (objects-list) - CPUs list
        • vendor (string) - vendor
        • model (string) - model name
        • clock (number) - CPU's clock [GHz]
        • cores (number) - number of cores
        • ht (boolean) - hyper-threading enabled
      • ram (objects-list) - memory modules list
        • capacity (number) - capacity [GB]
        • type (string) - module type
        • speed (number) - speed [MHz]
      • hdd (objects-list) - list of HDDs
        • capacity (number) - capacity [GB]
        • type (string) - HDD type
        • speed (string) - speed
      • hdd_controller (objects-list) - list of HDD's controllers
        • model (string) - model name
        • builtin (boolean) - is this is builtin controller
    • network_configuration (object) - network configuration details
      • ip (string) - IP address
      • additional_ips (strings-list) - list of additionals IP address
      • subnetworks (objects-list) - subnetworks list
        • id (number) - unique subnetwork ID number
        • ip (string) - subnetwork address
        • mask (string) - subnetwork's mask
        • mask_short (string) - mask short (in notation like '/29')
        • type (string) - subnetwork type (IPv4 / IPv6)
      • firewall_ruleset_id (string) - identifier of firewall ruleset applaying to this serwer; in depends of your servers network cofniguration one ruleset may apply to one (usuall) or more of your servers; if firewall configuration is not available for this server this field will not occure
    • features (object) - features allowed for this server
      • ilo_access_management (boolean) - if it's true you can enable access to ILO / IPMI for this server
      • power_management (boolean) - if it's true you can manage pawer of this server
      • firewall_management (boolean) - if it's true you can manage externall firewall rules for this server
    • active (boolean) - determines whether the server is active (true) or locked (false)
Error codes:
  • authorization-failed
/dedicated/transfer-usage-details - information about transfer (network traffic) usage Returns detailes about transfer usage of this server in prevoius 3 and current payment period. Parameters:
  • service_id (number) - service ID
Response:
  • transfer_usage_details (object) - transfer details
    • periods_list (objects-list) - list of objects describing transfer usage across last payment periods
      • time_range (object) - object describing time range
        • from (number) - timestamp (UNIX) of begining of period
        • from (number) - timestamp (UNIX) of begining of period
      • transfer_usage (object) - object describing transfer usage in period
        • up (number) - amount of data sended [bytes]
        • down (number) - amount of data received [bytes]
Error codes:
  • invalid-service-type
  • unsupported-feature
/dedicated/ilo-details - iLO / IPMI access details Detailed informations about iLO / IPMI panel managements access. Parameters:
  • service_id (number) - service ID
Response:
  • ilo_details (object) - iLO / IPMI access details
    • available (boolean) - if it's true you can enable access to ILO / IPMI for this server
    • ip (string) - iLO / IPMI service IP address
    • access_enabled (boolean) - determines whether access to iLO / IPMI is currenly open
    • access_ip (string) - if access to iLO / IPMI is enabled this field contains remote IP address allowed to connect
Error codes:
  • invalid-service-type
  • unsupported-feature
/dedicated/ilo-access-enable - opens access to connect to iLO / IPMI service Opens access to iLO / IPMI service for specified remote IP address. Parameters:
  • service_id (number) - service ID
  • remote_ip (string) - remote IP address for which access to iLO / IPMI is to be open
Error codes:
  • invalid-service-type
  • unsupported-feature
  • internal-operation-error
/dedicated/ilo-access-disable - closes access to connect to iLO / IPMI service Closes access to iLO / IPMI service. Parameters:
  • service_id (number) - service ID
Error codes:
  • invalid-service-type
  • unsupported-feature
  • internal-operation-error
/dedicated/power-details - detailed informations about management and state of serwer power Detailed informations about ability of management and actual state of serwer power (power state refers to power-line state and not wheter server is truned on, by default all servers turns on if power line is on). Parameters:
  • service_id (number) - service ID
Response:
  • power_details (object) - power state details
    • manageable (boolean) - determines wheter for this server power line can be managed
    • state (string) - current power state
Error codes:
  • invalid-service-type
  • unsupported-feature
/dedicated/power-on - change power-state to: ON Changes power-state of server to: ON. Parameters:
  • service_id (number) - service ID
  • confirm (string) - value of this field has to be "confirm"
Error codes:
  • invalid-service-type
  • unsupported-feature
  • unconfirmed
  • internal-operation-error
/dedicated/power-off - change power-state to: OFF Changes power-state of server to: OFF. Parameters:
  • service_id (number) - service ID
  • confirm (string) - value of this field has to be "confirm"
Error codes:
  • invalid-service-type
  • unsupported-feature
  • unconfirmed
  • internal-operation-error
/dedicated/power-restart - restart server Restarts server power. Its acoomplished by sequentially turning server OFF and then ON again. Parameters:
  • service_id (number) - service ID
  • confirm (string) - value of this field has to be "confirm"
Error codes:
  • invalid-service-type
  • unsupported-feature
  • unconfirmed
  • internal-operation-error
Module: colocation Management of servers colocation services. /colocation/list - colocations list Returns list of customer's colocations services. Command is literally the same as calling /services/list with parameter service_type=colocation. /colocation/details - colocation details Returns details of colocation. Parameters:
  • service_id (number) - service ID
Response:
  • service_details (object) - colocation details
    • id (number) - unique service ID
    • network_configuration (object) - network configuration details
      • ip (string) - IP address
      • additional_ips (strings-list) - list of additionals IP address
      • subnetworks (objects-list) - subnetworks list
        • id (number) - unique subnetwork ID number
        • ip (string) - subnetwork address
        • mask (string) - subnetwork's mask
        • mask_short (string) - mask short (in notation like '/29')
        • type (string) - subnetwork type (IPv4 / IPv6)
      • firewall_ruleset_id (string) - identifier of firewall ruleset applaying to this serwer; in depends of your servers network cofniguration one ruleset may apply to one (usuall) or more of your servers; if firewall configuration is not available for this server this field will not occure
    • features (object) - features allowed for this server
      • power_management (boolean) - if it's true you can manage pawer of this server
      • firewall_management (boolean) - if it's true you can manage externall firewall rules for this colocation
    • active (boolean) - determines whether the server is active (true) or locked (false)
Error codes:
  • authorization-failed
/colocation/transfer-usage-details - information about transfer (network traffic) usage Returns detailes about transfer usage of this server in prevoius 3 and current payment period. Parameters:
  • service_id (number) - service ID
Response:
  • transfer_usage_details (object) - transfer details
    • periods_list (objects-list) - list of objects describing transfer usage across last payment periods
      • time_range (object) - object describing time range
        • from (number) - timestamp (UNIX) of begining of period
        • from (number) - timestamp (UNIX) of begining of period
      • transfer_usage (object) - object describing transfer usage in period
        • up (number) - amount of data sended [bytes]
        • down (number) - amount of data received [bytes]
Error codes:
  • invalid-service-type
  • unsupported-feature
/colocation/power-details - detailed informations about management and state of serwer power Detailed informations about ability of management and actual state of serwer power (power state refers to power-line state and not wheter server is truned on, by default all servers turns on if power line is on). Parameters:
  • service_id (number) - service ID
Response:
  • power_details (object) - power state details
    • manageable (boolean) - determines wheter for this server power line can be managed
    • state (string) - current power state
Error codes:
  • invalid-service-type
  • unsupported-feature
/colocation/power-on - change power-state to: ON Changes power-state of server to: ON. Parameters:
  • service_id (number) - service ID
  • confirm (string) - value of this field has to be "confirm"
Error codes:
  • invalid-service-type
  • unsupported-feature
  • unconfirmed
  • internal-operation-error
/colocation/power-off - change power-state to: OFF Changes power-state of server to: OFF. Parameters:
  • service_id (number) - service ID
  • confirm (string) - value of this field has to be "confirm"
Error codes:
  • invalid-service-type
  • unsupported-feature
  • unconfirmed
  • internal-operation-error
/colocation/power-restart - restart server Restarts server power. Its acoomplished by sequentially turning server OFF and then ON again. Parameters:
  • service_id (number) - service ID
  • confirm (string) - value of this field has to be "confirm"
Error codes:
  • invalid-service-type
  • unsupported-feature
  • unconfirmed
  • internal-operation-error
Module: ip-blackholing Manage IP blackholing. Enabling blackholing for specified IP address will block all network traffic for this IP and results in dropping all packets. It can be use to reduce load of server in case of DDoS attack. /ip-blackholing/list - list of blocked IP address Returns list of blocked blackholed IP addresses. Response:
  • blackholed_ips_list (objects-list) - list of blocked IP addresses
    • ip (string) - blocked IP address
    • type (string) - Type of blockade. This field can be: "customer" if it was set by customer and can be unset, "admin" if it was set by network administrator and cannot be unset by you.
Error codes:
  • authorization-failed
/ip-blackholing/enable - enables blackholing Enables blackholing for specified IP address. You can provide any address from your subnetworks or IP address of your service. Parameters:
  • ip (string) - IP address you want to block
Error codes:
  • incorrect-ip
  • ip-not-allowed
  • ip-already-blackholed
  • internal-blackholing-ip-error
/ip-blackholing/disable - disables blackholing Disables blackholing for specified IP address. You can provide any address from your subnetworks or IP address of your service. This is not possible to disable blackholing that was setted by network administrator. Parameters:
  • ip (string) - IP address you want to unlock
Error codes:
  • incorrect-ip
  • ip-not-allowed
  • ip-not-blackholed
  • admin-blackhole
  • internal-blackholing-ip-error
Module: dns Manages domain zones configuration in DNS. This module allow you to add to Artnet NS server (ns1.artnet.pl and ns2.artnet.pl) your domains zones (primary or secoundary) and managing it. /dns/list - list of configured DNS zones Returns list of configured DNS zones with basic infomrations. Response:
  • zones_list (objects-list) - list of zones
    • id (number) - zone ID
    • domain (string) - domain name
    • type (string) - Zone type. It can be either "primary" or "secoundary".
    • master_nameserver (string) - name of primary server (this field is given only for secoundary zones)
Error codes:
  • authorization-failed
/dns/delete - removes domain from DNS Removes existing domain zone from DNS Parameters:
  • zone_id (number) - zone ID
Error codes:
  • incorrect-param-value
  • invalid-zone-id
  • internal-dns-error
/dns/details-secoundary - details of DNS secoundary zone configuration Returns DNS zone configuration. Parameters:
  • zone_id (number) - zone ID
Response:
  • zone_details (object) - configuration details
    • id (number) - zone ID
    • domain (string) - domain name
    • type (string) - Zone type. It can be either "primary" or "secoundary".
    • master_nameserver (string) - name of primary server
Error codes:
  • incorrect-ip
  • ip-not-allowed
  • ip-already-blackholed
  • internal-blackholing-ip-error
/dns/add-secoundary - adds secoundary zone to DNS Adds new domain to DNS as secoundary zone. Customer has to be allowed to add specified domain, you can check your add priviliges by using command /dns/info. Its required to provide master nameserver and it has to be resolveable to IP address. Parameters:
  • domain (string) - domain name to add to DNS
  • master_nameserver (string) - host name or IP address of master nameserver
Response:
  • zone_details (object) - details of newly created zone
    • id (number) - zone ID
    • domain (string) - domain name
    • type (string) - Zone type. It can be either "primary" or "secoundary".
    • master_nameserver (string) - name of primary server
Error codes:
  • incorrect-param-value
  • domain-not-allowed
  • domain-already-exists
  • unresolveable-master-nameserver
  • internal-dns-error
/dns/details-primary - details of DNS primary zone configuration Returns DNS zone configuration: serial number of actual configuration, list of name servers and list of DNS records. Parameters:
  • zone_id (number) - zone ID
Response:
  • zone_details (object) - configuration details
    • id (number) - zone ID
    • domain (string) - domain name
    • type (string) - Zone type. It can be either "primary" or "secoundary".
    • nameservers (strings-list) - list of name servers hostnames (according to NS records)
    • serial (number) - Current value of DNS zone serial number. Its value is required to edit records and it changes after every edit.
    • records (objects-list) - List of DNS records in this zone. Records fields are in form described in according RFC documents (see RFC 1035). Order is significat.
      • name (string) - host name for this DNS record; allowed forms: relative name, full wuallified domain name (ending with a point sign), @ sign (relative to main domain), living this field empty (relative to previuos record)
      • ttl (number) - time-to-live - time in secoudns after which any name server should refresh cached value of this record
      • type (string) - DNS record type ('A', 'AAAA', 'CNAME', 'MX', 'TXT', 'SRV')
      • data1 (string) - first part of record's data; this field is provided for all records types, next fields are optional and their existing depends on record type
      • data2 (string) - [optional, depending on record type] secound part of data
      • data3 (string) - [optional, depending on record type] third part of data
      • data4 (string) - [optional, depending on record type] fourth part of data
Error codes:
  • incorrect-ip
  • ip-not-allowed
  • ip-already-blackholed
  • internal-blackholing-ip-error
/dns/add-primary - adds primary zone to DNS Adds new domain to DNS as secoundary zone. Customer has to be allowed to add specified domain, you can check your add priviliges by using command /dns/info. Domain is add to DNS with empty configuration (without records). To configure it you have to use edit command. Parameters:
  • domain (string) - domain name to add to DNS
Response:
  • zone_details (object) - details of newly created zone
    • id (number) - zone ID
    • domain (string) - domain name
    • type (string) - Zone type. It can be either "primary" or "secoundary".
Error codes:
  • incorrect-param-value
  • domain-not-allowed
  • domain-already-exists
  • internal-dns-error
/dns/edit-primary-records - changes DNS records of primary zone Changes DNS records for specified primary zone. You have to provide actual value of SOA serial number (you can find it in /dns/details-primary command response). Parameters:
  • zone_id (number) - zone ID
  • serial (string) - actual value of SOA serial number
  • records[N] (array-of-arrays) - array describing single DNS record; index N have to be unique for single firewall rule within request; order of records i significant
  • records[N][name] (string) - host name for this DNS record; allowed forms: relative name, full wuallified domain name (ending with a point sign), @ sign (relative to main domain), living this field empty (relative to previuos record)
  • records[N][ttl] (number) - time-to-live - time in secoudns after which any name server should refresh cached value of this record
  • records[N][type] (string) - DNS record type ('A', 'AAAA', 'CNAME', 'MX', 'TXT', 'SRV')
  • records[N][data1] (number) - first part of record's data; this field is provided for all records types, next fields are optional and their existing depends on record type
  • records[N][data2] (number) - [optional, depending on record type] secound part of data
  • records[N][data3] (number) - [optional, depending on record type] third part of data
  • records[N][data4] (number) - [optional, depending on record type] fourth part of data
Error codes:
  • incorrect-param-value
  • invalid-zone-id
  • invalid-zone-type
  • internal-dns-error
  • incorrect-soa-serial
Module: rev-dns PTR records management in revDNS. /rev-dns/list - list of subnetworks available to configure Returns list of subnetworks available to configure. Due to technical reasons, revDNS configuration is organized over subclasses at size of class C. For this reason each subnetwork details includes a list of available to configure subclasses (dns_subclasses). While fetching details or editing subnetwork, you need then to give ID of subnetwork as well as name of specific configuration subclass. Response:
  • subnetworks_list (objects-list) - list of subnetworks along with configuration subclasses
    • id (number) - unique subnetwork ID number
    • ip (string) - subnetwork address
    • mask (string) - subnetwork's mask
    • mask_short (string) - mask short (in notation like '/29')
    • type (string) - subnetwork type (IPv4 / IPv6)
    • dns_subclasses (strings-list) - list of configuration subclasses in subnetwork
/rev-dns/details - fetchs revDNS configuration Returns details and PTR records configurations of selected revDNS configuration subclass. It is required to enter ID number of subnetwork and name of selected configuration subclass of it. Parameters:
  • subnetwork_id (number) - subnetwork ID
  • dns_subclass (string) - configuration subclass name (one element of dns_subclasses list of selected subnetwork)
Response:
  • subclass_details (object) - configuration of selected subclass
    • serial (number) - serial number of SOA record of current configuration; this value is required to configuration editing
    • type (string) - subnetwork type (IPv4 / IPv6)
    • prefix (string) - IP address prefix; this value is contant part of IP addresses in entire subclass; prefix + IP separator + origin is the complete IP address
    • ptr_records (objects-list) - list of PTR records
      • origin (string) - record ID in subclass
      • ptr (string) - PTR record value
      • address (string) - full IP address of this record
Error codes:
  • authorization-failed
/rev-dns/edit - edits revDNS configuration Edits PTR records. It is required to enter ID number of subnetwork and name of selected configuration subclass of it. It is also requiret to enter current value of serial of SOA record (according to details of subclass configuration) - this value changes after each successful edit if something changed. Operation returns list of warnings objects which contains errors that occured while editing specific record. Error while editing record will not break all operation and will not generate error. Existing of warning object for some record means that for this record no changes have been made. Parameters:
  • subnetwork_id (number) - subnetwork ID
  • dns_subclass (string) - configuration subclass name (one element of dns_subclasses list of selected subnetwork)
  • serial (number) - current value of SOA serial value
  • ptr_records[N] (array-of-arrays) - array containing arrays of PTR records values; N index have to be unique within the query for each PTR record
  • ptr_records[N][origin] (string) - origin of record to edit or add
  • ptr_records[N][ptr] (string) - PTR record value to set
  • ptr_records[N][delete] (string) - if value of this field is "delete" corresponding field will be deleted
Response:
  • warnings (objects-list) - list of error occured while editing specific records; warning object for record means that no changes have been made on in
    • origin (string) - identificator of record for which error eccured
    • address (string) - full record IP address
    • task (string) - name of operation for which error occured
    • code (string) - error code
    • description (object) - error description
      • pl (string) - error description in polish
      • en (string) - error description in english
Error codes:
  • authorization-failed
  • invalid-subclass
  • internal-dns-error
  • invalid-origin
  • invalid-serial
  • authorization-failed
Module: firewall Manages rules of external firewall. If externall firewall configuration is allowed for your servers, this module is used to manage them. For each server or group of servers (depeneding on network configuration) with firewall management feature enabled there is "firewall ruleset". Firewall ruleset is a set of firewall rules used to filter packets. Mind that if one ruleset applies to more that one server, packets to all the servers will be filtered. /firewall/list - firewall rulesets list Returns list of firewall rulesets availablle to configuration. Each ruleset describes firewall filtering packets rules for one or more servers (depending on their network configuration). Each ruleset object contains filed (services_ids_list) with ID of server services which are applied to its rules. Response:
  • rulesets_list (objects-list) - list of ruleset of firewall rules
    • id (string) - ruleset identifier
    • services_ids_list (numbers-list) - list of IDs of servers services, which are applied to firewall rules of this set
/firewall/details - fetches firewall configuration Returns configuration of firewall for specified ruleset. Contains informations about maximum allowed number of rules for each direction, actual state (enabled / disabled) of firewall and list of rules for each traffic direction. Parameters:
  • ruleset_id (string) - ruleset identifier
Response:
  • ruleset_details (object) - details of firewall configuration
    • id (string) - ruleset identifier
    • enabled (boolean) - whether the firewall is active
    • maximum_rules_number (number) - specifies maximum number of rules, that can be set for one direction
    • protocol (string) - protocol number (rfc1700) or empty string field if protocol is not to be checked
    • rules (object) - object describing firewall rules
      • in (objects-list) - list of rules for incoming traffic (order is significant)
        • policy (string) - rule policy ("ACCEPT" or "DROP")
        • source (object) - packet source conditions
          • ip (string) - IP address
          • mask_short (number) - number specifying short form of subnetwork mask (as number from range 0 - 32)
          • port (object) - conditions for source port of the packet
            • begin (string) - the lower limit of port range (or empty string if not apply to selected protocol or is not to be checked)
            • end (string) - the upper limit of port range (or empty string if not apply to selected protocol or is not to be checked)
        • destination (object) - packet destination conditions
          • ip (string) - IP address
          • mask_short (number) - number specifying short form of subnetwork mask (as number from range 0 - 32)
          • port (object) - conditions for destination port of the packet
            • begin (string) - the lower limit of port range (or empty string if not apply to selected protocol or is not to be checked)
            • end (string) - the upper limit of port range (or empty string if not apply to selected protocol or is not to be checked)
      • out (objects-list) - list of rules for outgoing traffic (order is significant)
        • policy (string) - rule policy ("ACCEPT" or "DROP")
        • source (object) - packet source conditions
          • ip (string) - IP address
          • mask_short (number) - number specifying short form of subnetwork mask (as number from range 0 - 32)
          • port (object) - conditions for source port of the packet
            • begin (string) - the lower limit of port range (or empty string if not apply to selected protocol or is not to be checked)
            • end (string) - the upper limit of port range (or empty string if not apply to selected protocol or is not to be checked)
        • destination (object) - packet destination conditions
          • ip (string) - IP address
          • mask_short (number) - number specifying short form of subnetwork mask (as number from range 0 - 32)
          • port (object) - conditions for destination port of the packet
            • begin (string) - the lower limit of port range (or empty string if not apply to selected protocol or is not to be checked)
            • end (string) - the upper limit of port range (or empty string if not apply to selected protocol or is not to be checked)
Error codes:
  • invalid-ruleset-id
/firewall/enable - enables firewall Enables pockets filtering by firewall. Parameters:
  • ruleset_id (string) - ruleset identifier
Error codes:
  • invalid-service-type
  • internal-firewall-error
/firewall/disable - disables firewall Disables pockets filtering by firewall. Parameters:
  • ruleset_id (string) - ruleset identifier
Error codes:
  • invalid-service-type
  • internal-firewall-error
/firewall/save - changes firewall rules Changes firewall rules of specified ruleset. In case of error no changes in firewall configurations will be saved. Error object for syntax errors may contain additional field errors_details describing what kind of error and in which rule index it occured. Parameters:
  • ruleset_id (string) - ruleset identifier
  • rules[in][N] (array-of-arrays) - array describing single firewall rule for incomoing traffic; index N have to be unique for single firewall rule within request
  • rules[in][N][policy] (string) - rule policy ("ACCEPT" or "DROP")
  • rules[in][N][protocol] (number) - packet protocol number (according to RFC1700)
  • rules[in][N][source][ip] (string) - source IP address of packet
  • rules[in][N][source][mask_short] (number) - number specyfying subnetwork short (number from range 0 - 32)
  • rules[in][N][source][port][begin] (number) - the lower limit of source port range (or an empty string if not applied to selected protokol or is not to be checked)
  • rules[in][N][source][port][end] (number) - the upper limit of source port range (or an empty string if not applied to selected protokol or is not to be checked)
  • rules[in][N][destination][ip] (string) - source IP address of packet
  • rules[in][N][destination][mask_short] (number) - number specyfying subnetwork short (number from range 0 - 32)
  • rules[in][N][destination][port][begin] (number) - the lower limit of destination port range (or an empty string if not applied to selected protokol or is not to be checked)
  • rules[in][N][destination][port][end] (number) - the upper limit of destination port range (or an empty string if not applied to selected protokol or is not to be checked)
  • rules[out][N] (array-of-arrays) - array describing single firewall rule for outgoing traffic; index N have to be unique for single firewall rule within request
  • rules[out][N][policy] (string) - rule policy ("ACCEPT" or "DROP")
  • rules[out][N][protocol] (number) - packet protocol number (according to RFC1700)
  • rules[out][N][source][ip] (string) - source IP address of packet
  • rules[out][N][source][mask_short] (number) - number specyfying subnetwork short (number from range 0 - 32)
  • rules[out][N][source][port][begin] (number) - the lower limit of source port range (or an empty string if not applied to selected protokol or is not to be checked)
  • rules[out][N][source][port][end] (number) - the upper limit of source port range (or an empty string if not applied to selected protokol or is not to be checked)
  • rules[out][N][destination][ip] (string) - source IP address of packet
  • rules[out][N][destination][mask_short] (number) - number specyfying subnetwork short (number from range 0 - 32)
  • rules[out][N][destination][port][begin] (number) - the lower limit of destination port range (or an empty string if not applied to selected protokol or is not to be checked)
  • rules[out][N][destination][port][end] (number) - the upper limit of destination port range (or an empty string if not applied to selected protokol or is not to be checked)
Error codes:
  • invalid-ruleset-id
  • too-many-rules
  • rules-syntax-error
  • internal-firewall-error
Module: offer-dedicated Offer and ordering ready to run dedicated servers. /offer-dedicated/custom-offer - dedicated offer Returns configuration parameters list of dedicated servers which allows the preparation and calculation of an order. Response:
  • resources (objects-list) - list of available servers
    • platforms (object-list) - list of available platforms
      • model_name (string) - model name
      • resources (object-list) - resources of the model
        • cpu (string) - CPU name
        • hdd_controller (string) - HDD controller name
      • resources_limits (object-list) - platform limits
        • hdd_sizes (array-string) - available disk sizes
        • hdd_slots (string) - maximum available disk slots
        • ram_max (string) - maximum amount of RAM
        • cpu_slots (integer) - maximum available CPU slots
      • price (object-list) - price
        • price (integer) - price
        • currency (string) - currency of payment
        • payment_period (string) - payment period
    • hdd_disks (object-list) - available disks list
      • capacity (string) - disk capacity
      • type (string) - disk type
      • speed (string) - disk speed
      • size (string) - disk size
      • price (object-list) - price
        • price (integer) - price
        • currency (string) - currency of payment
        • payment_period (string) - payment period
    • rams (string) - available RAM
      • capacity (string) - disk capacity
      • price (object-list) - price
        • price (integer) - price
        • currency (string) - currency of payment
        • payment_period (string) - payment period
    • additional_cpus (object-list) - available additional CPU
      • name (string) - additional CPU name
      • price (object-list) - price
        • price (integer) - price
        • currency (string) - currency of payment
        • payment_period (string) - payment period
    • hdd_controllers (object-list) - available additional HDD controllers
      • name (string) - additional HDD controller name
      • price (object-list) - price
        • price (integer) - price
        • currency (string) - currency of payment
        • payment_period (string) - payment period
    • transfer_package (object-list) - available transfer packeges
      • transfer (string) - data package size
      • price (object-list) - price
        • price (integer) - price
        • currency (string) - currency of payment
        • payment_period (string) - payment period
    • bandwidth_package (object-list) - available bandwidth packeges
      • bandwidth (string) - bandwidth speed
      • price (object-list) - price
        • price (integer) - price
        • currency (string) - currency of payment
        • payment_period (string) - payment period
    • others (object-list) - additional services
      • name (string) - name of additional service
      • price (object-list) - price
        • price (integer) - price
        • currency (string) - currency of payment
        • payment_period (string) - payment period
    • ip (object-list) - additional ip address
      • amount (string) - amount of additional ip addresses
      • price (object-list) - price
Error codes:
  • authorization-failed
/offer-dedicated/express-offer - current offer Returns list of available to the customer dedicated servers in "ready to run" (Express Server) selling model along with their parameters and pricing. Response:
  • offer (objects-list) - list of available servers
    • id (number) - unique server ID
    • hardware_configuration (object) - hardwer resources details
      • server (object) - server details
        • vendor (string) - vendor
        • model (string) - model name
      • cpu (objects-list) - CPUs list
        • vendor (string) - vendor
        • model (string) - model name
        • clock (number) - CPU's clock [GHz]
        • cores (number) - number of cores
        • ht (boolean) - hyper-threading enabled
      • ram (objects-list) - memory modules list
        • capacity (number) - capacity [GB]
        • type (string) - module type
        • speed (number) - speed [MHz]
      • hdd (objects-list) - list of HDDs
        • capacity (number) - capacity [GB]
        • type (string) - HDD type
        • speed (string) - speed
      • hdd_controller (objects-list) - list of HDD's controllers
        • model (string) - model name
        • builtin (boolean) - is this is builtin controller
    • prices (object) - information about prices
      • regular (object) - price for customers
        • price (number) - price for server (VAT excl.)
        • currency (string) - currency code
        • payment_period (number) - payment period for this price (number of months)
      • reseller (object) - visible only for resellers; price for reseller
        • price (number) - price for server (VAT excl.)
        • currency (string) - currency code
        • payment_period (number) - payment period for this price (number of months)
Error codes:
  • authorization-failed
/offer-dedicated/express-reservations-list - list of reserved servers Returns list of servers reserved by customer. Response:
  • offer (objects-list) - list of available servers
    • id (number) - unique server ID
    • hardware_configuration (object) - hardwer resources details
      • server (object) - server details
        • vendor (string) - vendor
        • model (string) - model name
      • cpu (objects-list) - CPUs list
        • vendor (string) - vendor
        • model (string) - model name
        • clock (number) - CPU's clock [GHz]
        • cores (number) - number of cores
        • ht (boolean) - hyper-threading enabled
      • ram (objects-list) - memory modules list
        • capacity (number) - capacity [GB]
        • type (string) - module type
        • speed (number) - speed [MHz]
      • hdd (objects-list) - list of HDDs
        • capacity (number) - capacity [GB]
        • type (string) - HDD type
        • speed (string) - speed
      • hdd_controller (objects-list) - list of HDD's controllers
        • model (string) - model name
        • builtin (boolean) - is this is builtin controller
    • prices (object) - information about prices
      • regular (object) - price for customers
        • price (number) - price for server (VAT excl.)
        • currency (string) - currency code
        • payment_period (number) - payment period for this price (number of months)
      • reseller (object) - visible only for resellers; price for reseller
        • price (number) - price for server (VAT excl.)
        • currency (string) - currency code
        • payment_period (number) - payment period for this price (number of months)
Error codes:
  • authorization-failed
/offer-dedicated/express-reservation - makes a reservation for selected server Command only avail for resellers. It allow to makes an reservation (to keep server from being selled) for 48h. One customer may have maximum of 3 servers reserved at a time. Parameters:
  • server_id (number) - server ID
Error codes:
  • authorization-failed
  • invalid-server-id
/offer-dedicated/express-reservation-cancel - cancel reservation for selected server Command only avail for resellers. It allow to cancel reservation made for server. Parameters:
  • server_id (number) - server ID
Error codes:
  • authorization-failed
  • invalid-server-id
/offer-dedicated/express-order - makes an order for selected server This command allow customer to make an order for dedicated server from ready to run "express" servers offer. After this command is proceeded it will return ID of newly created service, invoice number for this order and URL link to web management panel with management and OS installation tools. Its important to remember that URL link contains authorization parameters and should be treat as password for server. Proforma invoice can be downloaded from Artnet Customer Panel or by usign /invoices/download-proforma API command. Parameters:
  • server_id (number) - server ID
Response:
  • order_details (object) - order details
    • service_id (number) - unique service ID
    • invoice_number (string) - invoice number of this order
    • management_panel_url (string) - link to server management and operating system installation panel
Error codes:
  • authorization-failed
  • invalid-server-id
  • internal-error-invalid-service
  • internal-error-invalid-data
Module: cloud-instance Cloud virtual instances management. /cloud-instance/list - list of instances Returns list of created virtual instances along with basic informations. Response:
  • instances_list (objects-list) - list instances
    • id (number) - unique instance ID
    • name (string) - System instance name, identifier.
    • custom_name (string) - Customizable instance display name.
    • price_resources (object) - Details of current price. Prices refers to 24h costs with current instance parameters without additional costs (like transfer).
      • price (number) - Price for 24h. Price is given with 4 decimal places precision to allow you to calculate price to other periods.
      • currency (string) - Currency code.
      • period (string) - Period of calculation. Currently its always '24h'.
    • vnc_configuration (object) - Host and port of VNC console.
      • host (string) - VNC server address. Address is not permanently assigned to an instance and it can change sometimes.
      • port (number) - VNC server port.
    • resources (object) - Current hardware resources of instance.
      • cpu_cores (number) - Number of CPU cores.
      • ram (number) - RAM memory available [MB].
      • hdd (number) - Available disk space [GB].
      • bandwidth (number) - Bandwidth [Mbps].
    • state (string) - Current instance status.
    • state_time (timestamp) - Time of last refresh of instance status.
    • boot_status (string) - Boot status of instance. If value of this field is 'install' instance will boot from chosen installation image. If this field value is 'boot' it will normal boot from own hard drive.
Error codes:
  • authorization-failed
/cloud-instance/details - details of instance Returns more detailed informations of instances of specified ID. Parameters:
  • instance_id (number) - instance ID
Response:
  • instance_details (object) - instance details
    • id (number) - unique instance ID
    • name (string) - System instance name, identifier.
    • custom_name (string) - Customizable instance display name.
    • price_resources (object) - Details of current price. Prices refers to 24h costs with current instance parameters without additional costs (like transfer).
      • price (number) - Price for 24h. Price is given with 4 decimal places precision to allow you to calculate price to other periods.
      • currency (string) - Currency code.
      • period (string) - Period of calculation. Currently its always '24h'.
    • vnc_configuration (object) - Host and port of VNC console.
      • host (string) - VNC server address. Address is not permanently assigned to an instance and it can change sometimes.
      • port (number) - VNC server port.
    • resources (object) - Current hardware resources of instance.
      • cpu_cores (number) - Number of CPU cores.
      • ram (number) - RAM memory available [MB].
      • hdd (number) - Available disk space [GB].
      • bandwidth (number) - Bandwidth [Mbps].
    • state (string) - Current instance status.
    • state_time (timestamp) - Time of last refresh of instance status.
    • boot_status (string) - Boot status of instance. If value of this field is 'install' instance will boot from chosen installation image. If this field value is 'boot' it will normal boot from own hard drive.
    • custom_properties (object) - Properties set by customer (like display name, instance notes).
      • display_name (string) - Display name of instance. This value is used in e.g. instances list in Customers Panel.
      • notes (string) - Customer defined field for notes about instance. This field is designed for free use by the customer.
    • network_configuration (object) - Network configuration of instance. It is neccessary to configure internet connection of instance.
      • ip (string) - Instance IP address.
      • mask (string) - Mask of subnetwork in which instance is configured.
      • gateway_ip (string) - Gateway IP address.
      • dns_list (strings-list) - List of DNS IP addresses.
Error codes:
  • authorization-failed
/cloud-instance/action-power-on - instance power on Turns virtual instance power ON and starts it. Parameters:
  • instance_id (number) - instance ID
  • instance_password (string) - management password of this instance
Error codes:
  • authorization-failed
  • invalid-service-type
  • instance-password-incorrect
  • internal-cloud-power-on-error
/cloud-instance/action-power-off - instance power off Turns virtual instance power OFF and stops it. Parameters:
  • instance_id (number) - instance ID
  • instance_password (string) - management password of this instance
Error codes:
  • authorization-failed
  • invalid-service-type
  • instance-password-incorrect
  • internal-cloud-power-on-error
/cloud-instance/action-power-restart - instance power restart Restart virtual instance power and starts it. This command does power OFF and subsequently power ON. Parameters:
  • instance_id (number) - instance ID
  • instance_password (string) - management password of this instance
Error codes:
  • authorization-failed
  • invalid-service-type
  • instance-password-incorrect
  • internal-cloud-power-on-error
/cloud-instance/action-shutdown - sends "shutdown" signal to OS Sends "shutdown" signal to virtual instance operating system. Parameters:
  • instance_id (number) - instance ID
  • instance_password (string) - management password of this instance
Error codes:
  • authorization-failed
  • invalid-service-type
  • instance-password-incorrect
  • internal-cloud-power-on-error
/cloud-instance/action-reboot - sends "reboot" signal to OS Sends "reboot" signal to virtual instance operating system. Parameters:
  • instance_id (number) - instance ID
  • instance_password (string) - management password of this instance
Error codes:
  • authorization-failed
  • invalid-service-type
  • instance-password-incorrect
  • internal-cloud-power-on-error
/cloud-instance/resources-allowed-ranges - boundaries and allowed values for hardware resources Returns object describing allowe values for hardawre resources for calculation and resources modification. For each parameter there is given minimum and maximum value and step (final value has to be multiple of step) Parameters:
  • instance_id (number) - instance ID
Response:
  • resources_ranges (object) - Object with allowed values ranges of hardware resources parameters.
    • cpu (object) - Ranges for number of CPU cores.
      • min (number) - Minimum value.
      • max (number) - Maximum value.
      • step (number) - Step. Final value has to be multiple of step (0 == value % step).
    • ram (object) - Ranges for RAM memory size [MB].
      • min (number) - Minimum value.
      • max (number) - Maximum value.
      • step (number) - Step. Final value has to be multiple of step (0 == value % step).
    • hdd (object) - Ranges for HDD disk size [GB].
      • min (number) - Minimum value.
      • max (number) - Maximum value.
      • step (number) - Step. Final value has to be multiple of step (0 == value % step).
    • bandwidth (object) - Ranges for internet connection bandwidth [Mbps].
      • min (number) - Minimum value.
      • max (number) - Maximum value.
      • step (number) - Step. Final value has to be multiple of step (0 == value % step).
Error codes:
  • authorization-failed
  • invalid-service-type
/cloud-instance/resources-calculate-price - hardware resources price calculation Calculates price of hardware resources of instance, which will be set for given hardware resources package. If "instance ID" parameter is set, calculation for specified instance is make. Otherwise prise is calculated as for new instance. Parameters:
  • instance_id (number) - instance ID
  • resources[cpu] (number) - CPU cores number
  • resources[ram] (number) - RAM memory size [MB]
  • resources[hdd] (number) - hdd disk space [GB]
  • resources[bandwidth] (number) - internet connection bandwidth [Mbps]
Response:
  • price_resources (object) - Details of current price. Prices refers to 24h costs with given hardware resources, without additional costs (like transfer).
    • price (number) - Price for 24h. Price is given with 4 decimal places precision to allow you to calculate price to other periods.
    • currency (string) - Currency code.
    • period (string) - Period of calculation. Currently its always '24h'.
Error codes:
  • authorization-failed
  • invalid-service-type
  • invalid-param-value
/cloud-instance/resources-negotiate - modification of hardware resources of the instance Modification of hardawre resources. Instance power restart is required for each modification. You can use "shutdown"="true" parameter to try do soft system shutdown. In this case our system will send shutdown signal and will wait fo 30s for system shutdown. If system wont shutdown during this time an error will be throw. For this reason "shutdown" option may increase operation time of this command. HDD disk space can only be increased, there is no possibility to customer to decrease HDD space by him. Parameters:
  • instance_id (number) - instance ID
  • instance_password (string) - management password of this instance
  • shutdown (boolean) - Determines wheter take try to shutdown OS. If value of this parameter will be "true" (string) system will try to shutdown OS; this may increase execution tme of this operation to few minutes and cause error if system cannot be shutted down. If value will be "false" power of your instance will be restarted without trying to shutdown OS.
  • resources[cpu] (number) - CPU cores number
  • resources[ram] (number) - RAM memory size [MB]
  • resources[hdd] (number) - hdd disk space [GB]. Attention! HDD space decreasing is not allowed!
  • resources[bandwidth] (number) - internet connection bandwidth [Mbps]
Error codes:
  • authorization-failed
  • invalid-service-type
  • invalid-param-value
  • internal-instance-resources-negotiate
  • instance-resources-negotiate-incorrect-parameters
  • instance-resources-negotiate-cannot-decrease-hdd
  • instance-unable-shutdown
/cloud-instance/boot-installation-images-list - list of available installation images Returns list of available installation images of operating systems for specified instance. Parameters:
  • instance_id (number) - instance ID
Response:
  • installation_images_list (objects-list) - List of available installations.
    • label (string) - Installation label (e.g. 'Debian 8.1 64bit').
    • distribution (string) - Shortname of distribution (e.g. 'debian').
    • image (string) - Installation image name.
Error codes:
  • authorization-failed
  • instance-password-incorrect
/cloud-instance/boot-mode-installation-image - switches boot mode to installation image boot Switches boot mode to boot specified installation image. Parameters:
  • instance_id (number) - instance ID
  • instance_password (string) - management password of this instance
  • installation_image (string) - chosen installation image
  • shutdown (boolean) - Determines wheter take try to shutdown OS. If value of this parameter will be "true" (string) system will try to shutdown OS; this may increase execution tme of this operation to few minutes and cause error if system cannot be shutted down. If value will be "false" power of your instance will be restarted without trying to shutdown OS.
Error codes:
  • authorization-failed
  • instance-password-incorrect
  • instance-boot-incorrect-installation-image
  • instance-unable-shutdown
  • internal-instance-boot-mode-installation-image
/cloud-instance/boot-mode-boot - switches boot mode to boot from HDD Switches boot mode to boot normal boot from instance HDD. Parameters:
  • instance_id (number) - instance ID
  • instance_password (string) - management password of this instance
  • shutdown (boolean) - Determines wheter take try to shutdown OS. If value of this parameter will be "true" (string) system will try to shutdown OS; this may increase execution tme of this operation to few minutes and cause error if system cannot be shutted down. If value will be "false" power of your instance will be restarted without trying to shutdown OS.
Error codes:
  • authorization-failed
  • instance-password-incorrect
  • instance-unable-shutdown
  • internal-instance-boot-mode-installation-image
/cloud-instance/custom-properties-edit - changes custom properties (e.g. display name, custom notes) Allows changing instance properties which are made for use of customer. This is e.g. display name of instance on list of instance in Customers Panel, custom notes about instance. Only parameters actualy present in request will be changed; missing parameters will not change their values. Parameters:
  • instance_id (number) - instance ID
  • custom_properties[display_name] (array) - Instance name which will show on list of isntances in Customers Panel. Maximum 35 characters.
  • custom_properties[notes] (string) - Notes about the instance. This field is designed for free use of customer for his purposes. Maximum 10240 characters.
Error codes:
  • authorization-failed
  • instance-custom-properties-display-name-too-long
  • instance-custom-properties-notes-too-long
  • internal-instance-custom-properties-edit-error
/cloud-instance/password-change - changes instance management password Changes instance management password. This password is required to access to VNC console and for key operations on the instance. Password has to be at least 4 characters long and can contain lower and uppercase letters, numbers and this special characters .!@#$%^&*()_+-= Parameters:
  • instance_id (number) - instance ID
  • instance_password (string) - management password of this instance
  • instance_new_password (string) - new password (allowed are: lower and uppercase letters, numbers and .!@#$%^&*()_+-= characters)
Error codes:
  • authorization-failed
  • instance-password-incorrect
  • password-too-short
  • password-invalid
/cloud-instance/delete - removing instance This command allows you to delete instance. Instance delete will cause immediatelly and irreversible remove and loss of instance and its data (including data on HDD). Parameters:
  • instance_id (number) - instance ID
  • instance_password (string) - management password of this instance
Error codes:
  • authorization-failed
  • instance-password-incorrect
  • internal-instance-delete-error