A PHP wrapper for the updown.io API
Switch branches/tags
Nothing to show
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.
src
.gitignore
LICENSE
README.md
composer.json

README.md

updown-php

A PHP wrapper for the updown.io API.

You need your API_KEY from your account's settings page to use this. Visit updown.io API documentation to see all settings you can use.

Requirements

  • PHP 5.4.0 or newer

Installation

The best way to install this package is through composer by running:

composer require fakiolinho/updown-php:~1.0

You could also add it in your project's composer.json file:

"require": {
	"fakiolinho/updown-php": "~1.0"
}

Then run:

composer update

Usage

All examples use the Composer autoloader.

List all your checks

<?php
require 'vendor/autoload.php';

use Foinikas\Updown\Updown;

$updown = new Updown(API_KEY);

$response = $updown->checks();

Show a single project's checks

<?php
require 'vendor/autoload.php';

use Foinikas\Updown\Updown;

$updown = new Updown(API_KEY);

$response = $updown->check(TOKEN);

Get all the downtimes of a check (paginated, 100 per call)

<?php
require 'vendor/autoload.php';

use Foinikas\Updown\Updown;

$updown = new Updown(API_KEY);

$response = $updown->downtimes(TOKEN);
$response = $updown->downtimes(TOKEN, ['page' => 2]);

Get detailed metrics about the check

<?php
require 'vendor/autoload.php';

use Foinikas\Updown\Updown;

$updown = new Updown(API_KEY);

$response = $updown->metrics(TOKEN);
$response = $updown->metrics(TOKEN, ['group' => 'host']);