Save Proxmox endpoints

PUT/api/config/proxmox

Adds, changes, renames or removes Proxmox endpoints in the config file. Protection: token. A token you leave out stays as it is. Send a token as {"value": "..."} to set it or {"clear": true} to remove it.

Authorizations

Authorizationstringheaderrequired

The token you start the server with: homebutler serve --token <token>, or web.token in the config file. Send it as Authorization: Bearer <token>. When the server has a token, every /api/ route except the CORS preflight requires it, reads included.

Body

application/json

revisionstringrequired

The revision from Get config.

endpointsobject[]required

The endpoints to add, change or remove.

Response

200 · application/json

The endpoints were saved.

savedbooleanrequired

true.

revisionstringrequired

The revision of the file as saved. Use it for the next save.

restart_neededstring[]

The processes that read this setting at start and need a restart to use it.

noticesstring[]

Things that are true about the save and worth knowing.

cURL

curl --request PUT \
  --url 'http://localhost:8080/api/config/proxmox' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "revision": "de00b31a091f1c29664eba416271abe6acc33d96ed0dcf954cec6f9c0fd7cc9a",
  "endpoints": [
    {
      "name": "pve",
      "host": "192.0.2.40",
      "port": 8006,
      "token_id": "monitoring@pve!ro",
      "token": {
        "value": "11111111-1111-1111-1111-111111111111"
      }
    }
  ]
}'

{
  "saved": true,
  "revision": "1867f7424ec647c39d6b1b76ce83a208aed331f72dadc51205788c509a93e50f",
  "restart_needed": [
    "watch"
  ]
}