Create Base Image Hash
curl --request POST \
--url https://rest.cerebrium.ai/v3/projects/{project_id}/apps/{app_id}/base-image \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"dependencies": {},
"baseImageUri": "<string>",
"preBuildCommands": "<array>",
"shellCommands": "<array>"
}
'import requests
url = "https://rest.cerebrium.ai/v3/projects/{project_id}/apps/{app_id}/base-image"
payload = {
"dependencies": {},
"baseImageUri": "<string>",
"preBuildCommands": "<array>",
"shellCommands": "<array>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
dependencies: {},
baseImageUri: '<string>',
preBuildCommands: '<array>',
shellCommands: '<array>'
})
};
fetch('https://rest.cerebrium.ai/v3/projects/{project_id}/apps/{app_id}/base-image', 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/v3/projects/{project_id}/apps/{app_id}/base-image",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'dependencies' => [
],
'baseImageUri' => '<string>',
'preBuildCommands' => '<array>',
'shellCommands' => '<array>'
]),
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/v3/projects/{project_id}/apps/{app_id}/base-image"
payload := strings.NewReader("{\n \"dependencies\": {},\n \"baseImageUri\": \"<string>\",\n \"preBuildCommands\": \"<array>\",\n \"shellCommands\": \"<array>\"\n}")
req, _ := http.NewRequest("POST", 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.post("https://rest.cerebrium.ai/v3/projects/{project_id}/apps/{app_id}/base-image")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"dependencies\": {},\n \"baseImageUri\": \"<string>\",\n \"preBuildCommands\": \"<array>\",\n \"shellCommands\": \"<array>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://rest.cerebrium.ai/v3/projects/{project_id}/apps/{app_id}/base-image")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"dependencies\": {},\n \"baseImageUri\": \"<string>\",\n \"preBuildCommands\": \"<array>\",\n \"shellCommands\": \"<array>\"\n}"
response = http.request(request)
puts response.read_body{
"digest": "<string>",
"status": "<string>"
}{
"message": "<string>"
}{
"message": "<string>"
}Builds
Create Base Image Hash
Generate a SHA256 hash from dependency lists to determine if a base image rebuild is needed.
POST
/
v3
/
projects
/
{project_id}
/
apps
/
{app_id}
/
base-image
Create Base Image Hash
curl --request POST \
--url https://rest.cerebrium.ai/v3/projects/{project_id}/apps/{app_id}/base-image \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"dependencies": {},
"baseImageUri": "<string>",
"preBuildCommands": "<array>",
"shellCommands": "<array>"
}
'import requests
url = "https://rest.cerebrium.ai/v3/projects/{project_id}/apps/{app_id}/base-image"
payload = {
"dependencies": {},
"baseImageUri": "<string>",
"preBuildCommands": "<array>",
"shellCommands": "<array>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
dependencies: {},
baseImageUri: '<string>',
preBuildCommands: '<array>',
shellCommands: '<array>'
})
};
fetch('https://rest.cerebrium.ai/v3/projects/{project_id}/apps/{app_id}/base-image', 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/v3/projects/{project_id}/apps/{app_id}/base-image",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'dependencies' => [
],
'baseImageUri' => '<string>',
'preBuildCommands' => '<array>',
'shellCommands' => '<array>'
]),
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/v3/projects/{project_id}/apps/{app_id}/base-image"
payload := strings.NewReader("{\n \"dependencies\": {},\n \"baseImageUri\": \"<string>\",\n \"preBuildCommands\": \"<array>\",\n \"shellCommands\": \"<array>\"\n}")
req, _ := http.NewRequest("POST", 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.post("https://rest.cerebrium.ai/v3/projects/{project_id}/apps/{app_id}/base-image")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"dependencies\": {},\n \"baseImageUri\": \"<string>\",\n \"preBuildCommands\": \"<array>\",\n \"shellCommands\": \"<array>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://rest.cerebrium.ai/v3/projects/{project_id}/apps/{app_id}/base-image")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"dependencies\": {},\n \"baseImageUri\": \"<string>\",\n \"preBuildCommands\": \"<array>\",\n \"shellCommands\": \"<array>\"\n}"
response = http.request(request)
puts response.read_body{
"digest": "<string>",
"status": "<string>"
}{
"message": "<string>"
}{
"message": "<string>"
}Authorizations
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.
Query Parameters
Region the base image is built for. Defaults to the app's deployed region
Body
application/json