Skip to content

Set-PveClusterNotificationsEndpointsWebhook

Update existing webhook endpoint

API: PUT /cluster/notifications/endpoints/webhook/{name}, Proxmox VE API viewer

Set-PveClusterNotificationsEndpointsWebhook
[-PveTicket <PveTicket>]
[-Body <string>]
[-Comment <string>]
[-Delete <array>]
[-Digest <string>]
[-Disable <bool>]
[-Header <array>]
[-Method <string>]
-Name <string>
[-Secret <array>]
[-Url <string>]
[<CommonParameters>]
Parameter Type Required Description
-PveTicket PveTicket No Ticket data connection.
-Body string No HTTP body, base64 encoded.
-Comment string No Comment.
-Delete array No A list of settings you want to delete.
-Digest string No Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.
-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 No 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 No 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.

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