Obtenir les informations du compte

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

requis

La clé d’API de votre compte. Vous pouvez la trouver dans les paramètres de votre compte.

Nécessite une clé API avec le scope account:read. Account Information renvoie tout ce qui concerne votre propre compte Square Cloud en un seul appel : profil, utilisation du plan et de la mémoire, ainsi que chaque application et base de données que vous possédez. C’est un bon appel racine pour les tableaux de bord ou les outils CLI qui doivent afficher une vue d’ensemble du compte sans interroger chaque application et base de données individuellement. La réponse est limitée au token authentifié ; il n’existe aucun moyen de demander les données d’un autre compte via cette route. Les applications incluent leur domaine et leur cluster, et les bases de données incluent leur type et leur RAM, ce qui suffit pour construire une interface de listing sans appels supplémentaires. Pour consulter le détail d’une seule application, voir Obtenir les infos de l’application ; pour les sauvegardes du compte, voir Lister les snapshots.

Réponse

string

Indique si l’appel a réussi : success si c’est le cas, error sinon.

object

Le contenu de la réponse.

Afficher Afficher l'objet

object

Afficher Afficher l'objet

string

L’ID de l’utilisateur.

string

Le nom de l’utilisateur.

string

L’e-mail de l’utilisateur.

string

La langue de l’utilisateur.

object

Afficher Afficher l'objet

string

Le nom du plan de l’utilisateur.

object

Les détails de mémoire du plan de l’utilisateur.

Afficher Afficher l'objet

number

La limite de mémoire du plan de l’utilisateur en Mo.

number

La mémoire disponible du plan de l’utilisateur en Mo.

number

La mémoire utilisée du plan de l’utilisateur en Mo.

number

Date d’expiration du plan, sous forme de timestamp Unix en millisecondes.

date

La date de création du compte de l’utilisateur.

array

Afficher Afficher l'objet

string

Le nom de l’application.

string

L’ID de l’application.

string

La description de l’application.

number

L’utilisation de RAM de l’application.

string

Le langage de l’application.

string

Le domaine de l’application.

string

Le domaine personnalisé de l’application.

string

Le cluster de l’application.

date

La date de création de l’application.

array

Afficher Afficher l'objet

string

L’ID de la base de données.

string

Le nom de la base de données.

number

L’utilisation de RAM de la base de données.

string

Le type de la base de données.

string

Le cluster de la base de données.

date

La date de création de la base de données.

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

Voir aussi

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

Obtenir les informations du compte

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

Premiers pas

Compte

Applications

Bases de données

Workspaces

IA

Obtenir les informations du compte

Réponse

Voir aussi

​Réponse

​Voir aussi

Réponse

Voir aussi