Skip to content
PHP
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github/ISSUE_TEMPLATE
src
tests
.editorconfig
.gitattributes
.gitignore
.scrutinizer.yml
.travis.yml
CODE_OF_CONDUCT.md
LICENSE
README.md
composer.json
phpunit.xml.dist

README.md

updown

UpDown.io PHP SDK

Build Status Code Coverage Build Status

Documentation

Now you can find compete documentation here

Frameworks

Getting started

First of all you need a UpDown.io account.

Further info/documentation will be ready ASAP.

Installation

You can install the package via composer:

composer require biscolab/updown-php-sdk

Configuration

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 
UpDown::init([
    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 updown.io.

Usage

Create Check object on updown.io

$check = new Check($attributes);
$check->create();

Read Check data from updown.io

$check = new Check($token);
$check->read();

// 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 updown.io

$check = new Check($token);
$check->update($attributes);

Delete Check from updown.io

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

Get Check "Metrics" from updown.io

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

Get Check "Downtimes" from updown.io

$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

License

MIT License

You can’t perform that action at this time.