Publiczne API

API pozwala użytkownikowi 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łana 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

Spis treści

Moduł: customer – Zarządzanie danymi klienta.

  • /customer/regenerate-api-key – wygenerowanie nowego klucza API
  • /customer/emails-list – lista wysłanych wiadomości email
  • /customer/email-details – szczegóły wysłanej wiadomości email
  • /customer/change-language – zmiana języka
  • /customer/get-language – sprawdzenie języka
  • /customer/details – szczegóły klienta
  • /customer/edit – edycja danych klienta

Moduł: services – Lista usług i podstawowe operacje na usługach klienta.

  • /services/list – lista usług
  • /services/details – szczegóły usługi

Moduł: domain – Lista usług i podstawowe operacje na usługach klienta dotyczących domen.

  • /domain/list – lista domen
  • /domain/details – szczegóły domeny
  • /domain/edit-dns-servers – edycja delegacji DNS domeny

Moduł: software – Lista licencji oprogramowania.

  • /software/list – lista usług
  • /software/details – szczegóły licencji

Moduł: additional-ip – Zarządzanie usługami dodatkowych adresów IP

  • /additional-ip/list – lista usług
  • /additional-ip/details – szczegóły usługi
  • /additional-ip/order-info – informacje / ceny dotyczące zamówienia dodatkowych IP
  • /additional-ip/order – zamówienie dodatkowych adresów IP

Moduł: vps – Lista serwerów VPS.

  • /vps/list – lista usług
  • /vps/details – szczegóły serwera VPS
  • /vps/power-on – zmiana stanu VPS na WŁĄCZONY
  • /vps/power-off – zmiana stanu VPS na WYŁĄCZONY
  • /vps/power-restart – restart VPS

Moduł: dedicated – Zarządzanie usługami serwerów dedykowanych.

  • /dedicated/list – lista serwerów dedykowanych
  • /dedicated/details – szczegóły serwera dedykowanego
  • /dedicated/transfer-usage-details – informacje o zużyciu transferu
  • /dedicated/ilo-details – szczegóły dostępu do iLO / IPMI
  • /dedicated/ilo-access-enable – otwiera dostęp do połączenia do iLO / IPMI
  • /dedicated/ilo-access-disable – zamyka dostęp do połączenia do iLO / IPMI
  • /dedicated/power-details – szczegóły dotyczące stanu i zarządzania zasilaniem serwera
  • /dedicated/power-on – zmiana stanu zasilania na WŁĄCZONY
  • /dedicated/power-off – zmiana stanu zasilania na WYŁĄCZONY
  • /dedicated/power-restart – restart serwera

Moduł: colocation – Zarządzanie usługami kolokacji serwerów.

  • /colocation/list – lista kolokacji
  • /colocation/details – szczegóły usługi kolokacji
  • /colocation/transfer-usage-details – informacje o zużyciu transferu
  • /colocation/power-details – szczegóły dotyczące stanu i zarządzania zasilaniem serwera
  • /colocation/power-on – zmiana stanu zasilania na WŁĄCZONY
  • /colocation/power-off – zmiana stanu zasilania na WYŁĄCZONY
  • /colocation/power-restart – restart serwera

Moduł: ip-blackholing – Zarządzanie mechanizmem IP blackholing.

  • /ip-blackholing/list – lista zablokowanych adresów IP
  • /ip-blackholing/enable – włączenie blackholingu
  • /ip-blackholing/disable – wyłączenie blackholingu

Moduł: dns – Zarządzanie strefami domen w DNS.

  • /dns/list – lista skonfigurowanych stref DNS
  • /dns/delete – usunięcie domeny z DNS
  • /dns/details-secoundary – szczegóły konfiguracji zapasowej strefy DNS
  • /dns/add-secoundary – dodanie zapasowej strefy do DNS
  • /dns/details-primary – szczegóły konfiguracji podstawowej strefy DNS
  • /dns/add-primary – dodanie podstawowej strefy do DNS
  • /dns/edit-primary-records – zmiana rekordów DNS strefy podstawowej

Moduł: rev-dns – Zarządzanie rekordami PTR w revDNS.

  • /rev-dns/list – lista podsieci dostępnych do konfiguracji
  • /rev-dns/details – pobranie konfiguracji revDNS
  • /rev-dns/edit – edycja konfiguracji revDNS

Moduł: firewall – Zarządzanie regułami zewnętrznego firewall.

  • /firewall/list – lista dostępnych zbiorów reguł
  • /firewall/details – pobranie konfiguracji firewall
  • /firewall/enable – włącza firewall
  • /firewall/disable – wyłącza firewall
  • /firewall/save – zmiana reguł firewall

Szczegóły

Moduł: customer – Zarządzanie danymi klienta.

  • /customer/regenerate-api-key
    • 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 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:
      • Brak
  • /customer/email-details
    • 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 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
    • Zwraca aktualnie ustawiony język (dla wiadomości email i Panelu Klienta).
    • Odpowiedź:
      • language (string) – nazwa języka
  • /customer/details
    • 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
    • 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] (boolean) – 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 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:
      • Brak
  • /services/details
    • Zwraca szczegółowe informacje 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
    • Zwraca listę wszystkich domen. Komenda działa identycznie jak wywołanie /services/list z parametrem service_type=domain.
  • /domain/details
    • Zwraca szczegółowe informacje 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 informacji o przypisanych serwerach DNS to pole nie będzie obecne
    • Kody błędów:
      • authorization-failed
  • /domain/edit-dns-servers
    • 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ł: software – Lista licencji oprogramowania.

  • /software/list
    • Zwraca listę wszystkich licencji oprogramowania. Komenda działa identycznie jak wywołanie /services/list z parametrem service_type=software.
  • /software/details
    • Zwraca szczegółowe informacje 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ł: 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
    • 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
    • Zwraca szczegółowe informacje 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
    • Zwraca informacje 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 informacje 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
    • 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
    • Zwraca listę wszystkich usług serwerów VPS. Komenda działa identycznie jak wywołanie /services/list z parametrem service_type=vps.
  • /vps/details
    • Zwraca szczegółowe informacje 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 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 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
    • 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
    • Zwraca listę serwerów dedykowanych. Komenda działa identycznie jak wywołanie /services/list z parametrem service_type=dedicated.
  • /dedicated/details
    • Zwraca szczegółowe informacje 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
        • installation_url (string) – jeśli instalacja OS jest dostępna zawiera link do instalacji, inaczej zawiera pustą wartość
        • active (boolean) – określa, czy ten serwer jest aktywny (true) czy zablokowany (false)
    • Kody błędów:
      • authorization-failed
  • /dedicated/transfer-usage-details
    • 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 informacji 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
            • to (number) – znacznik czasu (UNIX) określający koniec 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ółowe informacje 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
    • 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
    • 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ółowe informacje 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; domyślnie 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 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 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
    • 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
    • Zwraca listę usług kolokacji. Komenda działa identycznie jak wywołanie /services/list z parametrem service_type=colocation.
  • /colocation/details
    • Zwraca szczegółowe informacje 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
    • 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 informacji 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
            • to (number) – znacznik czasu (UNIX) określający koniec 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ółowe informacje 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; domyślnie 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 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 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
    • 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
    • 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 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 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
    • 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
    • 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
    • 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 serwera podstawowego
    • Kody błędów:
      • incorrect-ip
      • ip-not-allowed
      • ip-already-blackholed
      • internal-blackholing-ip-error
  • /dns/add-secoundary
    • 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 serwera podstawowego
    • Kody błędów:
      • incorrect-param-value
      • domain-not-allowed
      • domain-already-exists
      • unresolveable-master-nameserver
      • internal-dns-error
  • /dns/details-primary
    • 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 przyjmować 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
    • 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
    • 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
    • Zwraca listę podsieci dostępnych 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
    • 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 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 warnings 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
    • 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ł konfiguracji 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
    • 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łą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łączenie filtrowania pakietów przez firwall.
    • Parametry:
      • ruleset_id (string) – identyfikator ruleset
    • Kody błędów:
      • invalid-service-type
      • internal-firewall-error
  • /firewall/save
    • 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