Skip to main content
POST
/
v2
/
apps
/
{app_id}
/
network
/
custom
Set Custom Domain
curl --request POST \
  --url https://api.squarecloud.app/v2/apps/{app_id}/network/custom \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "custom": "<string>"
}
'
import requests

url = "https://api.squarecloud.app/v2/apps/{app_id}/network/custom"

payload = { "custom": "<string>" }
headers = {
    "Authorization": "<authorization>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'POST',
  headers: {Authorization: '<authorization>', 'Content-Type': 'application/json'},
  body: JSON.stringify({custom: '<string>'})
};

fetch('https://api.squarecloud.app/v2/apps/{app_id}/network/custom', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.squarecloud.app/v2/apps/{app_id}/network/custom",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'custom' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <authorization>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.squarecloud.app/v2/apps/{app_id}/network/custom"

	payload := strings.NewReader("{\n  \"custom\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "<authorization>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.squarecloud.app/v2/apps/{app_id}/network/custom")
  .header("Authorization", "<authorization>")
  .header("Content-Type", "application/json")
  .body("{\n  \"custom\": \"<string>\"\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.squarecloud.app/v2/apps/{app_id}/network/custom")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<authorization>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"custom\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
    "status": "success"
}
Is necessary to have at least the Standard plan to use this route. The same account may attach one domain to multiple applications (load balancing): up to 2 applications on Standard, 5 on Pro, and 10 on Enterprise. See List Load Balancers.
​
Authorization
string
required
The API key for your account. You can find this in your account settings.

​
Parameters

​
app_id
string
required
The ID of the application. You can find this in the URL of your application’s dashboard.
​
custom
string
required
The fully qualified domain to attach, or @ to remove the application’s current custom domain. It cannot be a Square Cloud domain (squareweb.app, squarecloud.app, …).

​
Response

​
status
string
Indicates whether the call was successful.. success if successful, error if not.
On failure, the response includes an error code:
StatusCodeMeaning
400REGEX_VALIDATIONThe domain is not a valid fully qualified domain name.
400RESERVED_DOMAINSquare Cloud domains cannot be used as a custom domain.
403UPGRADE_REQUIREDThe active plan does not include custom domains (Standard, Pro, or Enterprise required).
403LOAD_BALANCER_LIMIT_REACHEDThe plan’s limit of applications on this domain was reached.
409DOMAIN_ALREADY_EXISTSThe domain is already attached to an application owned by another account.
502DNS_FAILEDThe domain attachment failed at the edge provider.
{
    "status": "success"
}