Pbs Proxmox Proxmox Backup Server API

Name: Proxmox Backup Server API
Brand: Proxmox Backup Server API
Availability: InStock

✓ Official Vendor SpecCloud InfrastructureComputeapiKey27 EndpointsREST

For Agents

Install Jentic One Beta

Connect the Proxmox Backup Server API to your agent

Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Proxmox Backup Server API, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.

Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.

Step 1: Jentic One Host machine

# On the machine that will host your Jentic One instance:
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh

Step 2: Agent machine

# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh
jentic register       # connects your agent to your Jentic One instance

Jentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.

Capabilities

What an agent can do with Proxmox Backup Server API.

Create and manage user accounts with role-based access control and permissions

Generate and rotate API tokens scoped to specific users for automation

Configure two-factor authentication (TFA) for user accounts

GET STARTED

Start building with Proxmox Backup Server API

Explore with Jentic

View OpenAPI Document

Use Cases

Patterns agents use Proxmox Backup Server API for, with concrete tasks.

★ Backup Server User Management

Create, update, and manage user accounts on Proxmox Backup Server for team access to backup infrastructure. The API supports listing users, creating new accounts, updating profiles, and deleting decommissioned accounts. Each user can be assigned to a realm (PAM, OpenID, LDAP) and given specific roles that control what datastores and operations they can access.

Create a new user 'backup-agent@pbs' with admin role via POST /access/users, then generate an API token for that user via POST /access/users/{userid}/token/{token-name}

API Token Automation

Generate scoped API tokens for automated backup workflows. Tokens inherit the permissions of the parent user and can be individually revoked without affecting the user's interactive access. This enables CI/CD pipelines, monitoring systems, and backup orchestration tools to authenticate without sharing user passwords.

List all tokens for user 'admin@pam' via GET /access/users/{userid}/token, then create a new token named 'monitoring' with read-only scope

Access Control Configuration

Define granular permissions for users and tokens across datastores and system resources. The ACL system uses path-based permission assignments where each entry maps a user or token to a role on a specific resource path. This enables multi-tenant backup environments where each team can only access their designated datastores.

Retrieve the current ACL entries via GET /access/acl, then add a new entry granting 'DatastoreUser' role to 'backup-agent@pbs' on path '/datastore/vm-backups' via PUT /access/acl

AI Agent Backup Infrastructure Management via Jentic

AI agents use the Proxmox Backup Server API through Jentic to manage users, rotate tokens, and configure permissions on PBS instances. Jentic handles the cookie-based authentication and CSRF token injection so agents can automate backup infrastructure operations without managing session state directly.

Search Jentic for 'manage Proxmox backup users', load the schema for GET /access/users, and execute to retrieve all configured user accounts with their roles

Key Endpoints

27 endpoints — proxmox backup server api provides management of backup infrastructure including user access control, authentication, datastore operations, and system administration.

METHOD

PATH

DESCRIPTION

GET

/access/users

List all users on the backup server

POST

/access/users

Create a new user account

POST

/access/users/{userid}/token/{token-name}

Create an API token for a user

PUT

/access/acl

Set access control list entries

GET

/access/permissions

Query effective permissions

POST

/access/ticket

Create an authentication ticket

GET

/admin/datastore/{store}/active-operations

List active datastore operations

GET

/access/users

List all users on the backup server

POST

/access/users

Create a new user account

POST

/access/users/{userid}/token/{token-name}

Create an API token for a user

PUT

/access/acl

Set access control list entries

GET

/access/permissions

Query effective permissions

Why Jentic?

Three things that make agents converge on Jentic-routed access.

Credential isolation

PBS authentication tickets and CSRF tokens are managed by the Jentic vault. Agents authenticate once and Jentic maintains session state, handling ticket renewal and CSRF header injection for each request.

Intent-based discovery

Agents search by intent (e.g., 'manage backup server users') and Jentic returns matching PBS operations with typed schemas for immediate execution against any configured PBS instance.

Time to first call

Direct PBS integration: 1-2 days for authentication flow, CSRF handling, and endpoint discovery. Through Jentic: under 1 hour — search, load schema, execute with automatic session management.

FAQs

Specific to using Proxmox Backup Server API through Jentic.

What authentication does the Proxmox Backup Server API use?

The PBS API uses cookie-based authentication via PBSAuthCookie with a CSRFPreventionToken header for state-changing requests. You obtain a ticket via POST /access/ticket with username and password. Alternatively, API tokens provide stateless authentication. Through Jentic, session management and CSRF tokens are handled automatically.

Can I create API tokens for automated backup jobs?

Yes. POST /access/users/{userid}/token/{token-name} creates a token scoped to that user's permissions. Tokens can be used directly in API calls without session management. You can list all tokens via GET /access/users/{userid}/token and revoke individual tokens via DELETE.

What are the rate limits for the Proxmox Backup Server API?

PBS does not impose explicit per-endpoint rate limits as it is a self-hosted solution. Performance depends on your server resources. However, authentication ticket creation (POST /access/ticket) applies a per-IP throttle to prevent brute-force attacks.

How do I manage user permissions through Jentic?

Search Jentic for 'set Proxmox backup permissions', load the schema for PUT /access/acl, and execute with the path, user, and role. Jentic handles the cookie authentication and CSRF token injection automatically, returning the updated ACL configuration.

Does the PBS API support OpenID Connect authentication?

Yes. The API provides POST /access/openid/auth-url to generate an OpenID authentication URL and POST /access/openid/login to complete the login flow. This enables SSO integration with identity providers like Azure AD, Keycloak, and Google Workspace.

Pbs Proxmox Proxmox Backup Server API

Connect the Proxmox Backup Server API to your agent

Capabilities

Start building with Proxmox Backup Server API

Use Cases

Key Endpoints

Why Jentic?

Related APIs

FAQs