New-PveClusterNotificationsEndpointsWebhook

Create a new webhook endpoint

API: POST /cluster/notifications/endpoints/webhook, Proxmox VE API viewer

Syntax

New-PveClusterNotificationsEndpointsWebhook
    [-PveTicket <PveTicket>]
    [-Body <string>]
    [-Comment <string>]
    [-Disable <bool>]
    [-Header <array>]
    -Method <string>
    -Name <string>
    [-Secret <array>]
    -Url <string>
    [<CommonParameters>]

Parameters

Parameter	Type	Required	Description
-PveTicket	PveTicket	No	Ticket data connection.
-Body	string	No	HTTP body, base64 encoded.
-Comment	string	No	Comment.
-Disable	bool	No	Disable this target.
-Header	array	No	HTTP headers to set. These have to be formatted as a property string in the format name=<name>,value=<base64 of value>.
-Method	string	Yes	HTTP method. Values: post, put, get.
-Name	string	Yes	The name of the endpoint.
-Secret	array	No	Secrets to set. These have to be formatted as a property string in the format name=<name>,value=<base64 of value>.
-Url	string	Yes	Server URL.

Every parameter also binds by property name from the pipeline, so an object with node and vmid properties (the output of Get-PveGuest, for one) fills -Node and -Vmid. Without -PveTicket the cmdlet uses the last connection, see Connection.

Output

A PveResponse: the data returned by Proxmox VE is in .Response.data, the outcome in .IsSuccessStatusCode. See Results and Errors.