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

RunCloud

Add Domain Name

POST

/servers/{{serverId}}/webapps/{{webappId}}/domains

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

Domain URL

www

boolean

required

Enable www, can be true or false, default is false

redirection

string

required

Type of redirection, can be "www", or "non-www" or "none"

type

string

required

Type of domain, can be "primary", "redirect" or "alias"

apiId

integer

optional

ID of CloudFlare integration

proxy

boolean

optional

Enable CloudFlare proxy, default value is false

Example

{
    "name": "yog.alirahman.site",
    "www": false,
    "redirection": "non-www",
    "type": "alias" 
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location -g --request POST 'https://manage.runcloud.io/api/v3/servers/{{serverId}}/webapps/{{webappId}}/domains' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "yog.alirahman.site",
    "www": false,
    "redirection": "non-www",
    "type": "alias" 
}'

Responses

🟢200Success

application/json

Body

integer

required

Domain ID

name

string

required

Domain name

type

string

required

type of domain whether Alias/Redirection

www

integer

required

Enable www version of the domain

redirection

string

required

Enable redirection

wildcard

integer

required

Enable wildcard subdomain

dns_integration

string

required

Allow DNS Integration. E.g: Cloudflare

status

null

required

Domain status

created_at

string

required

Date which the domain is created at

Example

{
    "id": 710,
    "name": "yog.alirahman.site",
    "type": "alias",
    "www": 0,
    "redirection": "non-www",
    "wildcard": 0,
    "dns_integration": "none",
    "status": null,
    "created_at": "2024-07-18 01:31:10"
}

Modified at 2025-02-07 02:39:14

List Domain Names

Domain Name Object