API
Serverless App Services
Create, read, update, transfer and delete Serverless App Services.
A Serverless App Service links a repository to builds and deployments.
Every route below, with its parameters, request and response, errors and samples, is in the API reference.
| Route | What it does |
|---|---|
GET /v1/orgs/:orgId/projects | Lists the organization's Serverless App Services. |
POST /v1/orgs/:orgId/projects | Creates a Serverless App Service. Without location, the registry's default location is used. |
GET /v1/orgs/:orgId/projects/:projectId | A Serverless App Service with its most recent deployments and, once it has a production deployment, its production hostname. |
PATCH /v1/orgs/:orgId/projects/:projectId | Updates the name, repository link, production branch, root directory, build and install commands, function memory and max duration (for new deployments; null returns to the default) or deployment protection (standard or off, applied to existing deployment URLs at once). repoId: null unlinks the repository; productionHold: false lets new production builds go live again after a rollback. |
GET /v1/orgs/:orgId/projects/:projectId/crons | The production deployment's cron jobs (si.json), whether they're paused, and each path's last scheduled call. |
PUT /v1/orgs/:orgId/projects/:projectId/crons | Pauses or resumes the Serverless App Service's cron jobs. Schedules stay and are disabled, and stay disabled when a deployment, promotion or rollback replaces them, until resumed. |
GET /v1/orgs/:orgId/projects/:projectId/protection/groups | The org's groups (Tenant → Groups) that protection can be limited to, by name. |
POST /v1/orgs/:orgId/projects/:projectId/protection/bypass | Creates (or replaces) the protection bypass secret: automation sends it as the x-si-protection-bypass header or query parameter. Only its hash is stored; it's shown once. |
DELETE /v1/orgs/:orgId/projects/:projectId/protection/bypass | Revokes the protection bypass secret: requests carrying it get the sign-in from then on. |
POST /v1/orgs/:orgId/projects/:projectId/transfer | Moves a Serverless App Service to another org the caller administers. Deployments, domains, environment variables (re-encrypted for the new org) and crons move with it; the repository stays and is disconnected, and linked storage must be unlinked first. |
DELETE /v1/orgs/:orgId/projects/:projectId | Deletes a project: its domains (routes and certificates), crons, server functions, routes, deployment records and environment variables. Linked storage is unlinked, not deleted, and the repository is kept. |