Skip to content


Repository files navigation

updown PHP SDK

Build Status Code Coverage Build Status


Now you can find compete documentation here


Getting started

First of all you need a account.

Further info/documentation will be ready ASAP.


You can install the package via composer:

composer require biscolab/updown-php-sdk


API key

First of all you need an API key: Get API Key

Initialize the UpDown and create Check object

use Biscolab\UpDown\UpDown;
use Biscolab\UpDown\Objects\Check;
use Biscolab\UpDown\Fields\UpDownRequestFields;

// Initialize UpDown 
    UpDownRequestFields::API_KEY => '<YOUR_UPDOWN_API_KEY>'

// Create an empty "Check" CRUD object 
$check = new Check();

// OR

// Create an existing "Check" CRUD object 
$check = new Check($attributes);
  • $check is a CRUD object, so it has create, read, update and delete methods available.
  • $attributes could an array containing a list of attributes (Biscolab\UpDown\Fields\CheckFields) or a scalar value representing the token given by


Create Check object on

$check = new Check($attributes);

Read Check data from

$check = new Check($token);

// get data as array
$array_data = $check->toArray();

// get single value
$url = $check->{UpDownRequestFields::URL};

Use Enum values like UpDownRequestFields to avoid errors

Update Check on

$check = new Check($token);

Delete Check from

$check = new Check($token);
$deleted = $check->delete();
  • $deleted is bool, true if "ok", false if something went wrong

Get Check "Metrics" from

$check = new Check($token);
$metrics = $check->getMetrics($from, $to, $group);
  • $metrics is anf objact of class Biscolab\UpDown\Types\Metrics

Get Check "Downtimes" from

$check = new Check($token);
$downtimes = $check->getDowntimes($page);
  • $downtimes is anf objact of class Biscolab\UpDown\Types\DownTimes, a collection of Biscolab\UpDown\Types\DownTime objects


MIT License