Get App Resource Metrics

curl --request GET \
  --url https://rest.cerebrium.ai/v2/projects/{project_id}/apps/{app_id}/resource-metrics \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://rest.cerebrium.ai/v2/projects/{project_id}/apps/{app_id}/resource-metrics"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

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

fetch('https://rest.cerebrium.ai/v2/projects/{project_id}/apps/{app_id}/resource-metrics', 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://rest.cerebrium.ai/v2/projects/{project_id}/apps/{app_id}/resource-metrics",
  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: Bearer <token>"
  ],
]);

$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://rest.cerebrium.ai/v2/projects/{project_id}/apps/{app_id}/resource-metrics"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	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://rest.cerebrium.ai/v2/projects/{project_id}/apps/{app_id}/resource-metrics")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "containers": {},
  "cpu": {},
  "gpu": {},
  "memory": {},
  "requests": {}
}

{
  "message": "<string>"
}

{
  "message": "<string>"
}

GET

projects

{project_id}

apps

{app_id}

resource-metrics

Get App Resource Metrics

curl --request GET \
  --url https://rest.cerebrium.ai/v2/projects/{project_id}/apps/{app_id}/resource-metrics \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://rest.cerebrium.ai/v2/projects/{project_id}/apps/{app_id}/resource-metrics"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

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

fetch('https://rest.cerebrium.ai/v2/projects/{project_id}/apps/{app_id}/resource-metrics', 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://rest.cerebrium.ai/v2/projects/{project_id}/apps/{app_id}/resource-metrics",
  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: Bearer <token>"
  ],
]);

$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://rest.cerebrium.ai/v2/projects/{project_id}/apps/{app_id}/resource-metrics"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	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://rest.cerebrium.ai/v2/projects/{project_id}/apps/{app_id}/resource-metrics")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "containers": {},
  "cpu": {},
  "gpu": {},
  "memory": {},
  "requests": {}
}

{
  "message": "<string>"
}

{
  "message": "<string>"
}

Authorizations

Authorization

string

header

required

Service Account Token authentication. To authenticate API requests:

Create a Service Account Token:
- Go to the Cerebrium Dashboard and open the API Keys page
- Click Create Service Account, name it (e.g., "GitHub Actions CI/CD"), choose an expiry date, and click Create
- Copy the token generated for the desired service account
Use the Token: Include the service account token in the Authorization header of API requests: Authorization: Bearer <your-service-account-token>
Best Practices:
- Create separate service accounts for different environments (dev, staging, prod)
- Store tokens securely as secrets in consuming applications or workflows
- Set appropriate expiry dates and rotate tokens regularly
- Never commit tokens to source control

For CI/CD integration examples, see the CI/CD documentation.

Path Parameters

project_id

string

required

app_id

string

required

Query Parameters

start

string

required

Start of the time range, in RFC3339 format.

end

string

End of the time range, in RFC3339 format. Defaults to the current time.

container_id

string

Return metrics for a specific container instead of the whole app.

resolution

string

Granularity of the returned data points. Valid values: medium, high. Defaults to standard granularity.

Response

Time series of resource utilization for the app or a specific container.

containers

object

Container count chart data, with timestamps (array of integers) and series (array of objects with name and data fields).

cpu

object

CPU utilization chart data, with timestamps (array of integers) and series (array of objects with name and data fields).

gpu

object

GPU utilization chart data, with timestamps (array of integers) and series (array of objects with name and data fields).

memory

object

Memory utilization chart data, with timestamps (array of integers) and series (array of objects with name and data fields).

requests

object

Request rate chart data, with timestamps (array of integers) and series (array of objects with name and data fields).

⌘I

Builds

Projects

API Keys

Apps

Containers

Metrics

Runs

Secrets

Billing

Custom Domains

Subscriptions

Service Accounts

Users

Volumes

Files

Cerebrium Run

Integrations

Get App Resource Metrics

Authorizations

Path Parameters

Query Parameters

Response