Environments

Create and manage environments for your Stormkit applications

The Environments API allows you to programmatically create and delete environments within your applications.

Create Environment

POST /v1/env · endpoint

Create a new environment for an application.

Requires an application or team level API key.

Request Body

appId · number · required

The application ID

name · string · required

The environment name

branch · string · required

The default Git branch for this environment

autoDeploy · boolean · default: "false"

Enable automatic deployments

autoPublish · boolean · default: "false"

Automatically publish new deployments

buildCmd · string

The build command (e.g., “npm run build”)

distFolder · string

The output folder containing build assets

envVars · object

Environment variables as key-value pairs

apiFolder · string

The folder containing serverless API functions

autoDeployBranches · string

Regex/glob pattern to filter branches for auto-deployment

autoDeployCommits · string

Regex/glob pattern to filter commits for auto-deployment

errorFile · string

Custom error page file path (must be in distFolder)

headersFile · string

Path to custom headers file

redirectsFile · string

Path to custom redirects file

previewLinks · boolean

Enable preview links on pull/merge requests

serverCmd · string

Server command for running the application (self-hosted only)

statusChecks · array

Post-deployment status check commands

Show Status Check Object

name · string · required

Status check name

cmd · string · required

Command to execute

description · string

Status check description

redirects · array

Array of redirect rules (see Redirects API)

Response

envId · string

The ID of the newly created environment

Request

curl -X POST \
  -H 'Authorization: <api_key>' \
  -H 'Content-Type: application/json' \
  'https://api.stormkit.io/v1/env' \
  -d '{
    "appId": 1510,
    "branch": "main",
    "name": "production",
    "autoDeploy": true,
    "autoPublish": true,
    "buildCmd": "npm run build",
    "distFolder": "dist",
    "envVars": {
      "NODE_ENV": "production",
      "API_URL": "https://api.example.com"
    }
  }'

---

Delete Environment

DELETE /v1/env · endpoint

Delete an environment by its ID.

Query Parameters

id · string · required

The environment ID to delete

Response

ok · boolean

Whether the deletion was successful

Request

curl -X DELETE \
  -H 'Authorization: <api_key>' \
  -H 'Content-Type: application/json' \
  'https://api.stormkit.io/v1/env?id=5061'

---

Environment Configuration

Environments in Stormkit support various configuration options:

Auto-Deploy Settings

Control which branches and commits trigger automatic deployments:

• autoDeployBranches: Use glob patterns like feature/* or regex patterns to match branch names
• autoDeployCommits: Filter commits by message pattern

Build Configuration

• buildCmd: The command executed during the build phase
• distFolder: Where your static assets are output after build
• apiFolder: Location of serverless functions

Custom Files

• errorFile: Custom 404/error page
• headersFile: Custom HTTP headers configuration
• redirectsFile: Custom redirects and rewrites

For detailed information about redirects and path rewrites, see the Redirects API documentation.