Account Information - Square Cloud

GET

https://api.squarecloud.app

users

Account Information

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

{
  "status": "success",
  "response": {
    "user": {
      "id": "313397145698959364",
      "name": "joaootavios",
      "email": "[email protected]",
      "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"
      }
    ]
  }
}

Authorization

string

required

The API key for your account. You can find this in your account settings.

Response

status

string

Indicates whether the call was successful.. success if successful, error if not.

response

object

The response content.

Show Toggle object

user

object

Show Toggle object

string

The user’s ID.

name

string

The user’s name.

string

The user’s email.

locale

string

The user’s locale.

plan

object

Show Toggle object

name

string

The user’s plan name.

memory

object

The user’s plan memory details.

Show Toggle object

limit

number

The user’s plan memory limit in MB.

available

number

The user’s plan available memory in MB.

used

number

The user’s plan used memory in MB.

duration

number

The user’s plan duration in milliseconds.

created_at

date

The user’s account creation date.

applications

array

Show Toggle object

name

string

The application’s name.

string

The application’s ID.

desc

string

The application’s description.

ram

number

The application’s RAM usage.

lang

string

The application’s language.

domain

string

The application’s domain.

custom

string

The application’s custom domain.

cluster

string

The application’s cluster.

created_at

date

The application’s creation date.

databases

array

Show Toggle object

string

The database’s ID.

name

string

The database’s name.

ram

number

The database’s RAM usage.

type

string

The database’s type.

cluster

string

The database’s cluster.

created_at

date

The database’s creation date.

{
  "status": "success",
  "response": {
    "user": {
      "id": "313397145698959364",
      "name": "joaootavios",
      "email": "[email protected]",
      "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"
      }
    ]
  }
}

List SnapshotsGet List of all Snapshots.

⌘I

Account Information

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

{
  "status": "success",
  "response": {
    "user": {
      "id": "313397145698959364",
      "name": "joaootavios",
      "email": "[email protected]",
      "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"
      }
    ]
  }
}

API Reference

​Response

Response