Skip to content

chore: Update Proxmox API Specifications #79

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
github-actions wants to merge 1 commit into
base: main
Choose a base branch
from
Open

chore: Update Proxmox API Specifications #79

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions pr_body.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ This PR contains automated updates to the Proxmox API specifications.

### PBS API Changes

- Endpoints: 240 → 246 (+6)
- Endpoints: 246 → 246 (+0)
- File sizes:
- JSON: 1.8M
- YAML: 1.4M
Expand All @@ -23,4 +23,4 @@ This PR contains automated updates to the Proxmox API specifications.
3. Merge to update the API specifications

---
*Generated automatically by GitHub Actions on 2026-07-05 03:11:30 UTC*
*Generated automatically by GitHub Actions on 2026-07-19 05:24:09 UTC*
48 changes: 41 additions & 7 deletions proxmox-backup-server/apidoc.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23569,7 +23569,7 @@ var apiSchema = [
"info": {
"GET": {
"description": "Read syslog entries.",
"method": "GET",
"method": "DOWNLOAD",
"parameters": {
"additionalProperties": false,
"description": "Read syslog entries.",
Expand All @@ -23579,6 +23579,18 @@ var apiSchema = [
"optional": 1,
"type": "string"
},
"identifiers": {
"default": false,
"description": "Also list the distinct syslog identifiers present. Requires 'structured'.",
"optional": 1,
"type": "boolean"
},
"kernel": {
"default": false,
"description": "Only print kernel messages.",
"optional": 1,
"type": "boolean"
},
"lastentries": {
"description": "Limit to the last X lines. Conflicts with a range.",
"minimum": 0,
Expand All @@ -23590,6 +23602,16 @@ var apiSchema = [
"pattern": "/^(?:[a-zA-Z0-9](?:[a-zA-Z0-9\\-]*[a-zA-Z0-9])?)$/",
"type": "string"
},
"priority": {
"description": "Only print messages of this syslog priority: a single level from 0 (emerg) to 7 (debug), selecting that level and everything more severe, or a 'LOW..HIGH' range. Empty means no filter.",
"optional": 1,
"type": "string"
},
"service": {
"description": "Only print messages whose syslog identifier matches this glob.",
"optional": 1,
"type": "string"
},
"since": {
"description": "Display all log since this UNIX epoch. Conflicts with 'startcursor'.",
"minimum": 0,
Expand All @@ -23601,6 +23623,23 @@ var apiSchema = [
"optional": 1,
"type": "string"
},
"structured": {
"default": false,
"description": "Emit structured JSON with separate entry fields instead of plain text.",
"optional": 1,
"type": "boolean"
},
"unit": {
"description": "Only print messages of this systemd unit (the .service suffix is implied).",
"optional": 1,
"type": "string"
},
"units": {
"default": false,
"description": "Also list the distinct systemd units present. Requires 'structured'.",
"optional": 1,
"type": "boolean"
},
"until": {
"description": "Display all log until this UNIX epoch. Conflicts with 'endcursor'.",
"minimum": 0,
Expand All @@ -23622,12 +23661,7 @@ var apiSchema = [
}
},
"returns": {
"description": "Returns a list of journal entries.",
"items": {
"description": "Line text.",
"type": "string"
},
"type": "array"
"type": "null"
},
"unstable": false
}
Expand Down
85 changes: 78 additions & 7 deletions proxmox-backup-server/pbs-api.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40195,6 +40195,28 @@
},
"description": "End before the given Cursor. Conflicts with 'until'"
},
{
"name": "identifiers",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "Also list the distinct syslog identifiers present. Requires 'structured'.",
"default": false
},
"description": "Also list the distinct syslog identifiers present. Requires 'structured'."
},
{
"name": "kernel",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "Only print kernel messages.",
"default": false
},
"description": "Only print kernel messages."
},
{
"name": "lastentries",
"in": "query",
Expand All @@ -40206,6 +40228,26 @@
},
"description": "Limit to the last X lines. Conflicts with a range."
},
{
"name": "priority",
"in": "query",
"required": false,
"schema": {
"type": "string",
"description": "Only print messages of this syslog priority: a single level from 0 (emerg) to 7 (debug), selecting that level and everything more severe, or a 'LOW..HIGH' range. Empty means no filter."
},
"description": "Only print messages of this syslog priority: a single level from 0 (emerg) to 7 (debug), selecting that level and everything more severe, or a 'LOW..HIGH' range. Empty means no filter."
},
{
"name": "service",
"in": "query",
"required": false,
"schema": {
"type": "string",
"description": "Only print messages whose syslog identifier matches this glob."
},
"description": "Only print messages whose syslog identifier matches this glob."
},
{
"name": "since",
"in": "query",
Expand All @@ -40227,6 +40269,38 @@
},
"description": "Start after the given Cursor. Conflicts with 'since'."
},
{
"name": "structured",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "Emit structured JSON with separate entry fields instead of plain text.",
"default": false
},
"description": "Emit structured JSON with separate entry fields instead of plain text."
},
{
"name": "unit",
"in": "query",
"required": false,
"schema": {
"type": "string",
"description": "Only print messages of this systemd unit (the .service suffix is implied)."
},
"description": "Only print messages of this systemd unit (the .service suffix is implied)."
},
{
"name": "units",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "Also list the distinct systemd units present. Requires 'structured'.",
"default": false
},
"description": "Also list the distinct systemd units present. Requires 'structured'."
},
{
"name": "until",
"in": "query",
Expand All @@ -40241,16 +40315,13 @@
],
"responses": {
"200": {
"description": "Returns a list of journal entries.",
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "string",
"description": "Line text."
},
"description": "Returns a list of journal entries."
"type": "object",
"properties": {},
"additionalProperties": false
}
}
}
Expand Down
72 changes: 66 additions & 6 deletions proxmox-backup-server/pbs-api.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27664,6 +27664,23 @@ paths:
type: string
description: End before the given Cursor. Conflicts with 'until'
description: End before the given Cursor. Conflicts with 'until'
- name: identifiers
in: query
required: false
schema:
type: boolean
description: Also list the distinct syslog identifiers present. Requires
'structured'.
default: false
description: Also list the distinct syslog identifiers present. Requires 'structured'.
- name: kernel
in: query
required: false
schema:
type: boolean
description: Only print kernel messages.
default: false
description: Only print kernel messages.
- name: lastentries
in: query
required: false
Expand All @@ -27672,6 +27689,24 @@ paths:
description: Limit to the last X lines. Conflicts with a range.
minimum: 0
description: Limit to the last X lines. Conflicts with a range.
- name: priority
in: query
required: false
schema:
type: string
description: 'Only print messages of this syslog priority: a single level
from 0 (emerg) to 7 (debug), selecting that level and everything more
severe, or a ''LOW..HIGH'' range. Empty means no filter.'
description: 'Only print messages of this syslog priority: a single level
from 0 (emerg) to 7 (debug), selecting that level and everything more severe,
or a ''LOW..HIGH'' range. Empty means no filter.'
- name: service
in: query
required: false
schema:
type: string
description: Only print messages whose syslog identifier matches this glob.
description: Only print messages whose syslog identifier matches this glob.
- name: since
in: query
required: false
Expand All @@ -27687,6 +27722,33 @@ paths:
type: string
description: Start after the given Cursor. Conflicts with 'since'.
description: Start after the given Cursor. Conflicts with 'since'.
- name: structured
in: query
required: false
schema:
type: boolean
description: Emit structured JSON with separate entry fields instead of
plain text.
default: false
description: Emit structured JSON with separate entry fields instead of plain
text.
- name: unit
in: query
required: false
schema:
type: string
description: Only print messages of this systemd unit (the .service suffix
is implied).
description: Only print messages of this systemd unit (the .service suffix
is implied).
- name: units
in: query
required: false
schema:
type: boolean
description: Also list the distinct systemd units present. Requires 'structured'.
default: false
description: Also list the distinct systemd units present. Requires 'structured'.
- name: until
in: query
required: false
Expand All @@ -27697,15 +27759,13 @@ paths:
description: Display all log until this UNIX epoch. Conflicts with 'endcursor'.
responses:
'200':
description: Returns a list of journal entries.
description: Successful operation
content:
application/json:
schema:
type: array
items:
type: string
description: Line text.
description: Returns a list of journal entries.
type: object
properties: {}
additionalProperties: false
'400':
description: Bad Request - Invalid input parameters or malformed request
content:
Expand Down