Create a deployment

Create a new deployment.

POST /deployments

cURL

github_private

curl --request POST \
  --url https://api.onkernel.com/deployments \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form 'source={
  "auth": {
    "method": "github_token",
    "token": "ghs_***"
  },
  "entrypoint": "index.ts",
  "path": "apps/service",
  "ref": "main",
  "type": "github",
  "url": "https://github.com/org/private-repo"
}' \
  --form version=latest \
  --form 0.file='@example-file' \
  --form 1.file='@example-file'

201

{
  "created_at": "2023-11-07T05:31:56Z",
  "id": "rr33xuugxj9h0bkf1rdt2bet",
  "region": "aws.us-east-1a",
  "status": "queued",
  "entrypoint_rel_path": "src/app.py",
  "env_vars": {},
  "source_checksum": "3f4d0ea1bd2c5c1a1a1f0e9d8c7b6a5948372615049382716a5b4c3d2e1f0a9b",
  "source_path": "apps/api",
  "source_ref": "main",
  "source_type": "github",
  "source_url": "https://github.com/org/repo",
  "status_reason": "Deployment in progress",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

multipart/form-data

App deployment data

Option 1

Option 2

App deployment request. Provide either file+entrypoint_rel_path or source.

entrypoint_rel_path · string · required

Relative path to the entrypoint of the application

Example:

"src/app.py"

file · file · required

ZIP file containing the application source directory

env_vars · object

Map of environment variables to set for the deployed application. Each key-value pair represents an environment variable.

Show child attributes

force · boolean · default: false

Allow overwriting an existing app version

Example:

false

region · string · default: aws.us-east-1a

Region for deployment. Currently we only support "aws.us-east-1a"

Allowed value: "aws.us-east-1a"

Example:

"aws.us-east-1a"

source · object

Source from which to fetch application code.

Show child attributes

version · string · default: latest

Version of the application. Can be any string.

Example:

"1.0.0"

Response

201

application/json

Deployment created successfully

Deployment record information.

created_at · string<date-time> · required

Timestamp when the deployment was created

id · string · required

Unique identifier for the deployment

Example:

"rr33xuugxj9h0bkf1rdt2bet"

region · string · required

Deployment region code

Allowed value: "aws.us-east-1a"

Example:

"aws.us-east-1a"

status · enum<string> · required

Current status of the deployment

Available options: queued, in_progress, running, failed, stopped

Example:

"queued"

entrypoint_rel_path · string

Relative path to the application entrypoint

Example:

"src/app.py"

env_vars · object

Environment variables configured for this deployment. Values are redacted for API key, OAuth, and managed-auth callers, which receive every key with an empty string value. Only dashboard sessions receive the actual values.

Show child attributes

source_checksum · string

Hex-encoded SHA-256 checksum of the source archive. For file uploads, this hashes the uploaded archive; for GitHub-sourced deployments, this hashes the GitHub archive downloaded by the API. Omitted for deployments created before this field was recorded.

Example:

"3f4d0ea1bd2c5c1a1a1f0e9d8c7b6a5948372615049382716a5b4c3d2e1f0a9b"

source_path · string

For GitHub-sourced deployments, the subpath within the repository that was used as the deploy root. Omitted when the repo root was used or for file uploads.

Example:

"apps/api"

source_ref · string

For GitHub-sourced deployments, the git ref as requested at deploy time (branch, tag, or commit SHA — not resolved to a commit). Omitted for file uploads.

Example:

"main"

source_type · enum<string>

Origin of the deployed source code. This is read-only response provenance; file indicates an uploaded archive and github indicates a repository fetched by the API.

Available options: file, github

Example:

"github"

source_url · string

For GitHub-sourced deployments, the repository URL that was fetched. Omitted for file uploads.

Example:

"https://github.com/org/repo"

status_reason · string

Status reason

Example:

"Deployment in progress"

updated_at · string<date-time> | null

Timestamp when the deployment was last updated