Get App

Get App

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

import requests

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

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}', 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}",
  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}"

	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}")

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

{
  "baseImage": "<string>",
  "cerebriumVersion": "<string>",
  "computeTier": "<string>",
  "cooldownPeriodSeconds": "<string>",
  "costPerSecondCents": "<string>",
  "cpu": "<string>",
  "createdAt": "<string>",
  "deploymentInitializationTimeout": "<string>",
  "disableAuth": true,
  "entrypoint": "<array>",
  "errorMessage": "<string>",
  "evaluationIntervalSeconds": "<string>",
  "gpuCount": "<string>",
  "hardware": "<string>",
  "hardwareProvider": "<string>",
  "healthcheckEndpoint": "<string>",
  "id": "<string>",
  "internalEndpoint": "<string>",
  "lastBuildStatus": "<string>",
  "latestBuildId": "<string>",
  "latestCreatedBuildId": "<string>",
  "latestReadyBuildId": "<string>",
  "loadBalancingAlgorithm": "<string>",
  "maxReplicaCount": "<string>",
  "memory": "<string>",
  "minReplicaCount": "<string>",
  "name": "<string>",
  "port": 123,
  "projectId": "<string>",
  "pythonVersion": "<string>",
  "readycheckEndpoint": "<string>",
  "region": "<string>",
  "replicaConcurrency": "<string>",
  "responseGracePeriodSeconds": "<string>",
  "rollOutDurationSeconds": "<string>",
  "runtime": "<string>",
  "scalingBuffer": "<string>",
  "scalingMetric": "<string>",
  "scalingTarget": "<string>",
  "status": "<string>",
  "updatedAt": "<string>"
}

{
  "message": "<string>"
}

{
  "message": "<string>"
}

GET

projects

{project_id}

apps

{app_id}

Get App

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

import requests

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

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}', 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}",
  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}"

	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}")

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

{
  "baseImage": "<string>",
  "cerebriumVersion": "<string>",
  "computeTier": "<string>",
  "cooldownPeriodSeconds": "<string>",
  "costPerSecondCents": "<string>",
  "cpu": "<string>",
  "createdAt": "<string>",
  "deploymentInitializationTimeout": "<string>",
  "disableAuth": true,
  "entrypoint": "<array>",
  "errorMessage": "<string>",
  "evaluationIntervalSeconds": "<string>",
  "gpuCount": "<string>",
  "hardware": "<string>",
  "hardwareProvider": "<string>",
  "healthcheckEndpoint": "<string>",
  "id": "<string>",
  "internalEndpoint": "<string>",
  "lastBuildStatus": "<string>",
  "latestBuildId": "<string>",
  "latestCreatedBuildId": "<string>",
  "latestReadyBuildId": "<string>",
  "loadBalancingAlgorithm": "<string>",
  "maxReplicaCount": "<string>",
  "memory": "<string>",
  "minReplicaCount": "<string>",
  "name": "<string>",
  "port": 123,
  "projectId": "<string>",
  "pythonVersion": "<string>",
  "readycheckEndpoint": "<string>",
  "region": "<string>",
  "replicaConcurrency": "<string>",
  "responseGracePeriodSeconds": "<string>",
  "rollOutDurationSeconds": "<string>",
  "runtime": "<string>",
  "scalingBuffer": "<string>",
  "scalingMetric": "<string>",
  "scalingTarget": "<string>",
  "status": "<string>",
  "updatedAt": "<string>"
}

{
  "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

Response

Full configuration and status details of the requested app.

baseImage

string

Base Docker image the app is built from.

cerebriumVersion

string

Version of the client used to deploy the app.

computeTier

string

Compute tier of the app, interruptible or protected.

cooldownPeriodSeconds

string

Cooldown period in seconds before an idle replica scales down, as a string value.

costPerSecondCents

string

Estimated cost per second in US cents while a replica is running, as a string value.

cpu

string

Number of CPU cores allocated, as a string value.

createdAt

string

Timestamp when the app was created.

deploymentInitializationTimeout

string

Maximum time in seconds to wait for a deployment to initialize, as a string value.

disableAuth

boolean

Whether authentication is disabled on the app endpoint.

entrypoint

array

Command used to start a custom runtime app, as a list of strings.

errorMessage

string

Error message from the most recent failure, if any.

evaluationIntervalSeconds

string

Interval in seconds between autoscaling evaluations, as a string value.

gpuCount

string

Number of GPUs allocated, as a string value.

hardware

string

Compute type the app runs on.

hardwareProvider

string

Cloud provider the app is deployed on.

healthcheckEndpoint

string

HTTP endpoint used to check that the app is healthy.

string

Unique identifier of the app.

internalEndpoint

string

Base URL for invoking the app.

lastBuildStatus

string

Status of the most recent build.

latestBuildId

string

ID of the most recent build.

latestCreatedBuildId

string

ID of the most recently created build.

latestReadyBuildId

string

ID of the most recent build that reached the ready state.

loadBalancingAlgorithm

string

Load balancing algorithm used by the app.

maxReplicaCount

string

Maximum number of replicas, as a string value.

memory

string

Memory allocation in GB, as a string value.

minReplicaCount

string

Minimum number of replicas, as a string value.

name

string

Name of the app.

port

integer

Port the app listens on.

projectId

string

ID of the project the app belongs to.

pythonVersion

string

Python version the app uses.

readycheckEndpoint

string

HTTP endpoint used to check that the app is ready to receive traffic.

region

string

Region the app is deployed in.

replicaConcurrency

string

Maximum concurrent requests per replica, as a string value.

responseGracePeriodSeconds

string

Grace period in seconds for in-flight requests when a replica stops, as a string value.

rollOutDurationSeconds

string

Duration in seconds over which a new version is rolled out, as a string value.

runtime

string

App runtime, cortex or custom.

scalingBuffer

string

Number of extra replicas kept available beyond current demand, as a string value.

scalingMetric

string

Metric used for autoscaling.

scalingTarget

string

Target value for the scaling metric, as a string value.

status

string

Current status of the app.

updatedAt

string

Timestamp when the app was last updated.

⌘I

Builds

Projects

API Keys

Apps

Containers

Metrics

Runs

Secrets

Billing

Custom Domains

Subscriptions

Service Accounts

Users

Volumes

Files

Cerebrium Run

Integrations

Authorizations

Path Parameters

Response