panopta/php-panopta-api-client

为 Panopta API 提供了一个轻量级的 PHP 封装

1.1.0 2015-08-28 04:11 UTC

This package is not auto-updated.

Last update: 2024-09-28 18:42:16 UTC


README

Panopta REST API 提供了对 Panopta 监控服务所有配置、状态和故障管理功能的完全访问权限,包括创建和修改正在进行的监控检查、管理通知配置、响应活跃的故障以及拉取监控服务器的可用性统计数据的能力。

安装

运行 Composerrequire 命令

composer require panopta/php-panopta-api-client

将 Composer 自动加载器添加到您的项目中

require 'vendor/autoload.php';

API 文档

API 的完整文档可在 https://api2.panopta.com/v2/api-docs/ 找到。通过输入您的 API 令牌,您可以查看所有 API 方法的详细资料,并从文档页面发出 API 请求。令牌可以从控制面板设置菜单的 API 管理部分生成,该部分位于 https://my.panopta.com

用法

该库提供了对 Panopta REST API 的封装,使您可以轻松地向 API 发出 GET、POST、PUT 和 DELETE 操作。

实例化 Panopta API 客户端

$client = Panopta\ApiClient(
    'https://api2.panopta.com',
    'your-api-token',
    2, // API version
    Panopta\ApiClient::LOG_DEBUG,
    'logs/' // Log directory
);

GET

$fiveContacts = $client->get('/contact', ['limit' => 5]);

$serversWithACertainFullyQualifiedDomainName = $client->get(
    '/server',
    ['fqdn' => 'panopta.com']
);

$serverFortyTwo = $client->get('/server/42');

POST

$newNotificationSchedule = $client->post(
    '/notification_schedule',
    ['name' => 'New Notification Schedule', 'targets' => [$serverFortyTwo['url']]]
);

PUT

$updatedServerGroup = $client->put(
    '/server_group',
    [
        'name' => 'Updated Server Group',
        'notification_schedule' => $newNotificationSchedule['url']
    ]
);

DELETE

$client->delete('/contact/1');