From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from firstgate.proxmox.com (firstgate.proxmox.com [212.224.123.68]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits)) (No client certificate requested) by lists.proxmox.com (Postfix) with ESMTPS id AE543973C for ; Thu, 3 Aug 2023 14:18:10 +0200 (CEST) Received: from firstgate.proxmox.com (localhost [127.0.0.1]) by firstgate.proxmox.com (Proxmox) with ESMTP id 31E8227A8 for ; Thu, 3 Aug 2023 14:17:36 +0200 (CEST) Received: from proxmox-new.maurer-it.com (proxmox-new.maurer-it.com [94.136.29.106]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits)) (No client certificate requested) by firstgate.proxmox.com (Proxmox) with ESMTPS for ; Thu, 3 Aug 2023 14:17:34 +0200 (CEST) Received: from proxmox-new.maurer-it.com (localhost.localdomain [127.0.0.1]) by proxmox-new.maurer-it.com (Proxmox) with ESMTP id DB2E94265C for ; Thu, 3 Aug 2023 14:17:33 +0200 (CEST) From: Lukas Wagner To: pve-devel@lists.proxmox.com Date: Thu, 3 Aug 2023 14:17:01 +0200 Message-Id: <20230803121719.519207-13-l.wagner@proxmox.com> X-Mailer: git-send-email 2.39.2 In-Reply-To: <20230803121719.519207-1-l.wagner@proxmox.com> References: <20230803121719.519207-1-l.wagner@proxmox.com> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-SPAM-LEVEL: Spam detection results: 0 AWL -0.053 Adjusted score from AWL reputation of From: address BAYES_00 -1.9 Bayes spam probability is 0 to 1% DMARC_MISSING 0.1 Missing DMARC policy KAM_DMARC_STATUS 0.01 Test Rule for DKIM or SPF Failure with Strict Alignment SPF_HELO_NONE 0.001 SPF: HELO does not publish an SPF Record SPF_PASS -0.001 SPF: sender matches SPF record T_SCC_BODY_TEXT_LINE -0.01 - Subject: [pve-devel] [PATCH v6 pve-manager 12/30] api: notification: allow fetching notification targets X-BeenThere: pve-devel@lists.proxmox.com X-Mailman-Version: 2.1.29 Precedence: list List-Id: Proxmox VE development discussion List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Thu, 03 Aug 2023 12:18:10 -0000 The API call returns all entities that can be used as notification targets (endpoints, groups). Only targets for which the user has appropriate permissions are returned. Signed-off-by: Lukas Wagner --- PVE/API2/Cluster/Notifications.pm | 81 +++++++++++++++++++++++++++++++ 1 file changed, 81 insertions(+) diff --git a/PVE/API2/Cluster/Notifications.pm b/PVE/API2/Cluster/Notifications.pm index b4db7f8e..d6f29291 100644 --- a/PVE/API2/Cluster/Notifications.pm +++ b/PVE/API2/Cluster/Notifications.pm @@ -96,6 +96,7 @@ __PACKAGE__->register_method ({ { name => 'endpoints' }, { name => 'filters' }, { name => 'groups' }, + { name => 'targets' }, ]; return $result; @@ -130,6 +131,86 @@ __PACKAGE__->register_method ({ } }); +__PACKAGE__->register_method ({ + name => 'get_all_targets', + path => 'targets', + method => 'GET', + description => 'Returns a list of all entities that can be used as notification targets' . + ' (endpoints and groups).', + permissions => { + description => "Only lists entries where you have 'Mapping.Modify', 'Mapping.Use' or" + . " 'Mapping.Audit' permissions on '/mapping/notification/'.", + user => 'all', + }, + protected => 1, + parameters => { + additionalProperties => 0, + properties => {}, + }, + returns => { + type => 'array', + items => { + type => 'object', + properties => { + name => { + description => 'Name of the endpoint/group.', + type => 'string', + format => 'pve-configid', + }, + 'type' => { + description => 'Type of the endpoint or group.', + type => 'string', + enum => [qw(sendmail gotify group)], + }, + 'comment' => { + description => 'Comment', + type => 'string', + optional => 1, + }, + }, + }, + links => [ { rel => 'child', href => '{name}' } ], + }, + code => sub { + my $config = PVE::Notify::read_config(); + my $rpcenv = PVE::RPCEnvironment::get(); + + my $targets = eval { + my $result = []; + + for my $target (@{$config->get_sendmail_endpoints()}) { + push @$result, { + name => $target->{name}, + comment => $target->{comment}, + type => 'sendmail', + }; + } + + for my $target (@{$config->get_gotify_endpoints()}) { + push @$result, { + name => $target->{name}, + comment => $target->{comment}, + type => 'gotify', + }; + } + + for my $target (@{$config->get_groups()}) { + push @$result, { + name => $target->{name}, + comment => $target->{comment}, + type => 'group', + }; + } + + $result + }; + + raise_api_error($@) if $@; + + return filter_entities_by_privs($rpcenv, $targets); + } +}); + my $group_properties = { name => { description => 'Name of the group.', -- 2.39.2