LibreNMS/Alert/Transport/Ukfastpss.php
<?php
/* Copyright (C) 2020 Raphael Dannecker <rdannecker@gmail.com>
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>. */
/**
* UKFastPSS Transport
*
* @author Lee Spottiswood (github.com/0x4c6565)
* @copyright 2021, LibreNMS
* @license GPL
*/
namespace LibreNMS\Alert\Transport;
use LibreNMS\Alert\Transport;
use LibreNMS\Exceptions\AlertTransportDeliveryException;
use LibreNMS\Util\Http;
class Ukfastpss extends Transport
{
protected string $name = 'UKFast PSS';
public function deliverAlert(array $alert_data): bool
{
$apiKey = $this->config['api-key'];
$author = $this->config['author'];
$secure = $this->config['secure'];
$priority = $this->config['priority'];
$body = [
'author' => [
'id' => $author,
],
'secure' => ($secure == 'on'),
'subject' => $alert_data['title'],
'details' => $alert_data['msg'],
'priority' => $priority,
];
$res = Http::client()
->withHeaders([
'Authorization' => $apiKey,
'Content-Type' => 'application/json',
'Accept' => 'application/json',
])
->post('https://api.ukfast.io/pss/v1/requests', $body);
if ($res->successful()) {
return true;
}
throw new AlertTransportDeliveryException($alert_data, $res->status(), $res->body(), $alert_data['msg'], $body);
}
public static function configTemplate(): array
{
return [
'config' => [
[
'title' => 'API Key',
'name' => 'api-key',
'descr' => 'API key to use for authentication',
'type' => 'password',
],
[
'title' => 'Author',
'name' => 'author',
'descr' => 'Author ID for new PSS request',
'type' => 'text',
],
[
'title' => 'Priority',
'name' => 'priority',
'descr' => 'Priority of request. Defaults to "Normal"',
'type' => 'select',
'options' => [
'Normal' => 'Normal',
'High' => 'High',
'Critical' => 'Critical',
],
'default' => 'Normal',
],
[
'title' => 'Secure',
'name' => 'secure',
'descr' => 'Specifies whether created request should be secure',
'type' => 'checkbox',
'default' => true,
],
],
'validation' => [
'api-key' => 'required',
'author' => 'required',
],
];
}
}