README

Livewatch Server Monitoring API

For more information, please visit https://www.livewatch.de.

Installation & Usage

Requirements

PHP 7.3 and later. Should also work with PHP 8.0 but has not been tested.

Composer

To install the bindings via Composer, add the following to composer.json:

{
  "repositories": [
    {
      "type": "vcs",
      "url": "https://github.com/livewatch-monitoring/livewatch-php-client.git"
    }
  ],
  "require": {
    "livewatch-monitoring/livewatch-php-client": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

<?php
require_once('/path/to/LivewatchApi/vendor/autoload.php');

Getting Started

Register your free account

To receive an API-Token, register a free account at https://www.livewatch.de After registration you will find your personal API token at https://www.livewatch.de/profile

First steps

Please follow the installation procedure and then run the following:

<?php
require_once(__DIR__ . '/vendor/autoload.php');



// Configure API key authorization: LivewatchToken
$config = LivewatchApi\Configuration::getDefaultConfiguration()->setApiKey('auth-livewatch-token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = LivewatchApi\Configuration::getDefaultConfiguration()->setApiKeyPrefix('auth-livewatch-token', 'Bearer');


$apiInstance = new LivewatchApi\Api\AccountApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);

try {
    $result = $apiInstance->accountDetails();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AccountApi->accountDetails: ', $e->getMessage(), PHP_EOL;
}

API Endpoints

All URIs are relative to https://www.livewatch.de

Class	Method	HTTP request	Description
AccountApi	accountDetails	GET /api/account	Get Account details
CheckApi	allCheckNotifications	GET /api/check/notifications	Get notifications of all checks
CheckApi	checkDetails	GET /api/check/details/{uuid}	Get details of one check
CheckApi	checkEventsByDate	POST /api/check/check/events/{uuid}	Get events of one check by date
CheckApi	checkHistory	GET /api/check/latest/{uuid}	Get history of one check
CheckApi	checkList	GET /api/check/list/{page}	List all your checks configured
CheckApi	checkNotifications	GET /api/check/notifications/{uuid}	Get notifications of one check
CheckApi	checkReport	GET /api/check/report/{uuid}	Get report of one check
CheckApi	checksByTag	POST /api/check/checks/tag	Get report of checks by Tag
CheckApi	setCheckState	POST /api/check/enable/{uuid}/{state}	Enable or disable a check
GeneralApi	listMonitoringIPs	GET /api/general/listMonitoringIPs	List all our IPs with details
UserApi	apiTokenDetails	POST /api/user/token	Get your API-Token.

Models

Authorization

LivewatchToken

Type: API key
API key parameter name: auth-livewatch-token
Location: HTTP header

Tests

To run the tests, use:

composer install
vendor/bin/phpunit

API version: 1.0.0
- Package version: 1.1.3
Build package: org.openapitools.codegen.languages.PhpClientCodegen

livewatch-monitoring / livewatch-php-client

Maintainers

Details