pbs_s3_check
Check an S3 client configuration's connectivity and credentials against a Proxmox Backup Server endpoint. Dry-run by default; use confirm=true to execute a live probe.
Instructions
MUTATION: perform a basic sanity check for a PBS S3 client configuration.
RISK_LOW: PUT verb, but genuinely non-config-mutating (schema-confirmed: PBS's own state never changes, returns null) — this is a read-shaped probe that makes a REAL outbound network call to the configured S3 endpoint using its stored credentials. Confirm-gated anyway (verb is not the safety signal): this endpoint has no safe default to fall back on (unlike pbs_tape_media_list's update_status=False) — every invocation's whole purpose is the live probe; see proximo.pbs_s3 module docstring fact #6 for the full argued reasoning (weighed against both the pbs_tape_media_destroy and pbs_notification_target_test precedents). Dry-run by default (returns a PLAN, nothing is called); confirm=True executes (PUT /admin/s3/{s3-endpoint-id}/check) and returns {"status": "ok", "result": None}. Needs PROXIMO_PBS_* config.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| s3_id | Yes | S3 client config id to check. | |
| bucket | Yes | Bucket name for the S3 object store (3-63 chars). REQUIRED. | |
| confirm | No | False (default) returns a dry-run PLAN only; True runs the live check. | |
| store_prefix | No | Store prefix within the bucket for S3 object keys (commonly a datastore name). | |
| proximo_target | No | Which configured Proxmox target to run this call against — a target name from your multi-target config (a specific PVE/PBS/PMG/PDM box). Omit to use the single/default target from the environment; the selection applies only to this call. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |