Application Status
curl --request GET \
--url https://api.vertracloud.app/v1/apps/{id}/statusimport requests
url = "https://api.vertracloud.app/v1/apps/{id}/status"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.vertracloud.app/v1/apps/{id}/status', 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.vertracloud.app/v1/apps/{id}/status",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$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.vertracloud.app/v1/apps/{id}/status"
req, _ := http.NewRequest("GET", url, nil)
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.vertracloud.app/v1/apps/{id}/status")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.vertracloud.app/v1/apps/{id}/status")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"response": {
"id": "app-abc123def456",
"cpu": "25.50%",
"ram": "512.00 MB",
"storage": "1024.00 MB",
"status": "running",
"running": true,
"network": {
"total": "569.90KB ↓ 36.41KB ↑",
"now": "18.78KB ↑ 1.20KB ↓"
},
"uptime": 3600
}
}
Applications
Application Status
Retrieves the current status and resource usage of an application by its ID.
GET
/
v1
/
apps
/
{id}
/
status
Application Status
curl --request GET \
--url https://api.vertracloud.app/v1/apps/{id}/statusimport requests
url = "https://api.vertracloud.app/v1/apps/{id}/status"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.vertracloud.app/v1/apps/{id}/status', 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.vertracloud.app/v1/apps/{id}/status",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$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.vertracloud.app/v1/apps/{id}/status"
req, _ := http.NewRequest("GET", url, nil)
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.vertracloud.app/v1/apps/{id}/status")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.vertracloud.app/v1/apps/{id}/status")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"response": {
"id": "app-abc123def456",
"cpu": "25.50%",
"ram": "512.00 MB",
"storage": "1024.00 MB",
"status": "running",
"running": true,
"network": {
"total": "569.90KB ↓ 36.41KB ↑",
"now": "18.78KB ↑ 1.20KB ↓"
},
"uptime": 3600
}
}
string
required
The application ID to retrieve the status. If the application belongs to a workspace, pass its ID in the
workspace_id query parameter.string
If the application belongs to a workspace, the workspace’s ID. Required for workspace members acting on an application they don’t own.
A stopped application answers
200, not an error. The container of a stopped application does not exist — it is removed on stop — and that is a normal state, not a failure. The API returns 200 with running: false and every metric zeroed. Only a genuine failure to read the status returns 500.Response
object
The application status and resource usage details.
Show Toggle object
Show Toggle object
string
The application ID.
string
CPU usage percentage (e.g.,
25.5%).string
RAM usage (e.g.,
512 MB).string
Storage usage (e.g.,
1024 MB).string
The application status (e.g.,
running).boolean
Indicates if the application is running.
boolean
Present and
true while dependencies are being installed or the application is rebuilding. During this time, running can be false even though work is in progress. Treat this as an in-progress state, not as “stopped”, and do not issue a start while it is true. A restart with reinstall_dependencies or force_build is one of the operations that opens this window.object
number
The application uptime in seconds.
{
"response": {
"id": "app-abc123def456",
"cpu": "25.50%",
"ram": "512.00 MB",
"storage": "1024.00 MB",
"status": "running",
"running": true,
"network": {
"total": "569.90KB ↓ 36.41KB ↑",
"now": "18.78KB ↑ 1.20KB ↓"
},
"uptime": 3600
}
}
Error Responses
string
The error code indicating the reason for the failure. Possible values:
UNAUTHORIZED: The user is not authenticated or does not have sufficient permissions.APP_NOT_FOUND: The specified application does not exist.FORBIDDEN: The user does not have permission to access the application.INTERNAL_SERVER_ERROR: The status could not be read. A stopped application is not this case — see the note above.
string
A descriptive message providing additional details about the error.
{
"code": "APP_NOT_FOUND"
}
{
"code": "FORBIDDEN"
}
{
"code": "INTERNAL_SERVER_ERROR"
}