Websites (Monitors)

Retrieve all websites (monitors)

GET https://pingping.io/webapi/monitors

Headers

Name	Type	Description
Authentication	string	Don't forget to authenticate

        
            
                
                    
                    200
                
            
        
        [
  {
    "id": 3,
    "identifier": "iolqRzxr",
    "alias": "google.com",
    "scheme": "https",
    "host": "google.com",
    "port": "",
    "url": "https://google.com/",
    "status_page": "https://pingping.io/iolqRzxr",
    "checks": {
      "uptime": {
        "id": 5,
        "status": "ok",
        "error": null,
        "interval": 900,
        "is_enabled": true,
        "notification_threshold": 0,
        "last_check_at": "2019-10-23 14:56:03",
        "meta": {
          "http_status_code": 200,
          "average_uptime_percentage": 100,
          "average_response_time": 0.17569,
          "offline_since": null
        },
        "last_run": {
          "time_namelookup": 0.125187,
          "time_tcp_connection": 0.109253,
          "time_redirect": 0.000000,
          "time_content_generation": 0.260395,
          "time_content_transfer": 0.011066,
          "time_total": 0.505901,
          "http_status_code": 200
        }
      },
      "certificate_health": {
        "id": 6,
        "status": "ok",
        "error": null,
        "interval": 900,
        "is_enabled": true,
        "notification_threshold": 900,
        "last_check_at": "2019-10-23 14:56:10",
        "meta": {
          "issuer": "TeleSec ServerPass Class 2 CA",
          "signature_algorithm": "RSA-SHA256",
          "is_self_signed": false,
          "valid_from": "2018-12-14 05:30:26",
          "valid_to": "2020-12-19 23:59:59"
        }
      }
    }
  },
  {
    "id": 9,
    "identifier": "WtDGqzWl",
    "alias": "Laracasts",
    "scheme": "https",
    "host": "www.laracasts.com",
    "port": "",
    "url": "https://www.laracasts.com/",
    "checks": {
      "uptime": {
        "id": 17,
        "status": "none",
        "error": null,
        "interval": 900,
        "is_enabled": true,
        "last_check_at": null,
        "meta": {
          "http_status_code": null,
          "average_uptime_percentage": null,
          "average_response_time": null,
          "offline_since": null
        }
      },
      "certificate_health": {
        "id": 18,
        "status": "none",
        "error": null,
        "interval": 900,
        "is_enabled": true,
        "last_check_at": null,
        "meta": {
          "issuer": null,
          "signature_algorithm": null,
          "is_self_signed": null,
          "valid_from": null,
          "valid_to": null
        }
      }
    }
  }
]

Retrieve a specific website (monitor)

GET https://pingping.io/webapi/monitors/{id}

Path Parameters

Name	Type	Description
id	number	The monitor id that should be retrieved

Headers

Name	Type	Description
Authentication	string	Don't forget to authenticate

        
            
                
                    
                    200
                
            
        
        {
  "id": 3,
  "identifier": "iolqRzxr",
  "alias": "WEB.de",
  "scheme": "https",
  "host": "web.de",
  "port": "",
  "url": "https://web.de/",
  "status_page": "https://pingping.io/iolqRzxr",
  "checks": {
    "uptime": {
      "id": 5,
      "status": "ok",
      "error": null,
      "interval": 900,
      "is_enabled": true,
      "notification_threshold": 0,
      "last_check_at": "2019-10-23 14:56:03",
      "meta": {
        "http_status_code": 200,
        "average_uptime_percentage": 100,
        "average_response_time": 0.27569,
        "offline_since": null
      },
      "last_run": {
        "time_namelookup": 0.125187,
        "time_tcp_connection": 0.109253,
        "time_redirect": 0.000000,
        "time_content_generation": 0.260395,
        "time_content_transfer": 0.011066,
        "time_total": 0.505901,
        "http_status_code": 200
      }
    },
    "certificate_health": {
      "id": 6,
      "status": "ok",
      "error": null,
      "interval": 900,
      "is_enabled": true,
      "notification_threshold": 900,
      "last_check_at": "2019-10-23 14:56:10",
      "meta": {
        "issuer": "TeleSec ServerPass Class 2 CA",
        "signature_algorithm": "RSA-SHA256",
        "is_self_signed": false,
        "valid_from": "2018-12-14 05:30:26",
        "valid_to": "2020-12-19 23:59:59"
      }
    }
  }
}

Retrieve statistics from a specific website (monitor)

GET https://pingping.io/webapi/monitors/{id}/statistics

If you need some more statistics from a given website, this is the right endpoint for you. You'll get back the uptime and response statistics of every single day for every single website.

Path Parameters

Name	Type	Description
id	number	The monitor id that the statistics should be retrieved for.

Headers

Name	Type	Description
Authentication	string	Don't forget to authenticate

        
            
                
                    
                    200
                
            
        
        {
  "uptimes": [
    {
      "date": "2019-10-27",
      "uptime_percentage": 99,
      "downtime_in_seconds": 864
    },
    {
      "date": "2019-10-26",
      "uptime_percentage": 100,
      "downtime_in_seconds": 0
    }
  ],
  "response_times": [
    {
      "date": "2019-10-27",
      "time_namelookup": 0.001,
      "time_tcp_connection": 0.002,
      "time_redirect": 0.003,
      "time_content_generation": 0.004,
      "time_content_transfer": 0.005,
      "time_total": 0.015
    },
    {
      "date": "2019-10-26",
      "time_namelookup": 0.001,
      "time_tcp_connection": 0.002,
      "time_redirect": 0.003,
      "time_content_generation": 0.004,
      "time_content_transfer": 0.005,
      "time_total": 0.015
    }
  ]
}

Create a website (monitor)

POST https://pingping.io/webapi/monitors

Headers

Name	Type	Description
Authentication	string	Don't forget to authenticate

Request Body

Name	Type	Description
url	string	The full url you want to monitor.
alias	string	A custom name. Otherwise alias is set to the url.

        
            
                
                    
                    200
                
            
        
        {
  "id": 10,
  "identifier": "lfogzwb8",
  "alias": "test",
  "scheme": "https",
  "host": "laravel.com",
  "port": "",
  "url": "https://laravel.com/",
  "status_page": "https://pingping.io/lfogzwb8",
  "checks": {
    "uptime": {
      "id": 19,
      "status": "none",
      "error": null,
      "interval": 900,
      "is_enabled": true,
      "last_check_at": null,
      "notification_threshold": 0,
      "meta": {
        "http_status_code": null,
        "average_uptime_percentage": null,
        "average_response_time": null,
        "offline_since": null
      }
    },
    "certificate_health": {
      "id": 20,
      "status": "none",
      "error": null,
      "interval": 900,
      "is_enabled": true,
      "last_check_at": null,
      "notification_threshold": 900,
      "meta": {
        "issuer": null,
        "signature_algorithm": null,
        "is_self_signed": null,
        "valid_from": null,
        "valid_to": null
      }
    }
  }
}

Update a website (monitor)

PUT https://pingping.io/webapi/monitors/{id}

Path Parameters

Name	Type	Description
id	number	The monitor id that should be updated.

Headers

Name	Type	Description
Authentication	string	Don't forget to authenticate

Request Body

Name	Type	Description
url	string	The full url you want to monitor.
alias	string	A custom name.

        
            
                
                    
                    200
                
            
        
        {
  "id": 3,
  "identifier": "iolqRzxr",
  "alias": "WEB.de",
  "scheme": "https",
  "host": "web.de",
  "port": "",
  "url": "https://web.de/",
  "status_page": "https://pingping.io/iolqRzxr",
  "checks": {
    "uptime": {
      "id": 5,
      "status": "ok",
      "error": null,
      "interval": 900,
      "is_enabled": true,
      "notification_threshold": 900,
      "last_check_at": "2019-10-23 14:56:03",
      "meta": {
        "http_status_code": 200,
        "average_uptime_percentage": 100,
        "average_response_time": 0.27569,
        "offline_since": null
      }
    },
    "certificate_health": {
      "id": 6,
      "status": "ok",
      "error": null,
      "interval": 900,
      "is_enabled": true,
      "notification_threshold": 900,
      "last_check_at": "2019-10-23 14:56:10",
      "meta": {
        "issuer": "TeleSec ServerPass Class 2 CA",
        "signature_algorithm": "RSA-SHA256",
        "is_self_signed": false,
        "valid_from": "2018-12-14 05:30:26",
        "valid_to": "2020-12-19 23:59:59"
      }
    }
  }
}

Delete a website (monitor)

DELETE https://pingping.io/webapi/monitors/{id}

Path Parameters

Name	Type	Description
id	number	The monitor id that should be deleted.

Headers

Name	Type	Description
Authentication	string	Don't forget to authenticate

Websites (Monitors)

¶Retrieve all websites (monitors)

¶Retrieve a specific website (monitor)

¶Retrieve statistics from a specific website (monitor)

¶Create a website (monitor)

¶Update a website (monitor)

¶Delete a website (monitor)

On this page

Retrieve all websites (monitors)

Retrieve a specific website (monitor)

Retrieve statistics from a specific website (monitor)

Create a website (monitor)

Update a website (monitor)

Delete a website (monitor)