Докуменация для разработчиков к api версия 0.0.8


  • Описание доступных функций по ключу к api.keyip.ru для работы с PORT

    curl -XPOST "https://node1.keyip.ru/api-v1/cli/add_mon/port?" \
    -d "&mon_address=postq.ru\
    &mon_nota_owner_email=ВашеЕмаилДляУведомлений\
    &mon_protocol=tcp\
    &mon_port_list=443,80\
    &mon_interval=120\
    &mon_max_retry=0\
    &mon_time_location_code=310\
    &mon_owner_key=КлючДоступаКapi"

    переменная значение
    mon_address Адрес проверяемой цели, допустимо указывать без прификса протоколоа, например ftp:// http:// и https://
    Например node1.keyip.ru
    или 94.158.171.2
    mon_nota_owner_email Адресс электронной почты куда будут уходить уведомления о инцидентах
    mon_nota_owner_phone Адресс мобильного номера куда будут уходить уведомления о инцидентах, номер указывается в цифрах, без каких либо дополнительных символах, например 79261045222
    mon_nota_owner_telegram_id User Id вашего телеграм аккаунта куда будут уходить уведомления о инцидентах, id указывается в цифрах, без каких либо дополнительных символах, например 9261045222
    Как узнать свой ID ?
    Для этого вам необходимо воспользоваться нашим телеграм ботом @keyip_ru_bot
    mon_protocol Протокол используемый при мониторинге портов, в данный момент это tcp
    mon_port_list Порты для мониторинга, в диапазоне 1-65535Порты перечисляются через запятую например 443,22,80
    Service Name and Transport Protocol Port Number Registry
    mon_interval Интервал проверки, указывается в секундах, рекомендуемое значение 120 что ровняется 2 минутам
    минимальное значение 10 что ровняется 10 секундам
    максимальное значение 14400 что ровняется 4 часам
    mon_time_location_code Код региона, по которому будет отображаться время инциндета, например 310 это Europe/Moscow
    mon_max_retry Число попыток после которых при обноружение проблем будет выслано уведомление о онциденте, 0 вышлет сразу как будет обнаружена проблема, 1 бедет ждать когда отработает счечтик mon_interval и попробет еще раз проверить, если попытка будет неудачной вышлет уведомление, следовательно указывая 2 и так далее позволяет контролировать чувственность к кратковременным прлблемам проверямого узла, например вызваного сменой маршрутизации или ложным срабатываниям в исключительных случаях.
    минимальное значение 0 попыток повторной проверки
    максимальное значение 20 попыток повторной проверки.
    Рекомендуется ставить значение 1 и вот почему: при первой проверке мы можем попасть в тот момент когда мршрутизация меняется, следовательно хост станет неоступным в этот мемент, при значение 1 проверка вовторится еще раз, и если действительно проверяемый узел недоступен то будет выслано уведомление об инциндете, такчто значение 1 является оптимальным.
    mon_owner_key Ключ позволяющий получить доступ к api сервиса, ключ уникальный у каждого пользователя

  • Описание доступных функций по ключу к api.keyip.ru для работы с PING

    curl -XPOST "https://node1.keyip.ru/api-v1/cli/add_mon/ping?" \
    -d "&mon_address=postq.ru\
    &mon_nota_owner_email=ВашеЕмаилДляУведомлений\
    &mon_interval=120\
    &mon_max_retry=0\
    &mon_time_location_code=310\
    &mon_owner_key=КлючДоступаКapi"


    переменная значение
    mon_address Адрес проверяемой цели, допустимо указывать без прификса протоколоа, например ftp:// http:// и https://
    Например node1.keyip.ru
    или 94.158.171.2
    mon_nota_owner_email Адресс электронной почты куда будут уходить уведомления о инцидентах
    mon_nota_owner_phone Адресс мобильного номера куда будут уходить уведомления о инцидентах, номер указывается в цифрах, без каких либо дополнительных символах, например 79261045222
    mon_nota_owner_telegram_id User Id вашего телеграм аккаунта куда будут уходить уведомления о инцидентах, id указывается в цифрах, без каких либо дополнительных символах, например 9261045222
    Как узнать свой ID ?
    Для этого вам необходимо воспользоваться нашим телеграм ботом @keyip_ru_bot
    mon_interval Интервал проверки, указывается в секундах, рекомендуемое значение 120 что ровняется 2 минутам
    минимальное значение 10 что ровняется 10 секундам
    максимальное значение 14400 что ровняется 4 часам
    mon_time_location_code Код региона, по которому будет отображаться время инциндета, например 310 это Europe/Moscow
    mon_max_retry Число попыток после которых при обноружение проблем будет выслано уведомление о онциденте, 0 вышлет сразу как будет обнаружена проблема, 1 бедет ждать когда отработает счечтик mon_interval и попробет еще раз проверить, если попытка будет неудачной вышлет уведомление, следовательно указывая 2 и так далее позволяет контролировать чувственность к кратковременным прлблемам проверямого узла, например вызваного сменой маршрутизации или ложным срабатываниям в исключительных случаях.
    минимальное значение 0 попыток повторной проверки
    максимальное значение 20 попыток повторной проверки.
    Рекомендуется ставить значение 1 и вот почему: при первой проверке мы можем попасть в тот момент когда мршрутизация меняется, следовательно хост станет неоступным в этот мемент, при значение 1 проверка вовторится еще раз, и если действительно проверяемый узел недоступен то будет выслано уведомление об инциндете, такчто значение 1 является оптимальным.
    mon_owner_key Ключ позволяющий получить доступ к api сервиса, ключ уникальный у каждого пользователя

  • Описание доступных функций по ключу к api.keyip.ru для работы с протоколом HTTP

    curl -XPOST "https://node1.keyip.ru/api-v1/cli/add_mon/http?" \
    -d "&mon_method=get\
    &mon_address=postq.ru\
    &mon_nota_owner_email=ВашеЕмаилДляУведомлений\
    &mon_interval=120\
    &mon_protocol=https\
    &mon_max_retry=0\
    &mon_time_location_code=310\
    &mon_owner_key=КлючДоступаКapi"

    переменная значение
    mon_method Каким методом осуществлять запрос при проверке, доступны несколько методов GET/POST
    mon_address Адрес проверяемой цели, допустимо указывать в качестве ссылки на струницу без прификса http:// и https://
    Например node1.keyip.ru
    или так node1.keyip.ru/help
    mon_nota_owner_email Адресс электронной почты куда будут уходить уведомления о инцидентах
    mon_nota_owner_phone Адресс мобильного номера куда будут уходить уведомления о инцидентах, номер указывается в цифрах, без каких либо дополнительных символах, например 79261045222
    mon_nota_owner_telegram_id User Id вашего телеграм аккаунта куда будут уходить уведомления о инцидентах, id указывается в цифрах, без каких либо дополнительных символах, например 9261045222
    Как узнать свой ID ?
    Для этого вам необходимо воспользоваться нашим телеграм ботом @keyip_ru_bot
    mon_interval Интервал проверки, указывается в секундах, рекомендуемое значение 120 что ровняется 2 минутам
    минимальное значение 10 что ровняется 10 секундам
    максимальное значение 14400 что ровняется 4 часам
    mon_time_location_code Код региона, по которому будет отображаться время инциндета, например 310 это Europe/Moscow
    mon_protocol Какой протокол используется при работе есди указывается mon_type, доступны несколько http/https
    mon_max_retry Число попыток после которых при обноружение проблем будет выслано уведомление о онциденте, 0 вышлет сразу как будет обнаружена проблема, 1 бедет ждать когда отработает счечтик mon_interval и попробет еще раз проверить, если попытка будет неудачной вышлет уведомление, следовательно указывая 2 и так далее позволяет контролировать чувственность к кратковременным прлблемам проверямого узла, например вызваного сменой маршрутизации или ложным срабатываниям в исключительных случаях.
    минимальное значение 0 попыток повторной проверки
    максимальное значение 20 попыток повторной проверки.
    Рекомендуется ставить значение 1 и вот почему: при первой проверке мы можем попасть в тот момент когда мршрутизация меняется, следовательно хост станет неоступным в этот мемент, при значение 1 проверка вовторится еще раз, и если действительно проверяемый узел недоступен то будет выслано уведомление об инциндете, такчто значение 1 является оптимальным.
    mon_owner_key Ключ позволяющий получить доступ к api сервиса, ключ уникальный у каждого пользователя

  • коды для установки времени, по какому времени будет уотображаться инциндет mon_time_location_code
    Код Регион
    1 Europe/Andorra
    2 Asia/Dubai
    3 Asia/Kabul
    4 America/Antigua
    5 America/Anguilla
    6 Europe/Tirane
    7 Asia/Yerevan
    8 Africa/Luanda
    9 Antarctica/McMurdo
    10 Antarctica/Casey
    11 Antarctica/Davis
    12 Antarctica/DumontDUrville
    13 Antarctica/Mawson
    14 Antarctica/Palmer
    15 Antarctica/Rothera
    16 Antarctica/Syowa
    17 Antarctica/Troll
    18 Antarctica/Vostok
    19 America/Argentina/Buenos_Aires
    20 America/Argentina/Cordoba
    21 America/Argentina/Salta
    22 America/Argentina/Jujuy
    23 America/Argentina/Tucuman
    24 America/Argentina/Catamarca
    25 America/Argentina/La_Rioja
    26 America/Argentina/San_Juan
    27 America/Argentina/Mendoza
    28 America/Argentina/San_Luis
    29 America/Argentina/Rio_Gallegos
    30 America/Argentina/Ushuaia
    31 Pacific/Pago_Pago
    32 Europe/Vienna
    33 Australia/Lord_Howe
    34 Antarctica/Macquarie
    35 Australia/Hobart
    36 Australia/Currie
    37 Australia/Melbourne
    38 Australia/Sydney
    39 Australia/Broken_Hill
    40 Australia/Brisbane
    41 Australia/Lindeman
    42 Australia/Adelaide
    43 Australia/Darwin
    44 Australia/Perth
    45 Australia/Eucla
    46 America/Aruba
    47 Europe/Mariehamn
    48 Asia/Baku
    49 Europe/Sarajevo
    50 America/Barbados
    51 Asia/Dhaka
    52 Europe/Brussels
    53 Africa/Ouagadougou
    54 Europe/Sofia
    55 Asia/Bahrain
    56 Africa/Bujumbura
    57 Africa/Porto-Novo
    58 America/St_Barthelemy
    59 Atlantic/Bermuda
    60 Asia/Brunei
    61 America/La_Paz
    62 America/Kralendijk
    63 America/Noronha
    64 America/Belem
    65 America/Fortaleza
    66 America/Recife
    67 America/Araguaina
    68 America/Maceio
    69 America/Bahia
    70 America/Sao_Paulo
    71 America/Campo_Grande
    72 America/Cuiaba
    73 America/Santarem
    74 America/Porto_Velho
    75 America/Boa_Vista
    76 America/Manaus
    77 America/Eirunepe
    78 America/Rio_Branco
    79 America/Nassau
    80 Asia/Thimphu
    81 Africa/Gaborone
    82 Europe/Minsk
    83 America/Belize
    84 America/St_Johns
    85 America/Halifax
    86 America/Glace_Bay
    87 America/Moncton
    88 America/Goose_Bay
    89 America/Blanc-Sablon
    90 America/Toronto
    91 America/Nipigon
    92 America/Thunder_Bay
    93 America/Iqaluit
    94 America/Pangnirtung
    95 America/Atikokan
    96 America/Winnipeg
    97 America/Rainy_River
    98 America/Resolute
    99 America/Rankin_Inlet
    100 America/Regina
    101 America/Swift_Current
    102 America/Edmonton
    103 America/Cambridge_Bay
    104 America/Yellowknife
    105 America/Inuvik
    106 America/Creston
    107 America/Dawson_Creek
    108 America/Fort_Nelson
    109 America/Vancouver
    110 America/Whitehorse
    111 America/Dawson
    112 Indian/Cocos
    113 Africa/Kinshasa
    114 Africa/Lubumbashi
    115 Africa/Bangui
    116 Africa/Brazzaville
    117 Europe/Zurich
    118 Africa/Abidjan
    119 Pacific/Rarotonga
    120 America/Santiago
    121 America/Punta_Arenas
    122 Pacific/Easter
    123 Africa/Douala
    124 Asia/Shanghai
    125 Asia/Urumqi
    126 America/Bogota
    127 America/Costa_Rica
    128 America/Havana
    129 Atlantic/Cape_Verde
    130 America/Curacao
    131 Indian/Christmas
    132 Asia/Nicosia
    133 Asia/Famagusta
    134 Europe/Prague
    135 Europe/Berlin
    136 Europe/Busingen
    137 Africa/Djibouti
    138 Europe/Copenhagen
    139 America/Dominica
    140 America/Santo_Domingo
    141 Africa/Algiers
    142 America/Guayaquil
    143 Pacific/Galapagos
    144 Europe/Tallinn
    145 Africa/Cairo
    146 Africa/El_Aaiun
    147 Africa/Asmara
    148 Europe/Madrid
    149 Africa/Ceuta
    150 Atlantic/Canary
    151 Africa/Addis_Ababa
    152 Europe/Helsinki
    153 Pacific/Fiji
    154 Atlantic/Stanley
    155 Pacific/Chuuk
    156 Pacific/Pohnpei
    157 Pacific/Kosrae
    158 Atlantic/Faroe
    159 Europe/Paris
    160 Africa/Libreville
    161 Europe/London
    162 America/Grenada
    163 Asia/Tbilisi
    164 America/Cayenne
    165 Europe/Guernsey
    166 Africa/Accra
    167 Europe/Gibraltar
    168 America/Godthab
    169 America/Danmarkshavn
    170 America/Scoresbysund
    171 America/Thule
    172 Africa/Banjul
    173 Africa/Conakry
    174 America/Guadeloupe
    175 Africa/Malabo
    176 Europe/Athens
    177 Atlantic/South_Georgia
    178 America/Guatemala
    179 Pacific/Guam
    180 Africa/Bissau
    181 America/Guyana
    182 Asia/Hong_Kong
    183 America/Tegucigalpa
    184 Europe/Zagreb
    185 America/Port-au-Prince
    186 Europe/Budapest
    187 Asia/Jakarta
    188 Asia/Pontianak
    189 Asia/Makassar
    190 Asia/Jayapura
    191 Europe/Dublin
    192 Asia/Jerusalem
    193 Europe/Isle_of_Man
    194 Asia/Kolkata
    195 Indian/Chagos
    196 Asia/Baghdad
    197 Asia/Tehran
    198 Atlantic/Reykjavik
    199 Europe/Rome
    200 Europe/Jersey
    201 America/Jamaica
    202 Asia/Amman
    203 Asia/Tokyo
    204 Africa/Nairobi
    205 Asia/Bishkek
    206 Asia/Phnom_Penh
    207 Pacific/Tarawa
    208 Pacific/Enderbury
    209 Pacific/Kiritimati
    210 Indian/Comoro
    211 America/St_Kitts
    212 Asia/Pyongyang
    213 Asia/Seoul
    214 Asia/Kuwait
    215 America/Cayman
    216 Asia/Almaty
    217 Asia/Qyzylorda
    218 Asia/Qostanay
    219 Asia/Aqtobe
    220 Asia/Aqtau
    221 Asia/Atyrau
    222 Asia/Oral
    223 Asia/Vientiane
    224 Asia/Beirut
    225 America/St_Lucia
    226 Europe/Vaduz
    227 Asia/Colombo
    228 Africa/Monrovia
    229 Africa/Maseru
    230 Europe/Vilnius
    231 Europe/Luxembourg
    232 Europe/Riga
    233 Africa/Tripoli
    234 Africa/Casablanca
    235 Europe/Monaco
    236 Europe/Chisinau
    237 Europe/Podgorica
    238 America/Marigot
    239 Indian/Antananarivo
    240 Pacific/Majuro
    241 Pacific/Kwajalein
    242 Europe/Skopje
    243 Africa/Bamako
    244 Asia/Yangon
    245 Asia/Ulaanbaatar
    246 Asia/Hovd
    247 Asia/Choibalsan
    248 Asia/Macau
    249 Pacific/Saipan
    250 America/Martinique
    251 Africa/Nouakchott
    252 America/Montserrat
    253 Europe/Malta
    254 Indian/Mauritius
    255 Indian/Maldives
    256 Africa/Blantyre
    257 America/Mexico_City
    258 America/Cancun
    259 America/Merida
    260 America/Monterrey
    261 America/Matamoros
    262 America/Mazatlan
    263 America/Chihuahua
    264 America/Ojinaga
    265 America/Hermosillo
    266 America/Tijuana
    267 America/Bahia_Banderas
    268 Asia/Kuala_Lumpur
    269 Asia/Kuching
    270 Africa/Maputo
    271 Africa/Windhoek
    272 Pacific/Noumea
    273 Africa/Niamey
    274 Pacific/Norfolk
    275 Africa/Lagos
    276 America/Managua
    277 Europe/Amsterdam
    278 Europe/Oslo
    279 Asia/Kathmandu
    280 Pacific/Nauru
    281 Pacific/Niue
    282 Pacific/Auckland
    283 Pacific/Chatham
    284 Asia/Muscat
    285 America/Panama
    286 America/Lima
    287 Pacific/Tahiti
    288 Pacific/Marquesas
    289 Pacific/Gambier
    290 Pacific/Port_Moresby
    291 Pacific/Bougainville
    292 Asia/Manila
    293 Asia/Karachi
    294 Europe/Warsaw
    295 America/Miquelon
    296 Pacific/Pitcairn
    297 America/Puerto_Rico
    298 Asia/Gaza
    299 Asia/Hebron
    300 Europe/Lisbon
    301 Atlantic/Madeira
    302 Atlantic/Azores
    303 Pacific/Palau
    304 America/Asuncion
    305 Asia/Qatar
    306 Indian/Reunion
    307 Europe/Bucharest
    308 Europe/Belgrade
    309 Europe/Kaliningrad
    310 Europe/Moscow
    311 Europe/Simferopol
    312 Europe/Kirov
    313 Europe/Astrakhan
    314 Europe/Volgograd
    315 Europe/Saratov
    316 Europe/Ulyanovsk
    317 Europe/Samara
    318 Asia/Yekaterinburg
    319 Asia/Omsk
    320 Asia/Novosibirsk
    321 Asia/Barnaul
    322 Asia/Tomsk
    323 Asia/Novokuznetsk
    324 Asia/Krasnoyarsk
    325 Asia/Irkutsk
    326 Asia/Chita
    327 Asia/Yakutsk
    328 Asia/Khandyga
    329 Asia/Vladivostok
    330 Asia/Ust-Nera
    331 Asia/Magadan
    332 Asia/Sakhalin
    333 Asia/Srednekolymsk
    334 Asia/Kamchatka
    335 Asia/Anadyr
    336 Africa/Kigali
    337 Asia/Riyadh
    338 Pacific/Guadalcanal
    339 Indian/Mahe
    340 Africa/Khartoum
    341 Europe/Stockholm
    342 Asia/Singapore
    343 Atlantic/St_Helena
    344 Europe/Ljubljana
    345 Arctic/Longyearbyen
    346 Europe/Bratislava
    347 Africa/Freetown
    348 Europe/San_Marino
    349 Africa/Dakar
    350 Africa/Mogadishu
    351 America/Paramaribo
    352 Africa/Juba
    353 Africa/Sao_Tome
    354 America/El_Salvador
    355 America/Lower_Princes
    356 Asia/Damascus
    357 Africa/Mbabane
    358 America/Grand_Turk
    359 Africa/Ndjamena
    360 Indian/Kerguelen
    361 Africa/Lome
    362 Asia/Bangkok
    363 Asia/Dushanbe
    364 Pacific/Fakaofo
    365 Asia/Dili
    366 Asia/Ashgabat
    367 Africa/Tunis
    368 Pacific/Tongatapu
    369 Europe/Istanbul
    370 America/Port_of_Spain
    371 Pacific/Funafuti
    372 Asia/Taipei
    373 Africa/Dar_es_Salaam
    374 Europe/Kiev
    375 Europe/Uzhgorod
    376 Europe/Zaporozhye
    377 Africa/Kampala
    378 Pacific/Midway
    379 Pacific/Wake
    380 America/New_York
    381 America/Detroit
    382 America/Kentucky/Louisville
    383 America/Kentucky/Monticello
    384 America/Indiana/Indianapolis
    385 America/Indiana/Vincennes
    386 America/Indiana/Winamac
    387 America/Indiana/Marengo
    388 America/Indiana/Petersburg
    389 America/Indiana/Vevay
    390 America/Chicago
    391 America/Indiana/Tell_City
    392 America/Indiana/Knox
    393 America/Menominee
    394 America/North_Dakota/Center
    395 America/North_Dakota/New_Salem
    396 America/North_Dakota/Beulah
    397 America/Denver
    398 America/Boise
    399 America/Phoenix
    400 America/Los_Angeles
    401 America/Anchorage
    402 America/Juneau
    403 America/Sitka
    404 America/Metlakatla
    405 America/Yakutat
    406 America/Nome
    407 America/Adak
    408 Pacific/Honolulu
    409 America/Montevideo
    410 Asia/Samarkand
    411 Asia/Tashkent
    412 Europe/Vatican
    413 America/St_Vincent
    414 America/Caracas
    415 America/Tortola
    416 America/St_Thomas
    417 Asia/Ho_Chi_Minh
    418 Pacific/Efate
    419 Pacific/Wallis
    420 Pacific/Apia
    421 Asia/Aden
    422 Indian/Mayotte
    423 Africa/Johannesburg
    424 Africa/Lusaka
    425 Africa/Harare

  • Описание доступных функций по ключу к api.keyip.ru для работы с Метриками

    Функция в разработке и возвращает не все данные и имеет не полное описание

    curl -XPOST "https://node1.keyip.ru/api-v1/cli/metrics/regular?" \
    -d "&mon_host=postq.ru\
    &mon_host_date=2020-03-16\
    &type_data=json\
    &mon_owner_key=КлючДоступаКapi"

    переменная значение
    mon_host Адрес проверяемой цели в работе, допустимо указывать без прификса протоколоа, например ftp:// http:// и https://
    Например node1.keyip.ru
    или 94.158.171.2
    mon_host_date Дата за которую хотим посмотреть, без указания времени, формат данты YYYY-MM-DD (год-месяц-день)
    type_data Формат запрашиваемых даныых в ответ json
    mon_owner_key Ключ позволяющий получить доступ к api сервиса, ключ уникальный у каждого пользователя

    Возвращаемые данные

    переменная значение
    mon_date_warning_human Возрашает дату и время инцендента2020-03-16 00:01:18