ONonkernel
Deployments

Create a deployment

Create a new deployment.

post/deployments

Request

  • Base URL
    https://api.onkernel.com
  • URL
    https://api.onkernel.com/deployments
  • Auth
    HTTP bearer

Request body multipart/form-data

OR

Example request

{
  "entrypoint_rel_path": "src/app.py",
  "file": "@path/to/file.zip",
  "region": "aws.us-east-1a",
  "source": {
    "auth": {
      "method": "github_token",
      "token": "ghs_***"
    },
    "entrypoint": "src/index.ts",
    "path": "apps/api",
    "ref": "main",
    "type": "github",
    "url": "https://github.com/org/repo"
  },
  "version": "1.0.0"
}

Response

Deployment created successfully

created_atstring date-time required

Timestamp when the deployment was created

entrypoint_rel_pathstring

Relative path to the application entrypoint

env_varsobject

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.

idstring required

Unique identifier for the deployment

region'aws.us-east-1a' required

Deployment region code

source_checksumstring

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.

source_pathstring

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.

source_refstring

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.

source_type'file' | 'github'

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.

source_urlstring

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

status'queued' | 'in_progress' | 'running' | 'failed' | 'stopped' required

Current status of the deployment

status_reasonstring

Status reason

updated_atstring date-time nullable

Timestamp when the deployment was last updated

Example response

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

Changes

No recorded changes to this operation across all 76 revisions of this API.