Obter informações da conta

GET

users

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

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

fetch('https://api.squarecloud.app/v2/users/me', 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/users/me",
  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/users/me"

	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/users/me")

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": {
    "user": {
      "id": "123456789012345678",
      "name": "John Doe",
      "email": "john@example.com",
      "plan": {
        "name": "standard-4",
        "memory": {
          "limit": 4096,
          "available": 3840,
          "used": 256
        },
        "duration": 1732072955446
      },
      "created_at": "2022-01-10T12:00:00Z"
    },
    "applications": [
      {
        "name": "Square Example APP",
        "id": "446b0b4118634a1c99e73bac9a54e475",
        "desc": "This is a example of description",
        "ram": 512,
        "lang": "javascript",
        "domain": "square-example-app.squareweb.app",
        "custom": "mydomain.com",
        "cluster": "suki-cluster",
        "created_at": "2023-02-20T14:30:00Z"
      }
    ],
    "databases": [
      {
        "id": "db1234567890",
        "name": "example-database",
        "type": "mongodb",
        "cluster": "suki-cluster",
        "ram": 1024,
        "created_at": "2023-01-15T10:00: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 account:read. Informações da Conta retorna tudo sobre a sua própria conta Square Cloud em uma única chamada: perfil, plano e uso de memória, e cada aplicação e banco de dados que você possui. É uma boa chamada raiz para dashboards ou ferramentas de CLI que precisam renderizar uma visão geral da conta sem consultar cada aplicação e banco de dados individualmente. A resposta é restrita ao token autenticado; não há como solicitar dados de outra conta por esta rota. As aplicações incluem seu domínio e cluster, e os bancos de dados incluem seu tipo e RAM, ambos suficientes para montar uma UI de listagem sem chamadas extras. Para detalhar uma única aplicação, veja Consultar Informações da Aplicação; para os backups da conta, veja Listar Snapshots.

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

object

Mostrar Alternar objeto

string

O ID do usuário.

string

O nome do usuário.

string

O e-mail do usuário.

string

O locale do usuário.

object

Mostrar Alternar objeto

string

O nome do plano do usuário.

object

Os detalhes de memória do plano do usuário.

Mostrar Alternar objeto

number

O limite de memória do plano do usuário em MB.

number

A memória disponível do plano do usuário em MB.

number

A memória usada do plano do usuário em MB.

number

Quando o plano expira, como um timestamp Unix em milissegundos.

date

A data da criação da conta do usuário.

array

Mostrar Alternar objeto

string

O nome da aplicação.

string

O ID da aplicação.

string

A descrição da aplicação.

number

O uso de RAM da aplicação.

string

A linguagem da aplicação.

string

O domínio da aplicação.

string

O domínio customizado da aplicação.

string

O cluster da aplicação.

date

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

array

Mostrar Alternar objeto

string

O ID do banco de dados.

string

O nome do banco de dados.

number

O uso de RAM do banco de dados.

string

O tipo do banco de dados.

string

O cluster do banco de dados.

date

A data de criação do banco de dados.

{
  "status": "success",
  "response": {
    "user": {
      "id": "123456789012345678",
      "name": "John Doe",
      "email": "john@example.com",
      "plan": {
        "name": "standard-4",
        "memory": {
          "limit": 4096,
          "available": 3840,
          "used": 256
        },
        "duration": 1732072955446
      },
      "created_at": "2022-01-10T12:00:00Z"
    },
    "applications": [
      {
        "name": "Square Example APP",
        "id": "446b0b4118634a1c99e73bac9a54e475",
        "desc": "This is a example of description",
        "ram": 512,
        "lang": "javascript",
        "domain": "square-example-app.squareweb.app",
        "custom": "mydomain.com",
        "cluster": "suki-cluster",
        "created_at": "2023-02-20T14:30:00Z"
      }
    ],
    "databases": [
      {
        "id": "db1234567890",
        "name": "example-database",
        "type": "mongodb",
        "cluster": "suki-cluster",
        "ram": 1024,
        "created_at": "2023-01-15T10:00:00Z"
      }
    ]
  }
}

Relacionados

CLI: squarecloud auth whoami
SDKs: api.account.me() (JavaScript), client.account.me() (Python), c.Account.Me() (Go)

Obter informações da conta

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

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

fetch('https://api.squarecloud.app/v2/users/me', 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/users/me",
  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/users/me"

	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/users/me")

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": {
    "user": {
      "id": "123456789012345678",
      "name": "John Doe",
      "email": "john@example.com",
      "plan": {
        "name": "standard-4",
        "memory": {
          "limit": 4096,
          "available": 3840,
          "used": 256
        },
        "duration": 1732072955446
      },
      "created_at": "2022-01-10T12:00:00Z"
    },
    "applications": [
      {
        "name": "Square Example APP",
        "id": "446b0b4118634a1c99e73bac9a54e475",
        "desc": "This is a example of description",
        "ram": 512,
        "lang": "javascript",
        "domain": "square-example-app.squareweb.app",
        "custom": "mydomain.com",
        "cluster": "suki-cluster",
        "created_at": "2023-02-20T14:30:00Z"
      }
    ],
    "databases": [
      {
        "id": "db1234567890",
        "name": "example-database",
        "type": "mongodb",
        "cluster": "suki-cluster",
        "ram": 1024,
        "created_at": "2023-01-15T10:00:00Z"
      }
    ]
  }
}

Primeiros passos

Conta

Aplicações

Bancos de dados

Workspaces

IA

Obter informações da conta

Resposta

Relacionados

​Resposta

​Relacionados

Resposta

Relacionados