Imposta dominio personalizzato

POST

apps

{app_id}

network

custom

Imposta dominio personalizzato

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"
}

È necessario avere almeno il piano Standard per usare questa route. Lo stesso account può collegare un dominio a più applicazioni (load balancing): fino a 2 applicazioni su Standard, 5 su Pro e 10 su Enterprise. Vedi Elenca Load Balancer.

string

obbligatorio

La chiave API del tuo account. Puoi trovarla nelle impostazioni del tuo account.

Sostituire un dominio personalizzato esistente rilascia l’hostname precedente all’edge prima di collegare quello nuovo, a meno che un’altra applicazione dello stesso account non punti ancora a esso. La stessa validazione viene eseguita sia per il collegamento che per la rimozione (custom: "@"): su un’applicazione condivisa in un workspace, il chiamante deve avere il ruolo di Amministratore del workspace o esserne il proprietario. Un dominio può essere rivendicato da un solo account alla volta: collegare un hostname già detenuto da un altro account restituisce DOMAIN_ALREADY_EXISTS. Per vedere ogni hostname configurato tra le tue applicazioni, vedi Elenca Domini. Una volta collegato, recupera i record di validazione richiesti con Ottieni record DNS.

Parametri

string

obbligatorio

L’ID dell’applicazione. Puoi trovarlo nell’URL della dashboard della tua applicazione.

string

obbligatorio

Il dominio completo (fully qualified) da collegare, oppure @ per rimuovere l’attuale dominio personalizzato dell’applicazione. Non può essere un dominio Square Cloud (squareweb.app, squarecloud.app, …).

Risposta

string

Indica se la chiamata è andata a buon fine. success in caso di successo, error in caso contrario.

In caso di errore, la risposta include un code di errore:

Status	Code	Significato
`400`	`INVALID_DOMAIN`	Il dominio non è un nome di dominio completo (fully qualified) valido.
`400`	`RESERVED_DOMAIN`	I domini Square Cloud non possono essere usati come dominio personalizzato.
`403`	`UPGRADE_REQUIRED`	Il piano attivo non include i domini personalizzati (richiesto Standard, Pro o Enterprise).
`403`	`LOAD_BALANCER_LIMIT_REACHED`	È stato raggiunto il limite di applicazioni del piano su questo dominio.
`409`	`DOMAIN_ALREADY_EXISTS`	Il dominio è già collegato a un’applicazione di proprietà di un altro account.
`502`	`DNS_FAILED`	Il collegamento del dominio è fallito presso il provider edge.

{
    "status": "success"
}

Elenca Load BalancerElenca i load balancer a dominio personalizzato dell'account. Ha un limite di frequenza di 20 richieste ogni 60 secondi.

Imposta dominio personalizzato

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"
}

​Parametri

​Risposta

Parametri

Risposta