API Reference
Account Information
Get information about your account.
GET
/
v2
/
users
/
me
Account Information
curl --request GET \
--url https://api.squarecloud.app/v2/users/me \
--header 'Authorization: <authorization>'import requests
url = "https://api.squarecloud.app/v2/users/me"
headers = {"Authorization": "<authorization>"}
response = requests.get(url, headers=headers)
print(response.text)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))
}HttpResponse<String> response = Unirest.get("https://api.squarecloud.app/v2/users/me")
.header("Authorization", "<authorization>")
.asString();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": "313397145698959364",
"name": "joaootavios",
"email": "joao@squarecloud.app",
"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
required
The API key for your account. You can find this in your account settings.
Response
string
Indicates whether the call was successful..
success if successful, error if not.object
The response content.
Show Toggle object
Show Toggle object
object
Show Toggle object
Show Toggle object
string
The user’s ID.
string
The user’s name.
string
The user’s email.
string
The user’s locale.
object
date
The user’s account creation date.
array
Show Toggle object
Show Toggle object
string
The application’s name.
string
The application’s ID.
string
The application’s description.
number
The application’s RAM usage.
string
The application’s language.
string
The application’s domain.
string
The application’s custom domain.
string
The application’s cluster.
date
The application’s creation date.
{
"status": "success",
"response": {
"user": {
"id": "313397145698959364",
"name": "joaootavios",
"email": "joao@squarecloud.app",
"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"
}
]
}
}
Common errors
| Code | HTTP | Meaning |
|---|---|---|
USER_NOT_FOUND | 404 | The authenticated token does not map to an existing user record. |
⌘I
Account Information
curl --request GET \
--url https://api.squarecloud.app/v2/users/me \
--header 'Authorization: <authorization>'import requests
url = "https://api.squarecloud.app/v2/users/me"
headers = {"Authorization": "<authorization>"}
response = requests.get(url, headers=headers)
print(response.text)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))
}HttpResponse<String> response = Unirest.get("https://api.squarecloud.app/v2/users/me")
.header("Authorization", "<authorization>")
.asString();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": "313397145698959364",
"name": "joaootavios",
"email": "joao@squarecloud.app",
"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"
}
]
}
}

