npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

proxmox-api

v1.1.1

Published

Cutting edge javascript / Typescript / ESM / CJS Proxmox API

Downloads

4,619

Readme

Proxmox Api

NPM Version Typescript Api to manage proxmox servers.

Mapping 100% of available calls, contains all api documentation in typing file. code size < 10Ko including docs

Usage

intellisense

Overview

to use this API take the Path you want to call, and replace:

  • the / by .
  • the ${variable} by .(variable)
  • append the http method you want to call with a $ at the end (.$get(), .$post(), .$put() or .$delete())

that it.

Example

To call GET /cluster/acme/account/{name} you will call proxmox.cluster.acme.account.$(name).$get()

To call GET /api2/json/cluster/backup/{id}/included_volumes you will call proxmox.cluster.backup.{id}.included_volumes.$get()

To call GET /api2/json/nodes you will call proxmox.nodes.$get()

The provided typing will assist you within intelisense, so you do not need to read any external doc.

Code sample

  • NPM Version an hotplug usb service based on this API.
npm install proxmox-api
import proxmoxApi from "proxmox-api";

// authorize self signed cert if you do not use a valid SSL certificat
process.env.NODE_TLS_REJECT_UNAUTHORIZED = "0";

async function test() {
    // connect to proxmox
    const proxmox = proxmoxApi({host: '127.0.0.1', password: 'password', username: 'user1@pam'});
    // list nodes
    const nodes = await proxmox.nodes.$get();
    // iterate cluster nodes
    for (const node of nodes) {
        const theNode = proxmox.nodes.$(node.node);
        // list Qemu VMS
        const qemus = await theNode.qemu.$get({full:true});
        // iterate Qemu VMS
        for (const qemu of qemus) {
            // do some suff.
            const config = await theNode.qemu.$(qemu.vmid).config.$get();
            console.log(`vm: ${config.name}, memory: ${config.memory}`);
            // const vnc = await theNode.qemu.$(qemu.vmid).vncproxy.$post();
            // console.log('vnc:', vnc);
            // const spice = await theNode.qemu.$(qemu.vmid).spiceproxy.$post();
            // console.log('spice:', spice);
        }
    }    
}

test().catch(console.error);

Initialisation alternavives:

  • keeping access to ProxmoxEngine object (that can be use to share a ticket, or to access it)
import proxmoxApi, { ProxmoxEngine } from "proxmox-api";

process.env.NODE_TLS_REJECT_UNAUTHORIZED = "0";

async function test() {
    // connect to proxmox
    const engine = new ProxmoxEngine({host: '127.0.0.1', password: 'password', username: 'user1@pam'});
    const proxmox = proxmoxApi(engine);
}
  • Using Api token
import proxmoxApi from "proxmox-api";

process.env.NODE_TLS_REJECT_UNAUTHORIZED = "0";

async function test() {
    // connect to proxmox
    const proxmox = proxmoxApi({host: '127.0.0.1', tokenID: 'USER@REALM!TOKENID', tokenSecret: '12345678-1234-1234-1234-1234567890ab'});
}

Notes

  • if the call path contains a hyphen, you will need to use the ['field'] syntax ex:
await theNode.qemu.$(vmid).agent['get-fsinfo'].$get()