create-app

Create an app within a project. The app is created with default production and preview environments. Set exactly one source. Use git to create a GitHub-sourced app and connect its repository. Use oci to create an app from a prebuilt OCI image. The slug you provide is the stable, caller-defined handle used to reference this app. It must be unique within the project.

Usage

unkey api apps create-app [flags]

Flags

string

required

Project ID or slug.

string

required

Human-readable name for this app. Use a descriptive name like ‘Payments API’ to identify its purpose.

string

required

App slug. Accepts a resource ID or slug format.

JSON string

Connect a GitHub repository with a required repository field and optional defaultBranch field.

JSON string

Configure an OCI image source with a required image field. The image must include an explicit tag or digest.

Global Flags

Flag	Type	Description
`--root-key`	string	Override root key (`$UNKEY_ROOT_KEY`)
`--api-url`	string	Override API base URL (default: `https://api.unkey.com`)
`--config`	string	Path to config file (default: `~/.unkey/config.toml`)
`--output`	string	Output format. Use `json` for raw JSON
`--body`	string	Send this JSON string as the request body. You cannot combine it with request-building flags.

Examples

unkey api apps create-app --project=payments --name="Payments API" \
  --slug=payments-api \
  --git='{"repository":"unkeyed/api","defaultBranch":"main"}'

OCI image

unkey api apps create-app --project=payments --name="Payments API" \
  --slug=payments-api \
  --oci='{"image":"ghcr.io/acme/payments:v1.2.3"}'

See the API reference.

Getting Started

Platform

Build & Deploy

Networking

Observability

CLI

Security

Keyspaces

AI Code Gen

Audit Logs

Log Drains

CLI

Errors

Usage

Flags

Global Flags

Examples

​Usage

​Flags

​Global Flags

​Examples

Usage

Flags

Global Flags

Examples