serviceuptime/api

PHP Library for ServiceUptime.com API (https://www.serviceuptime.com/users/api-docs.php)

1.0.2 2020-09-18 10:29 UTC

Requires

• php: >=7

MIT

• serviceuptime
• service uptime
• serviceuptime api
• php serviceuptime api
• service uptime api
• uptime api

README

PHP Library for ServiceUptime API (https://www.serviceuptime.com/users/api-docs.php)

Dependencies

PHP version >= 7 required.

The following PHP extensions are required:

• curl

Install

Add ServiceUptime API to your composer.json file.

{
  "require": {
    "serviceuptime/api": "*"
  }
}

Examples

Initialize api

<?php
    $suapi = new \ServiceUptime\API\API('APIKEY');
?>

Add new monitor to your ServiceUptime account

<?php
    $monitor = $suapi->addMonitor([
		"Id" => "234342",
		"Name" => "domain.com",
		"CheckPeriod" => "5",
		"ServiceType" => "http",
		"Port" => "80",
		"HostName" => "domain.com",
		"HTTPAuthLogin" => "user1",
		"HTTPAuthPassword" => "pass123",
		"SendDefaultAlert" => "y",
		"SendAltAlert" => "[e-mail];[e-mail];[e-mail]",
		"FailuresBeforeAlert" => "1",
		"SendDefaultSMS" => "n",
		"SendAltSMS" => "[phone];[phone]",
		"FailuresBeforeSMS" => "3",
		"SendJabberAlert" => "n",
		"WebHookUrl" => "",
		"Timeout" => "15",
		"DownAlertSubject" => "Domain.com (http) is Down!",
		"UpAlertSubject" => "Domain.com (http) is Up!",
		"RepeatAlerts" => "0",
		"NoUpAlerts" => "n",
		"HighPriorityAlerts" => "y",
		"Enabled" => "y",
		"PublicStatAllowed" => "y",
		"HostPage" => "domain.com",
		"Status" => "active",
		"StatusMessage" => "Monitor is UP",
		"PubStatUrl" => "http://www.serviceuptime.com/users/uptimemonitoring.php?S=e4c9e21eb1222a4adb4a1da4cbc4a653&Id=234342",
		"LastCheckDate" => "2014-07-23 13:08:12",
		"LastCheckDateFormatted" => "34 sec. ago",
		"TotalChecks" => 909600,
		"TotalOutages" => 449,
		"TotalFailedChecks" => 921,
		"TotalUptime" => 99.899,
    ]);
    print_r($monitor);
?>

Edit monitor information

<?php
    $monitor = $suapi->updateMonitor([
		"Id" => "234342",
		"ServiceType" => "http",
		"Port" => "80",
    ]);
    print_r($monitor);
?>

Remove monitor from your ServiceUptime account

<?php
    $result = $suapi->deleteMonitor([
        "Id" => "234342",
    ]);
    print_r($result);
?>

Retrieve all your monitors information including uptime statistics summary and current status info

<?php
    $monitors = $suapi->getMonitors();
    print_r($monitors);
?>

Retrieve detailed uptime report for your monitor

<?php
    $report = $suapi->getReport([
        "Id" => "367168",
        "from_date" => "2019-11-01",
        "to_date" => "2019-11-07",
    ]);
    print_r($report);
?>

Retrieve one monitor information including uptime statistics summary and current status info

<?php
    $monitor = $suapi->monitorInfo([
        "Id" => "367168",
    ]);
    print_r($monitor);
?>

Start monitoring for a paused monitor

<?php
    $result = $suapi->startMonitor([
        "Id" => "367168",
    ]);
    print_r($result);
?>

Pause monitoring for a monitor

<?php
    $result = $suapi->stopMonitor([
        "Id" => "367168",
    ]);
    print_r($result);
?>

Retrieve account information such as number of SMS credits, available monitors, default email alert, etc.

<?php
    $account = $suapi->accountInfo();
    print_r($account);
?>

Documentation

• ServiceUptime Official documentation

License

The MIT License (MIT)