pbs_acme_account_create
Registers an ACME account with a Certificate Authority using a contact email. Offers a dry-run plan before executing.
Instructions
MUTATION: register a new ACME account with the CA. Dry-run by default.
Additive — does not affect any existing account. Pair with pbs_acme_plugin_create (DNS-01 challenge), then pbs_acme_cert_order, to actually issue a cert; to remove an account instead use pbs_acme_account_delete. confirm=True executes (POST /config/acme/account, synchronous — PBS returns null) and returns {"status": "ok", "result": None}; the default returns a dry-run PLAN dict. Needs PROXIMO_PBS_* config.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | No | Name to register the account under; omit to let PBS assign a default name. | |
| confirm | No | False (default) returns a dry-run PLAN only; True executes the account registration. | |
| contact | Yes | Contact email address for the ACME account (CA renewal/expiry notices). | |
| eab_kid | No | Key identifier for External Account Binding; pairs with eab_hmac_key. | |
| tos_url | No | URL of the CA's terms-of-service to accept; omit to accept the CA's default ToS. | |
| directory | No | ACME directory URL of the CA to register with; omit to use PBS's default CA. | |
| eab_hmac_key | No | HMAC key for External Account Binding (required by some CAs, e.g. ZeroSSL). Redacted from the PLAN preview and the audit ledger, but IS sent to PBS on confirm=True. | |
| 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
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |