POST · Applications
Install WordPress on a domain
Install WordPress on a domain
/api/v1/wordpress/install
Description
Returns installed:true, a message, the install record and admin carrying the one-time generated username / password. The password is shown once; hand it to the human and treat it as a credential. installed:false, accepted:true when the install was started but had not appeared in the install list within the wait; installed:false with the reason on a node without a licensed Installatron; an install Installatron refuses is an upstream_error with a translated reason.
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.
|
domain
|
string |
Optional: the domain to install on when input names a whole account (a username or service id) rather than a domain. Omit when input is the domain.
|
path
|
string |
Up to 64 characters. Pattern ^[A-Za-z0-9._\/-]+$.
|
title
|
string |
Em and en dashes are not options and pass. Up to 120 characters. Pattern ^[\p{L}\p{N}\s._,!?:;&'"()\/+\-—–]+$.
|
admin_username
|
string |
Pattern ^[a-z0-9._-]{3,60}$.
|
admin_email
|
string | Optional administrator email address for the new install. |
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.