Corsinvest.ProxmoxVE.Api.Shared 7.3.7

.NET Standard 2.0
There is a newer version of this package available.
See the version list below for details.
dotnet add package Corsinvest.ProxmoxVE.Api.Shared --version 7.3.7
NuGet\Install-Package Corsinvest.ProxmoxVE.Api.Shared -Version 7.3.7
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Corsinvest.ProxmoxVE.Api.Shared" Version="7.3.7" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Corsinvest.ProxmoxVE.Api.Shared --version 7.3.7
#r "nuget: Corsinvest.ProxmoxVE.Api.Shared, 7.3.7"
#r directive can be used in F# Interactive, C# scripting and .NET Interactive. Copy this into the interactive tool or source code of the script to reference the package.
// Install Corsinvest.ProxmoxVE.Api.Shared as a Cake Addin
#addin nuget:?package=Corsinvest.ProxmoxVE.Api.Shared&version=7.3.7

// Install Corsinvest.ProxmoxVE.Api.Shared as a Cake Tool
#tool nuget:?package=Corsinvest.ProxmoxVE.Api.Shared&version=7.3.7








Proxmox VE Client API .Net

Proxmox VE Api

   ______                _                      __
  / ____/___  __________(_)___ _   _____  _____/ /_
 / /   / __ \/ ___/ ___/ / __ \ | / / _ \/ ___/ __/
/ /___/ /_/ / /  (__  ) / / / / |/ /  __(__  ) /_
\____/\____/_/  /____/_/_/ /_/|___/\___/____/\__/

Corsinvest for Proxmox VE Api Client  (Made in Italy)

Copyright: Corsinvest Srl For licensing details please visit

Commercial Support

This software is part of a suite of tools called cv4pve. If you want commercial support send mail


The client is generated from a JSON Api on Proxmox VE.

Main features

  • Easy to learn
  • Method named
  • Set ResponseType json, png
  • Full class and method generated from documentation (about client)
  • Comment any method and parameters
  • Parameters indexed eg [n] is structured in array index and value
  • Tree structure
    • client.Nodes["pve1"].Qemu[100].Snapshot().snapshotList()
  • Return data Proxmox VE
  • Logger with MicrosMicrosoft.Extensions.Logging
  • Return result
    • Request
    • Response
    • Status
  • Last result action
  • Task utility
    • WaitForTaskToFinish
    • TaskIsRunning
    • GetExitStatusTask
  • Method direct access
    • Get
    • Create (Post)
    • Set (Put)
    • Delete
  • Login return bool if access
  • Return Result class more information
  • ClientBase lite function
  • Form Proxmox VE 6.2 support Api Token for user
  • Async / Await
  • Add model in Shared library for decode json
  • Add Extension method Get to decode in json from result in Extension library

Api token

From version 6.2 of Proxmox VE is possible to use Api token. This feature permit execute Api without using user and password. If using Privilege Separation when create api token remember specify in permission. Format USER@REALM!TOKENID=UUID


The result is class Result and contain properties:

  • Response returned from Proxmox VE (data,errors,...) dynamic ExpandoObject
  • ResponseToDictionary return response to dictionary IDictionary<String, object>
  • ResponseInError (bool) : Contains errors from Proxmox VE.
  • StatusCode (System.Net.HttpStatusCode): Status code of the HTTP response.
  • ReasonPhrase (string): The reason phrase which typically is sent by servers together with the status code.
  • IsSuccessStatusCode (bool) : Gets a value that indicates if the HTTP response was successful.
  • GetError() (string) : Get error.

Example result:

  "data": {
    "smbios1": "uuid=9246585e-0c8b-4d02-8fe2-f48fd0da3975",
    "ide2": "none,media=cdrom",
    "onboot": 1,
    "boot": "cdn",
    "cores": 2,
    "agent": 1,
    "memory": 4096,
    "numa": 0,
    "bootdisk": "virtio0",
    "sockets": 1,
    "net0": "virtio=3A:39:38:30:36:31,bridge=vmbr0",
    "parent": "auto4hours170904080002",
    "digest": "acafde32daab50bce801fef2e029440c54ebe2f7",
    "vga": "qxl",
    "virtio0": "local-zfs:vm-100-disk-1,cache=writeback,size=50G",
    "ostype": "win8",
    "name": "phenometa"


//if you want use lite version only get/set/create/delete use PveClientBase

var client = new PveClient("");
if (await client.Login("root", "password"))
    var vm = await client.Nodes["pve1"].Qemu[100];

    //config vm
    var config = await vm.Config.VmConfig();

    //create snapshot
    var response = await vm.Snapshot.Snapshot("pippo2311");

    //update snapshot description
    await vm.Snapshot["pippo2311"].Config.UpdateSnapshotConfig("description");

    //delete snapshot
    await vm.Snapshot["pippo2311"].Delsnapshot();

    //list of snapshot
    foreach (var snapshot in (await vm.Snapshot.SnapshotList())

    //change response type from json to png
    client.ResponseType = "png";
    var dataImg = client.Nodes["pve1"].Rrd.Rrd("cpu", "day").Response;
    Console.WriteLine("<img src=\"{dataImg}\" \>");

//using Api Token
var client = new PveClient("");
client.ApiToken = "root@pam!qqqqqq=8a8c1cd4-d373-43f1-b366-05ce4cb8061f";
var version = await client.Version.Version();
Console.WriteLine(JsonConvert.SerializeObject(, Formatting.Indented));


Extension add functionality on Api.

  • ApiExplorer
  • Retrive VM/CT data from name or id
  • Simplify management of VM/CT e.g snapshot
  • Extension method Get to decode json from result e.g Client.Cluster.Status.Get() return IEnumerable<IClusterStatus>


Contain model for Json conversion and utility.


Read documentation ProxmoxVE API and extract structure.


Utility for console application.

Product Versions
.NET net5.0 net5.0-windows net6.0 net6.0-android net6.0-ios net6.0-maccatalyst net6.0-macos net6.0-tvos net6.0-windows net7.0 net7.0-android net7.0-ios net7.0-maccatalyst net7.0-macos net7.0-tvos net7.0-windows
.NET Core netcoreapp2.0 netcoreapp2.1 netcoreapp2.2 netcoreapp3.0 netcoreapp3.1
.NET Standard netstandard2.0 netstandard2.1
.NET Framework net461 net462 net463 net47 net471 net472 net48
MonoAndroid monoandroid
MonoMac monomac
MonoTouch monotouch
Tizen tizen40 tizen60
Xamarin.iOS xamarinios
Xamarin.Mac xamarinmac
Xamarin.TVOS xamarintvos
Xamarin.WatchOS xamarinwatchos
Compatible target framework(s)
Additional computed target framework(s)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (1)

Showing the top 1 NuGet packages that depend on Corsinvest.ProxmoxVE.Api.Shared:

Package Downloads

Corsinvest for Proxmox VE Api Client Extension

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
7.3.8 174 11/3/2022
7.3.7 371 9/7/2022
7.3.6 483 6/16/2022
7.3.5 319 6/14/2022
7.3.4 560 5/27/2022
7.3.3 163 5/19/2022
7.3.2 529 5/3/2022
7.3.1 389 4/26/2022
7.3.0 438 4/5/2022