Create GitHub App

curl --request POST \
  --url https://rest.cerebrium.ai/v2/projects/{project_id}/apps/github \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "cliVersion": "<string>",
  "githubRepo": "<string>",
  "name": "<string>",
  "baseImage": "<string>",
  "cerebrium_toml": "<string>",
  "compute": "<array>",
  "computeTier": "<string>",
  "containerRuntime": "<string>",
  "cooldownPeriodSeconds": 123,
  "cpu": 123,
  "deploymentInitializationTimeout": 123,
  "disableAuth": true,
  "dockerAuth": "<string>",
  "dockerfilePath": "<string>",
  "entrypoint": "<array>",
  "evaluationIntervalSeconds": 123,
  "githubAutoDeploy": true,
  "githubBranch": "<string>",
  "githubPath": "<string>",
  "gpuCount": 123,
  "healthcheckEndpoint": "<string>",
  "loadBalancingAlgorithm": "<string>",
  "logLevel": "<string>",
  "maxReplicaCount": 123,
  "memory": 123,
  "minReplicaCount": 123,
  "partialUpload": true,
  "port": 123,
  "provider": "<string>",
  "pythonVersion": "<string>",
  "readycheckEndpoint": "<string>",
  "region": "<string>",
  "replicaConcurrency": 123,
  "responseGracePeriodSeconds": 123,
  "rollOutDurationSeconds": 123,
  "runtime": "<string>",
  "scalingBuffer": 123,
  "scalingMetric": "<string>",
  "scalingTarget": 123,
  "useUv": true
}
'

import requests

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

payload = {
    "cliVersion": "<string>",
    "githubRepo": "<string>",
    "name": "<string>",
    "baseImage": "<string>",
    "cerebrium_toml": "<string>",
    "compute": "<array>",
    "computeTier": "<string>",
    "containerRuntime": "<string>",
    "cooldownPeriodSeconds": 123,
    "cpu": 123,
    "deploymentInitializationTimeout": 123,
    "disableAuth": True,
    "dockerAuth": "<string>",
    "dockerfilePath": "<string>",
    "entrypoint": "<array>",
    "evaluationIntervalSeconds": 123,
    "githubAutoDeploy": True,
    "githubBranch": "<string>",
    "githubPath": "<string>",
    "gpuCount": 123,
    "healthcheckEndpoint": "<string>",
    "loadBalancingAlgorithm": "<string>",
    "logLevel": "<string>",
    "maxReplicaCount": 123,
    "memory": 123,
    "minReplicaCount": 123,
    "partialUpload": True,
    "port": 123,
    "provider": "<string>",
    "pythonVersion": "<string>",
    "readycheckEndpoint": "<string>",
    "region": "<string>",
    "replicaConcurrency": 123,
    "responseGracePeriodSeconds": 123,
    "rollOutDurationSeconds": 123,
    "runtime": "<string>",
    "scalingBuffer": 123,
    "scalingMetric": "<string>",
    "scalingTarget": 123,
    "useUv": True
}
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({
    cliVersion: '<string>',
    githubRepo: '<string>',
    name: '<string>',
    baseImage: '<string>',
    cerebrium_toml: '<string>',
    compute: '<array>',
    computeTier: '<string>',
    containerRuntime: '<string>',
    cooldownPeriodSeconds: 123,
    cpu: 123,
    deploymentInitializationTimeout: 123,
    disableAuth: true,
    dockerAuth: '<string>',
    dockerfilePath: '<string>',
    entrypoint: '<array>',
    evaluationIntervalSeconds: 123,
    githubAutoDeploy: true,
    githubBranch: '<string>',
    githubPath: '<string>',
    gpuCount: 123,
    healthcheckEndpoint: '<string>',
    loadBalancingAlgorithm: '<string>',
    logLevel: '<string>',
    maxReplicaCount: 123,
    memory: 123,
    minReplicaCount: 123,
    partialUpload: true,
    port: 123,
    provider: '<string>',
    pythonVersion: '<string>',
    readycheckEndpoint: '<string>',
    region: '<string>',
    replicaConcurrency: 123,
    responseGracePeriodSeconds: 123,
    rollOutDurationSeconds: 123,
    runtime: '<string>',
    scalingBuffer: 123,
    scalingMetric: '<string>',
    scalingTarget: 123,
    useUv: true
  })
};

fetch('https://rest.cerebrium.ai/v2/projects/{project_id}/apps/github', 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/github",
  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([
    'cliVersion' => '<string>',
    'githubRepo' => '<string>',
    'name' => '<string>',
    'baseImage' => '<string>',
    'cerebrium_toml' => '<string>',
    'compute' => '<array>',
    'computeTier' => '<string>',
    'containerRuntime' => '<string>',
    'cooldownPeriodSeconds' => 123,
    'cpu' => 123,
    'deploymentInitializationTimeout' => 123,
    'disableAuth' => true,
    'dockerAuth' => '<string>',
    'dockerfilePath' => '<string>',
    'entrypoint' => '<array>',
    'evaluationIntervalSeconds' => 123,
    'githubAutoDeploy' => true,
    'githubBranch' => '<string>',
    'githubPath' => '<string>',
    'gpuCount' => 123,
    'healthcheckEndpoint' => '<string>',
    'loadBalancingAlgorithm' => '<string>',
    'logLevel' => '<string>',
    'maxReplicaCount' => 123,
    'memory' => 123,
    'minReplicaCount' => 123,
    'partialUpload' => true,
    'port' => 123,
    'provider' => '<string>',
    'pythonVersion' => '<string>',
    'readycheckEndpoint' => '<string>',
    'region' => '<string>',
    'replicaConcurrency' => 123,
    'responseGracePeriodSeconds' => 123,
    'rollOutDurationSeconds' => 123,
    'runtime' => '<string>',
    'scalingBuffer' => 123,
    'scalingMetric' => '<string>',
    'scalingTarget' => 123,
    'useUv' => true
  ]),
  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/github"

	payload := strings.NewReader("{\n  \"cliVersion\": \"<string>\",\n  \"githubRepo\": \"<string>\",\n  \"name\": \"<string>\",\n  \"baseImage\": \"<string>\",\n  \"cerebrium_toml\": \"<string>\",\n  \"compute\": \"<array>\",\n  \"computeTier\": \"<string>\",\n  \"containerRuntime\": \"<string>\",\n  \"cooldownPeriodSeconds\": 123,\n  \"cpu\": 123,\n  \"deploymentInitializationTimeout\": 123,\n  \"disableAuth\": true,\n  \"dockerAuth\": \"<string>\",\n  \"dockerfilePath\": \"<string>\",\n  \"entrypoint\": \"<array>\",\n  \"evaluationIntervalSeconds\": 123,\n  \"githubAutoDeploy\": true,\n  \"githubBranch\": \"<string>\",\n  \"githubPath\": \"<string>\",\n  \"gpuCount\": 123,\n  \"healthcheckEndpoint\": \"<string>\",\n  \"loadBalancingAlgorithm\": \"<string>\",\n  \"logLevel\": \"<string>\",\n  \"maxReplicaCount\": 123,\n  \"memory\": 123,\n  \"minReplicaCount\": 123,\n  \"partialUpload\": true,\n  \"port\": 123,\n  \"provider\": \"<string>\",\n  \"pythonVersion\": \"<string>\",\n  \"readycheckEndpoint\": \"<string>\",\n  \"region\": \"<string>\",\n  \"replicaConcurrency\": 123,\n  \"responseGracePeriodSeconds\": 123,\n  \"rollOutDurationSeconds\": 123,\n  \"runtime\": \"<string>\",\n  \"scalingBuffer\": 123,\n  \"scalingMetric\": \"<string>\",\n  \"scalingTarget\": 123,\n  \"useUv\": true\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/v2/projects/{project_id}/apps/github")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"cliVersion\": \"<string>\",\n  \"githubRepo\": \"<string>\",\n  \"name\": \"<string>\",\n  \"baseImage\": \"<string>\",\n  \"cerebrium_toml\": \"<string>\",\n  \"compute\": \"<array>\",\n  \"computeTier\": \"<string>\",\n  \"containerRuntime\": \"<string>\",\n  \"cooldownPeriodSeconds\": 123,\n  \"cpu\": 123,\n  \"deploymentInitializationTimeout\": 123,\n  \"disableAuth\": true,\n  \"dockerAuth\": \"<string>\",\n  \"dockerfilePath\": \"<string>\",\n  \"entrypoint\": \"<array>\",\n  \"evaluationIntervalSeconds\": 123,\n  \"githubAutoDeploy\": true,\n  \"githubBranch\": \"<string>\",\n  \"githubPath\": \"<string>\",\n  \"gpuCount\": 123,\n  \"healthcheckEndpoint\": \"<string>\",\n  \"loadBalancingAlgorithm\": \"<string>\",\n  \"logLevel\": \"<string>\",\n  \"maxReplicaCount\": 123,\n  \"memory\": 123,\n  \"minReplicaCount\": 123,\n  \"partialUpload\": true,\n  \"port\": 123,\n  \"provider\": \"<string>\",\n  \"pythonVersion\": \"<string>\",\n  \"readycheckEndpoint\": \"<string>\",\n  \"region\": \"<string>\",\n  \"replicaConcurrency\": 123,\n  \"responseGracePeriodSeconds\": 123,\n  \"rollOutDurationSeconds\": 123,\n  \"runtime\": \"<string>\",\n  \"scalingBuffer\": 123,\n  \"scalingMetric\": \"<string>\",\n  \"scalingTarget\": 123,\n  \"useUv\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://rest.cerebrium.ai/v2/projects/{project_id}/apps/github")

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  \"cliVersion\": \"<string>\",\n  \"githubRepo\": \"<string>\",\n  \"name\": \"<string>\",\n  \"baseImage\": \"<string>\",\n  \"cerebrium_toml\": \"<string>\",\n  \"compute\": \"<array>\",\n  \"computeTier\": \"<string>\",\n  \"containerRuntime\": \"<string>\",\n  \"cooldownPeriodSeconds\": 123,\n  \"cpu\": 123,\n  \"deploymentInitializationTimeout\": 123,\n  \"disableAuth\": true,\n  \"dockerAuth\": \"<string>\",\n  \"dockerfilePath\": \"<string>\",\n  \"entrypoint\": \"<array>\",\n  \"evaluationIntervalSeconds\": 123,\n  \"githubAutoDeploy\": true,\n  \"githubBranch\": \"<string>\",\n  \"githubPath\": \"<string>\",\n  \"gpuCount\": 123,\n  \"healthcheckEndpoint\": \"<string>\",\n  \"loadBalancingAlgorithm\": \"<string>\",\n  \"logLevel\": \"<string>\",\n  \"maxReplicaCount\": 123,\n  \"memory\": 123,\n  \"minReplicaCount\": 123,\n  \"partialUpload\": true,\n  \"port\": 123,\n  \"provider\": \"<string>\",\n  \"pythonVersion\": \"<string>\",\n  \"readycheckEndpoint\": \"<string>\",\n  \"region\": \"<string>\",\n  \"replicaConcurrency\": 123,\n  \"responseGracePeriodSeconds\": 123,\n  \"rollOutDurationSeconds\": 123,\n  \"runtime\": \"<string>\",\n  \"scalingBuffer\": 123,\n  \"scalingMetric\": \"<string>\",\n  \"scalingTarget\": 123,\n  \"useUv\": true\n}"

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

{
  "appId": "<string>",
  "appUrl": "<string>",
  "buildId": "<string>",
  "dashboardUrl": "<string>",
  "internalEndpoint": "<string>",
  "jwt": "<string>",
  "logUrl": "<string>",
  "projectId": "<string>",
  "status": "<string>"
}

{
  "message": "<string>"
}

{
  "message": "<string>"
}

POST

projects

{project_id}

apps

github

Create GitHub App

curl --request POST \
  --url https://rest.cerebrium.ai/v2/projects/{project_id}/apps/github \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "cliVersion": "<string>",
  "githubRepo": "<string>",
  "name": "<string>",
  "baseImage": "<string>",
  "cerebrium_toml": "<string>",
  "compute": "<array>",
  "computeTier": "<string>",
  "containerRuntime": "<string>",
  "cooldownPeriodSeconds": 123,
  "cpu": 123,
  "deploymentInitializationTimeout": 123,
  "disableAuth": true,
  "dockerAuth": "<string>",
  "dockerfilePath": "<string>",
  "entrypoint": "<array>",
  "evaluationIntervalSeconds": 123,
  "githubAutoDeploy": true,
  "githubBranch": "<string>",
  "githubPath": "<string>",
  "gpuCount": 123,
  "healthcheckEndpoint": "<string>",
  "loadBalancingAlgorithm": "<string>",
  "logLevel": "<string>",
  "maxReplicaCount": 123,
  "memory": 123,
  "minReplicaCount": 123,
  "partialUpload": true,
  "port": 123,
  "provider": "<string>",
  "pythonVersion": "<string>",
  "readycheckEndpoint": "<string>",
  "region": "<string>",
  "replicaConcurrency": 123,
  "responseGracePeriodSeconds": 123,
  "rollOutDurationSeconds": 123,
  "runtime": "<string>",
  "scalingBuffer": 123,
  "scalingMetric": "<string>",
  "scalingTarget": 123,
  "useUv": true
}
'

import requests

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

payload = {
    "cliVersion": "<string>",
    "githubRepo": "<string>",
    "name": "<string>",
    "baseImage": "<string>",
    "cerebrium_toml": "<string>",
    "compute": "<array>",
    "computeTier": "<string>",
    "containerRuntime": "<string>",
    "cooldownPeriodSeconds": 123,
    "cpu": 123,
    "deploymentInitializationTimeout": 123,
    "disableAuth": True,
    "dockerAuth": "<string>",
    "dockerfilePath": "<string>",
    "entrypoint": "<array>",
    "evaluationIntervalSeconds": 123,
    "githubAutoDeploy": True,
    "githubBranch": "<string>",
    "githubPath": "<string>",
    "gpuCount": 123,
    "healthcheckEndpoint": "<string>",
    "loadBalancingAlgorithm": "<string>",
    "logLevel": "<string>",
    "maxReplicaCount": 123,
    "memory": 123,
    "minReplicaCount": 123,
    "partialUpload": True,
    "port": 123,
    "provider": "<string>",
    "pythonVersion": "<string>",
    "readycheckEndpoint": "<string>",
    "region": "<string>",
    "replicaConcurrency": 123,
    "responseGracePeriodSeconds": 123,
    "rollOutDurationSeconds": 123,
    "runtime": "<string>",
    "scalingBuffer": 123,
    "scalingMetric": "<string>",
    "scalingTarget": 123,
    "useUv": True
}
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({
    cliVersion: '<string>',
    githubRepo: '<string>',
    name: '<string>',
    baseImage: '<string>',
    cerebrium_toml: '<string>',
    compute: '<array>',
    computeTier: '<string>',
    containerRuntime: '<string>',
    cooldownPeriodSeconds: 123,
    cpu: 123,
    deploymentInitializationTimeout: 123,
    disableAuth: true,
    dockerAuth: '<string>',
    dockerfilePath: '<string>',
    entrypoint: '<array>',
    evaluationIntervalSeconds: 123,
    githubAutoDeploy: true,
    githubBranch: '<string>',
    githubPath: '<string>',
    gpuCount: 123,
    healthcheckEndpoint: '<string>',
    loadBalancingAlgorithm: '<string>',
    logLevel: '<string>',
    maxReplicaCount: 123,
    memory: 123,
    minReplicaCount: 123,
    partialUpload: true,
    port: 123,
    provider: '<string>',
    pythonVersion: '<string>',
    readycheckEndpoint: '<string>',
    region: '<string>',
    replicaConcurrency: 123,
    responseGracePeriodSeconds: 123,
    rollOutDurationSeconds: 123,
    runtime: '<string>',
    scalingBuffer: 123,
    scalingMetric: '<string>',
    scalingTarget: 123,
    useUv: true
  })
};

fetch('https://rest.cerebrium.ai/v2/projects/{project_id}/apps/github', 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/github",
  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([
    'cliVersion' => '<string>',
    'githubRepo' => '<string>',
    'name' => '<string>',
    'baseImage' => '<string>',
    'cerebrium_toml' => '<string>',
    'compute' => '<array>',
    'computeTier' => '<string>',
    'containerRuntime' => '<string>',
    'cooldownPeriodSeconds' => 123,
    'cpu' => 123,
    'deploymentInitializationTimeout' => 123,
    'disableAuth' => true,
    'dockerAuth' => '<string>',
    'dockerfilePath' => '<string>',
    'entrypoint' => '<array>',
    'evaluationIntervalSeconds' => 123,
    'githubAutoDeploy' => true,
    'githubBranch' => '<string>',
    'githubPath' => '<string>',
    'gpuCount' => 123,
    'healthcheckEndpoint' => '<string>',
    'loadBalancingAlgorithm' => '<string>',
    'logLevel' => '<string>',
    'maxReplicaCount' => 123,
    'memory' => 123,
    'minReplicaCount' => 123,
    'partialUpload' => true,
    'port' => 123,
    'provider' => '<string>',
    'pythonVersion' => '<string>',
    'readycheckEndpoint' => '<string>',
    'region' => '<string>',
    'replicaConcurrency' => 123,
    'responseGracePeriodSeconds' => 123,
    'rollOutDurationSeconds' => 123,
    'runtime' => '<string>',
    'scalingBuffer' => 123,
    'scalingMetric' => '<string>',
    'scalingTarget' => 123,
    'useUv' => true
  ]),
  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/github"

	payload := strings.NewReader("{\n  \"cliVersion\": \"<string>\",\n  \"githubRepo\": \"<string>\",\n  \"name\": \"<string>\",\n  \"baseImage\": \"<string>\",\n  \"cerebrium_toml\": \"<string>\",\n  \"compute\": \"<array>\",\n  \"computeTier\": \"<string>\",\n  \"containerRuntime\": \"<string>\",\n  \"cooldownPeriodSeconds\": 123,\n  \"cpu\": 123,\n  \"deploymentInitializationTimeout\": 123,\n  \"disableAuth\": true,\n  \"dockerAuth\": \"<string>\",\n  \"dockerfilePath\": \"<string>\",\n  \"entrypoint\": \"<array>\",\n  \"evaluationIntervalSeconds\": 123,\n  \"githubAutoDeploy\": true,\n  \"githubBranch\": \"<string>\",\n  \"githubPath\": \"<string>\",\n  \"gpuCount\": 123,\n  \"healthcheckEndpoint\": \"<string>\",\n  \"loadBalancingAlgorithm\": \"<string>\",\n  \"logLevel\": \"<string>\",\n  \"maxReplicaCount\": 123,\n  \"memory\": 123,\n  \"minReplicaCount\": 123,\n  \"partialUpload\": true,\n  \"port\": 123,\n  \"provider\": \"<string>\",\n  \"pythonVersion\": \"<string>\",\n  \"readycheckEndpoint\": \"<string>\",\n  \"region\": \"<string>\",\n  \"replicaConcurrency\": 123,\n  \"responseGracePeriodSeconds\": 123,\n  \"rollOutDurationSeconds\": 123,\n  \"runtime\": \"<string>\",\n  \"scalingBuffer\": 123,\n  \"scalingMetric\": \"<string>\",\n  \"scalingTarget\": 123,\n  \"useUv\": true\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/v2/projects/{project_id}/apps/github")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"cliVersion\": \"<string>\",\n  \"githubRepo\": \"<string>\",\n  \"name\": \"<string>\",\n  \"baseImage\": \"<string>\",\n  \"cerebrium_toml\": \"<string>\",\n  \"compute\": \"<array>\",\n  \"computeTier\": \"<string>\",\n  \"containerRuntime\": \"<string>\",\n  \"cooldownPeriodSeconds\": 123,\n  \"cpu\": 123,\n  \"deploymentInitializationTimeout\": 123,\n  \"disableAuth\": true,\n  \"dockerAuth\": \"<string>\",\n  \"dockerfilePath\": \"<string>\",\n  \"entrypoint\": \"<array>\",\n  \"evaluationIntervalSeconds\": 123,\n  \"githubAutoDeploy\": true,\n  \"githubBranch\": \"<string>\",\n  \"githubPath\": \"<string>\",\n  \"gpuCount\": 123,\n  \"healthcheckEndpoint\": \"<string>\",\n  \"loadBalancingAlgorithm\": \"<string>\",\n  \"logLevel\": \"<string>\",\n  \"maxReplicaCount\": 123,\n  \"memory\": 123,\n  \"minReplicaCount\": 123,\n  \"partialUpload\": true,\n  \"port\": 123,\n  \"provider\": \"<string>\",\n  \"pythonVersion\": \"<string>\",\n  \"readycheckEndpoint\": \"<string>\",\n  \"region\": \"<string>\",\n  \"replicaConcurrency\": 123,\n  \"responseGracePeriodSeconds\": 123,\n  \"rollOutDurationSeconds\": 123,\n  \"runtime\": \"<string>\",\n  \"scalingBuffer\": 123,\n  \"scalingMetric\": \"<string>\",\n  \"scalingTarget\": 123,\n  \"useUv\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://rest.cerebrium.ai/v2/projects/{project_id}/apps/github")

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  \"cliVersion\": \"<string>\",\n  \"githubRepo\": \"<string>\",\n  \"name\": \"<string>\",\n  \"baseImage\": \"<string>\",\n  \"cerebrium_toml\": \"<string>\",\n  \"compute\": \"<array>\",\n  \"computeTier\": \"<string>\",\n  \"containerRuntime\": \"<string>\",\n  \"cooldownPeriodSeconds\": 123,\n  \"cpu\": 123,\n  \"deploymentInitializationTimeout\": 123,\n  \"disableAuth\": true,\n  \"dockerAuth\": \"<string>\",\n  \"dockerfilePath\": \"<string>\",\n  \"entrypoint\": \"<array>\",\n  \"evaluationIntervalSeconds\": 123,\n  \"githubAutoDeploy\": true,\n  \"githubBranch\": \"<string>\",\n  \"githubPath\": \"<string>\",\n  \"gpuCount\": 123,\n  \"healthcheckEndpoint\": \"<string>\",\n  \"loadBalancingAlgorithm\": \"<string>\",\n  \"logLevel\": \"<string>\",\n  \"maxReplicaCount\": 123,\n  \"memory\": 123,\n  \"minReplicaCount\": 123,\n  \"partialUpload\": true,\n  \"port\": 123,\n  \"provider\": \"<string>\",\n  \"pythonVersion\": \"<string>\",\n  \"readycheckEndpoint\": \"<string>\",\n  \"region\": \"<string>\",\n  \"replicaConcurrency\": 123,\n  \"responseGracePeriodSeconds\": 123,\n  \"rollOutDurationSeconds\": 123,\n  \"runtime\": \"<string>\",\n  \"scalingBuffer\": 123,\n  \"scalingMetric\": \"<string>\",\n  \"scalingTarget\": 123,\n  \"useUv\": true\n}"

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

{
  "appId": "<string>",
  "appUrl": "<string>",
  "buildId": "<string>",
  "dashboardUrl": "<string>",
  "internalEndpoint": "<string>",
  "jwt": "<string>",
  "logUrl": "<string>",
  "projectId": "<string>",
  "status": "<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

Body

application/json

cliVersion

string

required

Version of the client initiating the deployment.

githubRepo

string

required

GitHub repository to deploy from, in owner/repo format.

name

string

required

The name of the app. 3-30 lowercase alphanumeric characters and dashes.

baseImage

string

Base Docker image for the app. Default: debian:bookworm-slim.

cerebrium_toml

string

Verbatim contents of the cerebrium.toml configuration file.

compute

array

Compute type(s) for the app, in priority order. A single value or a list of up to 5. Valid values: ADA_L4, ADA_L40, AMPERE_A10, AMPERE_A100_40GB, AMPERE_A100_80GB, HOPPER_H100, HOPPER_H200, BLACKWELL_B200, BLACKWELL_RTX6000, CPU, INF2, TRN1, TURING_T4. Default: CPU.

computeTier

string

Compute tier for the app. Valid values: interruptible, protected.

containerRuntime

string

Container runtime version. Valid values: v1, v2.

cooldownPeriodSeconds

integer

Cooldown period in seconds before an idle replica scales down. Range: 0-3600. Default: 10.

cpu

number

Number of CPU cores to allocate. Range: 0.25-192. Default: 2.

deploymentInitializationTimeout

integer

Maximum time in seconds to wait for a deployment to initialize. Range: 60-830. Default: 600.

disableAuth

boolean

Disable authentication on the app endpoint. Default: false.

dockerAuth

string

Credentials for pulling the base image from a private Docker registry.

dockerfilePath

string

Path to a Dockerfile to build the app from.

entrypoint

array

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

evaluationIntervalSeconds

integer

Interval in seconds between autoscaling evaluations. Range: 6-300.

githubAutoDeploy

boolean

Automatically deploy new commits pushed to the configured branch.

githubBranch

string

Git branch to deploy. Default: main.

githubPath

string

Path within the repository containing the app.

gpuCount

integer

Number of GPUs to allocate. Range: 0-16. Default: 0.

healthcheckEndpoint

string

HTTP endpoint used to check that a custom runtime app is healthy.

loadBalancingAlgorithm

string

Load balancing algorithm. Valid values: round-robin, first-available, min-connections, random-choice-2.

logLevel

string

Log level for the deployment. Valid values: INFO, DEBUG, INTERNAL, ERROR. Default: INFO.

maxReplicaCount

integer

Maximum number of replicas. Range: 1-2000. Default: 1.

memory

number

Memory allocation in GB. Range: 0.05-1984. Default: 4.

minReplicaCount

integer

Minimum number of replicas. Range: 0-2000. Default: 0.

partialUpload

boolean

Whether the upload contains only files changed since the previous deployment.

port

integer

Port the app listens on. Range: 0-65535. Default: 8000.

provider

string

Cloud provider to deploy to. Valid values: aws, crusoe, nebius. Defaults to an automatically selected provider.

pythonVersion

string

Python version to use. Default: 3.10.

readycheckEndpoint

string

HTTP endpoint used to check that a custom runtime app is ready to receive traffic.

region

string

Region to deploy to. Defaults to an automatically selected region.

replicaConcurrency

integer

Maximum concurrent requests per replica. Defaults to 100 for CPU apps and 1 for GPU apps.

responseGracePeriodSeconds

integer

Grace period in seconds for in-flight requests when a replica stops. Range: 16-43200. Default: 900.

rollOutDurationSeconds

integer

Duration in seconds over which to roll out a new version. Range: 0-21600.

runtime

string

App runtime. Valid values: cortex, custom. Default: cortex.

scalingBuffer

integer

Number of extra replicas to keep available beyond current demand. Must be >= 0.

scalingMetric

string

Metric used for autoscaling. Valid values: cpu_utilization, memory_utilization, requests_per_second, concurrency_utilization. Default: concurrency_utilization.

scalingTarget

integer

Target value for the scaling metric. Must be > 0. Default: 100.

useUv

boolean

Use uv for Python package installation.

Response

Details of the created GitHub-linked app and its first build.

appId

string

Unique identifier of the created app.

appUrl

string

URL of the app in the dashboard.

buildId

string

ID of the build created for this deployment.

dashboardUrl

string

URL of the build in the dashboard.

internalEndpoint

string

Base URL for invoking the app.

jwt

string

Access token for streaming build logs.

logUrl

string

URL for retrieving build logs.

projectId

string

ID of the project the app belongs to.

status

string

Current status of the build.

⌘I

Builds

Projects

API Keys

Apps

Containers

Metrics

Runs

Secrets

Billing

Custom Domains

Subscriptions

Service Accounts

Users

Volumes

Files

Cerebrium Run

Integrations

Create GitHub App

Authorizations

Path Parameters

Body

Response