Get Application Info - Square Cloud

GET

apps

{app_id}

Get Application Info

curl --request GET \
  --url https://api.squarecloud.app/v2/apps/{app_id} \
  --header 'Authorization: <authorization>'

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

fetch('https://api.squarecloud.app/v2/apps/{app_id}', 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/apps/{app_id}",
  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/apps/{app_id}"

	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/apps/{app_id}")

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": {
    "name": "Best bot forever",
    "id": "64d0c750212742ca8704fb458c9771af",
    "owner": "3133971456989594464",
    "cluster": "nasa-cluster",
    "ram": 1024,
    "language": "rust",
    "domain": null,
    "custom": null,
    "created_at": "2023-02-20T14:30:00Z"
  }
}

string

required

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

This endpoint returns an application’s identity and configuration: its name, owner, cluster, allocated RAM, programming language, and DNS setup. It is the endpoint to call when you need to look up an application’s metadata before acting on it, for example to confirm which cluster it lives on or which subdomain it is reachable at. Access is scoped to the caller: if the application belongs to a workspace you are a member of, it is returned automatically without any extra parameter. For live resource usage instead of static metadata, see Get Application Status; for configured hostnames across your whole account, see List Domains.

Parameters

string

required

The ID of the application. You can find this in the URL of your application’s dashboard.

Response

string

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

object

The contents of the response.

Show Toggle object

string

The application’s name.

string

The application’s ID.

string

The ID of the application owner.

string

The application’s cluster.

number

The application’s RAM usage in MB.

string

The application’s programming language.

string

The application’s domain (null if not applicable).

string

Custom information about the application (null if not applicable).

date

The application’s creation date.

{
  "status": "success",
  "response": {
    "name": "Best bot forever",
    "id": "64d0c750212742ca8704fb458c9771af",
    "owner": "3133971456989594464",
    "cluster": "nasa-cluster",
    "ram": 1024,
    "language": "rust",
    "domain": null,
    "custom": null,
    "created_at": "2023-02-20T14:30:00Z"
  }
}

Get Application StatusCollect status information about your application.

Get Application Info

curl --request GET \
  --url https://api.squarecloud.app/v2/apps/{app_id} \
  --header 'Authorization: <authorization>'

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

fetch('https://api.squarecloud.app/v2/apps/{app_id}', 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/apps/{app_id}",
  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/apps/{app_id}"

	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/apps/{app_id}")

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": {
    "name": "Best bot forever",
    "id": "64d0c750212742ca8704fb458c9771af",
    "owner": "3133971456989594464",
    "cluster": "nasa-cluster",
    "ram": 1024,
    "language": "rust",
    "domain": null,
    "custom": null,
    "created_at": "2023-02-20T14:30:00Z"
  }
}

​Parameters

​Response

Parameters

Response