Edit Task

Request URI

Warning! If parameters described below will have value “empty string” these parameters will not be changed. An exception — parameter “txt” (see the description of this parameter for more details).

All requests you must send using GET or POST to this URI:

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=edit_task&api_key=6e59663b2ce62ac378be24bc30f48b95946&[other parameters]

id

Required: yes.
Value: Task ID which you wand to update.
Example:

https://ping-admin.com/?a=api&sa=edit_task&id=2&[other parameters]

url

Required: no.
Value: URL to check.
Example:

https://ping-admin.com/?a=api&sa=edit_task&url=ping-admin.com%2Ffree_test%2F&[other parameters]

hosts_ip

Required: no.
Value: IP (IPv4) of checked web site, will be used this IP, not from DNS. If input “no_change” (without quotes) this parameter will not be changed in tasks settings.
Example:

https://ping-admin.com/?a=api&sa=edit_task&hosts_ip=1.2.3.4&[other parameters]

nazv

Required: no.
Value: task name; string, 255 letters maximum. If input “empty” (without quotes) the task will not have any name.
Example:

https://ping-admin.com/?a=api&sa=edit_task&nazv=%F2%E5%F1%F2123&[other parameters]

period

Required: no.
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=edit_task&period=3&[other parameters]

txt

Required: no.
Default value: empty string.
Value: site should contain this string with check GET or POST (only ASCII-letters). If input “no_change” (without quotes) this parameter will not be changed in tasks settings.
Example:

https://ping-admin.com/?a=api&sa=edit_task&txt=search_text_12345&[other parameters]

httpcode_from

Required: no.
Value: HTTP status code in response (begin of allowed interval). If set 0 and next parameter also set 0 will be used 200–399 interval.
Example:

https://ping-admin.com/?a=api&sa=edit_task&httpcode_from=200&[other parameters]

httpcode_to

Required: no.
Value: HTTP status code in response (end of allowed interval). If set 0 and previous parameter also set 0 will be used 200–399 interval.
Example:

https://ping-admin.com/?a=api&sa=edit_task&size_to=399&[other parameters]

size_from

Required: no.
Value: minimal size in bytes of checked site; if set 0 minimal page size will not be checked.
Example:

https://ping-admin.com/?a=api&sa=edit_task&size_from=1000&[other parameters]

size_to

Required: no.
Value: maximal size in bytes of checked site; if set 0 maximal page size will not be checked.
Example:

https://ping-admin.com/?a=api&sa=edit_task&size_to=2000&[other parameters]

sb

Required: no.
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=edit_task&sb=1&[other parameters]

rk

Required: no.
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=edit_task&rk=1&[other parameters]

rk_ip

Required: no.
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=edit_task&rk_ip=1&[other parameters]

oshib

Required: no.
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=edit_task&oshib=0&[other parameters]

test_redirect

Required: no.
Value: is it necessary to follow the redirect: 0 — don't follow, 1 — follow.
Example:

https://ping-admin.com/?a=api&sa=edit_task&test_redirect=1&[other parameters]

test_https

Required: no.
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=edit_task&test_https=1&[other parameters]

cert

Required: no.
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=edit_task&cert=1&[other parameters]

status

Required: no.
Value: 1 — task is on, checks are performed, 0 — task is off, checks are not performed.
Example:

https://ping-admin.com/?a=api&sa=edit_task&status=0&[other parameters]

ssl_version

Required: no.
Value: protocall to use: 1 — TLS; 0 — SSLv3.
Example:

https://ping-admin.com/?a=api&sa=edit_task&ssl_version=0&[other parameters]

mails

Required: no.
Value: -mails from “Alerts / E-mails”, each other after comma.
Example:

https://ping-admin.com/?a=api&sa=edit_task&mails=test1%40site.com,test2%40site.com&[other parameters]

phones

Required: no.
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]). To remove all phone numbers for SMS from alerts for the task please use space (%20) in this parameter.
Example:

https://ping-admin.com/?a=api&sa=edit_task&phones=79991112233,38060000000&[other parameters]

gphones

Required: no.
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]). To remove all phone numbers for calls from alerts for the task please use space (%20) in this parameter.
Example:

https://ping-admin.com/?a=api&sa=edit_task&gphones=14621112233,79991112233&[other parameters]

ims

Required: no.
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. To remove all contacts in internet messengers from alerts for the task please use space (%20) in this parameter.
Example:

https://ping-admin.com/?a=api&sa=edit_task&ims=12345,jabber%40site.com&[other parameters]

https

Required: no.
Value: URL for requests from “Alerts / HTTP”, each other after comma. To remove this type of alerts from task use space (%20) in this parameter.
Example:

https://ping-admin.com/?a=api&sa=edit_task&https=http%3A%2F%2Fsite.com%2Fscript.php&[other parameters]

Response

If we can't update the task (for example wrong parameters will be send), response will be with error description.

Response Parameters

status

Type: string.
Value: OK.

← Back to API sections