compute

Fork sandbox

Forks a sandbox into a new sandbox or application. When forking to a sandbox, the target must not already exist (409 if it does). When forking to an application, a new revision is added if the app already exists, or a new application is created. This is a WIP endpoint — the full implementation depends on the execution plane.

post/sandboxes/{sandboxName}/fork

Request

Base URL
https://api.blaxel.ai/v0
Auth
- OAuth 2
  Authorization code/oauth/authorize
  Client credentials
  Token URL/oauth/token
  Scopessandboxes:create
- or HTTP bearer
TypeScript
https://skmtc.dev/blaxel/apis/blaxel-control-plane/docs/sandboxes/:sandboxName/fork/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

sandboxNamestring required

Name of the sandbox to fork

Request body

customDomainstring

Custom domain for the application

portinteger

Port to expose from the sandbox

prefixstring

URL prefix for the application

snapshotIdstring

Snapshot ID to fork from. When set, the application revision references this snapshot.

targetNamestring required

Name of the target application to create or update

targetTypestring required

Target resource type to fork into

trafficinteger

Traffic percentage for canary deployment (0-100). When set on an existing target, creates a new revision with this traffic percentage.

Example request

{
  "port": 8080,
  "targetName": "my-app",
  "targetType": "application",
  "traffic": 10
}

Response

Fork created successfully

namestring

Name of the created or updated resource

snapshotIdstring

The snapshot ID the fork was created from

type'sandbox' | 'application'

Type of resource that was created (sandbox or application)

Changes

No recorded changes to this operation across all 1 revision of this API.