Install WordPress on the environment (site-key authable).

POST

https://api.servebolt.io/environments/{id}/wordpress/install

Install WordPress on the environment. The customer-facing counterpart
of install-wordpress: usable with an environment API key (no account
auth required), and open to every option wp core install accepts —
admin username/email/password and locale, none of which
install-wordpress lets you override. The environment must be empty
unless force is set, which wipes the existing installation and its
database.

Request

Authorization

Path Params

Body Params application/jsonRequired

Example

{
    "alias_id": 4316,
    "db_name": "example",
    "db_user": "example",
    "db_password": "s3cret",
    "wp_title": "My Awesome WordPress Site",
    "wp_path": "site/public",
    "wp_url": "https://example.com",
    "wp_version": "latest",
    "locale": "en_US",
    "admin_user": "siteowner",
    "admin_email": "owner@example.com",
    "admin_password": "s3cret",
    "force": false
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location 'https://api.servebolt.io/environments//wordpress/install' \
--header 'Content-Type: application/json' \
--data-raw '{
    "alias_id": 4316,
    "db_name": "example",
    "db_user": "example",
    "db_password": "s3cret",
    "wp_title": "My Awesome WordPress Site",
    "wp_path": "site/public",
    "wp_url": "https://example.com",
    "wp_version": "latest",
    "locale": "en_US",
    "admin_user": "siteowner",
    "admin_email": "owner@example.com",
    "admin_password": "s3cret",
    "force": false
}'

Responses

🟢200

application/json

WordPress installed

Bodyapplication/json

Example

{}

🟠404

Modified at 2026-08-14 10:44:25

Delete all WordPress transients.

Pet