Deploy a website. Files is a map of file paths to file contents. Configuration is optional and contains additional information about the deployment.

POST/web/v1/deployment

Request Body

application/jsonRequired

sourceRequiredobject | object | object

The files to deploy, a map of file paths to file contents, e.g. { "index.js": {"content": "your main", "encoding": "utf-8"}, "file2.js": {"content": "your helper" } }

Do not include node modules in this bundle, they will not work. Instead, includes a package-lock.json, bun.lockb, pnpm-lock.yaml, or yarn.lock, the node modules for the project will be installed from that lock file, or use the node_modules field in the configuration to specify the node modules to install.

configobject

Response Body

200

successfully deployed

deploymentIdRequiredstring

Format: "uuid"

projectIdRequiredDeprecatedstring

Format: "uuid"

domainsarray | null

entrypointRequiredstring

The entrypoint file for the website. If not specified we try to automatically detect it.

400

failed to deploy

messageRequiredstring

curl -X POST "https://api.freestyle.sh/web/v1/deployment" \
  -H "Content-Type: application/json" \
  -d '{
    "source": {
      "files": {
        "property1": {
          "content": "string",
          "encoding": "string"
        },
        "property2": {
          "content": "string",
          "encoding": "string"
        }
      },
      "kind": "files"
    },
    "config": {
      "entrypoint": "index.js",
      "domains": [
        "subdomain.yourdomain.com"
      ],
      "projectId": null,
      "nodeModules": {
        "resend": "4.0.1"
      },
      "envVars": {
        "RESEND_API_KEY": "re_123456789"
      },
      "serverStartCheck": false,
      "networkPermissions": null,
      "build": null,
      "timeout": "15"
    }
  }'

successfully deployed

{
  "deploymentId": "a73c85a1-d857-491e-a6b2-51dce05de7a2",
  "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
  "domains": [
    "string"
  ],
  "entrypoint": "string"
}

Deploy a Website

Request Body

Response Body

200

400

Response

TypeScript