Obtener información de la cuenta

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

requerido

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

Requiere una clave de API con el scope account:read. Información de la cuenta devuelve todo sobre tu propia cuenta de Square Cloud en una sola llamada: perfil, plan y uso de memoria, y cada aplicación y base de datos que posees. Es una buena llamada raíz para paneles o herramientas de CLI que necesiten mostrar una visión general de la cuenta sin consultar cada aplicación y base de datos por separado. La respuesta está limitada al token autenticado; no hay forma de solicitar los datos de otra cuenta mediante esta ruta. Las aplicaciones incluyen su dominio y cluster, y las bases de datos incluyen su tipo y RAM, suficiente para construir una interfaz de listado sin llamadas adicionales. Para profundizar en una sola aplicación, consulta Obtener Información de la Aplicación; para las copias de seguridad de la cuenta, consulta Listar Snapshots.

Respuesta

string

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

object

El contenido de la respuesta.

Mostrar Alternar objeto

object

Mostrar Alternar objeto

string

El ID del usuario.

string

El nombre del usuario.

string

El correo electrónico del usuario.

string

El idioma del usuario.

object

Mostrar Alternar objeto

string

El nombre del plan del usuario.

object

Los detalles de memoria del plan del usuario.

Mostrar Alternar objeto

number

El límite de memoria del plan del usuario en MB.

number

La memoria disponible del plan del usuario en MB.

number

La memoria utilizada del plan del usuario en MB.

number

Cuándo caduca el plan, como marca de tiempo Unix en milisegundos.

date

La fecha de creación de la cuenta del usuario.

array

Mostrar Alternar objeto

string

El nombre de la aplicación.

string

El ID de la aplicación.

string

La descripción de la aplicación.

number

El uso de RAM de la aplicación.

string

El lenguaje de la aplicación.

string

El dominio de la aplicación.

string

El dominio personalizado de la aplicación.

string

El cluster de la aplicación.

date

La fecha de creación de la aplicación.

array

Mostrar Alternar objeto

string

El ID de la base de datos.

string

El nombre de la base de datos.

number

El uso de RAM de la base de datos.

string

El tipo de la base de datos.

string

El cluster de la base de datos.

date

La fecha de creación de la base de datos.

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

Relacionado

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

Obtener información de la cuenta

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

Primeros pasos

Cuenta

Aplicaciones

Bases de datos

Workspaces

IA

Obtener información de la cuenta

Respuesta

Relacionado

​Respuesta

​Relacionado

Respuesta

Relacionado