Introduction
Welcome to the Pinguzo API! The API allows you to query our database for all relevant monitoring data as long as you provide a valid API key
Rate Limiting
Each User ID is limited to 500 requests per hour.
Return Values
Always validate if the returned data is a JSON object, our servers may return HTML code due to server errors. In case of an error you will receive the status ERROR and an array errors containing one or more description messages.
Authentication
Pinguzo uses API key and password to allow access to the API. You can sign up with Pinguzo (https://cp.pinguzo.com).
To generate API key and password use API Credentials.
Pinguzo expects API key and password to be included in all API requests to the server.
Servers
Get All Servers
curl -i "https://cp.pinguzo.com/index?apikey=APIKEY&apipass=APIPASS\
&api=json&act=servers"
The above command returns JSON structured like this:
{
"uid": "XXXXXX",
"act": "servers",
"timezone": 0,
"timenow": 1530189388,
"email": "XXXXXX",
"username": "XXXXXX",
"mainuser": "XXXXXX",
"user_type": null,
"preferences": {
"theme": "default",
"language": "english",
"timezone": 0,
"timezone_adjust": 0
},
"url": "index?",
"num_incidents": "16",
"mirror_incidents": "eu.pinguzo.com",
"title": "Pinguzo",
"servers": {
"kXXXXXX": {
"sid": "XXXXXX",
"uid": "XXXXXX",
"ip": "XXXXXX",
"ipv6": "XXXXXX",
"server_name": "testme",
"hostname": "localhost.localdomain",
"os": "CentOS Linux release 7.5.1804 (Core)",
"os_arch": "x86_64",
"cpu_model": "Intel(R) Pentium(R) CPU G620",
"cpu_cores": "1",
"cpu_speed": "2594",
"cpu_usage": "1.00",
"ram_total": "992",
"ram_usage": "495",
"disk_size": "6486016",
"disk_free": "3834600",
"interface": "enp0s3",
"net_in_speed": "67",
"net_out_speed": "163",
"load_1": "0.04",
"load_5": "0.02",
"load_15": "0.05",
"uptime": "212726.81",
"availability": "14.069",
"availability_monthly": "97.568",
"missed": "958",
"missed_monthly": "958",
"kernel": "3.10.0-862.el7.x86_64",
"agent_version": "0.8.0",
"update_interval": "60",
"added_time": "1530107430",
"started_time": "1530107470",
"last_update": "1530189390",
"status": "1",
"os_distro": "centos",
"mirror": "fi.pinguzo.com"
},
"kXXXXXX": {
"sid": "XXXXXX",
"uid": "XXXXXX",
"ip": "XXXXXX",
"ipv6": "XXXXXX",
"server_name": "compile",
"hostname": "compile",
"os": "CentOS Linux release 7.1.1503 (Core)",
"os_arch": "x86_64",
"cpu_model": "Intel(R) Xeon(R) CPU E5-1620 0",
"cpu_cores": "4",
"cpu_speed": "3600",
"cpu_usage": "1.25",
"ram_total": "2001",
"ram_usage": "1134",
"disk_size": "19479228",
"disk_free": "7288468",
"interface": "eth0",
"net_in_speed": "207",
"net_out_speed": "307",
"load_1": "0.11",
"load_5": "0.20",
"load_15": "0.60",
"uptime": "6842081.62",
"availability": "99.715",
"availability_monthly": "99.952",
"missed": "325",
"missed_monthly": "19",
"kernel": "3.10.0-229.1.2.el7.x86_64",
"agent_version": "0.8.0",
"update_interval": "60",
"added_time": "1523346612",
"started_time": "1523346689",
"last_update": "1530189329",
"status": "1",
"os_distro": "centos",
"mirror": "fi.pinguzo.com"
}
"page": {
"maxNum": "10",
"len": 5,
"start": 0
},
"screen_options": {
"sortcolumn": [
"id",
"name",
"cpu",
"ip",
"cpu",
"ram",
"disk",
"net_up",
"net_down"
],
"0": "sortby",
"1": "pagelength",
"vals": {
"sortcolumn": "disk",
"sortby": "asc",
"pagelength": 5
}
},
"time_taken": "0.013"
}
HTTP Request
https://cp.pinguzo.com/index?apikey=APIKEY&apipass=APIPASS&api=json&act=servers
| Name | Type | Value | Required | Description |
|---|---|---|---|---|
| act | GET | servers | yes | Get list of servers |
| search | GET | string | no | Searches for Server name, Sid, IP |
| page | GET | Int | no | Page No |
| reslen | GET | Int | no | Default page length is 50 |
View Server
curl -i "https://mirror/index?apikey=APIKEY&apipass=APIPASS\
&api=json&act=viewserver&sid=XXXXXX\
&from=201806281209&to=201806281212"
The above command returns JSON structured like this:
{
"uid": "XXXXXX",
"act": "viewserver",
"timezone": 0,
"timenow": 1530192083,
"email": "emailid",
"username": "XXXXXX",
"mainuser": "XXXXXX",
"user_type": null,
"preferences": {
"theme": "default",
"language": "english",
"timezone": 0,
"timezone_adjust": 0
},
"url": "index?",
"num_incidents": "16",
"mirror_incidents": "eu.pinguzo.com",
"title": "Pinguzo",
"server": {
"sid": "XXXXXX",
"uid": "XXXXXX",
"ip": "XXXXXX",
"ipv6": "XXXXXX",
"server_name": "Server1",
"hostname": "server.com",
"os": "CentOS Linux release 7.3.1611 (Core)",
"os_arch": "x86_64",
"cpu_model": "Intel(R) Xeon(R) CPU E5-1620 0",
"cpu_cores": "4",
"cpu_speed": "3600",
"cpu_usage": "73.24",
"ram_total": "15670",
"ram_usage": "5241",
"disk_size": "1027863552",
"disk_free": "158710064",
"interface": "eth0",
"net_in_speed": "852078",
"net_out_speed": "81389",
"load_1": "1.64",
"load_5": "1.88",
"load_15": "1.78",
"uptime": "3901601.89",
"availability": "99.241",
"availability_monthly": "99.473",
"missed": "3057",
"missed_monthly": "207",
"kernel": "3.10.0-514.6.1.el7.x86_64",
"agent_version": "0.8.0",
"update_interval": "60",
"added_time": "1505986037",
"started_time": "1505986208",
"last_update": "1530192008",
"status": "1",
"mirror": "uk.pinguzo.com"
},
"data": {
"TIME": 1530192083,
"from": 201806281209,
"to": 201806281212,
"status_logs": {
"k201806281209": {
"datetime": 201806281209,
"time": 1530187740,
"status": "1"
}
}
"disk_keys": {
"1": "\/dev\/vda1",
"2": "\/dev\/vdb"
},
"network": {
"eth0": [
[
0,
1027441.334
],
[
-1,
936377.383
],
[
-2,
1305976.567
],
[
-3,
111892.65
]
]
},
"network_stats": {
"eth0": {
"in_speed": 0,
"out_speed": 0,
"total_speed": 0
}
},
"latest_network_stats": {
"eth0": {
"interface": "eth0",
"in_bytes": "51124668",
"out_bytes": "4883355",
"in_speed": "852077.8",
"out_speed": "81389.25",
"in_packets": "46348",
"out_packets": "43965",
"total_speed": 933467.05
}
},
"disk_stats": {
"\/": {
"mount_point": "\/",
"used_percentage": "84"
},
"\/var\/lib\/mongo": {
"mount_point": "\/var\/lib\/mongo",
"used_percentage": "74"
}
},
"processes": {
"latest_datetime": 201806281320,
"latest": {
"atd": {
"process": "atd",
"user": "root",
"count": 1,
"percent_cpu": 0,
"percent_ram": 0,
"resident_mem": 156,
"virtual_mem": 25860
},
"auditd": {
"process": "auditd",
"user": "root",
"count": 1,
"percent_cpu": 0,
"percent_ram": 0,
"resident_mem": 648,
"virtual_mem": 55432
},
"bash": {
"process": "bash",
"user": "pinguzo",
"count": 5,
"percent_cpu": 0,
"percent_ram": 0,
"resident_mem": 4444,
"virtual_mem": 52756
},
"crond": {
"process": "crond",
"user": "root",
"count": 2,
"percent_cpu": 0,
"percent_ram": 0,
"resident_mem": 3840,
"virtual_mem": 97264
}
},
"range_datetime": "201806281209",
"range": {
"ping": {
"process": "ping",
"user": "root",
"count": 12,
"percent_cpu": 0,
"percent_ram": 0,
"resident_mem": 15892,
"virtual_mem": 315012
},
"postmaster": {
"process": "postmaster",
"user": "postgres",
"count": 8,
"percent_cpu": 0,
"percent_ram": 0,
"resident_mem": 8248,
"virtual_mem": 2018264
},
"ps": {
"process": "ps",
"user": "pinguzo",
"count": 1,
"percent_cpu": 0,
"percent_ram": 0,
"resident_mem": 1800,
"virtual_mem": 47624
},
"rsyslogd": {
"process": "rsyslogd",
"user": "root",
"count": 1,
"percent_cpu": 0,
"percent_ram": 0,
"resident_mem": 8104,
"virtual_mem": 705080
},
"screen": {
"process": "screen",
"user": "root",
"count": 2,
"percent_cpu": 0,
"percent_ram": 0,
"resident_mem": 796,
"virtual_mem": 48752
}
}
}
},
"page_status": {
"maxNum": 1,
"len": 50,
"start": 0
},
"time_taken": "0.010"
}
HTTP Request
https://mirror/index?apikey=APIKEY&apipass=APIPASS&api=json&act=viewserver&sid=XXXXXX&from=201806281209&to=201806281212
| Name | Type | Value | Required | Description |
|---|---|---|---|---|
| act | GET | viewserver | yes | Get metrics of server |
| sid | GET | Int | yes | Server ID |
| mirror | GET | hostname | yes | Mirror of viewing server can be found in servers list api |
| from | GET | Int | no | YYYYMMDDHHii Format. For given range metrics will be displayed |
| to | GET | Int | no | YYYYMMDDHHii Format. For given range metrics will be displayed |
View Process Information
curl -i "https://mirror/index?apikey=APIKEY&apipass=APIPASS\
&api=json&act=serverprocesses&sid=XXXXXX&process=mysqld\
&datetime=201806290734&for_datetime=201806290634"
The above command returns JSON structured like this:
{
"uid": "XXXXXX",
"act": "serverprocesses",
"timezone": 0,
"timenow": 1530258921,
"email": "emailid",
"username": "XXXXXX",
"mainuser": "XXXXXX",
"user_type": null,
"preferences": {
"theme": "default",
"language": "english",
"timezone": 0,
"timezone_adjust": 0
},
"url": "index?",
"num_incidents": "17",
"mirror_incidents": "eu.pinguzo.com",
"title": "Pinguzo",
"process": {
"process_list": [
{
"user": "mysql",
"percent_cpu": "6.4",
"percent_ram": "17.3",
"resident_mem": "2776492",
"virtual_mem": "5756996",
"full_cmd": "",
"process": "mysqld"
},
{
"user": "mysql",
"percent_cpu": "3.2",
"percent_ram": "1",
"resident_mem": "171664",
"virtual_mem": "1003092",
"full_cmd": "",
"process": "mysqld"
},
{
"user": "mysql",
"percent_cpu": "1.7",
"percent_ram": "1",
"resident_mem": "172756",
"virtual_mem": "960608",
"full_cmd": "",
"process": "mysqld"
}
],
"to": 201806290734,
"from": "201806290334",
"stats": {
"count": {
"k-400": [
-400,
3
],
"k-399": [
-399,
3
],
"k-398": [
-398,
3
],
"k-397": [
-397,
3
],
"k-2": [
-2,
3
],
"k-1": [
-1,
3
],
"k0": [
0,
3
]
},
"ram": {
"k-400": [
-400,
19.1
],
"k-399": [
-399,
19.1
],
"k-398": [
-398,
19.1
],
"k-397": [
-397,
19.1
],
"k-2": [
-2,
19
],
"k-1": [
-1,
19
],
"k0": [
0,
19
]
},
"cpu": {
"k-400": [
-400,
11.3
],
"k-399": [
-399,
11.3
],
"k-398": [
-398,
11.3
],
"k-397": [
-397,
11.3
],
"k-2": [
-2,
11.3
],
"k-1": [
-1,
11.3
],
"k0": [
0,
11.3
]
}
}
},
"time_taken": "0.081"
}
HTTP Request
https://mirror/index?apikey=APIKEY&apipass=APIPASS&api=json&act=serverprocesses&sid=XXXXXX&process=mysqld&datetime=201806290734&for_datetime=201806290634
| Name | Type | Value | Required | Description |
|---|---|---|---|---|
| act | GET | serverprocesses | yes | Get process related information |
| sid | GET | Int | yes | Server ID |
| mirror | GET | hostname | yes | Mirror of viewing server can be found in servers list api. |
| process | GET | string | yes | For given process metrics will be displayed. |
| datetime | GET | Int | no | YYYYMMDDHHii Format. For given range metrics will be displayed. |
| for_datetime | GET | Int | no | YYYYMMDDHHii Format. If specified, for given point data will displayed else end point data will be considered. |
Websites
Get Websites
curl -i "https://cp.pinguzo.com/index?apikey=APIKEY&apipass=APIPASS\
&api=json&act=websites"
The above command returns JSON structured like this:
{
"uid": "XXXXXX",
"act": "websites",
"timezone": 0,
"timenow": 1530265658,
"email": "EmailID",
"username": "XXXXXX",
"mainuser": "XXXXXX",
"user_type": null,
"preferences": {
"theme": "default",
"language": "english",
"timezone": 0,
"timezone_adjust": 0
},
"url": "index?",
"num_incidents": "16",
"mirror_incidents": "eu.pinguzo.com",
"title": "Pinguzo",
"websites": {
"kXXXXXX": {
"cid": "XXXXXX",
"uid": "XXXXXX",
"name": "Server 1",
"address": "https:\/\/server1.com",
"port": "0",
"use_ssl": "1",
"check_type": "HTTP",
"interval_sec": "60",
"username": "",
"use_ipv6": "0",
"post_data": "",
"headers": "N;",
"added_time": "1481202014",
"started_time": "1481202121",
"last_update": "1530265561",
"current_status": "1",
"load_time": "449",
"resolved_ip": "XXXXXX",
"uptime": "207599.000",
"availability": "99.370",
"availability_weekly": "99.968",
"availability_monthly": "99.990",
"mirror": "qc-ca.pinguzo.com"
},
"kXXXXXX": {
"cid": "XXXXXX",
"uid": "XXXXXX",
"name": "Server 2",
"address": "https:\/\/server2.com",
"port": "0",
"use_ssl": "1",
"check_type": "HTTP",
"interval_sec": "60",
"username": "",
"use_ipv6": "0",
"post_data": "",
"headers": "N;",
"added_time": "1481202043",
"started_time": "1481202121",
"last_update": "1530265561",
"current_status": "1",
"load_time": "523",
"resolved_ip": "XXXXXX",
"uptime": "1913340.000",
"availability": "99.276",
"availability_weekly": "100.000",
"availability_monthly": "99.980",
"mirror": "qc-ca.pinguzo.com"
}
},
"page": {
"maxNum": "7",
"len": 50,
"start": 0
},
"time_taken": "0.016"
}
HTTP Request
https://cp.pinguzo.com/index?apikey=APIKEY&apipass=APIPASS&api=json&act=websites
| Name | Type | Value | Required | Description |
|---|---|---|---|---|
| act | GET | websites | yes | Get list of websites |
| search | GET | string | no | Searches for website name, cid |
| page | GET | Int | no | Page No |
| reslen | GET | Int | no | Default page length is 50 |
View Website
curl -i "http://mirror/index?apikey=APIKEY&apipass=APIPASS\
&api=json&act=viewcheck&cid=XXXXXX\
&from=201806290349&to=201806290359"
The above command returns JSON structured like this:
{
"uid": "XXXXXX",
"act": "viewcheck",
"timezone": 0,
"timenow": 1530267836,
"email": "EmailID",
"username": "XXXXXX",
"mainuser": "XXXXXX",
"user_type": null,
"preferences": {
"theme": "default",
"language": "english",
"timezone": 0,
"timezone_adjust": 0
},
"url": "index?",
"num_incidents": "16",
"mirror_incidents": "eu.pinguzo.com",
"title": "Pinguzo",
"check": {
"cid": "XXXXXX",
"uid": "XXXXXX",
"name": "Server 1",
"address": "https:\/\/server1.com",
"port": "0",
"use_ssl": "1",
"check_type": "HTTP",
"interval_sec": "60",
"username": "",
"use_ipv6": "0",
"post_data": "",
"headers": "N;",
"added_time": "1481202043",
"started_time": "1481202121",
"last_update": "1530267781",
"current_status": "1",
"load_time": "455",
"resolved_ip": "95.216.26.197",
"uptime": "1915560.000",
"availability": "99.276",
"availability_weekly": "100.000",
"availability_monthly": "99.980",
"mirror": "qc-ca.pinguzo.com"
},
"data": {
"TIME": 1530267836,
"from": 201806290349,
"to": 201806290359,
"datetime": "201806290349",
"dns": [
[
0,
0
],
[
-2,
0.002
],
[
-3,
0
],
[
-4,
0
]
],
"connect": [
[
0,
0.025
],
[
-2,
0.112
],
[
-3,
0.045
],
[
-4,
0.125
]
],
"starttransfer": [
[
0,
0.111
],
[
-2,
0.686
],
[
-3,
0.193
],
[
-4,
0.576
]
],
"total": [
[
0,
0.111
],
[
-2,
0.686
],
[
-3,
0.193
],
[
-4,
0.576
]
],
"logs": {
"k708041": {
"clid": "708041",
"cid": "1533",
"datetime": "201806290359",
"time": "1530244742",
"total_time": "0.113",
"resolved_to_ip": "95.216.26.197",
"failed": "0",
"location": 0
},
"k708040": {
"clid": "708040",
"cid": "1533",
"datetime": "201806290358",
"time": "1530244683",
"total_time": "0.459",
"resolved_to_ip": "95.216.26.197",
"failed": "0",
"location": 1
},
"k708039": {
"clid": "708039",
"cid": "1533",
"datetime": "201806290357",
"time": "1530244623",
"total_time": "0.162",
"resolved_to_ip": "95.216.26.197",
"failed": "0",
"location": 2
},
"k708038": {
"clid": "708038",
"cid": "1533",
"datetime": "201806290356",
"time": "1530244563",
"total_time": "0.711",
"resolved_to_ip": "95.216.26.197",
"failed": "0",
"location": 3
}
},
"locations": [
{
"region": "Florence",
"country": "Italy",
"flag": "it"
},
{
"region": "Las Vegas",
"country": "United States",
"flag": "us"
},
{
"region": "Paris",
"country": "France",
"flag": "fr"
},
{
"region": "Quebec",
"country": "Canada",
"flag": "ca"
}
],
"load_avg_hourly_max": "255",
"load_avg_hourly": {
"k2018062903": {
"datetime": "2018062903",
"avg_resp": "255"
}
},
"status_logs": {
"k201806290349": {
"datetime": 201806290349,
"time": 1530244140,
"status": "1"
}
}
},
"page_hourly": {
"maxNum": "1",
"len": 50,
"start": 0
},
"page_logs": {
"maxNum": "9",
"len": 50,
"start": 0
},
"page_status": {
"maxNum": 1,
"len": 50,
"start": 0
},
"time_taken": "0.130"
}
HTTP Request
http://mirror/index?apikey=APIKEY&apipass=APIPASS&api=json&act=viewcheck&cid=XXXXXX&from=201806290349&to=201806290359
| Name | Type | Value | Required | Description |
|---|---|---|---|---|
| act | GET | viewcheck | yes | Get metrics of website |
| cid | GET | Int | yes | Check ID |
| mirror | GET | hostname | yes | Mirror of viewing check |
| from | GET | Int | no | YYYYMMDDHHii Format. For given range metrics will be displayed |
| to | GET | Int | no | YYYYMMDDHHii Format. For given range metrics will be displayed |
Checks
Get Checks
curl -i "https://cp.pinguzo.com/index?apikey=APIKEY&apipass=APIPASS\
&api=json&act=checks"
The above command returns JSON structured like this:
{
"uid": "XXXXXX",
"act": "checks",
"timezone": 0,
"timenow": 1530273498,
"email": "EmailID",
"username": "XXXXXX",
"mainuser": "XXXXXX",
"user_type": null,
"preferences": {
"theme": "default",
"language": "english",
"timezone": 0,
"timezone_adjust": 0
},
"url": "index?",
"num_incidents": "16",
"mirror_incidents": "eu.pinguzo.com",
"title": "Pinguzo",
"checks": {
"k3838": {
"cid": "XXXXXX",
"uid": "XXXXXX",
"name": "test Blacklist",
"address": "compilor.com",
"port": "0",
"use_ssl": "0",
"check_type": "BLACKLIST",
"interval_sec": "60",
"username": "",
"use_ipv6": "0",
"post_data": null,
"string_expect": "",
"dns_server": "",
"headers": null,
"added_time": "0",
"started_time": "1491305762",
"last_update": "1530273422",
"current_status": "0",
"load_time": "1079",
"resolved_ip": "",
"uptime": "168663.000",
"availability": "76.745",
"availability_weekly": "20.145",
"availability_monthly": "18.339",
"mirror": "qc-ca.pinguzo.com"
},
"k11592": {
"cid": "XXXXXX",
"uid": "XXXXXX",
"name": "pinguzo.com",
"address": "pinguzo.com",
"port": "0",
"use_ssl": "0",
"check_type": "BLACKLIST",
"interval_sec": "60",
"username": "",
"use_ipv6": "0",
"post_data": null,
"string_expect": "",
"dns_server": "",
"headers": null,
"added_time": "0",
"started_time": "1529408702",
"last_update": "1530273421",
"current_status": "1",
"load_time": "2341",
"resolved_ip": "",
"uptime": "850329.000",
"availability": "99.993",
"availability_weekly": "100.000",
"availability_monthly": "99.998",
"mirror": "lv-us.pinguzo.com"
}
},
"page": {
"maxNum": "2",
"len": 50,
"start": 0
},
"time_taken": "0.015"
}
HTTP Request
https://cp.pinguzo.com/index?apikey=APIKEY&apipass=APIPASS&api=json&act=checks
| Name | Type | Value | Required | Description |
|---|---|---|---|---|
| act | GET | checks | yes | Get list of checks |
| search | GET | string | no | Searches for website name, cid |
| page | GET | Int | no | Get the requested page servers |
| reslen | GET | Int | no | Default page length is 50 |
View Check Metrics
curl -i "https://mirror/index?apikey=APIKEY&apipass=APIPASS\
&api=json&act=viewcheck&cid=XXXXXX\
&from=201806290349&to=201806290359"
The above command returns JSON structured like this:
{
"uid": "XXXXXX",
"act": "viewcheck",
"timezone": 0,
"timenow": 1530267836,
"email": "EmailID",
"username": "XXXXXX",
"mainuser": "XXXXXX",
"user_type": null,
"preferences": {
"theme": "default",
"language": "english",
"timezone": 0,
"timezone_adjust": 0
},
"url": "index?",
"num_incidents": "16",
"mirror_incidents": "eu.pinguzo.com",
"title": "Pinguzo",
"check": {
"cid": "XXXXXX",
"uid": "XXXXXX",
"name": "Server 1",
"address": "https:\/\/server1.com",
"port": "0",
"use_ssl": "1",
"check_type": "HTTP",
"interval_sec": "60",
"username": "",
"use_ipv6": "0",
"post_data": "",
"headers": "N;",
"added_time": "1481202043",
"started_time": "1481202121",
"last_update": "1530267781",
"current_status": "1",
"load_time": "455",
"resolved_ip": "95.216.26.197",
"uptime": "1915560.000",
"availability": "99.276",
"availability_weekly": "100.000",
"availability_monthly": "99.980",
"mirror": "qc-ca.pinguzo.com"
},
"data": {
"TIME": 1530267836,
"from": 201806290349,
"to": 201806290359,
"datetime": "201806290349",
"dns": [
[
0,
0
],
[
-2,
0.002
],
[
-3,
0
],
[
-4,
0
]
],
"connect": [
[
0,
0.025
],
[
-2,
0.112
],
[
-3,
0.045
],
[
-4,
0.125
]
],
"starttransfer": [
[
0,
0.111
],
[
-2,
0.686
],
[
-3,
0.193
],
[
-4,
0.576
]
],
"total": [
[
0,
0.111
],
[
-2,
0.686
],
[
-3,
0.193
],
[
-4,
0.576
]
],
"logs": {
"k708041": {
"clid": "708041",
"cid": "1533",
"datetime": "201806290359",
"time": "1530244742",
"total_time": "0.113",
"resolved_to_ip": "95.216.26.197",
"failed": "0",
"location": 0
},
"k708040": {
"clid": "708040",
"cid": "1533",
"datetime": "201806290358",
"time": "1530244683",
"total_time": "0.459",
"resolved_to_ip": "95.216.26.197",
"failed": "0",
"location": 1
},
"k708039": {
"clid": "708039",
"cid": "1533",
"datetime": "201806290357",
"time": "1530244623",
"total_time": "0.162",
"resolved_to_ip": "95.216.26.197",
"failed": "0",
"location": 2
},
"k708038": {
"clid": "708038",
"cid": "1533",
"datetime": "201806290356",
"time": "1530244563",
"total_time": "0.711",
"resolved_to_ip": "95.216.26.197",
"failed": "0",
"location": 3
}
},
"locations": [
{
"region": "Florence",
"country": "Italy",
"flag": "it"
},
{
"region": "Las Vegas",
"country": "United States",
"flag": "us"
},
{
"region": "Paris",
"country": "France",
"flag": "fr"
},
{
"region": "Quebec",
"country": "Canada",
"flag": "ca"
}
],
"load_avg_hourly_max": "255",
"load_avg_hourly": {
"k2018062903": {
"datetime": "2018062903",
"avg_resp": "255"
}
},
"status_logs": {
"k201806290349": {
"datetime": 201806290349,
"time": 1530244140,
"status": "1"
}
}
},
"page_hourly": {
"maxNum": "1",
"len": 50,
"start": 0
},
"page_logs": {
"maxNum": "9",
"len": 50,
"start": 0
},
"page_status": {
"maxNum": 1,
"len": 50,
"start": 0
},
"time_taken": "0.130"
}
HTTP Request
https://mirror/index?apikey=APIKEY&apipass=APIPASS&api=json&act=viewcheck&cid=XXXXXX&from=201806290349&to=201806290359
| Name | Type | Value | Required | Description |
|---|---|---|---|---|
| act | GET | viewcheck | yes | Get metrics of check |
| cid | GET | Int | yes | Check ID |
| mirror | GET | hostname | yes | Mirror of viewing check |
| from | GET | Int | no | YYYYMMDDHHii Format. For given range metrics will be displayed |
| to | GET | Int | no | YYYYMMDDHHii Format. For given range metrics will be displayed |
Incidents
Get Incidents
curl -i "https://inci_mirror/index?apikey=APIKEY&apipass=APIPASS\
&api=json&act=incidents&sids[]=1-XXXXXX&reslen=5"
The above command returns JSON structured like this:
{
"uid": "XXXXXX",
"act": "incidents",
"timezone": 0,
"timenow": 1530518555,
"email": "EmailID",
"username": "XXXXXX",
"mainuser": "XXXXXX",
"user_type": null,
"preferences": {
"theme": "default",
"language": "english",
"timezone": 0,
"timezone_adjust": 0
},
"url": "index?",
"num_incidents": "18",
"mirror_incidents": "eu.pinguzo.com",
"title": "Pinguzo",
"incident_counts": [
{
"199": {
"num": 426
},
"209": {
"num": 430
},
"582": {
"num": 423
},
"756": {
"num": 430
}
},
{
"10": {
"num": 437
},
"102": {
"num": 436
},
"119": {
"num": 433
},
"3837": {
"num": 409
}
}
],
"sat_catwise": {
"Disk": {
"12": 12,
"11": 11,
"13": 13,
"14": 14
},
"CPU": {
"21": 21,
"31": 31,
"22": 22,
"23": 23,
"24": 24,
"25": 25,
"26": 26,
"27": 27,
"28": 28,
"29": 29,
"30": 30
},
"RAM": {
"51": 51,
"52": 52,
"53": 53,
"54": 54
},
"SWAP": {
"61": 61,
"62": 62
},
"System": {
"81": 81,
"92": 92
},
"File & Dir": {
"82": 82,
"83": 83
},
"Network": {
"84": 84,
"85": 85,
"101": 101,
"102": 102,
"103": 103,
"104": 104,
"105": 105,
"106": 106
},
"System Load": {
"86": 86,
"87": 87,
"88": 88
},
"Ping": {
"89": 89,
"90": 90,
"91": 91
},
"Processes": {
"121": 121,
"122": 122,
"123": 123,
"124": 124,
"125": 125
}
},
"cat_catwise": {
"HTTP": {
"11": 11,
"12": 12,
"13": 13
},
"SMTP": {
"21": 21,
"22": 22
},
"POP": {
"31": 31,
"32": 32
},
"IMAP": {
"41": 41,
"42": 42
},
"PING": {
"51": 51,
"52": 52
},
"TCP": {
"61": 61,
"62": 62,
"63": 63
},
"UDP": {
"71": 71,
"72": 72,
"73": 73
},
"DNS": {
"81": 81,
"82": 82
},
"FTP": {
"91": 91,
"92": 92,
"93": 93
},
"SSH": {
"101": 101,
"102": 102
},
"RDP": {
"111": 111,
"112": 112
},
"MYSQL": {
"121": 121,
"122": 122
},
"BLACKLIST": {
"131": 131
}
},
"incidents": {
"k658569589": {
"sinid": "658569589",
"mid": "5",
"orig_mid": "4",
"itype": "1",
"sid": "XXXXXX",
"aid": "12",
"said": "3013",
"comparision": ">=",
"val_limit": "7000",
"val": "7243.273",
"val_unit": "ms",
"for_val": "",
"start_time": "1530428521",
"report_time": "1530429001",
"update_time": "1530428521",
"end_time": "1530429061",
"type": "HTTP > Load Time"
},
"k658558751": {
"sinid": "658558751",
"mid": "5",
"orig_mid": "4",
"itype": "1",
"sid": "XXXXXX",
"aid": "12",
"said": "3013",
"comparision": ">=",
"val_limit": "7000",
"val": "7238.462",
"val_unit": "ms",
"for_val": "",
"start_time": "1530427621",
"report_time": "1530428521",
"update_time": "1530427621",
"end_time": "1530428581",
"type": "HTTP > Load Time"
},
"k658553226": {
"sinid": "658553226",
"mid": "5",
"orig_mid": "4",
"itype": "1",
"sid": "XXXXXX",
"aid": "12",
"said": "3013",
"comparision": ">=",
"val_limit": "7000",
"val": "7346.457",
"val_unit": "ms",
"for_val": "",
"start_time": "1530427321",
"report_time": "1530428221",
"update_time": "1530427321",
"end_time": "1530428282",
"type": "HTTP > Load Time"
},
"k658547602": {
"sinid": "658547602",
"mid": "5",
"orig_mid": "4",
"itype": "1",
"sid": "XXXXXX",
"aid": "11",
"said": "3012",
"comparision": "!=",
"val_limit": "200",
"val": "0",
"val_unit": "",
"for_val": "",
"start_time": "1530427021",
"report_time": "1530427921",
"update_time": "1530427021",
"end_time": "1530427982",
"type": "HTTP > Response Code"
},
"k656902125": {
"sinid": "656902125",
"mid": "5",
"orig_mid": "4",
"itype": "1",
"sid": "XXXXXX",
"aid": "12",
"said": "3013",
"comparision": ">=",
"val_limit": "7000",
"val": "7192.681",
"val_unit": "ms",
"for_val": "",
"start_time": "1530343321",
"report_time": "1530343621",
"update_time": "1530343321",
"end_time": "1530343682",
"type": "HTTP > Load Time"
}
},
"page": {
"maxNum": 268855,
"len": 5,
"start": 0
},
"time_taken": "0.004"
}
HTTP Request
https://inci_mirror/index?apikey=APIKEY&apipass=APIPASS&api=json&act=incidents&sids[]=1-1532&reslen=5
| Name | Type | Value | Required | Description |
|---|---|---|---|---|
| act | GET | incidents | yes | Get all pages |
| inci_mirror | GET | hostname | yes | Hostname where all the users incidents can be found |
| sids | GET | type-id | no | Type (0 - for server 1 - for checks), id (check or server id) by default all incidents are displayed |
| nocount | GET | Boolean | no | Gives incidents counts for each server check |
| reslen | GET | INT | no | Incident page length |
Notifications
Get Notifications
curl -i "https://cp.pinguzo.com/index?apikey=APIKEY&apipass=APIPASS\
&api=json&act=notifications"
The above command returns JSON structured like this:
{
"uid": "XXXXXX",
"act": "notifications",
"timezone": 0,
"timenow": 1530341798,
"email": "EmailID",
"username": "XXXXXX",
"mainuser": "XXXXXX",
"user_type": null,
"preferences": {
"theme": "default",
"language": "english",
"timezone": 0,
"timezone_adjust": 0
},
"url": "index?",
"num_incidents": "19",
"mirror_incidents": "eu.pinguzo.com",
"title": "Pinguzo",
"user_noti": {
"83": {
"nid": "83",
"uid": "XXXXXX",
"name": "Default Email",
"noti_type": "Email",
"settings": {
"email": "EmailID"
},
"validated": "1468337483"
},
"730": {
"nid": "730",
"uid": "XXXXXX",
"name": "XXXXXX",
"noti_type": "HipChat",
"settings": {
"api_token": "XXXXXX",
"rm_name_id": "XXXXXX",
"desktop_noti": 1
},
"validated": "1475058135"
}
},
"noti_types": {
"Group": [
"id",
"name"
],
"Email": [
"email"
],
"Webhook": [
"url"
],
"Pushbullet": [
"api_token"
],
"Pagerduty": [
"api_key"
],
"HipChat": [
"api_token",
"rm_name_id",
"desktop_noti"
],
"Slack": [
"api_token",
"channel"
],
"Mobile": [
"call_code",
"mobile_num"
],
"Flock": [
"flock_webhook_id"
],
"Telegram": [
"username",
"chat_id"
],
"Twitter": [
"username"
],
"Pushover": [
"user_key",
"api_token"
],
"Discord": [
"url"
]
},
"call_codes": [
[
93,
"Afghanistan"
],
[
355,
"Albania"
],
[
213,
"Algeria"
],
[
1,
"U.S. Virgin Islands"
],
[
376,
"Andorra"
],
[
244,
"Angola"
],
[
54,
"Argentina"
],
[
374,
"Armenia"
],
[
297,
"Aruba"
],
[
247,
"Ascension"
],
[
356,
"Malta"
],
[
692,
"Marshall Islands"
],
[
596,
"Martinique"
],
[
222,
"Mauritania"
],
[
230,
"Mauritius"
],
[
262,
"Reunion"
],
[
52,
"Mexico"
],
[
691,
"Micronesia"
],
[
373,
"Moldova"
],
[
377,
"Monaco"
],
[
976,
"Mongolia"
],
[
382,
"Montenegro"
],
[
212,
"Morocco"
],
[
258,
"Mozambique"
],
[
95,
"Myanmar"
],
[
264,
"Namibia"
],
[
674,
"Nauru"
],
[
977,
"Nepal"
],
[
31,
"Netherlands"
],
[
599,
"Netherlands Antilles"
],
[
687,
"New Caledonia"
],
[
64,
"New Zealand"
],
[
505,
"Nicaragua"
],
[
227,
"Niger"
],
[
234,
"Nigeria"
],
[
683,
"Niue Island"
],
[
850,
"North Korea"
],
[
47,
"Norway"
],
[
968,
"Oman"
],
[
92,
"Pakistan"
],
[
680,
"Palau"
],
[
507,
"Panama"
],
[
675,
"Papua New Guinea"
],
[
595,
"Paraguay"
],
[
51,
"Peru"
],
[
63,
"Philippines"
],
[
48,
"Poland"
],
[
351,
"Portugal"
],
[
974,
"Qatar"
],
[
380,
"Ukraine"
],
[
971,
"United Arab Emirates"
],
[
44,
"United Kingdom"
],
[
598,
"Uruguay"
],
[
998,
"Uzbekistan"
],
[
678,
"Vanuatu"
],
[
379,
"Vatican City"
],
[
58,
"Venezuela"
],
[
84,
"Vietnam"
],
[
681,
"Wallis and Futuna"
],
[
967,
"Yemen"
],
[
260,
"Zambia"
],
[
263,
"Zimbabwe"
]
],
"time_taken": "0.002"
}
HTTP Request
https://cp.pinguzo.com/index?apikey=APIKEY&apipass=APIPASS&api=json&act=notifications
| Name | Type | Value | Required | Description |
|---|---|---|---|---|
| act | GET | notifications | yes | Get notifications |
View Notification Groups
curl -i "https://cp.pinguzo.com/index?apikey=APIKEY&apipass=APIPASS\
&api=json&act=noti_groups"
The above command returns JSON structured like this:
{
"uid": "XXXXXX",
"act": "noti_groups",
"timezone": 0,
"timenow": 1530351357,
"email": "EmailID",
"username": "XXXXXX",
"mainuser": "XXXXXX",
"user_type": null,
"preferences": {
"theme": "default",
"language": "english",
"timezone": 0,
"timezone_adjust": 0
},
"url": "index?",
"num_incidents": "18",
"mirror_incidents": "eu.pinguzo.com",
"title": "Pinguzo",
"noti_groups": {
"2124": {
"nid": "2124",
"name": "test",
"notifications": {
"83": {
"nid": "83",
"name": "Default Email",
"noti_type": "Email"
},
"1154": {
"nid": "1154",
"name": "XXXXXX",
"noti_type": "Email"
}
},
"userinfo": {
"uid": "77075",
"username": "username",
"user_type": "1"
}
}
},
"time_taken": "0.006"
}
HTTP Request
https://cp.pinguzo.com/index?apikey=APIKEY&apipass=APIPASS&api=json&act=noti_groups
| Name | Type | Value | Required | Description |
|---|---|---|---|---|
| act | GET | noti_groups | yes | Get notifications groups |
Pages
Get All Pages
curl -i "https://cp.pinguzo.com/index?apikey=APIKEY&apipass=APIPASS\
&api=json&act=pages"
The above command returns JSON structured like this:
{
"uid": "XXXXXX",
"act": "pages",
"timezone": 0,
"timenow": 1530351841,
"email": "EmailID",
"username": "XXXXXX",
"mainuser": "XXXXXX",
"user_type": null,
"preferences": {
"theme": "default",
"language": "english",
"timezone": 0,
"timezone_adjust": 0
},
"url": "index?",
"num_incidents": "17",
"mirror_incidents": "eu.pinguzo.com",
"title": "Pinguzo",
"mid": "2",
"pages": {
"28": {
"pid": "28",
"uid": "XXXXXX",
"name": "testPages",
"twitter_handle": "nixstats",
"subdomain": "testme",
"views": "0",
"servers": "XXXXXX,XXXXXX",
"websites": null,
"checks": "XXXXXX, XXXXXX"
}
},
"servers": {
"XXXXXX": "Server1",
"XXXXXX": "Server2",
},
"checks": {
"XXXXXX": "Check1",
"XXXXXX": "Check2"
},
"time_taken": "0.008"
}
HTTP Request
https://cp.pinguzo.com/index?apikey=APIKEY&apipass=APIPASS&api=json&act=pages
| Name | Type | Value | Required | Description |
|---|---|---|---|---|
| act | GET | pages | yes | Get pages |
Sub Users
Get Sub Users
curl -i "https://cp.pinguzo.com/index?apikey=APIKEY&apipass=APIPASS\
&api=json&act=users"
The above command returns JSON structured like this:
{
"uid": "XXXXXX",
"act": "users",
"timezone": 0,
"timenow": 1530351626,
"email": "EmailID",
"username": "XXXXXX",
"mainuser": "XXXXXX",
"user_type": null,
"preferences": {
"theme": "default",
"language": "english",
"timezone": 0,
"timezone_adjust": 0
},
"url": "index?",
"num_incidents": "18",
"mirror_incidents": "eu.pinguzo.com",
"title": "Pinguzo",
"users": {
"XXXXXX": {
"uid": "XXXXXX",
"username": "XXXXXX",
"email": "EmailID",
"user_type": "1",
"first_name": "first",
"last_name": "last"
},
"XXXXXX": {
"uid": "XXXXXX",
"username": "bhavesh556",
"email": "EmailID",
"user_type": "1",
"first_name": "first1",
"last_name": "last1"
}
},
"time_taken": "0.023"
}
HTTP Request
https://cp.pinguzo.com/index?apikey=APIKEY&apipass=APIPASS&api=json&act=users
| Name | Type | Value | Required | Description |
|---|---|---|---|---|
| act | GET | users | yes | Get sub users |