Establecer dominio personalizado

POST

apps

{app_id}

network

custom

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

Es necesario tener al menos el plan Standard para usar esta ruta. La misma cuenta puede asociar un dominio a varias aplicaciones (balanceo de carga): hasta 2 aplicaciones en Standard, 5 en Pro y 10 en Enterprise. Consulta Listar balanceadores de carga.

string

requerido

La clave de API de tu cuenta. Puedes encontrarla en la configuración de tu cuenta.

Reemplazar un dominio personalizado existente libera el hostname anterior en el borde antes de asociar el nuevo, a menos que otra aplicación de la misma cuenta todavía apunte a él. Se ejecuta la misma validación tanto al asociar como al eliminar (custom: "@"): en una aplicación compartida dentro de un workspace, quien realiza la solicitud necesita el rol de Administrador del workspace o ser el propietario. Un dominio solo puede ser reclamado por una cuenta a la vez: asociar un hostname que ya pertenece a otra cuenta devuelve DOMAIN_ALREADY_EXISTS. Para ver todos los hostnames configurados en tus aplicaciones, consulta Listar dominios. Una vez asociado, obtén los registros de validación necesarios con Obtener registros DNS.

Parámetros

string

requerido

El ID de la aplicación. Puedes encontrarlo en la URL del panel de tu aplicación.

string

requerido

El dominio completamente cualificado que se va a asociar, o @ para eliminar el dominio personalizado actual de la aplicación. No puede ser un dominio de Square Cloud (squareweb.app, squarecloud.app, …).

Respuesta

string

Indica si la llamada fue exitosa. success si fue exitosa, error si no.

En caso de fallo, la respuesta incluye un code de error:

Status	Code	Significado
`400`	`INVALID_DOMAIN`	El dominio no es un nombre de dominio completamente cualificado válido.
`400`	`RESERVED_DOMAIN`	Los dominios de Square Cloud no pueden usarse como dominio personalizado.
`403`	`UPGRADE_REQUIRED`	El plan activo no incluye dominios personalizados (se requiere Standard, Pro o Enterprise).
`403`	`LOAD_BALANCER_LIMIT_REACHED`	Se alcanzó el límite de aplicaciones del plan en este dominio.
`409`	`DOMAIN_ALREADY_EXISTS`	El dominio ya está asociado a una aplicación de otra cuenta.
`502`	`DNS_FAILED`	La asociación del dominio falló en el proveedor edge.

{
    "status": "success"
}

Listar balanceadores de cargaLista los balanceadores de carga de dominios personalizados de la cuenta. Tiene un límite de 20 solicitudes cada 60 segundos.

Establecer dominio 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

​Respuesta

Parámetros

Respuesta