Skip to main content

Documentation Index

Fetch the complete documentation index at: https://unkey.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

Unkey Deploy is in public beta. To try it, open the product switcher in the top-left of the dashboard and select Deploy. During beta, deployed resources are free. We’re eager for feedback, so let us know what you think on Discord, X, or email support@unkey.com.
A project is the top-level organizational unit in Unkey Deploy. Each project maps to a single codebase (typically a GitHub repository) and groups the apps, environments, and configuration needed to build, deploy, and run your application.

​
Project hierarchy

Projects live inside a workspace. A project contains one or more apps, and each app has its own environments, deployments, and configuration. 
Workspace
  └── Project (one per codebase)
        └── App (deployable service)
              ├── Environments (production, preview, custom)
              │     ├── Deployments
              │     ├── Variables
              │     └── Custom domains
              └── Configuration (build, runtime, Sentinel)
An app represents a single deployable service within your project. When you create a project, Unkey creates a default app automatically. A project can contain multiple apps, for example an API server and a background worker that share the same repository. Build settings, runtime configuration, and Sentinel policies are configured per app. Variables and custom domains are scoped to an app’s environment.

​
Create a project

  1. Navigate to your workspace’s Projects page.
  2. Click New project.
  3. Enter a project name. Unkey generates a URL-friendly slug from the name, which you can edit.
  4. Connect your GitHub account if you haven’t already. You can skip this step and connect later.
  5. Select the repository to deploy from your connected GitHub accounts. To finish onboarding without a repository, for example, if you plan to deploy with the CLI or want to connect GitHub later, click Skip for now.
  6. Configure initial build and runtime settings. You can change these later.
  7. Click Deploy to trigger your first deployment.
The slug must be unique within your workspace and can only contain lowercase letters, numbers, and hyphens. If you skipped the repository step, the project is created without a connected repo. You can connect one later from the project’s Settings tab and trigger your first deployment from there.

​
Project dashboard

After creation, the project dashboard gives you four tabs:
TabWhat it shows
DeploymentsActive and past deployments across all environments, with commit info and status
LogsRuntime logs from your running instances
RequestsHTTP request analytics processed by the Sentinel
SettingsBuild, runtime, and advanced configuration. See Settings for details
The deployments tab is the default view when you open a project.

​
Delete a project

Deleting a project permanently removes all deployments, environments, custom domains, variables, and associated data. This action cannot be undone.
To delete a project:
  1. Open the project actions menu (three-dot icon on the project card).
  2. Select Delete project.
  3. Check the confirmation box acknowledging the permanent deletion.
  4. Confirm the deletion.
Deletion is asynchronous. Unkey removes all associated resources (deployments, environments, domains, variables) in the background. The project disappears from your workspace immediately, but cleanup of underlying resources completes shortly after.
Last modified on May 6, 2026