Configurar domínio personalizado

POST

apps

{app_id}

network

custom

Configurar domínio personalizado

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

É necessário ter pelo menos o plano Standard para usar esta rota. A mesma conta pode associar um domínio a várias aplicações (balanceamento de carga): até 2 aplicações no Standard, 5 no Pro e 10 no Enterprise. Veja Listar balanceadores de carga.

Authorization

string

obrigatório

A chave da API para sua conta. Você pode encontrá-la nas configurações da conta.

Substituir um domínio personalizado existente libera o hostname anterior na borda antes de associar o novo, a menos que outra aplicação na mesma conta ainda aponte para ele. A mesma validação roda tanto ao associar quanto ao remover (custom: "@"): em uma aplicação compartilhada em workspace, quem chama precisa do papel de Administrador do workspace ou ser o proprietário. Um domínio só pode ser reivindicado por uma conta por vez: associar um hostname já pertencente a outra conta retorna DOMAIN_ALREADY_EXISTS. Para ver todos os hostnames configurados nas suas aplicações, veja Listar domínios. Depois de associado, obtenha os registros de validação necessários com Obter registros DNS.

Parâmetros

app_id

string

obrigatório

O ID da aplicação. Você pode encontrá-lo na URL do painel da sua aplicação.

custom

string

obrigatório

O domínio totalmente qualificado a associar, ou @ para remover o domínio personalizado atual da aplicação. Não pode ser um domínio da Square Cloud (squareweb.app, squarecloud.app, …).

Resposta

status

string

Indica se a chamada foi bem-sucedida. success se bem-sucedida, error se não.

Em caso de falha, a resposta inclui um code de erro:

Status	Code	Significado
`400`	`INVALID_DOMAIN`	O domínio não é um domínio totalmente qualificado válido.
`400`	`RESERVED_DOMAIN`	Domínios da Square Cloud não podem ser usados como domínio personalizado.
`403`	`UPGRADE_REQUIRED`	O plano ativo não inclui domínios personalizados (requer Standard, Pro ou Enterprise).
`403`	`LOAD_BALANCER_LIMIT_REACHED`	O limite de aplicações neste domínio para o plano foi atingido.
`409`	`DOMAIN_ALREADY_EXISTS`	O domínio já está associado a uma aplicação de outra conta.
`502`	`DNS_FAILED`	A associação do domínio falhou no provedor de edge.

{
    "status": "success"
}

Listar balanceadores de cargaListar os balanceadores de carga de domínio personalizado da conta. Possui limite de taxa de 20 requisições a cada 60 segundos.

Configurar domínio personalizado

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

​Parâmetros

​Resposta

Parâmetros

Resposta