Create WordPress Web Application

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/json

name

string

required

Web App name

domainName

string

required

Domain name for the web app

siteTitle

string

required

WordPress Site name

adminUsername

string

required

Username for login to WordPress dashboard

password

string

required

Password for login to WordPress dashboard

adminEmail

string

required

Email for WordPress administrator user

dbUser

string

optional

Database user, if empty it will be autogenerated

dbPassword

string

optional

Database password, if empty it will be autogenerated

dbName

string

optional

Database name, if empty it will be autogenerated

dbPrefix

string

optional

Database prefix, if empty it will be autogenerated

user

integer

optional

System user ID assigned to the web app, default is id of runcloud user

publicPath

string | null

optional

Public path for the web app

phpVersion

string

optional

PHP version of the web app, for example: "php72rc", "php73rc", "php74rc", "php80rc", "php81rc", "php82rc", "php83rc". Default value: same with default PHP version in server config

stack

string

optional

stack of the web app, for example: "hybrid", "nativenginx", or "customnginx". Default value "hybrid"

stackMode

string

optional

stack mode, for example: "production", "development". Default value "production"

apiId

integer

optional

ID of Cloudflare integration

proxy

boolean

optional

enable Cloudflare proxy, default value is false.

canvas_id

integer

optional

ID of WordPress canvas

Example

{
  "name": "wp-via-api5",
  "domainName": "wp-via-api5.site",
  "siteTitle": "wp-api",
  "adminUsername": "useradmin",
  "password": "123456",
  "adminEmail": "[email protected]",  
  "dbUser": "usernew",
  "dbPassword": "123456",
  "dbName": "dbnew",
  "dbPrefix": "wp_",
  "user": 1539,
  "publicPath": null,
  "phpVersion": "php80rc",
  "stack": "hybrid",
  "stackMode": "production"  
}

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location -g --request POST 'https://manage.runcloud.io/api/v3/servers/{{serverId}}/webapps/wordpress' \
--header 'Content-Type: application/json' \
--data-raw '{
  "name": "wp-via-api5",
  "domainName": "wp-via-api5.site",
  "siteTitle": "wp-api",
  "adminUsername": "useradmin",
  "password": "123456",
  "adminEmail": "[email protected]",  
  "dbUser": "usernew",
  "dbPassword": "123456",
  "dbName": "dbnew",
  "dbPrefix": "wp_",
  "user": 1539,
  "publicPath": null,
  "phpVersion": "php80rc",
  "stack": "hybrid",
  "stackMode": "production"  
}'

Responses

🟢200Success

application/json

Body

id

integer

required

webapp id

server_user_id

integer

required

system user ID assigned to the web app

name

string

required

webapp name

rootPath

string

required

root path of the webapp

publicPath

string

required

public path of the webapp

phpVersion

string

required

php version of the webapp

stack

string

required

webapp stack

stackMode

string

required

Stack mode

type

string

required

webapp type

defaultApp

null

required

show if a default app or not

alias

null

required

value that show if have any aliases or not

pullKey1

string

required

pullkey1 value

pullKey2

string

required

pullkey2 value

created_at

string

required

date which the webapp got created

Example

{
    "id": 660,
    "server_user_id": 1668,
    "name": "wp-api",
    "rootPath": "/home/syahslam/webapps/wp-api",
    "publicPath": "/home/syahslam/webapps/wp-api",
    "phpVersion": "php80rc",
    "stack": "hybrid",
    "stackMode": "production",
    "type": "wordpress",
    "defaultApp": null,
    "alias": null,
    "pullKey1": "TsMTuEyGlA0WEqjEPVzJXWpv1721205430",
    "pullKey2": "ZqZaO9dDD4hf5iZBOFkHkOoB4cDnK3Ix",
    "created_at": "2024-07-17 08:37:10"
}