Passer au contenu principal
POST
/
v2
/
apps
/
{app_id}
/
network
/
custom
Définir un domaine personnalisé
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"
}
Il est nécessaire de disposer au minimum du plan Standard pour utiliser cette route. Un même compte peut rattacher un domaine à plusieurs applications (load balancing) : jusqu’à 2 applications sur Standard, 5 sur Pro et 10 sur Enterprise. Voir Lister les load balancers.
​
Authorization
string
requis
La clé d’API de votre compte. Vous pouvez la trouver dans les paramètres de votre compte.

​
Paramètres

​
app_id
string
requis
L’ID de l’application. Vous pouvez le trouver dans l’URL du tableau de bord de votre application.
​
custom
string
requis
Le domaine pleinement qualifié à rattacher, ou @ pour supprimer le domaine personnalisé actuel de l’application. Il ne peut pas s’agir d’un domaine Square Cloud (squareweb.app, squarecloud.app, …).

​
Réponse

​
status
string
Indique si l’appel a réussi. success en cas de succès, error sinon.
En cas d’échec, la réponse inclut un code d’erreur :
StatutCodeSignification
400REGEX_VALIDATIONLe domaine n’est pas un nom de domaine pleinement qualifié valide.
400RESERVED_DOMAINLes domaines Square Cloud ne peuvent pas être utilisés comme domaine personnalisé.
403UPGRADE_REQUIREDLe plan actif n’inclut pas les domaines personnalisés (Standard, Pro ou Enterprise requis).
403LOAD_BALANCER_LIMIT_REACHEDLa limite d’applications du plan sur ce domaine a été atteinte.
409DOMAIN_ALREADY_EXISTSLe domaine est déjà rattaché à une application appartenant à un autre compte.
502DNS_FAILEDLe rattachement du domaine a échoué au niveau du fournisseur edge.
{
    "status": "success"
}