Public API
API allows user to automate most actions that can be done using Artnet Customers Panel.
Connection to API is made by connecting to artnet.pl server using HTTPS protocol. Each command has its own URL path and it has to be called using POST request with command parameters given as POST variables. Request sent to the server should look like it was sent from a POST HTML form. Server response is always a JSON object.
Connection
URL address to connect to the API: https://panel.artnet.pl/api/COMMAND/NAME
The string /COMMAND/NAME is the name of a command to call according to “API commands” section of this documentation.
Authorization
Authorization credentials have to be sent with each request as command parameters (i.e. POST variables) id
(customer ID) and api_key
(API authorization key). Customer ID (id
) is a number and it is the one using to login to Customers Panel. API key (api_key
) is alphanumeric string that can be taken from Customers Panel – select “Customer” from menu, then from the “Utilities” sections choose “Manage API access”. If API access is disabled, please enable it – new API key will be generated then.
API request example
Example request that gets detailed information about specified service using /services/details
command looks like this:
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
Server response
Servers response is always a JSON object. Every response will contain field success
(boolean), which value determines whether command execution was successful. If an error occurs, success
will be false
and response will contain an error
object describing the error. If the command was successful, the response might contain other fields according to what is described in “API commands” section.
Server response example
Example error response:
{
"success": false,
"error": {
"code": "unknown-command",
"description": {
"pl": "Nieznane polecenie",
"en": "Unknown command"
}
}
}
Example successful response (command: /services/details
):
{
"service": {
"id": 12345,
"type": "dedicated",
"name": "HP DL120 G7 123.123.123.123",
"custom_description": null,
"expiration_time": 1481213614,
"payment_details": {
"price": 527,
"price_brutto": 648.21,
"currency": "EUR",
"payment_period": "1"
},
"parent_service_id": 0,
"ip": "123.123.123.123"
},
"success": true
}
Rodzaje usług
dedicated
– dedicated servercolocation
– colocationvps
– VPSdomain
– domainadditional-ip
– additional IP addressesavx
– shared hosting AVX.pleasyisp
– shared hosting EasyISP.plhosting-artnet
– shared hosting Artnet.plfoip
– Fail-over IPlink
– internet linksoftware
– software licensessl
– SSL certificateother
– other service
API Commands
Spis treści
Module: customer – Customer information management.
/customer/regenerate-api-key
– API key generation/customer/emails-list
– list of sent emails/customer/email-details
– details of sent email/customer/change-language
– change language/customer/get-language
– fetch language/customer/details
– get customer details/customer/edit
– edit customer details
Module: services – Services list and details.
/services/list
– services list/services/details
– service details
Module: domain – Domain service management.
/domain/list
– domain list/domain/details
– domain details/domain/edit-dns-servers
– edit DNS servers
Module: software – List of software licenses.
/software/list
– services list/software/details
– license details
Module: 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
Module: 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
Module: 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
Module: 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
Module: 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
Module: 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
Module: 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
Module: 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 pobraniaoffset
(number) – numer rekordu od którego mają być listowane nagłówki
- Odpowiedź:
emails_list
(objects-list) – lista nagłówków wiadomościid
(number) – unikalne ID wiadomościtime
(timestamp) – czas wysłania wiadomościsubject
(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 emailid
(number) – unikalne ID wiadomościtime
(timestamp) – czas wysłania wiadomościaddress
(string) – adres, na jaki wysłano emailsubject
(string) – temat wiadomościbody
(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 klientaid
(number) – unikalne IDname
(string) – nazwa klientanip
(string) – NIP number (VAT identification number)regon
(string) – numer REGON lub PESELstreet
(string) – adres klienta – ulicapostcode
(string) – adres klienta – kod pocztowycity
(string) – adres klienta – miastocountry_code
(string) – adres klienta – kod państwacountry_label
(string) – adres klienta – nazwa państwatel
(string) – numer telefonufax
(string) – numer faxuemail
(string) – adres emailemail_tech
(string) – techniczny adres emailemail_invoice
(string) – księgowy adres email (dla przesyłania faktur elektronicznych)correspondence_name
(string) – adres korespondencyjny – nazwa odbiorcycorrespondence_street
(string) – adres korespondencyjny – ulicacorrespondence_postcode
(string) – adres korespondencyjny – kod pocztowycorrespondence_city
(string) – adres korespondencyjny – miastobusiness
(boolean) – forma prawna (true – firma, false – osoba fizyczna)language
(string) – używany językcurrency
(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 klientacustomer[nip]
(string) – NIP number (VAT identification number)customer[regon]
(string) – numer REGON lub PESELcustomer[street]
(string) – adres klienta – ulicacustomer[postcode]
(string) – adres klienta – kod pocztowycustomer[city]
(string) – adres klienta – miastocustomer[country_code]
(string) – adres klienta – kod państwacustomer[tel]
(string) – numer telefonucustomer[fax]
(string) – numer faxucustomer[email]
(string) – adres emailcustomer[email_tech]
(string) – techniczny adres emailcustomer[email_invoice]
(string) – księgowy adres email (dla przesyłania faktur elektronicznych)customer[correspondence_name]
(string) – adres korespondencyjny – nazwa odbiorcycustomer[correspondence_street]
(string) – adres korespondencyjny – ulicacustomer[correspondence_postcode]
(string) – adres korespondencyjny – kod pocztowycustomer[correspondence_city]
(string) – adres korespondencyjny – miastocustomer[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 pobraniaoffset
(number) – offset pierwszego rekordu do pobraniaservice_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ługid
(number) – unikalne ID usługitype
(string) – typ usługiname
(string) – nazwa identyfikacyjna usługi (nazwa domeny, login konta hostingowego, itp.) lub nazwa usługicustom_description
(string) – własny (klienta) opis usługiexpiration_time
(timestamp) – data ważności usługipayment_details
(object) – szczegóły dotyczące ceny usługi i płatnościprice
(number) – cena netto za okres rozliczeniowyprice_brutto
(number) – cena brutto za okres rozliczeniowycurrency
(string) – kod walutypayment_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 0ip
(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ługiid
(number) – unikalne ID usługitype
(string) – typ usługiname
(string) – nazwa identyfikacyjna usługi (nazwa domeny, login konta hostingowego, itp.) lub nazwa usługicustom_description
(string) – własny (klienta) opis usługiexpiration_time
(timestamp) – data ważności usługipayment_details
(object) – szczegóły dotyczące ceny usługi i płatnościprice
(number) – cena netto za okres rozliczeniowyprice_brutto
(number) – cena brutto za okres rozliczeniowycurrency
(string) – kod walutypayment_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 0ip
(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 parametremservice_type
=domain
.
- Zwraca listę wszystkich domen. Komenda działa identycznie jak wywołanie
/domain/details
- Zwraca szczegółowe informacje dotyczące domeny.
- Parametry:
service_id
(number) – numer ID usługi
- Odpowiedź:
service_details
(object) – szczegóły domenyid
(number) – unikalne ID usługidomain_name
(string) – nazwa domenymanageable
(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ługidns_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 parametremservice_type
=software
.
- Zwraca listę wszystkich licencji oprogramowania. Komenda działa identycznie jak wywołanie
/software/details
- Zwraca szczegółowe informacje dotyczące licencji oprogramowania.
- Parametry:
service_id
(number) – numer ID usługi
- Odpowiedź:
service_details
(object) – szczegółyid
(number) – unikalne ID usługilicence
(object) – szczegóły licencjiname
(string) – nazwa oprogramowania i licencjilicences_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 parametremservice_type
=additional-ip
.
- Zwraca listę wszystkich usług dodatkowych adresów IP. Komenda działa identycznie jak wywołanie
/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ółyid
(number) – unikalne ID usługisubnetworks
(objects-list) – lista podsieciid
(number) – unikalny numer ID podsieciip
(string) – adres siecimask
(string) – maska podsiecimask_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ówioneone_ip_payment_details
(object) – obiekt opisujący wyliczone szczegóły płatności za JEDEN dodatkowy adres IPprice
(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 addresyips_number
(number) – liczba nowych adresów do przypisania
- Odpowiedź:
order_details
(object) – szczegóły złożonego zamówieniaservice_id
(number) – unikalne ID nowo stworzonej usługi dodatkowych adresów IPips_number
(number) – liczba przypisanych adresów IPips_configuration
(objects-list) – lista obiektów opisujących konfigurację przypisanych adresówip
(string) – adres IPmask
(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
- 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ą
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 parametremservice_type
=vps
.
- Zwraca listę wszystkich usług serwerów VPS. Komenda działa identycznie jak wywołanie
/vps/details
- Zwraca szczegółowe informacje dotyczące serwera VPS.
- Parametry:
service_id
(number) – numer ID usługi
- Odpowiedź:
service_details
(object) – szczegółyid
(number) – unikalne ID usługinewtwork_configuration
(object) – konfiguracja sieciowa serweraip
(string) – główny adres IP serwera VPSadditional_ips_list
(strings-list) – lista dodatkowych adresów IP
features
(object) – dostępne funkcjonalności dla tego serwerapower_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ługiconfirm
(string) – wartość tego pola musi być ustawiona naconfirm
- 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ługiconfirm
(string) – wartość tego pola musi być ustawiona naconfirm
- 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ługiconfirm
(string) – wartość tego pola musi być ustawiona naconfirm
- 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 parametremservice_type
=dedicated
.
- Zwraca listę serwerów dedykowanych. Komenda działa identycznie jak wywołanie
/dedicated/details
- Zwraca szczegółowe informacje dotyczące serwera dedykowanego.
- Parametry:
service_id
(number) – numer ID usługi
- Odpowiedź:
service_details
(object) – szczegóły serweraid
(number) – unikalne ID usługihardware_configuration
(object) – szczegóły konfiguracji sprzętowejserver
(object) – szczegóły serweravendor
(string) – producentmodel
(string) – nazwa modelu
cpu
(objects-list) – lista procesorówvendor
(string) – producentmodel
(string) – nazwa modeluclock
(number) – zegar procesora [GHz]cores
(number) – liczba rdzeniht
(boolean) – wsparcie hyper-threading
ram
(objects-list) – lista modułów RAMcapacity
(number) – pojemność [GB]type
(string) – rodzaj modułuspeed
(number) – szybkość [MHz]
hdd
(objects-list) – lista dysków twardychcapacity
(number) – pojemność [GB]type
(string) – rodzaj dyskuspeed
(string) – szybkość
hdd_controller
(objects-list) – lista kontrolerów HDDmodel
(string) – nazwa modelubuiltin
(boolean) – informacja, czy kontroler wbudowany
network_configuration
(object) – szczegóły konfiguracji sieciowejip
(string) – adres IPadditional_ips
(strings-list) – lista dodatkowych adresów IPsubnetworks
(objects-list) – lista podsieciid
(number) – unikalny numer ID podsieciip
(string) – adres siecimask
(string) – maska podsiecimask_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 serwerailo_access_management
(boolean) – jeżeli true można włączyć dostęp do ILO / IPMI dla tego serwerapower_management
(boolean) – jeżeli true można zarządzać zasilaniem tego serwerafirewall_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 transferuperiods_list
(objects-list) – lista informacji o zużyciu transferu w poszczególnych okresach rozliczeniowychtime_range
(object) – obiekt określający okresfrom
(number) – znacznik czasu (UNIX) określający początek okresuto
(number) – znacznik czasu (UNIX) określający koniec okresu
transfer_usage
(object) – obiekt określający zużycie transferu w okresieup
(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 / IPMIavailable
(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 / IPMIaccess_enabled
(boolean) – określa, czy dostęp do iLO / IPMI jest w tej chwili otwartyaccess_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ługiremote_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 zasilaniamanageable
(boolean) – określa, czy dla tego serwera możliwe jest sterowanie stanem zasilaniastate
(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ługiconfirm
(string) – wartość tego pola musi być ustawiona naconfirm
- 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ługiconfirm
(string) – wartość tego pola musi być ustawiona naconfirm
- 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ługiconfirm
(string) – wartość tego pola musi być ustawiona naconfirm
- 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 parametremservice_type
=colocation
.
- Zwraca listę usług kolokacji. Komenda działa identycznie jak wywołanie
/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 kolokacjiid
(number) – unikalne ID usługinetwork_configuration
(object) – szczegóły konfiguracji sieciowejip
(string) – adres IPadditional_ips
(strings-list) – lista dodatkowych adresów IPsubnetworks
(objects-list) – lista podsieciid
(number) – unikalny numer ID podsieciip
(string) – adres siecimask
(string) – maska podsiecimask_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 serwerapower_management
(boolean) – jeżeli true można zarządzać zasilaniem tego serwerafirewall_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 transferuperiods_list
(objects-list) – lista informacji o zużyciu transferu w poszczególnych okresach rozliczeniowychtime_range
(object) – obiekt określający okresfrom
(number) – znacznik czasu (UNIX) określający początek okresuto
(number) – znacznik czasu (UNIX) określający koniec okresu
transfer_usage
(object) – obiekt określający zużycie transferu w okresieup
(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 zasilaniamanageable
(boolean) – określa, czy dla tego serwera możliwe jest sterowanie stanem zasilaniastate
(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ługiconfirm
(string) – wartość tego pola musi być ustawiona naconfirm
- 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ługiconfirm
(string) – wartość tego pola musi być ustawiona naconfirm
- 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ługiconfirm
(string) – wartość tego pola musi być ustawiona naconfirm
- 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 IPip
(string) – zablokowany adres IPtype
(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 strefid
(number) – numer ID strefydomain
(string) – nazwa domenytype
(string) – Rodzaj strefy. Pole może przyjmowąć dwie wartościprimary
dla strefy podstawowej isecoundary
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 konfiguracjiid
(number) – numer ID strefydomain
(string) – nazwa domenytype
(string) – Rodzaj strefy. Pole może przyjmowąć dwie wartościprimary
dla strefy podstawowej isecoundary
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 DNSmaster_nameserver
(string) – nazwa hosta albo IP podstawowego serwera nazw
- Odpowiedź:
zone_details
(object) – szczegóły nowo utworzonej strefyid
(number) – numer ID strefydomain
(string) – nazwa domenytype
(string) – Rodzaj strefy. Pole może przyjmowąć dwie wartościprimary
dla strefy podstawowej isecoundary
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 konfiguracjiid
(number) – numer ID strefydomain
(string) – nazwa domenytype
(string) – Rodzaj strefy. Pole może przyjmować dwie wartościprimary
dla strefy podstawowej isecoundary
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 rekordudata2
(string) – [opcjonalne, zależy od typu rekordu] drugi człon danychdata3
(string) – [opcjonalne, zależy od typu rekordu] trzeci człon danychdata4
(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 strefyid
(number) – numer ID strefydomain
(string) – nazwa domenytype
(string) – Rodzaj strefy. Pole może przyjmowąć dwie wartościprimary
dla strefy podstawowej isecoundary
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 strefyserial
(string) – aktualna wartość numeru serial rekordu SOArecords[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 znaczenierecords[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 rekordurecords[N][data2]
(number) – [opcjonalne, zależy od typu rekordu] drugi człon danychrecords[N][data3]
(number) – [opcjonalne, zależy od typu rekordu] trzeci człon danychrecords[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
- 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
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 konfiguracyjnymiid
(number) – unikalny numer ID podsieciip
(string) – adres siecimask
(string) – maska podsiecimask_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
- 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 (
/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 podsiecidns_subclass
(string) – nazwa podklasy konfiguracyjnej (jedna z pozycji listydns_subclasses
dla wskazanej podsieci)
- Odpowiedź:
subclass_details
(object) – szczegóły konfiguracji wybranej podklasyserial
(number) – numer serial rekordu SOA dla aktualnej konfiguracji; znajomość tej wartości jest niezbędna do wykonania edycji konfiguracjitype
(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 IPptr_records
(objects-list) – lista rekordów PTRorigin
(string) – identyfikator adresu w obrębie podklasyptr
(string) – wartość rekordu PTRaddress
(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 podsiecidns_subclass
(string) – nazwa podklasy konfiguracyjnej (jedna z pozycji listy dns_subclasses dla wskazanej podsieci)serial
(number) – dotychczasowa wartość numeru serial rekordu SOAptr_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ówptr_records[N][origin]
(string) – origin zmienianego / dodawanego rekorduptr_records[N][ptr]
(string) – wartość rekordu PTR do ustawieniaptr_records[N][delete]
(string) – jeżeli wartość tego pola zostanie ustawiona nadelete
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 zmianorigin
(string) – identyfikator rekordu, dla którego wystąpił błądaddress
(string) – pełen adres IP rekordutask
(string) – nazwa operacji, dla której wystąpił błądcode
(string) – kod błędudescription
(object) – opis błędupl
(string) – opis błędu w języku polskimen
(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 firewallid
(string) – identyfikator zbioru regułservices_ids_list
(numbers-list) – lista numerów ID usług serwerów, których dotyczy dany zbiór 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 (
/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 firewallid
(string) – identyfikator rulesetenabled
(boolean) – określa czy firewall jest aktywnymaximum_rules_number
(number) – określa maksymalną liczbę reguł, jaka może zostać ustawiona dla jednego kierunkuprotocol
(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 firewallin
(objects-list) – lista reguł dla ruchu przychodzącego (kolejność jest znacząca)policy
(string) – polityka reguły (ACCEPT
dla akceptacji pakietów, lubDROP
dla ich odrzucania)source
(object) – warunki dla źródła pakietuip
(string) – adres IPmask_short
(number) – liczba określająca skrót podsieci (0 – 32)port
(object) – warunki portu źródłowego pakietubegin
(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 pakietuip
(string) – adres IPmask_short
(number) – liczba określająca skrót podsieci (0 – 32)port
(object) – warunki portu przeznaczenia pakietubegin
(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, lubDROP
dla ich odrzucania)source
(object) – warunki dla źródła pakietuip
(string) – adres IPmask_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 pakietubegin
(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 rulesetrules[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 zapytaniarules[in][N][policy]
(string) – rodzaj polityki dla danej reguły (ACCEPT
lubDROP
)rules[in][N][protocol]
(number) – numer protokołu pakietu (wg RFC1700)rules[in][N][source][ip]
(string) – adres źródłowy pakieturules[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 pakieturules[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 zapytaniarules[out][N][policy]
(string) – rodzaj polityki dla danej reguły (ACCEPT
lubDROP
)rules[out][N][protocol]
(number) – numer protokołu pakietu (wg RFC1700)rules[out][N][source][ip]
(string) – adres źródłowy pakieturules[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 pakieturules[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