This API v3 documentation is currently still on progress. For any issue, please contact support@runcloud.io
- API v3 Introduction
- 3rd Party API Integrations
- DNS Integrations
- Server Integrations
- External Backup Storages
- List 3rd Party API IntegrationsGET
- 3rd Party API Integration ObjectGET
- Delete 3rd Party API IntegrationDELETE
- Servers
- Manage
- Health & Monitoring
- Databases
- Database Users
- System Users
- Deployment Keys
- Services
- Cron Job
- Supervisor
- SSH Keys
- SSH Session
- SSH Config
- Activity Logs
- Security - Firewall
- Security - Fail2Ban
- Settings - PHP
- Settings - Auto Security Update
- Settings - Change IP Address
- Web Applications
- Manage
- Custom WebApp
- One Click Installer
- Git Deployment
- PHP Script Installer
- WebApp Alias
- List Web ApplicationsGET
- Web Application ObjectGET
- Set as Default Web Application In The ServerPOST
- Delete Web ApplicationDELETE
- Domain Name
- SSL/TLS
- SSL Basic (WebApp SSL)
- SSL Advanced (Domain SSL) For Business/Enterprise
- Check SSL Method (Basic/Advanced) & AutoSSL Status
- Update/Change SSL Method (Basic/Advanced) & AutoSSL Status
- SSL Advanced – Install/Deploy Domain SSL
- SSL Advanced – Domain SSL Object
- SSL Advanced – Update Domain SSL Config
- SSL Advanced – Redeploy Domain SSL (Let’s Encrypt only)
- SSL Advanced – Delete Domain SSL
- Cloning
- Tools
- WordPress - RunCloud Hub
- WordPress - Staging
- WordPress - General Settings
- Activity Logs
- Settings
- Backup
- Atomic Deployment
- Static Data
- Settings
Create Alias Web Application
POST
/servers/{{serverId}}/webapps/{{webappId}}/alias
Request
Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.Example:
Authorization: Bearer ********************Body Params application/json
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 Code Samples
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location -g --request POST 'https://manage.runcloud.io/api/v3/servers/{{serverId}}/webapps/{{webappId}}/alias' \
--header 'Authorization: Bearer <token>' \
--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
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-16 08:56:29