Listar todos os domínios

GET

apps

domains

curl --request GET \
  --url https://api.squarecloud.app/v2/apps/domains \
  --header 'Authorization: <authorization>'

const options = {method: 'GET', headers: {Authorization: '<authorization>'}};

fetch('https://api.squarecloud.app/v2/apps/domains', 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/domains",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <authorization>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.squarecloud.app/v2/apps/domains"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<authorization>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.squarecloud.app/v2/apps/domains")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<authorization>'

response = http.request(request)
puts response.read_body

{
  "status": "success",
  "response": [
    { "app_id": "a1b2c3d4e5f64a7b8c9d0e1f2a3b4c5d", "hostname": "example.com", "type": "custom" },
    { "app_id": "a1b2c3d4e5f64a7b8c9d0e1f2a3b4c5d", "hostname": "my-app.squareweb.app", "type": "subdomain" }
  ]
}

string

obrigatório

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

Requer uma chave de API com o escopo apps:read. Use este endpoint para obter uma visão única, de toda a conta, de cada hostname que você configurou, útil para popular uma página de visão geral de domínios sem chamar Consultar informações da aplicação uma vez por aplicação. Para anexar ou alterar um domínio personalizado em uma aplicação específica, veja Definir domínio personalizado; os registros DNS de um domínio são obtidos separadamente via Consultar registros DNS.

Este endpoint aceita a sua chave da API ou um token de sessão (JWT) no cabeçalho Authorization. A autenticação é obrigatória: requisições sem ela retornam 401.

Resposta

string

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

O array response é uma lista achatada de todos os hostnames das aplicações que você possui. Os domínios personalizados vêm primeiro, seguidos pelos subdomínios padrão *.squareweb.app. Aplicações sem domínio web (ex.: workers e bots) são omitidas.

Esta lista é servida a partir da lista de projetos em cache, portanto não conta contra os limites de taxa de rede por aplicação.

array

A lista de hostnames.

Mostrar Alternar objeto

string

O identificador hexadecimal de 32 caracteres da aplicação dona do domínio.

string

O hostname totalmente qualificado.

string

"subdomain" para o host padrão *.squareweb.app; "custom" para um domínio personalizado anexado.

{
  "status": "success",
  "response": [
    { "app_id": "a1b2c3d4e5f64a7b8c9d0e1f2a3b4c5d", "hostname": "example.com", "type": "custom" },
    { "app_id": "a1b2c3d4e5f64a7b8c9d0e1f2a3b4c5d", "hostname": "my-app.squareweb.app", "type": "subdomain" }
  ]
}

Relacionados

CLI: squarecloud app domains
SDKs: api.apps.domains() (JavaScript), client.apps.domains() (Python), c.Apps.Domains() (Go)

Listar todos os domínios

curl --request GET \
  --url https://api.squarecloud.app/v2/apps/domains \
  --header 'Authorization: <authorization>'

const options = {method: 'GET', headers: {Authorization: '<authorization>'}};

fetch('https://api.squarecloud.app/v2/apps/domains', 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/domains",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <authorization>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.squarecloud.app/v2/apps/domains"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<authorization>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.squarecloud.app/v2/apps/domains")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<authorization>'

response = http.request(request)
puts response.read_body

{
  "status": "success",
  "response": [
    { "app_id": "a1b2c3d4e5f64a7b8c9d0e1f2a3b4c5d", "hostname": "example.com", "type": "custom" },
    { "app_id": "a1b2c3d4e5f64a7b8c9d0e1f2a3b4c5d", "hostname": "my-app.squareweb.app", "type": "subdomain" }
  ]
}

Primeiros passos

Conta

Aplicações

Bancos de dados

Workspaces

IA

Listar todos os domínios

Resposta

Relacionados

​Resposta

​Relacionados

Resposta

Relacionados