Create Task
Request URI
All requests you must send using GET or POST to this URI:
https://ping-admin.com/?a=api&sa=new_task&[other parameters described below]
Request Parameters
- api_key
-
Required: Yes.
Value: Your unique API key, which you can find in your profile.
Example:
https://ping-admin.com/?a=api&sa=new_task&api_key=6e59663b2ce62ac378be24bc30f48b95946
Default value: http (it means this type of check: HTTP (HEAD)).
Value: available types: http, http_get, http_post, https, https_get, https_post, ping.
Sample:
https://ping-admin.com/?a=api&sa=new_task&tip=http_get&[other parameters]
Value: URL to check.
Example:
https://ping-admin.com/?a=api&sa=new_task&url=ping-admin.com%2Ffree_test%2F&[other parameters]
Value: IP (IPv4) of checked web site, will be used this IP, not from DNS.
Example:
https://ping-admin.com/?a=api&sa=new_task&hosts_ip=1.2.3.4&[other parameters]
Value: task name; string, 255 letters maximum.
Example:
https://ping-admin.com/?a=api&sa=new_task&nazv=TestTaks&[other parameters]
Default value: 5.
Value: how often perform the checks, possible values: 1 — every minute; 2 — every 2 minutes; 3; 4; 5; 6; 10; 15; 20; 30; 60 — every hour.
Example:
https://ping-admin.com/?a=api&sa=new_task&period=3&[other parameters]
Value: site should contain this string with check GET or POST (only ASCII-letters).
Example:
https://ping-admin.com/?a=api&sa=new_task&txt=search_text_12345&[other parameters]
Value: HTTP status code in response (begin of allowed interval).
Example:
https://ping-admin.com/?a=api&sa=new_task&httpcode_from=200&[other parameters]
Value: HTTP status code in response (end of allowed interval).
Example:
https://ping-admin.com/?a=api&sa=new_task&size_to=399&[other parameters]
Value: minimal size in bytes of checked site.
Example:
https://ping-admin.com/?a=api&sa=new_task&size_from=1000&[other parameters]
Value: maximal size in bytes of checked site.
Example:
https://ping-admin.com/?a=api&sa=new_task&size_to=2000&[other parameters]
Default value: 0.
Value: check the site for viruses: 0 — don't check, 1 — check; only for tasks with types HTTP, HTTPS.
Example:
https://ping-admin.com/?a=api&sa=new_task&sb=1&[other parameters]
Default value: 0.
Value: check the site in blacklists (Spamhaus, Roskomnzdzor, etc.): 0 — don't check, 1 — check; only for tasks with types HTTP, HTTPS, Ping.
Example:
https://ping-admin.com/?a=api&sa=new_task&rk=1&[other parameters]
Default value: 0.
Value: 0 — search in Roskomnadzor blacklist IP, domain, path; 1 — search in Roskomnadzor blacklist only domain and path (don't search IP); only if parameter “rk” has value 1.
Example:
https://ping-admin.com/?a=api&sa=new_task&rk_ip=1&[other parameters]
Default value: 1.
Value: send alert when down N times (0 — immediately; 1 — after down 2 times; 2 — after down 3 times; 4 — after down 5 times; 9 — after down 10 times).
Example:
https://ping-admin.com/?a=api&sa=new_task&oshib=0&[other parameters]
Default value: 0.
Value: is it necessary to follow the redirect: 0 — don't follow, 1 — follow.
Example:
https://ping-admin.com/?a=api&sa=new_task&test_redirect=1&[other parameters]
Default value: 0.
Value: with value 1 is it necessary to check SSL-certificate: official certification centre, validity period, site address and certificate address compliance and other parameters.
Example:
https://ping-admin.com/?a=api&sa=new_task&test_https=1&[other parameters]
Default value: 0.
Value: with value 1 we will send e-mail 30, 7 and 3 days before the end date of SSL-certificate and also if it will be revoked.
Example:
https://ping-admin.com/?a=api&sa=new_task&cert=1&[other parameters]
Default value: 1.
Value: protocall to use: 1 — TLS; 0 — SSLv3.
Example:
https://ping-admin.com/?a=api&sa=new_task&ssl_version=0&[other parameters]
Default value: 0.
Value: if value 1 it's possible to add not working service.
Example:
https://ping-admin.com/?a=api&sa=new_task&nerab=1&[other parameters]
Value: e-mails from “Alerts / E-mails”, each other after comma.
Example:
https://ping-admin.com/?a=api&sa=new_task&mails=test1%40site.com,test2%40site.com&[other parameters]
Value: phone numbers for SMS, from “Alerts / SMS” each other after comma (only digits in international format [country code][city or area code][phone number]).
Example:
https://ping-admin.com/?a=api&sa=new_task&phones=79991112233,38060000000&[other parameters]
Value: phone numbers for phone calls, from “Alerts / Phone calls” each other after comma (only digits in international format [country code][city or area code][phone number]).
Example:
https://ping-admin.com/?a=api&sa=new_task&gphones=14621112233,79991112233&[other parameters]
Value: ID for API of contacts in Telegram, Slack, Viber, ICQ, Skype or Jabber, which you can find in “Alerts / Telegram, Viber, Skype, etc. / Edit”, each other after comma.
Example:
https://ping-admin.com/?a=api&sa=new_task&ims=12345,jabber%40site.com&[other parameters]
Value: URL for requests from “Alerts / HTTP”, each other after comma.
Example:
https://ping-admin.com/?a=api&sa=new_task&https=http%3A%2F%2Fsite.com%2Fscript.php&[other parameters]
Default value: 0.
Value: is it necessary to create graphs with time and speed (only for tasks with types: http, http_get, http_post, https, https_get, https_post); 1 — create, 0 — don't create.
Example:
https://ping-admin.com/?a=api&sa=new_task&graph=1&[other parameters]
Default value: 0.
Value: 0 — Auto; 1 — From each selected monitoring point independently; 2 — From all selected monitoring points (check algoriths description).
Example:
https://ping-admin.com/?a=api&sa=new_task&algoritm=0&[other parameters]
Value: ID of monitoring points, which you cand find with this method, each other after comma.
Example:
https://ping-admin.com/?a=api&sa=new_task&&algoritm=2&tm=ru9,ru15&[other parameters]
Response
[{"tid":"1"}]
If we can't create new task (for example wrong parameters will be send), response will be with error description.
Response Parameters
- tid
-
Type: integer.
Value: ID of created task.