POST · Applications
Read, install, update, back up, log in to, configure or uninstall an Installatron application
Read, install, update, back up, log in to, configure or uninstall an Installatron application
/api/v1/apps
Description
action=detail returns one record and needs read access. install needs application (from list_available_apps); update needs app_id; backup takes an on-demand backup; configure sets the auto-update policy (autoup*) and/or title. Those need write:hosting. sso returns a one-time admin login URL and needs sso:hosting.
Body
Send as application/json.
| Name | Type | Description |
|---|---|---|
input
required
|
string |
A domain, email address, website URL, or Inleed service id — for example example.se, [email protected] or 42976. Resolved to the owning account automatically, and the resolved target is echoed back in the response.
|
action
required
|
enum |
detail one app, install a new one, update one, backup one now, sso a one-time admin login, configure auto-updates/title, uninstall one, or delete_backup (the last two are confirmation-tier, need delete:hosting). One of detail, install, update, backup, sso, configure, uninstall, delete_backup.
|
app_id
|
string |
The application id, from list_apps (apps[].id). Optional when url or path names the install instead — prefer those: they are the address the customer used and cannot be mis-copied; with none given the app at the domain root is meant.
|
url
|
string |
Instead of app_id: the install's address as listed, e.g. https://example.com/shop (scheme and trailing slash do not matter).
|
backup_id
|
string |
For delete_backup: the backup id from list_app_backups (backups[].id).
|
application
|
string |
For install: the application to install (e.g. wordpress), an id from the REST GET /apps/available.
|
title
|
string |
For install or configure: the site title. Letters, digits, spaces and ._,- only.
|
admin_username
|
string |
Optional for install: the application admin username (letters, digits, -_). Installatron generates one if omitted.
|
admin_email
|
string |
Optional for install: the application admin email address.
|
version
|
string |
Optional for install: a specific version to install. Omit for the latest.
|
path
|
string |
For install: the subfolder to install into (e.g. shop); omit for the domain root.
|
autoup
|
enum |
For configure: core auto-update policy — none, minor (security/minor only) or all. One of none, minor, all.
|
autoup_plugins
|
enum |
For configure: plugin auto-update policy. One of none, all.
|
autoup_themes
|
enum |
For configure: theme auto-update policy. One of none, all.
|
autoup_backup
|
enum |
For configure: whether a backup is taken before each auto-update. One of none, all.
|
attempt_key
|
string |
An idempotency key you choose for an uninstall/delete_backup. Reusing it within an hour returns the same held action.
|
Responses
The specification does not describe this response body; the note in the rail says what to expect.
Every non-2xx response is an RFC 7807 problem with a stable
code.
Commonly returned errors
The codes this operation reaches on its own path: the auth stack, its own validation and
ownership checks, and the transport. Not a closed set — a shared code from the
full registry can still surface. Each links to the code’s own page,
the same URL its type dereferences to.