Dokumentacja API

Ogólne informacje

API pozwala użytownikowi zautomatyzować większość czynności, które mogą być wykonywane w Panelu Klienta Artnet.
Połączenie z API odbywa się poprzez połączenie z serwerem artnet.pl poprzez protokół HTTPS. Każda komenda posiada własną ścieżkę URL, która musi zostać wywołona w zapytaniu typu POST z parametrami komendy podanymi jako zmienne POST. Zapytanie wysłane do API powinno wyglądać tak, jak gdyby zostało wysłane z formularza HTML. Odpowiedź serwera jest zawsze obiektem typu JSON.

Połączenie

Adres do połączenia z API: https://panel.artnet.pl/api/NAZWA/KOMENDY
Ciąg znaków /NAZWA/KOMENDY odpowiada nazwie komendy do wywołania zgodnie z tym, co podano w sekcji "Komendy API" niniejszej dokumentacji.

Autoryzacja

Dane autoryzacyjne są przesyłane w każdym zapytaniu jako parametry id (numer ID klienta) i api_key (klucz autoryzacyjny API). ID klienta (id) jest liczbą i jest taki sam, jak podawany przy logowaniu do Panelu Klienta. Klucz API (api_key) można pobrać z Panelu Klienta - należy wybrać w menu opcje "Dane klienta" i następnie w sekcji "Narzędzie" wybrać odnośnik "Zarządzanie dostępem API". Jeżeli dostęp do API nie jest włączony, należy go włączyć - spowoduje to wygenerowanie nowego klucza API.

Przykładowe zapytanie

Przykładowe zapytanie, wraz z nagłówkami, służące do pobrania szczegółowych informacji o usłudze komendą /services/details mogło by mieć następującą postać:
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


Odpowiedź serwera

Odpowiedź serwera jest zawsze obiektem JSON. Każda odpowiedź zawiera pole success (boolean), którego wartość określa, czy wykonanie komendy zakończyło się powodzeniem. Jeżeli wykonanie komendy nie powiodło się, pole success przyjmie wartość false, a w odpowiedzi zwrócony zostanie również obiekt error zawierający informacje o błędzie. W przypadku poprawnego wyniku wywołania komendy odpowiedź może zawierać tylko pole success lub może zawierać także inne pole zgodnie z tym co opisano w sekcji "Komendy API".

Przykładowe odpowiedzi

Przykładowa odpowiedź błędu:
{ "success": false, "error": { "code": "unknown-command", "description": { "pl": "Nieznane polecenie", "en": "Unknown command" } } }
Przykładowa odpowiedź poprawna (komenda: /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 }


Rodzaje usług

  • dedicated - serwer dedykowany
  • colocation - kolokacja
  • vps - serwer VPS
  • domain - domena
  • additional-ip - dodatkowe adresy IP
  • avx - hosting współdzielony AVX.pl
  • easyisp - hosting współdzielony EasyISP.pl
  • hosting-artnet - hosting współdzielony Artnet.pl
  • foip - Fail-over IP
  • link - łącze internetowe
  • software - licencja oprogramowania
  • ssl - certyfikat SSL
  • other - inna usługa


Komendy API

Moduł: customer Zarządzanie danymi klienta. /customer/regenerate-api-key - wygenerowanie nowego klucza API Wygenerowanie nowego klucza API. Nowy klucz jest zwracany w odpowiedzi. Wygenerowanie klucza powoduje automatyczną utratę ważności dotychczasowego klucza - wszystkie przyszłe zapytania muszą być autoryzowane nowym kluczem. Odpowiedź:
  • api_key (string) - nowo wygenerowany klucz API
Kody błędów:
  • internal-update-error
/customer/emails-list - lista wysłanych wiadomości email Lista ostatnio wysłanych wiadomości e-mail. Nagłówki sortowane są malejąco po dacie wysłania. Parametry:
  • limit (number) - maksymalna liczba nagłówków do pobrania
  • offset (number) - numer rekordu od którego mają być listowane nagłówki
Odpowiedź:
  • emails_list (objects-list) - lista nagłówków wiadomości
    • id (number) - unikalne ID wiadomości
    • time (timestamp) - czas wysłania wiadomości
    • subject (string) - temat wiadomości
Kody błędów:
/customer/email-details - szczegóły wysłanej wiadomości email Pobranie szczegółów wiadomości email. Parametry:
  • email_id (number) - ID wiadomości email
Odpowiedź:
  • email (object) - szczegóły wiadomości email
    • id (number) - unikalne ID wiadomości
    • time (timestamp) - czas wysłania wiadomości
    • address (string) - adres, na jaki wysłano email
    • subject (string) - temat wiadomości
    • body (string) - treść wiadomości
Kody błędów:
  • invalid-id
/customer/change-language - zmiana języka Zmiana domyślnego języka klienta. Wykorzystywane do zmiany języka wykorzystywanego w korespondencji i w Panelu Klienta. Parametry:
  • language (string) - nazwa języka
Kody błędów:
  • incorrect-param-value
/customer/get-language - sprawdzenie języka Zwraca aktualnie ustawiony język (dla wiadomości email i Panelu Klienta). Odpowiedź:
  • language (string) - nazwa języka
/customer/details - szczegóły klienta Pobranie szczegółowych danych klienta. Odpowiedź:
  • customer (object) - szczegóły klienta
    • id (number) - unikalne ID
    • name (string) - nazwa klienta
    • nip (string) - NIP number (VAT identification number)
    • regon (string) - numer REGON lub PESEL
    • street (string) - adres klienta - ulica
    • postcode (string) - adres klienta - kod pocztowy
    • city (string) - adres klienta - miasto
    • country_code (string) - adres klienta - kod państwa
    • country_label (string) - adres klienta - nazwa państwa
    • tel (string) - numer telefonu
    • fax (string) - numer faxu
    • email (string) - adres email
    • email_tech (string) - techniczny adres email
    • email_invoice (string) - księgowy adres email (dla przesyłania faktur elektronicznych)
    • correspondence_name (string) - adres korespondencyjny - nazwa odbiorcy
    • correspondence_street (string) - adres korespondencyjny - ulica
    • correspondence_postcode (string) - adres korespondencyjny - kod pocztowy
    • correspondence_city (string) - adres korespondencyjny - miasto
    • business (boolean) - forma prawna (true - firma, false - osoba fizyczna)
    • language (string) - używany język
    • currency (string) - kod domyślnej waluty
Kody błędów:
  • invalid-id
/customer/edit - educja danych klienta Edycja szczegółowych danych klienta. Pozwala na modyfikowanie danych klienta w tym danych kontaktowych. Wszystkie parametry polecenia są opcjonalne, zmiany są wykonywane tylko dla podanych parametrów. Parametry:
  • customer[name] (string) - nazwa klienta
  • customer[nip] (string) - NIP number (VAT identification number)
  • customer[regon] (string) - numer REGON lub PESEL
  • customer[street] (string) - adres klienta - ulica
  • customer[postcode] (string) - adres klienta - kod pocztowy
  • customer[city] (string) - adres klienta - miasto
  • customer[country_code] (string) - adres klienta - kod państwa
  • customer[tel] (string) - numer telefonu
  • customer[fax] (string) - numer faxu
  • customer[email] (string) - adres email
  • customer[email_tech] (string) - techniczny adres email
  • customer[email_invoice] (string) - księgowy adres email (dla przesyłania faktur elektronicznych)
  • customer[correspondence_name] (string) - adres korespondencyjny - nazwa odbiorcy
  • customer[correspondence_street] (string) - adres korespondencyjny - ulica
  • customer[correspondence_postcode] (string) - adres korespondencyjny - kod pocztowy
  • customer[correspondence_city] (string) - adres korespondencyjny - miasto
  • customer[business] (string) - forma prawna (true - firma, false - osoba fizyczna)
Kody błędów:
  • incorrect-param-value
Moduł: services Lista usług i podstawowe operacje na usługach klienta. /services/list - lista usług Lista usług klienta. Opcjonalnie może być filtrowana typem usługi. Parametry:
  • limit (number) - maksymalna liczba rekordów do pobrania
  • offset (number) - offset pierwszego rekordu do pobrania
  • service_type (string) - typ usługi (jeżeli wartość zostanie podana zostaną zwrócone tylko usługi określonego typu)
  • parent_service_id (number) - ID usługi nadrzędnej (jeżeli zostanie podane i będzie niezerowe zwrócone zostaną tylko usługi podrzędne wobec usługi o podanym ID)
Odpowiedź:
  • services_list (objects-list) - lista usług
    • id (number) - unikalne ID usługi
    • type (string) - typ usługi
    • name (string) - nazwa identyfikacyjna usługi (nazwa domeny, login konta hostingowego, itp.) lub nazwa usługi
    • custom_description (string) - własny (klienta) opis usługi
    • expiration_time (timestamp) - data ważności usługi
    • payment_details (object) - szczegóły dotyczące ceny usługi i płatności
      • price (number) - cena netto za okres rozliczeniowy
      • price_brutto (number) - cena brutto za okres rozliczeniowy
      • currency (string) - kod waluty
      • payment_period (number) - okres rozliczeniowy (liczba miesięcy)
    • parent_service_id (number) - ID usługi nadrzędnej (jeżeli usługa jest powiązana z usługą nadrzędną) lub 0
    • ip (string) - adres IP, jeżeli dotyczy
Kody błędów:
/services/details - szczegóły usługi Zwraca szczegółowe infomracje dotyczące wybranej usługi. Parametry:
  • service_id (number) - numer ID usługi
Odpowiedź:
  • service (object) - szczegóły usługi
    • id (number) - unikalne ID usługi
    • type (string) - typ usługi
    • name (string) - nazwa identyfikacyjna usługi (nazwa domeny, login konta hostingowego, itp.) lub nazwa usługi
    • custom_description (string) - własny (klienta) opis usługi
    • expiration_time (timestamp) - data ważności usługi
    • payment_details (object) - szczegóły dotyczące ceny usługi i płatności
      • price (number) - cena netto za okres rozliczeniowy
      • price_brutto (number) - cena brutto za okres rozliczeniowy
      • currency (string) - kod waluty
      • payment_period (number) - okres rozliczeniowy (liczba miesięcy)
    • parent_service_id (number) - ID usługi nadrzędnej (jeżeli usługa jest powiązana z usługą nadrzędną) lub 0
    • ip (string) - adres IP, jeżeli dotyczy
Kody błędów:
  • authorization-failed
Moduł: domain Lista usług i podstawowe operacje na usługach klienta. /domain/list - lista domen Zwraca listę wszystkich domen. Komenda działa identycznie jak wywołanie /services/list z parametrem service_type=domain. /domain/details - szczegóły domeny Zwraca szczegółowe infomracje dotyczące domeny. Parametry:
  • service_id (number) - numer ID usługi
Odpowiedź:
  • service_details (object) - szczegóły domeny
    • id (number) - unikalne ID usługi
    • domain_name (string) - nazwa domeny
    • manageable (boolean) - określa czy jest możliwa automatyczna zmiana serwerów DNS (jeżeli to pole przyjmuje wartość false oznacza to, że zmiana serwerów DNS dla tej domeny wymaga skontaktowania się z Biurem Obsługi Klienta)
    • dns_servers (ordered-list) - lista serwerów DNS domeny (kolejność jest istotna); jeżeli w wewnętrznym systemie Artnet nie ma infomracji o przypisanych serwerach DNS to pole nie będzie obecne
Kody błędów:
  • authorization-failed
/domain/edit-dns-servers - edycja delegacji DNS domeny Zmienia delegację DNS domeny. Parametry:
  • service_id (number) - numer ID usługi
  • dns_servers (list) - kolejne adresy serwerów DNS jako elementy listy (kolejność jest istotna)
Kody błędów:
  • invalid-service-type
  • incorrect-param-value
  • dns-servers-insufficient
  • edit-dns-error
Moduł: easyisp Lista usług hostingowych pod marką EasyISP. /easyisp/list - lista usług Zwraca listę wszystkich usług hostingowych EasyISP. Komenda działa identycznie jak wywołanie /services/list z parametrem service_type=easyisp. /easyisp/details - szczegóły usługi hostingowej EasyISP Zwraca szczegółowe infomracje dotyczące usługi hostingowej EasyISP. Parametry:
  • service_id (number) - numer ID usługi
Odpowiedź:
  • service_details (object) - szczegóły
    • id (number) - unikalne ID usługi
    • login (string) - login konta
    • package (string) - nazwa pakietu
Kody błędów:
  • authorization-failed
Moduł: avx Lista usług hostingowych pod marką AVX. /avx/list - lista usług Zwraca listę wszystkich usług hostingowych AVX. Komenda działa identycznie jak wywołanie /services/list z parametrem service_type=avx. /avx/details - szczegóły usługi hostingowej AVX Zwraca szczegółowe infomracje dotyczące usługi hostingowej AVX. Parametry:
  • service_id (number) - numer ID usługi
Odpowiedź:
  • service_details (object) - szczegóły
    • id (number) - unikalne ID usługi
    • login (string) - login konta
    • package (string) - nazwa pakietu
Kody błędów:
  • authorization-failed
Moduł: hosting-artnet Lista usług hostingowych pod marką Artnet. /hosting-artnet/list - lista usług Zwraca listę wszystkich usług hostingowych Artnet. Komenda działa identycznie jak wywołanie /services/list z parametrem service_type=hosting-artnet. /hosting-artnet/details - szczegóły usługi hostingowej Zwraca szczegółowe infomracje dotyczące usługi hostingowej. Parametry:
  • service_id (number) - numer ID usługi
Odpowiedź:
  • service_details (object) - szczegóły
    • id (number) - unikalne ID usługi
    • login (string) - login konta
    • package (string) - nazwa pakietu
Kody błędów:
  • authorization-failed
Moduł: ssl Lista certyfikatów SSL. /ssl/list - lista usług Zwraca listę wszystkich usług hostingowych Artnet. Komenda działa identycznie jak wywołanie /services/list z parametrem service_type=ssl. /ssl/details - szczegóły certyfikatu SS Zwraca szczegółowe infomracje dotyczące usługi. Parametry:
  • service_id (number) - numer ID usługi
Odpowiedź:
  • service_details (object) - szczegóły
    • id (number) - unikalne ID usługi
    • domain (string) - nazwa domeny powiązanej z certyfikatem SSL
    • certificate (object) - obiekt opisujący nazwę certyfikatu
      • pl (string) - nazwa certyfikatu w języku polskim
      • en (string) - nazwa certyfikatu w języku angielskim
Kody błędów:
  • authorization-failed
Moduł: software Lista licencji oprogramowania. /software/list - lista usług Zwraca listę wszystkich licencji oprogramowania. Komenda działa identycznie jak wywołanie /services/list z parametrem service_type=software. /software/details - szczegóły licencji Zwraca szczegółowe infomracje dotyczące licencji oprogramowania. Parametry:
  • service_id (number) - numer ID usługi
Odpowiedź:
  • service_details (object) - szczegóły
    • id (number) - unikalne ID usługi
    • licence (object) - szczegóły licencji
      • name (string) - nazwa oprogramowania i licencji
      • licences_number (number) - liczba licencji w obrębie tej usługi
Kody błędów:
  • authorization-failed
Moduł: link-service Lista usług łącza internetowego. /link-service/list - lista usług Zwraca listę wszystkich usług łącza internetowego. Komenda działa identycznie jak wywołanie /services/list z parametrem service_type=link. /link-service/details - szczegóły łącza internetowego Zwraca szczegółowe infomracje dotyczące usługi łącza internetowego. Parametry:
  • service_id (number) - numer ID usługi
Odpowiedź:
  • service_details (object) - szczegóły
    • id (number) - unikalne ID usługi
    • bandwidth (object) - Przepustowość łącza.
      • up (number) - Przepustowość dla ruchu wychodzącego [Mbps].
      • down (number) - Przepustowość dla ruchu przychodzącego [Mbps].
    • network_configuration (object) - Konfiguracja sieciowa.
      • ip (string) - adres IP łącza
      • mask (string) - maska adresowa podsieci
      • mask_short (string) - skrot maski adresowej podsieci (w postaci np. "\32")
Kody błędów:
  • authorization-failed
Moduł: fail-over-ip Zarządzanie usługami fail-over IP. /fail-over-ip/list - lista usług Zwraca listę wszystkich usług fail-over IP. Komenda działa identycznie jak wywołanie /services/list z parametrem service_type=foip. /fail-over-ip/details - szczegóły usługi Zwraca szczegółowe infomracje dotyczące usługi fail-over IP. Parametry:
  • service_id (number) - numer ID usługi
Odpowiedź:
  • service_details (object) - szczegóły
    • id (number) - unikalne ID usługi
    • virtual_ip (string) - Wirtualny, stały adres IP widoczny z zewnątrz.
    • real_ip (string) - Rzeczywisty adres IP na który aktualnie przekierowywany jest ruch lub false jeżeli usługa nie jest aktywna.
    • real_ips_allowed_list (strings-list) - Lista adresów IP na które może zostać przekierowany ruch.
Kody błędów:
  • authorization-failed
/fail-over-ip/switch - przełącza rzeczywisty adres IP Przełącza docelowy (rzeczywisty) adres na który jest kierowany ruch przychodzący na zewnętrzny (wirtualny) adres IP. Parametry:
  • service_id (number) - numer ID usługi
  • real_ip (string) - nowy adres docelowy (musi znajdować się na liście dopuszczonych adresów)
Kody błędów:
  • authorization-failed
  • invalid-service-type
  • incorrect-param-value
  • ip-not-allowed
  • internal-fail-over-ip-error
Moduł: additional-ip Zarządzanie usługami dodatkowych adresów IP. Ten rodzaj usługi pozwala na wylistowanie i zamówienie nowych dodatkowych adresów IP dla usług centrum danych (serwerów dedykowanych, kolokacji, serwerów VPS) /additional-ip/list - lista usług Zwraca listę wszystkich usług dodatkowych adresów IP. Komenda działa identycznie jak wywołanie /services/list z parametrem service_type=additional-ip. /additional-ip/details - szczegóły usługi Zwraca szczegółowe infomracje dotyczące usługi dodatkowych adresów IP. Parametry:
  • service_id (number) - numer ID usługi
Odpowiedź:
  • service_details (object) - szczegóły
    • id (number) - unikalne ID usługi
    • subnetworks (objects-list) - lista podsieci
      • id (number) - unikalny numer ID podsieci
      • ip (string) - adres sieci
      • mask (string) - maska podsieci
      • mask_short (string) - skrót podsieci (w zapisie typu '/29')
      • type (string) - rodzaj podsieci (IPv4 / IPv6)
Kody błędów:
  • authorization-failed
/additional-ip/order-info - informacje / ceny dotyczące zamówienia dodatkowych IP Zwraca infomracje dotyczące zamawiania dodatkowych adresów IP. Zamawiane adresy muszą być zawsze powiązane z określoną usługą serwerową (serwerem dedykowanym, kolokacją, VPS) i okres rozliczeniowy dla płatności oraz waluta są zdeterminowane szczegółami płatności serwera. Komenda pozwala poznać cenę obliczoną dla pojedynczego adresu IP powiązanego z określoną usługą. Przy zamawianiu większej liczby adresów IP finalna cena będzie obliczona jako cena dla pojedynczego adresu IP razy zamówiona liczba adresów. Po realizacji zamówienia cena za dodatkowe adresy zostanie doliczona do ceny serwera. Poza danymi o cenach komenda zwraca także infomracje o maksymalnej możliwej do zamówienia w danej chwili liczbie adresów IP. Parametry:
  • parent_service_id (number) - numer ID usługi serwera, dla którego ma zostać wyliczona cena dodatkowego adresu IP
Odpowiedź:
  • order_info (object) -
    • maximum_ips_number (number) - maksymalna liczba adresów IP, jakie mogą zostać w tej chwili zamówione
    • one_ip_payment_details (object) - obiekt opisujący wyliczone szczegóły płatności za JEDEN dodatkowy adres IP
      • price (number) - cena za jeden adres IP (netto)
      • price_brutto (number) - cena za jeden adres IP (brutto)
      • currency (string) - kod waluty (like PLN, EUR, USD)
      • payment_period (number) - okres rozliczeniowy (liczba miesięcy)
Kody błędów:
  • invalid-parent-service-type
/additional-ip/order - zamówienie dodatkowych adresów IP Realizuje zamówienie dodatkowych adresów IP do wybranej usługi serwerowej (serwer dedykowany, kolokacja, VPS). Złożenie zamówienia powoduje automatyczne przypisanie adresów IP do wybranej usługi - przypisane adresy są zwracane w odpowiedzi zamówienia i są natychmiast gotowe do konfiguracji (każdy adres z maską 255.255.255.255). Złożenie zamówienia skutkuje automatycznym zwiększeniem ceny usługi nadrzędnej o cenę za adresy IP (będącej ceną za pojedynczy adres IP dla wybranej usługi pomnożoną przez ilość wybranych adresów) - adresy zamawiane są zawsze na okres płatności jednakowy jak okres płatności za usługę nadrzędną. Cenę za jeden adres IP dla danej usługi można sprawdzić komendą /additional-ip/order-info Parametry:
  • parent_service_id (number) - numer ID usługi serwera, do którego mają zostać przypisane addresy
  • ips_number (number) - liczba nowych adresów do przypisania
Odpowiedź:
  • order_details (object) - szczegóły złożonego zamówienia
    • service_id (number) - unikalne ID nowo stworzonej usługi dodatkowych adresów IP
    • ips_number (number) - liczba przypisanych adresów IP
    • ips_configuration (objects-list) - lista obiektów opisujących konfigurację przypisanych adresów
      • ip (string) - adres IP
      • mask (string) - maska z jaką powininen zostać skonfigurowany adres na serwerze
Kody błędów:
  • invalid-parent-service-type
  • invalid-ips-number
  • internal-service-create-error
  • internal-service-update-error
  • internal-additional-ip-error
Moduł: vps Lista serwerów VPS. /vps/list - lista usług Zwraca listę wszystkich usług serwerów VPS. Komenda działa identycznie jak wywołanie /services/list z parametrem service_type=vps. /vps/details - szczegóły serwera VPS Zwraca szczegółowe infomracje dotyczące serwera VPS. Parametry:
  • service_id (number) - numer ID usługi
Odpowiedź:
  • service_details (object) - szczegóły
    • id (number) - unikalne ID usługi
    • newtwork_configuration (object) - konfiguracja sieciowa serwera
      • ip (string) - główny adres IP serwera VPS
      • additional_ips_list (strings-list) - lista dodatkowych adresów IP
    • features (object) - dostępne funkcjonalności dla tego serwera
      • power_management (boolean) - jeżeli true można zarządzać zasilaniem tego VPS
    • power_state (string) - określa stan zasilania VPS (może przyjmować wartości: "unknown", "on", "off")
    • active (boolean) - określa, czy ten serwer jest aktywny (true) czy zablokowany (false)
Kody błędów:
  • authorization-failed
/vps/power-on - zmiana stanu VPS na WŁĄCZONY Zmiana stanu zasilania VPS na: WŁĄCZONY. Parametry:
  • service_id (number) - numer ID usługi
  • confirm (string) - wartość tego pola musi być ustawiona na "confirm"
Kody błędów:
  • invalid-service-type
  • service-suspended
  • unsupported-feature
  • unconfirmed
  • internal-operation-error
/vps/power-off - zmiana stanu VPS na WYŁĄCZONY Zmiana stanu zasilania VPS na: WYŁĄCZONY. Parametry:
  • service_id (number) - numer ID usługi
  • confirm (string) - wartość tego pola musi być ustawiona na "confirm"
Kody błędów:
  • invalid-service-type
  • service-suspended
  • unsupported-feature
  • unconfirmed
  • internal-operation-error
/vps/power-restart - restart VPS Zrestartowanie serwera VPS. Wykonywane jest przez WYŁĄCZENIE i następnie WŁĄCZENIE zasilania serwera. Parametry:
  • service_id (number) - numer ID usługi
  • confirm (string) - wartość tego pola musi być ustawiona na "confirm"
Kody błędów:
  • invalid-service-type
  • unsupported-feature
  • service-suspended
  • unconfirmed
  • internal-operation-error
Moduł: dedicated Zarządzanie usługami serwerów dedykowanych. /dedicated/list - lista serwerów dedykowanych Zwraca listę serwerów dedykowanych. Komenda działa identycznie jak wywołanie /services/list z parametrem service_type=dedicated. /dedicated/details - szczegóły serwera dedykowanego Zwraca szczegółowe infomracje dotyczące serwera dedykowanego. Parametry:
  • service_id (number) - numer ID usługi
Odpowiedź:
  • service_details (object) - szczegóły serwera
    • id (number) - unikalne ID usługi
    • hardware_configuration (object) - szczegóły konfiguracji sprzętowej
      • server (object) - szczegóły serwera
        • vendor (string) - producent
        • model (string) - nazwa modelu
      • cpu (objects-list) - lista procesorów
        • vendor (string) - producent
        • model (string) - nazwa modelu
        • clock (number) - zegar procesora [GHz]
        • cores (number) - liczba rdzeni
        • ht (boolean) - wsparcie hyper-threading
      • ram (objects-list) - lista modułów RAM
        • capacity (number) - pojemność [GB]
        • type (string) - rodzaj modułu
        • speed (number) - szybkość [MHz]
      • hdd (objects-list) - lista dysków twardych
        • capacity (number) - pojemność [GB]
        • type (string) - rodzaj dysku
        • speed (string) - szybkość
      • hdd_controller (objects-list) - lista kontrolerów HDD
        • model (string) - nazwa modelu
        • builtin (boolean) - informacja, czy kontroler wbudowany
    • network_configuration (object) - szczegóły konfiguracji sieciowej
      • ip (string) - adres IP
      • additional_ips (strings-list) - lista dodatkowych adresów IP
      • subnetworks (objects-list) - lista podsieci
        • id (number) - unikalny numer ID podsieci
        • ip (string) - adres sieci
        • mask (string) - maska podsieci
        • mask_short (string) - skrót podsieci (w zapisie typu '/29')
        • type (string) - rodzaj podsieci (IPv4 / IPv6)
      • firewall_ruleset_id (string) - identyfikator zbioru reguł firewall dotyczących tego serwera; w zależności od konfiguracji sieciowej twoich serwerów jeden zbiór reguł może dotyczyć jednego (zwykle) lub kilku twoich serwerów; jeżeli konfiguracja firewall dla tego serwera nie jest dostępna pole to nie wystąpi
    • features (object) - dostępne funkcjonalności dla tego serwera
      • ilo_access_management (boolean) - jeżeli true można włączyć dostęp do ILO / IPMI dla tego serwera
      • power_management (boolean) - jeżeli true można zarządzać zasilaniem tego serwera
      • firewall_management (boolean) - jeżeli true można zarządzać regułami zewnętrznego firewall dla tego serwera
    • active (boolean) - określa, czy ten serwer jest aktywny (true) czy zablokowany (false)
Kody błędów:
  • authorization-failed
/dedicated/transfer-usage-details - informacje o zużyciu transferu Zwraca szczegółowe informacje na temat wykorzystania transferu przez serwer w ostatnich 3 i bieżącym okresie rozliczeniowym. Parametry:
  • service_id (number) - numer ID usługi
Odpowiedź:
  • transfer_usage_details (object) - szczegóły transferu
    • periods_list (objects-list) - lista infomracji o zużyciu transferu w poszczególnych okresach rozliczeniowych
      • time_range (object) - obiekt określający okres
        • from (number) - znacznik czasu (UNIX) określający początek okresu
        • from (number) - znacznik czasu (UNIX) określający początek okresu
      • transfer_usage (object) - obiekt określający zużycie transferu w okresie
        • up (number) - ilość wysłanych danych [bajtów]
        • down (number) - ilość odebranych danych [bajtów]
Kody błędów:
  • invalid-service-type
  • unsupported-feature
/dedicated/ilo-details - szczegóły dostępu do iLO / IPMI Szczegółowe infomracje dotyczące dostępu do systemów zarządzania iLO / IPMI. Parametry:
  • service_id (number) - numer ID usługi
Odpowiedź:
  • ilo_details (object) - szczegóły dostepu do iLO / IPMI
    • available (boolean) - określa, czy usługa iLO / IPMI jest dostępna (jeżeli tak, można włączyć dostęp dla wybranego adresu IP)
    • ip (string) - adres IP usługi iLO / IPMI
    • access_enabled (boolean) - określa, czy dostęp do iLO / IPMI jest w tej chwili otwarty
    • access_ip (string) - jeżeli dostęp do iLO / IPMI jest otwarty to pole określa zewnętrzny adres IP uprawniony do połączenia
Kody błędów:
  • invalid-service-type
  • unsupported-feature
/dedicated/ilo-access-enable - otwiera dostęp do połączenia do iLO / IPMI Otwarcie dostępu do usługi iLO / IPMI dla wybranego zdalnego adresu IP. Parametry:
  • service_id (number) - numer ID usługi
  • remote_ip (string) - zdalny adres IP dla którego otwarty ma być dostęp do iLO / IPMI
Kody błędów:
  • invalid-service-type
  • unsupported-feature
  • internal-operation-error
/dedicated/ilo-access-disable - zamyka dostęp do połączenia do iLO / IPMI Zamknięcie dostępu do usługi iLO / IPMI. Parametry:
  • service_id (number) - numer ID usługi
Kody błędów:
  • invalid-service-type
  • unsupported-feature
  • internal-operation-error
/dedicated/power-details - szczegóły dotyczące stanu i zarządzania zasilaniem serwera Szczegółowe infomracje dotyczące możliwości zarządzania zasilaniem serwera i jego aktualnego stanu (stan serwera dotyczy zasilania serwera, a nie tego, czy serwer jest włączony; domylsnie wszystkie serwery automatycznie włączają się, jeżeli włączone jest zasilanie). Parametry:
  • service_id (number) - numer ID usługi
Odpowiedź:
  • power_details (object) - szczegóły zasilania
    • manageable (boolean) - określa, czy dla tego serwera możliwe jest sterowanie stanem zasilania
    • state (string) - aktualny stan zasilania serwera
Kody błędów:
  • invalid-service-type
  • unsupported-feature
/dedicated/power-on - zmiana stanu zasilania na WŁĄCZONY Zmiana stanu zasilania serwera na: WŁĄCZONY. Parametry:
  • service_id (number) - numer ID usługi
  • confirm (string) - wartość tego pola musi być ustawiona na "confirm"
Kody błędów:
  • invalid-service-type
  • unsupported-feature
  • unconfirmed
  • internal-operation-error
/dedicated/power-off - zmiana stanu zasilania na WYŁĄCZONY Zmiana stanu zasilania serwera na: WYŁĄCZONY. Parametry:
  • service_id (number) - numer ID usługi
  • confirm (string) - wartość tego pola musi być ustawiona na "confirm"
Kody błędów:
  • invalid-service-type
  • unsupported-feature
  • unconfirmed
  • internal-operation-error
/dedicated/power-restart - restart serwera Zrestartowanie serwera. Wykonywane jest przez WYŁĄCZENIE i następnie WŁĄCZENIE zasilania serwera. Parametry:
  • service_id (number) - numer ID usługi
  • confirm (string) - wartość tego pola musi być ustawiona na "confirm"
Kody błędów:
  • invalid-service-type
  • unsupported-feature
  • unconfirmed
  • internal-operation-error
Moduł: colocation Zarządzanie usługami kolokacji serwerów. /colocation/list - lista kolokacji Zwraca listę usług kolokacji. Komenda działa identycznie jak wywołanie /services/list z parametrem service_type=colocation. /colocation/details - szczegóły usługi kolokacji Zwraca szczegółowe infomracje dotyczące usługi kolokacji. Parametry:
  • service_id (number) - numer ID usługi
Odpowiedź:
  • service_details (object) - szczegóły kolokacji
    • id (number) - unikalne ID usługi
    • network_configuration (object) - szczegóły konfiguracji sieciowej
      • ip (string) - adres IP
      • additional_ips (strings-list) - lista dodatkowych adresów IP
      • subnetworks (objects-list) - lista podsieci
        • id (number) - unikalny numer ID podsieci
        • ip (string) - adres sieci
        • mask (string) - maska podsieci
        • mask_short (string) - skrót podsieci (w zapisie typu '/29')
        • type (string) - rodzaj podsieci (IPv4 / IPv6)
      • firewall_ruleset_id (string) - identyfikator zbioru reguł firewall dotyczących tego serwera; w zależności od konfiguracji sieciowej twoich serwerów jeden zbiór reguł może dotyczyć jednego (zwykle) lub kilku twoich serwerów; jeżeli konfiguracja firewall dla tego serwera nie jest dostępna pole to nie wystąpi
    • features (object) - dostępne funkcjonalności dla tego serwera
      • power_management (boolean) - jeżeli true można zarządzać zasilaniem tego serwera
      • firewall_management (boolean) - jeżeli true można zarządzać regułami zewnętrznego firewall dla tej kolokacji
    • active (boolean) - określa, czy ten serwer jest aktywny (true) czy zablokowany (false)
Kody błędów:
  • authorization-failed
/colocation/transfer-usage-details - informacje o zużyciu transferu Zwraca szczegółowe informacje na temat wykorzystania transferu przez serwer w ostatnich 3 i bieżącym okresie rozliczeniowym. Parametry:
  • service_id (number) - numer ID usługi
Odpowiedź:
  • transfer_usage_details (object) - szczegóły transferu
    • periods_list (objects-list) - lista infomracji o zużyciu transferu w poszczególnych okresach rozliczeniowych
      • time_range (object) - obiekt określający okres
        • from (number) - znacznik czasu (UNIX) określający początek okresu
        • from (number) - znacznik czasu (UNIX) określający początek okresu
      • transfer_usage (object) - obiekt określający zużycie transferu w okresie
        • up (number) - ilość wysłanych danych [bajtów]
        • down (number) - ilość odebranych danych [bajtów]
Kody błędów:
  • invalid-service-type
  • unsupported-feature
/colocation/power-details - szczegóły dotyczące stanu i zarządzania zasilaniem serwera Szczegółowe infomracje dotyczące możliwości zarządzania zasilaniem serwera i jego aktualnego stanu (stan serwera dotyczy zasilania serwera, a nie tego, czy serwer jest włączony; domylsnie wszystkie serwery automatycznie włączają się, jeżeli włączone jest zasilanie). Parametry:
  • service_id (number) - numer ID usługi
Odpowiedź:
  • power_details (object) - szczegóły zasilania
    • manageable (boolean) - określa, czy dla tego serwera możliwe jest sterowanie stanem zasilania
    • state (string) - aktualny stan zasilania serwera
Kody błędów:
  • invalid-service-type
  • unsupported-feature
/colocation/power-on - zmiana stanu zasilania na WŁĄCZONY Zmiana stanu zasilania serwera na: WŁĄCZONY. Parametry:
  • service_id (number) - numer ID usługi
  • confirm (string) - wartość tego pola musi być ustawiona na "confirm"
Kody błędów:
  • invalid-service-type
  • unsupported-feature
  • unconfirmed
  • internal-operation-error
/colocation/power-off - zmiana stanu zasilania na WYŁĄCZONY Zmiana stanu zasilania serwera na: WYŁĄCZONY. Parametry:
  • service_id (number) - numer ID usługi
  • confirm (string) - wartość tego pola musi być ustawiona na "confirm"
Kody błędów:
  • invalid-service-type
  • unsupported-feature
  • unconfirmed
  • internal-operation-error
/colocation/power-restart - restart serwera Zrestartowanie serwera. Wykonywane jest przez WYŁĄCZENIE i następnie WŁĄCZENIE zasilania serwera. Parametry:
  • service_id (number) - numer ID usługi
  • confirm (string) - wartość tego pola musi być ustawiona na "confirm"
Kody błędów:
  • invalid-service-type
  • unsupported-feature
  • unconfirmed
  • internal-operation-error
Moduł: ip-blackholing Zarządzanie mechanizmem IP blackholing. Włączenie blackholingu dla adresu IP powoduje blokadę całego ruchu dla tego adresu i odrzucanie wszystkich pakietów kierowanych na ten adres. Głównym zastosowaniem dla tego mechanizmu jest odcięcie adresu w trakcie ataktu typu DDoS w celu zmiejszenia obciążenia serwera. /ip-blackholing/list - lista zablokowanych adresów IP Zwraca listę blokad adresów IP. Odpowiedź:
  • blackholed_ips_list (objects-list) - lista zablokowanych adresów IP
    • ip (string) - zablokowany adres IP
    • type (string) - Typ blokady. Pole to może przyjmować dwie wartości: "customer" - jeżeli jest to blokada założona przez klienta i można ją zdjąć, "admin" - jeżeli blokada została założona przez administratora i nie można jej zdjąć samodzielnie.
Kody błędów:
  • authorization-failed
/ip-blackholing/enable - włączenie blackholingu Włączenie blackholingu dla podanego adresu IP. Można podać dowolny adres z zakresu zarządzalnego przez klienta lub dowolny adres IP powiązany z usługą. Parametry:
  • ip (string) - adres IP, dla które założona ma zostać blokada
Kody błędów:
  • incorrect-ip
  • ip-not-allowed
  • ip-already-blackholed
  • internal-blackholing-ip-error
/ip-blackholing/disable - wyłączenie blackholingu Wyłączenie blackholingu dla podanego adresu IP. Można podać dowolny adres z zakresu zarządzalnego przez klienta lub dowolny adres IP powiązany z usługą. Nie jest możliwe zdjęcie blokady założonej przez administratora. Parametry:
  • ip (string) - adres IP, dla którego zdjęta ma zostać blokada
Kody błędów:
  • incorrect-ip
  • ip-not-allowed
  • ip-not-blackholed
  • admin-blackhole
  • internal-blackholing-ip-error
Moduł: dns Zarządzanie strefami domen w DNS. Moduł pozwala na dodanie do DNS artnet (ns1.artnet.pl i ns2.artnet.pl) stref domen (podstawowych lub zapasowych) i zarządzanie ich konfiguracją. /dns/list - lista skonfigurowanych stref DNS Zwraca listę skonfigurowanych stref wraz z podstawowymi informacjami. Odpowiedź:
  • zones_list (objects-list) - lista stref
    • id (number) - numer ID strefy
    • domain (string) - nazwa domeny
    • type (string) - Rodzaj strefy. Pole może przyjmowąć dwie wartości "primary" dla strefy podstawowej i "secoundary" dla strefy zapasowej.
    • master_nameserver (string) - nazwa servera podstawowego (pole to występuje tylko dla stref zapasowych)
Kody błędów:
  • authorization-failed
/dns/delete - usunięcie domeny z DNS Usuwa istniejącą konfigurację domeny w DNS. Parametry:
  • zone_id (number) - ID strefy
Kody błędów:
  • incorrect-param-value
  • invalid-zone-id
  • internal-dns-error
/dns/details-secoundary - szczegóły konfiguracji zapasowej strefy DNS Zwraca konfigurację strefy DNS. Parametry:
  • zone_id (number) - ID strefy
Odpowiedź:
  • zone_details (object) - szczegóły konfiguracji
    • id (number) - numer ID strefy
    • domain (string) - nazwa domeny
    • type (string) - Rodzaj strefy. Pole może przyjmowąć dwie wartości "primary" dla strefy podstawowej i "secoundary" dla strefy zapasowej.
    • master_nameserver (string) - nazwa servera podstawowego
Kody błędów:
  • incorrect-ip
  • ip-not-allowed
  • ip-already-blackholed
  • internal-blackholing-ip-error
/dns/add-secoundary - dodanie zapasowej strefy do DNS Dodaje nową domenę do DNS jako strefę zapasową. Klient musi mieć uprawnienia do dodania wybranej domeny, uprawnienia do dodawania domen można sprawdzić komendą /dns/info. Wymagane jest podanie podstawowego serwera nazw dla tej strefy. Podany serwer nazw musi dać się rozwiązać do IP. Parametry:
  • domain (string) - nazwa domeny do dodania do DNS
  • master_nameserver (string) - nazwa hosta albo IP podstawowego serwera nazw
Odpowiedź:
  • zone_details (object) - szczegóły nowo utworzonej strefy
    • id (number) - numer ID strefy
    • domain (string) - nazwa domeny
    • type (string) - Rodzaj strefy. Pole może przyjmowąć dwie wartości "primary" dla strefy podstawowej i "secoundary" dla strefy zapasowej.
    • master_nameserver (string) - nazwa servera podstawowego
Kody błędów:
  • incorrect-param-value
  • domain-not-allowed
  • domain-already-exists
  • unresolveable-master-nameserver
  • internal-dns-error
/dns/details-primary - szczegóły konfiguracji podstawowej strefy DNS Zwraca konfigurację strefy DNS. Zawiera informacje o konfiguracji strefy, numerze seryjnym aktualnej konfiguracji, serwerach nazw i rekordach DNS. Parametry:
  • zone_id (number) - ID strefy
Odpowiedź:
  • zone_details (object) - szczegóły konfiguracji
    • id (number) - numer ID strefy
    • domain (string) - nazwa domeny
    • type (string) - Rodzaj strefy. Pole może przyjmowąć dwie wartości "primary" dla strefy podstawowej i "secoundary" dla strefy zapasowej.
    • nameservers (strings-list) - lista serwerów nazw (odpowiadająca rekordom NS)
    • serial (number) - Aktualna wartość numeru serial strefy DNS. Jej podanie jest wymagane do przeprowadzenia edycji. Po każdej edycji rekordów DNS wartość tego pola ulega zmianie.
    • records (objects-list) - Lista rekordów DNS w tej strefie. Pola rekordów są zgodne z opisanymi w odpowiednich dokumentach RFC opisujących strefy DNS (patrz RFC 1035). Kolejność jest istotna.
      • name (string) - nazwa hosta dla rekordu DNS; dopuszczalne są: nazwy względne, nazwy bezwględne (zakończone kropką), użycie znaku @ (w odniesieniu do głównej domeny), pozostawienie tego pola pustego (w odniesieniu do poprzedniej nazwy)
      • ttl (number) - time-to-live - ilość sekund po jakiej serwer przechowujący w cache ten wpis powininen go odświeżyć
      • type (string) - Typ rekordu DNS ('A', 'AAAA', 'CNAME', 'MX', 'TXT', 'SRV')
      • data1 (string) - pierwszy człon danych rekordu; pole to występuje dla wszystkich typów rekordów, pozostałe pola danych są opcjonalne i występują w zależności od typu rekordu
      • data2 (string) - [opcjonalne, zależy od typu rekordu] drugi człon danych
      • data3 (string) - [opcjonalne, zależy od typu rekordu] trzeci człon danych
      • data4 (string) - [opcjonalne, zależy od typu rekordu] drugi człon danych
Kody błędów:
  • incorrect-ip
  • ip-not-allowed
  • ip-already-blackholed
  • internal-blackholing-ip-error
/dns/add-primary - dodanie podstawowej strefy do DNS Dodaje nową domenę do DNS jako strefę podstawową. Klient musi mieć uprawnienia do dodania wybranej domeny, uprawnienia do dodawania domen można sprawdzić komendą /dns/info. Domena dodawana jest do DNS z pustą konfiguracją (bez rekordów). Aby je skonfigurować należy wykonać edycję strefy. Parametry:
  • domain (string) - nazwa domeny do dodania do DNS
Odpowiedź:
  • zone_details (object) - szczegóły nowo utworzonej strefy
    • id (number) - numer ID strefy
    • domain (string) - nazwa domeny
    • type (string) - Rodzaj strefy. Pole może przyjmowąć dwie wartości "primary" dla strefy podstawowej i "secoundary" dla strefy zapasowej.
Kody błędów:
  • incorrect-param-value
  • domain-not-allowed
  • domain-already-exists
  • internal-dns-error
/dns/edit-primary-records - zmiana rekordów DNS strefy podstawowej Komenda powoduje zapisanie nowej listy rekordów dla wybranej strefy podstawowej DNS. Należy podać aktualną wartość numeru serial rekordu SOA (zwracana w treści odpowiedzi komendy /dns/details-primary) aby można było zapisać edycję. Parametry:
  • zone_id (number) - ID strefy
  • serial (string) - aktualna wartość numeru serial rekordu SOA
  • records[N] (array-of-arrays) - tablica opisująca pojedynczy rekord DNS; indeks N musi być unikalny w obrębie zapytania; kolejność występowania rekordów ma znaczenie
  • records[N][name] (string) - nazwa hosta dla rekordu DNS; dopuszczalne są: nazwy względne, nazwy bezwględne (zakończone kropką), użycie znaku @ (w odniesieniu do głównej domeny), pozostawienie tego pola pustego (w odniesieniu do poprzedniej nazwy)
  • records[N][ttl] (number) - time-to-live - ilość sekund po jakiej serwer przechowujący w cache ten wpis powininen go odświeżyć
  • records[N][type] (string) - Typ rekordu DNS ('A', 'AAAA', 'CNAME', 'MX', 'TXT', 'SRV')
  • records[N][data1] (number) - pierwszy człon danych rekordu; pole to występuje dla wszystkich typów rekordów, pozostałe pola danych są opcjonalne i występują w zależności od typu rekordu
  • records[N][data2] (number) - [opcjonalne, zależy od typu rekordu] drugi człon danych
  • records[N][data3] (number) - [opcjonalne, zależy od typu rekordu] trzeci człon danych
  • records[N][data4] (number) - [opcjonalne, zależy od typu rekordu] drugi człon danych
Kody błędów:
  • incorrect-param-value
  • invalid-zone-id
  • invalid-zone-type
  • internal-dns-error
  • incorrect-soa-serial
Moduł: rev-dns Zarządzanie rekordami PTR w revDNS. /rev-dns/list - lista podsieci dostępnych do konfiguracji Zwraca listę podsieci dostepnych do konfiguracji. Ze względów technicznych konfiguracja revDNS odbywa się w podklasach o rozmiarze maksymalnym klasy C. Z tego względu każda podsieć zawiera listę dostępnych do konfiguracji podklas (dns_subclasses). Przy operacji pobrania szczegółów lub edycji danych należy podać numer ID podsieci oraz nazwę podklasy konfiguracyjnej. Odpowiedź:
  • subnetworks_list (objects-list) - lista podsieci wraz z podklasami konfiguracyjnymi
    • id (number) - unikalny numer ID podsieci
    • ip (string) - adres sieci
    • mask (string) - maska podsieci
    • mask_short (string) - skrót podsieci (w zapisie typu '/29')
    • type (string) - rodzaj podsieci (IPv4 / IPv6)
    • dns_subclasses (strings-list) - lista nazw podklas konfiguracyjnych w obrębie podsieci
/rev-dns/details - pobranie konfiguracji revDNS Szczegółowe informacje i konfiguracja rekordów PTR dla wybranej podklasy konfiguracyjnej revDNS. Wymagane jest podanie numeru ID podsieci oraz nazwy wybranej podklasy konfiguracyjnej w jej obrębie. Parametry:
  • subnetwork_id (number) - ID podsieci
  • dns_subclass (string) - nazwa podklasy konfiguracyjnej (jedna z pozycji listy dns_subclasses dla wskazanej podsieci)
Odpowiedź:
  • subclass_details (object) - szczegóły konfiguracji wybranej podklasy
    • serial (number) - numer serial rekordu SOA dla aktualnej konfiguracji; znajomość tej wartości jest niezbędna do wykonania edycji konfiguracji
    • type (string) - rodzaj podsieci (IPv4 / IPv6)
    • prefix (string) - prefix adresu IP; wartość ta określa stałą część adresu dla tej podlasy; prefix + separator IP + origin określa cały adres IP
    • ptr_records (objects-list) - lista rekordów PTR
      • origin (string) - identyfikator adresu w obrębie podklasy
      • ptr (string) - wartość rekordu PTR
      • address (string) - pełen adres IP rekordu
Kody błędów:
  • authorization-failed
/rev-dns/edit - edycja konfiguracji revDNS Edycja rekordów PTR. Wymagane jest podanie numeru ID podsieci oraz nazwy wybranej podklasy konfiguracyjnej w jej obrębie. Wymagane jest również podanie aktualnej wartości numeru serial recordu SOA (na podstawie szczegółów konfiguracji podklasy) - wartość ta zmienia się dla każdej skutecznej edycji (tj. kiedy coś zostało zmienione). Wykonanie operacji kończy się podaniem listy obiektów warinings zawierającej informacje o błędach, które wystąpiły dla edycji poszczególnych rekordów. Jeżeli dla jakiegoś rekordu wystąpi obiekt w warnings oznacza to, że dla tego rekordu wartość nie została zmieniona. Błędy edycji poszczególnych rekordów nie powodując przerwania operacji i nie generują błędu. Parametry:
  • subnetwork_id (number) - ID podsieci
  • dns_subclass (string) - nazwa podklasy konfiguracyjnej (jedna z pozycji listy dns_subclasses dla wskazanej podsieci)
  • serial (number) - dotychczasowa wartość numeru serial rekordu SOA
  • ptr_records[N] (array-of-arrays) - tablica zawierająca tablice określające wartości rekordów PTR; indeks N musi być w obrębie zapytania unikatowy dla poszczególnych rekordów
  • ptr_records[N][origin] (string) - origin zmienianego / dodawanego rekordu
  • ptr_records[N][ptr] (string) - wartość rekordu PTR do ustawienia
  • ptr_records[N][delete] (string) - jeżeli wartość tego pola zostanie ustawiona na "delete" odpowiedni rekord zostanie usunięte
Odpowiedź:
  • warnings (objects-list) - lista błędów związanych z poszczególnymi rekordami; istnienie obiektu warning dla jakiegoś rekordu oznacza, że dla tego obiektu nie dokonano żadnych zmian
    • origin (string) - identyfikator rekordu, dla którego wystąpił błąd
    • address (string) - pełen adres IP rekordu
    • task (string) - nazwa operacji, dla której wystąpił błąd
    • code (string) - kod błędu
    • description (object) - opis błędu
      • pl (string) - opis błędu w języku polskim
      • en (string) - opis błędu w języku angielskim
Kody błędów:
  • authorization-failed
  • invalid-subclass
  • internal-dns-error
  • invalid-origin
  • invalid-serial
  • authorization-failed
Moduł: firewall Zarządzanie regułami zewnętrznego firewall. Jeżeli twoje serwery mają dostępną opcję konfiguracji reguł zewnętrznego firewall ten moduł pozwala na zarządzanie nimi. Dla każdego serwera lub grupy serwerów (w zależności do konfiguracji sieciowej) dostępne są "zbiory reguł", które określają politykę filtracji pakietów. Pamiętaj, że jeżeli zbiór reguł dotyczy więcej niż jednego serwera określone reguły filtracji dotyczą każdego z nich. /firewall/list - lista dostępnych zbiorów reguł Zwraca listę zbiorów reguł firewall dostępnych do konfiguracji. Każdy zbiór reguł określa reguły filtracji pakietów dla jednego lub kilku twoich serwerów. Każdy obiekt ruleset zawiera pole z listą ID usług serwerów (services_ids_list), których dotyczą reguły z danego zbioru. Odpowiedź:
  • rulesets_list (objects-list) - lista zbirów reguł kofngiuracji firewall
    • id (string) - identyfikator zbioru reguł
    • services_ids_list (numbers-list) - lista numerów ID usług serwerów, których dotyczy dany zbiór reguł
/firewall/details - pobranie konfiguracji firewall Szczegóły konfiguracji firewall dla określonego ruleset. Zwraca informację o dopuszczalej liczbie reguł dla każdego z kierunków, o stanie (włączony / wyłączony) firewall oraz listę reguł każdego z kierunków. Parametry:
  • ruleset_id (string) - identyfikator ruleset (zestawu reguł)
Odpowiedź:
  • ruleset_details (object) - szczegóły konfiguracji firewall
    • id (string) - identyfikator ruleset
    • enabled (boolean) - określa czy firewall jest aktywny
    • maximum_rules_number (number) - określa maksymalną liczbę reguł, jaka może zostać ustawiona dla jednego kierunku
    • protocol (string) - liczba określająca numer protokołu (wg rfc1700) lub puste pole jeżeli protokół ma nie być brany pod uwagę
    • rules (object) - obiekt opisujący reguły firewall
      • in (objects-list) - lista reguł dla ruchu przychodzącego (kolejność jest znacząca)
        • policy (string) - polityka reguły ("ACCEPT" dla akceptacji pakietów, lub "DROP" dla ich odrzucania)
        • source (object) - warunki dla źródła pakietu
          • ip (string) - adres IP
          • mask_short (number) - liczba określająca skrót podsieci (0 - 32)
          • port (object) - warunki portu źródłowego pakietu
            • begin (string) - port początkowy (lub puste pole jeżeli nie ma zastosowania do wybranego protokoły lub nie ma być brane pod uwagę)
            • end (string) - port końcowy (lub puste pole jeżeli nie ma zastosowania do wybranego protokoły lub nie ma być brane pod uwagę)
        • destination (object) - warunki dla celu pakietu
          • ip (string) - adres IP
          • mask_short (number) - liczba określająca skrót podsieci (0 - 32)
          • port (object) - warunki portu przeznaczenia pakietu
            • begin (string) - port początkowy (lub puste pole jeżeli nie ma zastosowania do wybranego protokoły lub nie ma być brane pod uwagę)
            • end (string) - port końcowy (lub puste pole jeżeli nie ma zastosowania do wybranego protokoły lub nie ma być brane pod uwagę)
      • out (objects-list) - lista reguł dla ruchu wychodzącego (kolejność jest znacząca)
        • policy (string) - polityka reguły ("ACCEPT" dla akceptacji pakietów, lub "DROP" dla ich odrzucania)
        • source (object) - warunki dla źródła pakietu
          • ip (string) - adres IP
          • mask_short (number) - liczba określająca skrót podsieci (0 - 32)
          • port (object) - warunki portu źródłowego pakietu
            • begin (string) - port początkowy (lub puste pole jeżeli nie ma zastosowania do wybranego protokoły lub nie ma być brane pod uwagę)
            • end (string) - port końcowy (lub puste pole jeżeli nie ma zastosowania do wybranego protokoły lub nie ma być brane pod uwagę)
        • destination (object) - warunki dla celu pakietu
          • ip (string) - adres IP
          • mask_short (number) - liczba określająca skrót podsieci (0 - 32)
          • port (object) - warunki portu przeznaczenia pakietu
            • begin (string) - port początkowy (lub puste pole jeżeli nie ma zastosowania do wybranego protokoły lub nie ma być brane pod uwagę)
            • end (string) - port końcowy (lub puste pole jeżeli nie ma zastosowania do wybranego protokoły lub nie ma być brane pod uwagę)
Kody błędów:
  • invalid-ruleset-id
/firewall/enable - włącza firewall Włączenie filtrowania pakietów przez firwall. Parametry:
  • ruleset_id (string) - identyfikator ruleset
Kody błędów:
  • invalid-service-type
  • internal-firewall-error
/firewall/disable - wyłącza firewall Wyłączenie filtrowania pakietów przez firwall. Parametry:
  • ruleset_id (string) - identyfikator ruleset
Kody błędów:
  • invalid-service-type
  • internal-firewall-error
/firewall/save - zmiana reguł firewall Zapisuje nowy zestaw reguł firewall dla wybranego ruleset. W przypadku błędu zmiany na firewall nie zostaną zapisane. Obiekt error dla błędów składni zawiera dodatkowe pole errors_details podające jaki i dla którego indeksu reguły wystąpił problem Parametry:
  • ruleset_id (string) - identyfikator ruleset
  • rules[in][N] (array-of-arrays) - tablica opisująca pojedynczą regułę firewall dla ruchu przychodzącego; indeks N musi być stały i unikalny dla pojedynczej reguły firewall w obrębie zapytania
  • rules[in][N][policy] (string) - rodzaj polityki dla danej reguły ("ACCEPT" lub "DROP")
  • rules[in][N][protocol] (number) - numer protokołu pakietu (wg RFC1700)
  • rules[in][N][source][ip] (string) - adres źródłowy pakietu
  • rules[in][N][source][mask_short] (number) - liczba określająca skrót podsieci (0 - 32)
  • rules[in][N][source][port][begin] (number) - dolna granica zakresu źródłowych portów (lub pusty string jeżeli nie ma sensu przy wybranym rodzaju protokołu lub nie ma być sprawdzane)
  • rules[in][N][source][port][end] (number) - górna granica zakresu źródłowych portów (lub pusty string jeżeli nie ma sensu przy wybranym rodzaju protokołu lub nie ma być sprawdzane)
  • rules[in][N][destination][ip] (string) - adres docelowy pakietu
  • rules[in][N][destination][mask_short] (number) - liczba określająca skrót podsieci (0 - 32)
  • rules[in][N][destination][port][begin] (number) - dolna granica zakresu docelowych portów (lub pusty string jeżeli nie ma sensu przy wybranym rodzaju protokołu lub nie ma być sprawdzane)
  • rules[in][N][destination][port][end] (number) - górna granica zakresu docelowych portów (lub pusty string jeżeli nie ma sensu przy wybranym rodzaju protokołu lub nie ma być sprawdzane)
  • rules[out][N] (array-of-arrays) - tablica opisująca pojedynczą regułę firewall dla ruchu wychodzącego; indeks N musi być stały i unikalny dla pojedynczej reguły firewall w obrębie zapytania
  • rules[out][N][policy] (string) - rodzaj polityki dla danej reguły ("ACCEPT" lub "DROP")
  • rules[out][N][protocol] (number) - numer protokołu pakietu (wg RFC1700)
  • rules[out][N][source][ip] (string) - adres źródłowy pakietu
  • rules[out][N][source][mask_short] (number) - liczba określająca skrót podsieci (0 - 32)
  • rules[out][N][source][port][begin] (number) - dolna granica zakresu źródłowych portów (lub pusty string jeżeli nie ma sensu przy wybranym rodzaju protokołu lub nie ma być sprawdzane)
  • rules[out][N][source][port][end] (number) - górna granica zakresu źródłowych portów (lub pusty string jeżeli nie ma sensu przy wybranym rodzaju protokołu lub nie ma być sprawdzane)
  • rules[out][N][destination][ip] (string) - adres docelowy pakietu
  • rules[out][N][destination][mask_short] (number) - liczba określająca skrót podsieci (0 - 32)
  • rules[out][N][destination][port][begin] (number) - dolna granica zakresu docelowych portów (lub pusty string jeżeli nie ma sensu przy wybranym rodzaju protokołu lub nie ma być sprawdzane)
  • rules[out][N][destination][port][end] (number) - górna granica zakresu docelowych portów (lub pusty string jeżeli nie ma sensu przy wybranym rodzaju protokołu lub nie ma być sprawdzane)
Kody błędów:
  • invalid-ruleset-id
  • too-many-rules
  • rules-syntax-error
  • internal-firewall-error
Moduł: offer-dedicated Oferta i zamawianie serwerów dedykowanych od ręki. /offer-dedicated/custom-offer - oferta dedykowana Zwraca listę parametrów konfiguracyjnych serwerów dedykowanych umożliwiającą przygotowanie i kalkulację zamówienia. Odpowiedź:
  • resources (objects-list) - lista dostępnych serwerów
    • platforms (object-list) - lista dostępnych platform
      • model_name (string) - nazwa modelu
      • resources (object-list) - zasoby modelu
        • cpu (string) - nazwa CPU
        • hdd_controller (string) - nazwa kontrolera HDD
      • resources_limits (object-list) - ograniczenia platformy
        • hdd_sizes (array-string) - dostępne rozmiary dysków
        • hdd_slots (string) - maksymalna ilość slotów dysków
        • ram_max (string) - maksymalna ilość RAM
        • cpu_slots (integer) - maksymalna ilość dodatkowych CPU
      • price (object-list) - cena
        • price (integer) - cena
        • currency (string) - waluta w której podana jest cena
        • payment_period (string) - okres płatności
    • hdd_disks (object-list) - lista dostępnych dysków
      • capacity (string) - pojemność dysku
      • type (string) - rodzaj dysku
      • speed (string) - prędkość dysku
      • size (string) - wymiary dysku
      • price (object-list) - cena
        • price (integer) - cena
        • currency (string) - waluta w której podana jest cena
        • payment_period (string) - okres płatności
    • rams (string) - dostępne pamięci RAM
      • capacity (string) - pojemność dysku
      • price (object-list) - cena
        • price (integer) - cena
        • currency (string) - waluta w której podana jest cena
        • payment_period (string) - okres płatności
    • additional_cpus (object-list) - dostępne dodatkowe CPU
      • name (string) - nazwa dodatkowego CPU
      • price (object-list) - cena
        • price (integer) - cena
        • currency (string) - waluta w której podana jest cena
        • payment_period (string) - okres płatności
    • hdd_controllers (object-list) - dostępne dodatkowe kontrolery HDD
      • name (string) - nazwa dodatkowego kontrolera HDD
      • price (object-list) - cena
        • price (integer) - cena
        • currency (string) - waluta w której podana jest cena
        • payment_period (string) - okres płatności
    • transfer_package (object-list) - dostępne pakiety danych
      • transfer (string) - wielkość pakietu danych
      • price (object-list) - cena
        • price (integer) - cena
        • currency (string) - waluta w której podana jest cena
        • payment_period (string) - okres płatności
    • bandwidth_package (object-list) - dostępna przepustowość danych
      • bandwidth (string) - prędkość przesyłu danych
      • price (object-list) - cena
        • price (integer) - cena
        • currency (string) - waluta w której podana jest cena
        • payment_period (string) - okres płatności
    • others (object-list) - usługi dodatkowe
      • name (string) - nazwa usługi dodatkowej
      • price (object-list) - cena
        • price (integer) - cena
        • currency (string) - waluta w której podana jest cena
        • payment_period (string) - okres płatności
    • ip (object-list) - dodatowy adres ip
      • amount (string) - ilość dodatkowych adresów ip
      • price (object-list) - cena
Kody błędów:
  • authorization-failed
/offer-dedicated/express-offer - aktualna oferta Zwraca listę dostepnych serwerów dedykowanych sprzedawanych w modelu "od ręki" (Express Server) wraz z ich parametrami i cenami. Odpowiedź:
  • offer (objects-list) - lista dostępnych serwerów
    • id (number) - unikalne ID serwera
    • hardware_configuration (object) - szczegóły konfiguracji sprzętowej
      • server (object) - szczegóły serwera
        • vendor (string) - producent
        • model (string) - nazwa modelu
      • cpu (objects-list) - lista procesorów
        • vendor (string) - producent
        • model (string) - nazwa modelu
        • clock (number) - zegar procesora [GHz]
        • cores (number) - liczba rdzeni
        • ht (boolean) - wsparcie hyper-threading
      • ram (objects-list) - lista modułów RAM
        • capacity (number) - pojemność [GB]
        • type (string) - rodzaj modułu
        • speed (number) - szybkość [MHz]
      • hdd (objects-list) - lista dysków twardych
        • capacity (number) - pojemność [GB]
        • type (string) - rodzaj dysku
        • speed (string) - szybkość
      • hdd_controller (objects-list) - lista kontrolerów HDD
        • model (string) - nazwa modelu
        • builtin (boolean) - informacja, czy kontroler wbudowany
    • prices (object) - informacje o cenach
      • regular (object) - cena dla klientów
        • price (number) - cena netto serwera
        • currency (string) - kod waluty
        • payment_period (number) - okres rozliczeniowy dla podanej ceny (liczba miesięcy)
      • reseller (object) - widoczne tylko dla resellerów; cena dla resellera
        • price (number) - cena netto serwera
        • currency (string) - kod waluty
        • payment_period (number) - okres rozliczeniowy dla podanej ceny (liczba miesięcy)
Kody błędów:
  • authorization-failed
/offer-dedicated/express-reservations-list - list zarezerwowanych serwerów Zwraca listę serwerów zarezerwowanych przez klienta. Odpowiedź:
  • offer (objects-list) - lista dostępnych serwerów
    • id (number) - unikalne ID serwera
    • hardware_configuration (object) - szczegóły konfiguracji sprzętowej
      • server (object) - szczegóły serwera
        • vendor (string) - producent
        • model (string) - nazwa modelu
      • cpu (objects-list) - lista procesorów
        • vendor (string) - producent
        • model (string) - nazwa modelu
        • clock (number) - zegar procesora [GHz]
        • cores (number) - liczba rdzeni
        • ht (boolean) - wsparcie hyper-threading
      • ram (objects-list) - lista modułów RAM
        • capacity (number) - pojemność [GB]
        • type (string) - rodzaj modułu
        • speed (number) - szybkość [MHz]
      • hdd (objects-list) - lista dysków twardych
        • capacity (number) - pojemność [GB]
        • type (string) - rodzaj dysku
        • speed (string) - szybkość
      • hdd_controller (objects-list) - lista kontrolerów HDD
        • model (string) - nazwa modelu
        • builtin (boolean) - informacja, czy kontroler wbudowany
    • prices (object) - informacje o cenach
      • regular (object) - cena dla klientów
        • price (number) - cena netto serwera
        • currency (string) - kod waluty
        • payment_period (number) - okres rozliczeniowy dla podanej ceny (liczba miesięcy)
      • reseller (object) - widoczne tylko dla resellerów; cena dla resellera
        • price (number) - cena netto serwera
        • currency (string) - kod waluty
        • payment_period (number) - okres rozliczeniowy dla podanej ceny (liczba miesięcy)
Kody błędów:
  • authorization-failed
/offer-dedicated/express-reservation - rezerwuje określony serwer Dostępna dla resellerów komenda pozwalająca dokonać rezerwacji serwera. Rezerwacja dokonywana jest na 48h. Klient może posiadać jedynie 3 zarezerwowane serwery na raz. Parametry:
  • server_id (number) - numer ID servera
Kody błędów:
  • authorization-failed
  • invalid-server-id
/offer-dedicated/express-reservation-cancel - anuluje rezerwację określony serwer Dostępna dla resellerów komenda pozwalająca anulować rezerwację serwera. Parametry:
  • server_id (number) - numer ID servera
Kody błędów:
  • authorization-failed
  • invalid-server-id
/offer-dedicated/express-order - złożenie zamówienia na wybrany serwer Komenda pozwalająca na dokonanie zamówienia serwera dedykowanego dostępnego w modelu "od ręki". Po wykonaniu tej komendy zwrócony zostanie numer ID nowo utworzonej usługi, numer faktury proforma powiązanej z zamówieniem usługi oraz link do panelu zarządzania serwerem i instalacji systemu operacyjnego. Należy pamiętać, że parametry przekazywane w linku stanowią metodę autoryzacji i należy je traktować jak hasła. Fakturę proforma można pobrać z Panelu Klienta Artnet lub poprzez komendę API /invoices/download-proforma. Parametry:
  • server_id (number) - numer ID servera
Odpowiedź:
  • order_details (object) - szczegóły zamówienia
    • service_id (number) - unikalne ID usługi
    • invoice_number (string) - numer faktury proforma dla tego zamówienia
    • management_panel_url (string) - link do panelu zarządzania serwerem i instalacji systemu operacyjnego
Kody błędów:
  • authorization-failed
  • invalid-server-id
  • internal-error-invalid-service
  • internal-error-invalid-data
Moduł: cloud-instance Zarządzanie instancjami wirtualnymi Cloud. /cloud-instance/list - lista instancji Zwraca listę utworzonych instancji wirtualnych wraz z podstawowymi informacjami. Odpowiedź:
  • instances_list (objects-list) - lista instancji
    • id (number) - unikalny numer ID instancji
    • name (string) - Nazwa, identyfikator instancji w systemie.
    • custom_name (string) - Ustawiana przez klienta wyświetlana nazwa instancji.
    • price_resources (object) - Szczegóły dotyczące aktualnej ceny. Podane wartości dotyczą kosztów za 24h przy aktualnie ustawionych parametrach instancji bez dodatkowych kosztów (jak np. transfer).
      • price (number) - Cena za 24 godziny. Cena jest podawana z dokładnością do 4 liczby po przecinku, aby umożliwić przeliczanie na inne okresy.
      • currency (string) - Kod waluty.
      • period (string) - Okres kalkulacji. Obecnie wartość zawsze przyjmuje '24h'.
    • vnc_configuration (object) - Dane do połączenia z konsolą VNC.
      • host (string) - Adres serwera VNC. Adres nie jest stale prrzypisany do instancji i może czasem ulegać zmianie.
      • port (number) - Port do połączenia z VNC.
    • resources (object) - Aktualne zasoby sprzętowe przypisane do isntancji.
      • cpu_cores (number) - Liczba rdzeni CPU.
      • ram (number) - Dostępna pamięć RAM [MB].
      • hdd (number) - Dostępna przestrzeń dyskowa [GB].
      • bandwidth (number) - Dostępna przepustowość [Mbps].
    • state (string) - Aktualny stan instancji.
    • state_time (timestamp) - Czas ostatniego odświeżenia informacji o stanie instancji.
    • boot_status (string) - Tryb bootowania instancji. Jeżeli przyjmuje wartość 'install' bootowanie odbędzie się z wybranego nośnika instalacyjnego. Jeżeli wartość tego pola to 'boot' instancja zostanie normalnie zabootowana z dysku twardego.
Kody błędów:
  • authorization-failed
/cloud-instance/details - szczegółowe dane instancji Zwraca bardziej szczegółowe informacje dotyczące instancji o podanym ID. Parametry:
  • instance_id (number) - numer ID instancji
Odpowiedź:
  • instance_details (object) - szczegóły instancji
    • id (number) - unikalny numer ID instancji
    • name (string) - Nazwa, identyfikator instancji w systemie.
    • custom_name (string) - Ustawiana przez klienta wyświetlana nazwa instancji.
    • price_resources (object) - Szczegóły dotyczące aktualnej ceny. Podane wartości dotyczą kosztów za 24h przy aktualnie ustawionych parametrach instancji bez dodatkowych kosztów (jak np. transfer).
      • price (number) - Cena za 24 godziny. Cena jest podawana z dokładnością do 4 liczby po przecinku, aby umożliwić przeliczanie na inne okresy.
      • currency (string) - Kod waluty.
      • period (string) - Okres kalkulacji. Obecnie wartość zawsze przyjmuje '24h'.
    • vnc_configuration (object) - Dane do połączenia z konsolą VNC.
      • host (string) - Adres serwera VNC. Adres nie jest stale prrzypisany do instancji i może czasem ulegać zmianie.
      • port (number) - Port do połączenia z VNC.
    • resources (object) - Aktualne zasoby sprzętowe przypisane do isntancji.
      • cpu_cores (number) - Liczba rdzeni CPU.
      • ram (number) - Dostępna pamięć RAM [MB].
      • hdd (number) - Dostępna przestrzeń dyskowa [GB].
      • bandwidth (number) - Dostępna przepustowość [Mbps].
    • state (string) - Aktualny stan instancji.
    • state_time (timestamp) - Czas ostatniego odświeżenia informacji o stanie instancji.
    • boot_status (string) - Tryb bootowania instancji. Jeżeli przyjmuje wartość 'install' bootowanie odbędzie się z wybranego nośnika instalacyjnego. Jeżeli wartość tego pola to 'boot' instancja zostanie normalnie zabootowana z dysku twardego.
    • custom_properties (object) - Właściwości ustawione przez klienta (typu nazwa wyświetlana, notatki do instancji).
      • display_name (string) - Nazwa wyświetlana instancji. Wykorzystywana m.in. do prezentacji na liście instancji w Panelu Klienta.
      • notes (string) - Definiowane przez klienta notatki powiązane z instancją. Jest to pole do wyłącznego, dowolnego wykorzsytania przez klienta (max. 10240 znaki)
    • network_configuration (object) - Konfiguracja sieciowa instancji. Wymagana do skonfigurowania połączenia internetowego isntancji.
      • ip (string) - IP address of instance.
      • mask (string) - Maska podsieci, w której znajduje się instancja.
      • gateway_ip (string) - Adres IP bramy sieciowej.
      • dns_list (strings-list) - Lista adresów IP serwerów DNS.
Kody błędów:
  • authorization-failed
/cloud-instance/action-power-on - włączenie zasilania instancji Włącza "zasilanie" instancji wirtualnej powodując jej uruchomienie. Parametry:
  • instance_id (number) - ID instancji
  • instance_password (string) - hasło zarządzania tą instancję wirtualną
Kody błędów:
  • authorization-failed
  • invalid-service-type
  • instance-password-incorrect
  • internal-cloud-power-on-error
/cloud-instance/action-power-off - wyłączenie zasilania instancji Wyłącza "zasilanie" instancji wirtualnej. Parametry:
  • instance_id (number) - ID instancji
  • instance_password (string) - hasło zarządzania tą instancję wirtualną
Kody błędów:
  • authorization-failed
  • invalid-service-type
  • instance-password-incorrect
  • internal-cloud-power-on-error
/cloud-instance/action-power-restart - restart zasilania instancji Restart zasilania instancji wirtualnej. Wykonuje kolejno wyłączenie i włączenie jej zasilania. Parametry:
  • instance_id (number) - ID instancji
  • instance_password (string) - hasło zarządzania tą instancję wirtualną
Kody błędów:
  • authorization-failed
  • invalid-service-type
  • instance-password-incorrect
  • internal-cloud-power-on-error
/cloud-instance/action-shutdown - sygnał "shutdown" do OS Wysłanie sygnału "shutdown" do systemu operacyjnego instancji wirtualnej. Parametry:
  • instance_id (number) - ID instancji
  • instance_password (string) - hasło zarządzania tą instancję wirtualną
Kody błędów:
  • authorization-failed
  • invalid-service-type
  • instance-password-incorrect
  • internal-cloud-power-on-error
/cloud-instance/action-reboot - sygnał "reboot" do OS Wysłanie sygnału "reboot" do systemu operacyjnego instancji wirtualnej. Parametry:
  • instance_id (number) - ID instancji
  • instance_password (string) - hasło zarządzania tą instancję wirtualną
Kody błędów:
  • authorization-failed
  • invalid-service-type
  • instance-password-incorrect
  • internal-cloud-power-on-error
/cloud-instance/resources-allowed-ranges - waruniki brzegowe i dozwolne wartości dla zasobów sprzętowych Zwraca obiekt opisujący możliwe wartości dla zasobów sprzętowych do kalkulacji i zmiany parameterów instancji. Dla każdego z parametrów zasobów podawana jest wartość maksymalna, minimalna i krok (finalna wartość musi być wielokrotnością kroku). Parametry:
  • instance_id (number) - ID instancji
Odpowiedź:
  • resources_ranges (object) - Obiekt zawierający zakresy dopuszczalnych wartości parametrów zasobów sprzętowych.
    • cpu (object) - Dopuszczalne zakresy wartości dla liczby rdzeni CPU.
      • min (number) - Wartość minimalna.
      • max (number) - Wartość maksymalna.
      • step (number) - Krok zmiany. Końcowa wartość musi być wielokrotnością kroku (0 == value % step).
    • ram (object) - Dopuszczalne zakresy wartości dla wielkosći pamięci RAM [MB].
      • min (number) - Wartość minimalna.
      • max (number) - Wartość maksymalna.
      • step (number) - Krok zmiany. Końcowa wartość musi być wielokrotnością kroku (0 == value % step).
    • hdd (object) - Dopuszczalne zakresy wartości dla wielkości dysku twardego [GB].
      • min (number) - Wartość minimalna.
      • max (number) - Wartość maksymalna.
      • step (number) - Krok zmiany. Końcowa wartość musi być wielokrotnością kroku (0 == value % step).
    • bandwidth (object) - Dopuszczalne zakresy wartości dla przepustowości łącza [Mbps].
      • min (number) - Wartość minimalna.
      • max (number) - Wartość maksymalna.
      • step (number) - Krok zmiany. Końcowa wartość musi być wielokrotnością kroku (0 == value % step).
Kody błędów:
  • authorization-failed
  • invalid-service-type
/cloud-instance/resources-calculate-price - wycena pakietu zasobów sprzętowych Wylicza cenę dla podanych zasobów sprzętowych instancji, jaka byłaby ustawiona po zmianie obecnych zasobów na podane. Jeżeli podany zostanie numer ID instancji obliczona zostanie kwota dla nowych parametrów tej instancji. Jeżeli ten parametr nie wystąpi w zapytaniu zwrócona zostanie kwota jak dla nowej uługi. Parametry:
  • instance_id (number) - ID instancji
  • resources[cpu] (number) - liczba rdzeni CPU
  • resources[ram] (number) - rozmiar pamięci RAM [MB]
  • resources[hdd] (number) - pojemność dysku twardego [GB]
  • resources[bandwidth] (number) - przepustowość łącza [Mbps]
Odpowiedź:
  • price_resources (object) - Szczegóły dotyczące aktualnej ceny. Podane wartości dotyczą kosztów zasobów sprzętowych za 24h przy podanych parametrach instancji bez dodatkowych kosztów (jak np. transfer).
    • price (number) - Cena za 24 godziny. Cena jest podawana z dokładnością do 4 liczby po przecinku, aby umożliwić przeliczanie na inne okresy.
    • currency (string) - Kod waluty.
    • period (string) - Okres kalkulacji. Obecnie wartość zawsze przyjmuje '24h'.
Kody błędów:
  • authorization-failed
  • invalid-service-type
  • invalid-param-value
/cloud-instance/resources-negotiate - modyfikacja zasobów sprzętowych instancji Operacja wykonuje zmianę zasobów sprzętowych instancji wirtualnej. Każda zmiana operacji wymusza restart zasilania instancji. Parametr 'shutdown' pozwala na wykonanie próby miękkiego zamknięcia. systemu operacyjnego. W tym przypadku przez 30 sekund bedzie monitorowany stan instancji. Jeżeli w tym czasie nie uda się zamknąć systemu opracyjnego zwrócony zostanie błąd. Z tego powodu wybranie opcji "shutdown" może powodować znaczne zwiększenie czasu wykonywania tej komendy. Zmiana dostępnej przestrzeni dyskowej HDD możliwa jest tylko w górę, nie ma możliwości automatycznego zmniejszenia rozmiaru dysku. Parametry:
  • instance_id (number) - ID instancji
  • instance_password (string) - hasło zarządzania tą instancję wirtualną
  • shutdown (boolean) - Określa czy próbować zamknąć system przed restartem zasilania. Jeżeli wartość tego parametru będzie "true" (string) system spróbuje wyłączyć OS; może to zwiększyć czas wykonywania operacji do kilku minut i spowodować błąd, jeżeli system nie będzie mógł zostać zamknięty. Jeżeli wartość tego parametry przyjmie "false" zostanie wymuszony restart zasilania bez próby wyłączenia systemu operacyjnego.
  • resources[cpu] (number) - liczba rdzeni CPU
  • resources[ram] (number) - rozmiar pamięci RAM [MB]
  • resources[hdd] (number) - pojemność dysku twardego [GB]. Uwaga: Nie możliwości samodzielnego zmniejszenia rozmiaru dysku!
  • resources[bandwidth] (number) - przepustowość łącza [Mbps]
Kody błędów:
  • 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 - lista dostępnych obrazów instalacyjnych Zwraca listę dostępnych dla określonej instancji obrazów instalacyjnych systemów operacyjnych. Parametry:
  • instance_id (number) - ID instancji
Odpowiedź:
  • installation_images_list (objects-list) - Lista dostępnych instalacji.
    • label (string) - Etykieta systemu do wyświetlenia (np. 'Debian 8.1 64bit).
    • distribution (string) - Skrótowa nazwa dystrybucji (np. 'debian').
    • image (string) - Nazwa obrazu instalacyjnego.
Kody błędów:
  • authorization-failed
  • instance-password-incorrect
/cloud-instance/boot-mode-installation-image - przełączenie trybu bootowania na boot obrazu instalacyjnego Zmienia tryb bootowania instancji na boot wybranego obrazu instalacyjnego. Parametry:
  • instance_id (number) - ID instancji
  • instance_password (string) - hasło zarządzania tą instancję wirtualną
  • installation_image (string) - wybrany obraz instalacyjny
  • shutdown (boolean) - Określa czy próbować zamknąć system przed restartem zasilania. Jeżeli wartość tego parametru będzie "true" (string) system spróbuje wyłączyć OS; może to zwiększyć czas wykonywania operacji do kilku minut i spowodować błąd, jeżeli system nie będzie mógł zostać zamknięty. Jeżeli wartość tego parametry przyjmie "false" zostanie wymuszony restart zasilania bez próby wyłączenia systemu operacyjnego.
Kody błędów:
  • authorization-failed
  • instance-password-incorrect
  • instance-boot-incorrect-installation-image
  • instance-unable-shutdown
  • internal-instance-boot-mode-installation-image
/cloud-instance/boot-mode-boot - przełączenie trybu bootowania na boot z HDD Zmienia tryb bootowania instancji na normalny boot z dysku twardego. Parametry:
  • instance_id (number) - ID instancji
  • instance_password (string) - hasło zarządzania tą instancję wirtualną
  • shutdown (boolean) - Określa czy próbować zamknąć system przed restartem zasilania. Jeżeli wartość tego parametru będzie "true" (string) system spróbuje wyłączyć OS; może to zwiększyć czas wykonywania operacji do kilku minut i spowodować błąd, jeżeli system nie będzie mógł zostać zamknięty. Jeżeli wartość tego parametry przyjmie "false" zostanie wymuszony restart zasilania bez próby wyłączenia systemu operacyjnego.
Kody błędów:
  • authorization-failed
  • instance-password-incorrect
  • instance-unable-shutdown
  • internal-instance-boot-mode-installation-image
/cloud-instance/custom-properties-edit - zmiana właściwości customizacji (np. nazwa wyświetlana, notatki klienta) Pozwala na zmianę parametrów instancji przeznaczonych dla klienta. Obejmuje takie parametry, jak nazwa wyświetlana (pod jaką instancja pojawia się na liście instancji w Panelu Klienta). Tylko podane parametry zostaną zmienione, paraemtry, które nie wystąpią w zapytaniu nie zmienią wartości. Parametry:
  • instance_id (number) - ID instancji
  • custom_properties[display_name] (array) - Nazwa instancji wyświetlana na liście w Panelu Klienta. Maksymalnie 35 znaków.
  • custom_properties[notes] (string) - Notatki związane z instancją. To pole przeznaczone jest do wyłącznego i dowolnego wykorzystania przez klienta. Maksymalnie 10240 znaki.
Kody błędów:
  • 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 - zmiana hasła zarządzania instancji Zmiana hasła zarządzania instancją. Hasło zarządzania wykorzsystywane jest do logowania do VNC oraz do wykonywania krytycznych operacji związanych z instancją wirtualną. Hasło musi mieć długość min 4 znaków i może składać się z wielkich i małych liter, cyfr oraz znaków specjalnych spośród .!@#$%^&*()_+-= Parametry:
  • instance_id (number) - ID instancji
  • instance_password (string) - hasło zarządzania tą instancję wirtualną
  • instance_new_password (string) - nowe hasło (dopuszczalne są: małe i wielkie litery, cyfry oraz znaki .!@#$%^&*()_+-=)
Kody błędów:
  • authorization-failed
  • instance-password-incorrect
  • password-too-short
  • password-invalid
/cloud-instance/delete - skasowanie instancji Całkowite skasowanie instancji. Wywołanie tej komendy spowoduje natychmiastowe i nieodwracalne skasowanie instancji i utratę danych z nią powiązanych (w tym danych zapisanych na dysku). Parametry:
  • instance_id (number) - ID instancji
  • instance_password (string) - hasło zarządzania tą instancję wirtualną
Kody błędów:
  • authorization-failed
  • instance-password-incorrect
  • internal-instance-delete-error