Consultar informações da aplicação

GET

apps

{app_id}

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

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

fetch('https://api.squarecloud.app/v2/apps/{app_id}', 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}",
  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/{app_id}"

	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/{app_id}")

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": {
    "name": "Best bot forever",
    "id": "64d0c750212742ca8704fb458c9771af",
    "owner": "3133971456989594464",
    "cluster": "nasa-cluster",
    "ram": 1024,
    "language": "rust",
    "domain": null,
    "custom": null,
    "created_at": "2023-02-20T14:30:00Z"
  }
}

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. Este endpoint retorna a identidade e a configuração de uma aplicação: nome, proprietário, cluster, RAM alocada, linguagem de programação e configuração de DNS. É o endpoint a chamar quando você precisa consultar os metadados de uma aplicação antes de agir sobre ela, por exemplo para confirmar em qual cluster ela está ou em qual subdomínio ela pode ser acessada. O acesso é restrito a quem faz a chamada: se a aplicação pertence a um workspace do qual você é membro, ela é retornada automaticamente, sem nenhum parâmetro extra. Para uso de recursos em tempo real em vez de metadados estáticos, veja Obter status da aplicação; para os hostnames configurados em toda a sua conta, veja Listar domínios.

Parâmetros

string

obrigatório

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

Resposta

string

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

object

O conteúdo da resposta.

Mostrar Alternar objeto

string

O nome da aplicação.

string

O ID da aplicação.

string

O ID do proprietário da aplicação.

string

O cluster da aplicação.

number

O uso de RAM da aplicação em MB.

string

A linguagem de programação da aplicação.

string

O domínio da aplicação (null se não aplicável).

string

Informações customizadas sobre a aplicação (null se não aplicável).

date

A data de criação da aplicação.

{
  "status": "success",
  "response": {
    "name": "Best bot forever",
    "id": "64d0c750212742ca8704fb458c9771af",
    "owner": "3133971456989594464",
    "cluster": "nasa-cluster",
    "ram": 1024,
    "language": "rust",
    "domain": null,
    "custom": null,
    "created_at": "2023-02-20T14:30:00Z"
  }
}

Relacionados

CLI: squarecloud app info
SDKs: api.apps.get() (JavaScript), client.apps.get() (Python), c.Apps.Get() (Go)

Consultar informações da aplicação

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

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

fetch('https://api.squarecloud.app/v2/apps/{app_id}', 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}",
  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/{app_id}"

	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/{app_id}")

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": {
    "name": "Best bot forever",
    "id": "64d0c750212742ca8704fb458c9771af",
    "owner": "3133971456989594464",
    "cluster": "nasa-cluster",
    "ram": 1024,
    "language": "rust",
    "domain": null,
    "custom": null,
    "created_at": "2023-02-20T14:30:00Z"
  }
}

Primeiros passos

Conta

Aplicações

Bancos de dados

Workspaces

IA

Consultar informações da aplicação

Parâmetros

Resposta

Relacionados

​Parâmetros

​Resposta

​Relacionados

Parâmetros

Resposta

Relacionados