This API v2 documentation is currently still on progress. For any issue, please contact support@runcloud.io

Create Web App (custom)

POST

/v2/servers/{{serverId}}/webapps/custom

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

user

integer

optional

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

publicPath

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"

clickjackingProtection

boolean

optional

Showing if have click jacking protection. Default value is true

xssProtection

boolean

optional

Showing if have xss protection. Default value is true

mimeSniffingProtection

boolean

optional

Showing if have mime sniffing protection. Default value is true

processManager

string

optional

Process Manager type, for example "dynamic", "ondemand", "static". Default value "ondemand"

processManagerMaxChildren

integer

optional

Process Manager Max children value. Default value 50

processManagerMaxRequests

integer

optional

Process Manager Max Requests value. Default value 500

openBasedir

string

optional

Path for open base directory

timezone

string

optional

Timezone. Default value "UTC"

disableFunctions

string

optional

PHP functions that disabled for this Web App, separated by comma.

maxExecutionTime

integer

optional

Max execution time value. Default value 30

maxInputTime

integer

optional

Max input time value. Default value 60

maxInputVars

integer

optional

Max input vars value. Default value 1000

memoryLimit

integer

optional

Memory limit value in MB. Default value 256

postMaxSize

integer

optional

Post maximum size value in MB. Default value 256

uploadMaxFilesize

integer

optional

Upload maximum file size in MB. Default value 256

sessionGcMaxlifetime

integer

optional

Session GC maximum lifetime value in seconds. Default value 1440

allowUrlFopen

boolean

optional

UrlFOpen allowed or not. Default value is false

Example

{
  "name": "eyeshield-testing",
  "domainName": "eyeshield.alirahman.site",
  "user": 1647,
  "publicPath": "/public",
  "phpVersion": "php80rc",
  "stack": "hybrid",
  "stackMode": "production",
  "clickjackingProtection": true,
  "xssProtection": true,
  "mimeSniffingProtection": true,
  "processManager": "ondemand",
  "processManagerMaxChildren": 50,
  "processManagerMaxRequests": 500,
  "openBasedir": "/home/myuser/webapps/testing:/var/lib/php/session:/tmp",
  "timezone": "UTC",
  "disableFunctions": "getmyuid,passthru,leak,listen,diskfreespace,tmpfile,link,ignore_user_abort,shell_exec,dl,set_time_limit,exec,system,highlight_file,source,show_source,fpassthru,virtual,posix_ctermid,posix_getcwd,posix_getegid,posix_geteuid,posix_getgid,posix_getgrgid,posix_getgrnam,posix_getgroups,posix_getlogin,posix_getpgid,posix_getpgrp,posix_getpid,posix,_getppid,posix_getpwuid,posix_getrlimit,posix_getsid,posix_getuid,posix_isatty,posix_kill,posix_mkfifo,posix_setegid,posix_seteuid,posix_setgid,posix_setpgid,posix_setsid,posix_setuid,posix_times,posix_ttyname,posix_uname,proc_open,proc_close,proc_nice,proc_terminate,escapeshellcmd,ini_alter,popen,pcntl_exec,socket_accept,socket_bind,socket_clear_error,socket_close,socket_connect,symlink,posix_geteuid,ini_alter,socket_listen,socket_create_listen,socket_read,socket_create_pair,stream_socket_server",
  "maxExecutionTime": 30,
  "maxInputTime": 60,
  "maxInputVars": 1000,
  "memoryLimit": 256,
  "postMaxSize": 256,
  "uploadMaxFilesize": 256,
  "sessionGcMaxlifetime": 1440,
  "allowUrlFopen": true
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location -g --request POST 'https://manage.runcloud.io/api/v2/servers/{{serverId}}/webapps/custom' \
--header 'Content-Type: application/json' \
--data-raw '{
  "name": "eyeshield-testing",
  "domainName": "eyeshield.alirahman.site",
  "user": 1647,
  "publicPath": "/public",
  "phpVersion": "php80rc",
  "stack": "hybrid",
  "stackMode": "production",
  "clickjackingProtection": true,
  "xssProtection": true,
  "mimeSniffingProtection": true,
  "processManager": "ondemand",
  "processManagerMaxChildren": 50,
  "processManagerMaxRequests": 500,
  "openBasedir": "/home/myuser/webapps/testing:/var/lib/php/session:/tmp",
  "timezone": "UTC",
  "disableFunctions": "getmyuid,passthru,leak,listen,diskfreespace,tmpfile,link,ignore_user_abort,shell_exec,dl,set_time_limit,exec,system,highlight_file,source,show_source,fpassthru,virtual,posix_ctermid,posix_getcwd,posix_getegid,posix_geteuid,posix_getgid,posix_getgrgid,posix_getgrnam,posix_getgroups,posix_getlogin,posix_getpgid,posix_getpgrp,posix_getpid,posix,_getppid,posix_getpwuid,posix_getrlimit,posix_getsid,posix_getuid,posix_isatty,posix_kill,posix_mkfifo,posix_setegid,posix_seteuid,posix_setgid,posix_setpgid,posix_setsid,posix_setuid,posix_times,posix_ttyname,posix_uname,proc_open,proc_close,proc_nice,proc_terminate,escapeshellcmd,ini_alter,popen,pcntl_exec,socket_accept,socket_bind,socket_clear_error,socket_close,socket_connect,symlink,posix_geteuid,ini_alter,socket_listen,socket_create_listen,socket_read,socket_create_pair,stream_socket_server",
  "maxExecutionTime": 30,
  "maxInputTime": 60,
  "maxInputVars": 1000,
  "memoryLimit": 256,
  "postMaxSize": 256,
  "uploadMaxFilesize": 256,
  "sessionGcMaxlifetime": 1440,
  "allowUrlFopen": true
}'

Responses

🟢200Success

application/json

Body

integer

required

Web App ID

server_user_id

integer

required

ID of the web app owner

name

string

required

Name of web app

rootPath

string

required

Root path for the web app

publicPath

string

required

Public path for the web app

phpVersion

string

required

PHP version of the web app

stack

string

required

Web App stack

stackMode

string

required

Stack mode

type

string

required

Type of the web app

defaultApp

boolean

required

Showing whether the web app is default web app or not

alias

string | null

required

Web App Alias

pullKey1

string

required

pullKey2

string

required

created_at

string

required

Date which the web app got created

Example

{
    "id": 655,
    "server_user_id": 1647,
    "name": "eyeshield-testing",
    "rootPath": "/home/runcloud/webapps/eyeshield-testing",
    "publicPath": "/home/runcloud/webapps/eyeshield-testing",
    "phpVersion": "php80rc",
    "stack": "hybrid",
    "stackMode": "production",
    "type": "custom",
    "defaultApp": false,
    "alias": null,
    "pullKey1": "5pGuNkULhLZHyXmTZQUoN4Xr1721180441",
    "pullKey2": "f3qO5mNq50bMQV7VZGRKwCmfvcngInCX",
    "created_at": "2024-07-17 01:40:41"
}

Modified at 2024-10-07 03:50:39

Software Update

Cloning GIT Repository