Invoke-PveRestApi

Invoke Proxmox VE Rest API

Explained with examples in this guide.

Syntax

Invoke-PveRestApi
    [-PveTicket <PveTicket>]
    -Resource <string>
    [-Method <string>]
    [-ResponseType <string>]
    [-Parameters <hashtable>]
    [<CommonParameters>]

Parameters

Parameter	Type	Required	Pipeline	Description
-PveTicket	PveTicket	No	By value, by property name	Ticket data.
-Resource	string	Yes	No	Resource Request.
-Method	string	No	No	Method request. Values: Get, Set, Create, Delete. Default: 'Get'.
-ResponseType	string	No	No	Type request. Values: json, extjs, html, text, png. Default: 'json'.
-Parameters	hashtable	No	No	Parameters request.

Output

Return object request

Example

$PveTicket = Connect-PveCluster -HostsAndPorts '192.168.128.115' -Credentials (Get-Credential -Username 'root')
(Invoke-PveRestApi -PveTicket $PveTicket -Method Get -Resource '/version').Response.data

data
----
@{version=5.4; release=15; repoid=d0ec33c6; keyboard=it}