Skip to main content
PATCH
/
v2
/
projects
/
{project_id}
/
apps
/
{app_id}
Modify App
curl --request PATCH \
  --url https://rest.cerebrium.ai/v2/projects/{project_id}/apps/{app_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "compute": "<string>",
  "cooldownPeriodSeconds": 123,
  "cpu": "<string>",
  "gpuCount": 123,
  "maxReplicaCount": 123,
  "memory": "<string>",
  "minReplicaCount": 123,
  "replicaConcurrency": 123,
  "responseGracePeriodSeconds": 123
}
'
import requests

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

payload = {
    "compute": "<string>",
    "cooldownPeriodSeconds": 123,
    "cpu": "<string>",
    "gpuCount": 123,
    "maxReplicaCount": 123,
    "memory": "<string>",
    "minReplicaCount": 123,
    "replicaConcurrency": 123,
    "responseGracePeriodSeconds": 123
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    compute: '<string>',
    cooldownPeriodSeconds: 123,
    cpu: '<string>',
    gpuCount: 123,
    maxReplicaCount: 123,
    memory: '<string>',
    minReplicaCount: 123,
    replicaConcurrency: 123,
    responseGracePeriodSeconds: 123
  })
};

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 => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'compute' => '<string>',
    'cooldownPeriodSeconds' => 123,
    'cpu' => '<string>',
    'gpuCount' => 123,
    'maxReplicaCount' => 123,
    'memory' => '<string>',
    'minReplicaCount' => 123,
    'replicaConcurrency' => 123,
    'responseGracePeriodSeconds' => 123
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

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

	payload := strings.NewReader("{\n  \"compute\": \"<string>\",\n  \"cooldownPeriodSeconds\": 123,\n  \"cpu\": \"<string>\",\n  \"gpuCount\": 123,\n  \"maxReplicaCount\": 123,\n  \"memory\": \"<string>\",\n  \"minReplicaCount\": 123,\n  \"replicaConcurrency\": 123,\n  \"responseGracePeriodSeconds\": 123\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.patch("https://rest.cerebrium.ai/v2/projects/{project_id}/apps/{app_id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"compute\": \"<string>\",\n  \"cooldownPeriodSeconds\": 123,\n  \"cpu\": \"<string>\",\n  \"gpuCount\": 123,\n  \"maxReplicaCount\": 123,\n  \"memory\": \"<string>\",\n  \"minReplicaCount\": 123,\n  \"replicaConcurrency\": 123,\n  \"responseGracePeriodSeconds\": 123\n}")
  .asString();
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::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"compute\": \"<string>\",\n  \"cooldownPeriodSeconds\": 123,\n  \"cpu\": \"<string>\",\n  \"gpuCount\": 123,\n  \"maxReplicaCount\": 123,\n  \"memory\": \"<string>\",\n  \"minReplicaCount\": 123,\n  \"replicaConcurrency\": 123,\n  \"responseGracePeriodSeconds\": 123\n}"

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

Authorizations

​
Authorization
string
header
required

Service Account Token authentication. To authenticate API requests:

  1. 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

  2. Use the Token: Include the service account token in the Authorization header of API requests: Authorization: Bearer <your-service-account-token>

  3. 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

Body

application/json
​
compute
string

Compute type. Valid values: ADA_L4, ADA_L40, AMPERE_A10, CPU, INF2, TRN1, TURING_T4.

​
cooldownPeriodSeconds
integer

Cooldown period in seconds. Range: 1-3600.

​
cpu
string

CPU allocation as a string value. Range: 0-100.

​
gpuCount
integer

Number of GPUs allocated. Range: 0-8.

​
maxReplicaCount
integer

Maximum number of replicas. Must be >= 1.

​
memory
string

Memory allocation as a string value. Range: 0-192.

​
minReplicaCount
integer

Minimum number of replicas. Must be >= 0.

​
replicaConcurrency
integer

Maximum concurrency per replica. Must be >= 1.

​
responseGracePeriodSeconds
integer

Response grace period in seconds. Range: 1-3600.

Response

200

OK