Skip to content

Meta API

Health

Responses

StatusDescriptionSchema
200Successful Responseany

Onboarding

Where setup has got to.

PUBLIC by necessity, so it answers a stranger with the three booleans the pre-session screens genuinely cannot work without and nothing else: admin_exists (step 1 of the wizard, and whether this is a fresh install), complete (the redirect both shell.tsx and the wizard route make before any session exists) and oidc (whether the login page draws an SSO button).

host_added and ssh_pending are a different kind of fact: they say this install manages Proxmox hosts and that a root SSH key is enrolled but not yet working, which is reconnaissance for anyone who can reach the port. The wizard only reads them from step 2 onwards, and step 1 signs the new admin in before it gets there (components/AdminAccountStep.tsx posts /users then /auth/login), so a session always exists by the time they matter. Absent rather than faked for everyone else: a hardcoded False would send a signed-out caller to the wrong wizard step.

Responses

StatusDescriptionSchema
200Successful Responseany

Update Status

Responses

StatusDescriptionSchema
200Successful Responseany

Apply Update

Request body (required), application/json, proxploy__api__meta__UpdateIn

FieldTypeRequiredDescription
versionstringyes

Responses

StatusDescriptionSchema
202Successful Responseany
422Validation ErrorHTTPValidationError

Version

Responses

StatusDescriptionSchema
200Successful Responseany