Previewv0.1.0
58 actions · 1 auth method
Developer Tools
Getting Started
1
Create or Select a Project
Set up a new project or select an existing one. See Organizations & Projects.
2
Configure the Connector
Enable the connector and set up a Connector Profile in your project. See Setup Connector Profile.
Connector Profile · API Key
Uses a team API key sent in the X-API-Key header. No app registration required. The key is team-scoped, so it reaches on…
3
Link an Account
Link an account from the dashboard (or via StackOne Hub).See the guide for the authentication type chosen in the Connector Profile:
Link Account · API Key
4
Use Actions
Connect an AI platform to the linked account’s actions. See AI Platforms.Other ways to call actions are listed in Protocols & SDKs.
Actions
58 actions
Action
Description
List Directory
List the entries of a directory inside a running sandbox, optionally recursing to a given depth.
Stat File
Return metadata for one path inside a running sandbox.
Upload File
Upload a file into a running sandbox, creating parent directories as needed.
Download File
Download a file from inside a running sandbox by path.
Make Directory
Create a directory inside a running sandbox.
Move File
Move or rename a file or directory inside a running sandbox.
Remove File
Delete a file or directory inside a running sandbox.
Create Watcher
Create a pollable filesystem watcher on a directory inside a running sandbox.
Get Watcher Events
Drain the filesystem events a watcher has buffered since the last poll.
Remove Watcher
Destroy a filesystem watcher and free its server-side event buffer.
Compose Files
Concatenate several files inside a sandbox into one using zero-copy composition.
List Processes
List the processes currently running inside a sandbox.
Send Process Input
Send stdin or PTY bytes to a running process inside a sandbox.
Send Process Signal
Send a termination signal to a running process inside a sandbox.
Update Process
Update a running process inside a sandbox, such as resizing its pseudo-terminal.
Close Process Stdin
Close standard input on a running process to signal end of file.
Get Sandbox Health
Probe whether a sandbox’s in-sandbox agent is alive and reachable.
Get Sandbox Service Stats
Return internal service statistics from a sandbox’s in-sandbox agent.
List Sandbox Environment Variables
Return the environment variables visible inside a running sandbox.
List Sandboxes
List the team’s sandboxes, newest first, with optional state, template, metadata and start-time filters.
Get Sandbox
Get a single sandbox by ID, including its state, resource allocation, expiry and envd access token.
Create Sandbox
Start a new sandbox from a template and return its ID and envd access token.
Connect To Sandbox
Return sandbox details and resume the sandbox first if it is paused.
Pause Sandbox
Snapshot a sandbox in place and stop it so it can be resumed later.
Kill Sandbox
Terminate a sandbox immediately and release its resources.
Fork Sandbox
Checkpoint a running sandbox and create new sandboxes from that snapshot.
Set Sandbox Timeout
Overwrite a sandbox’s time to live so it expires the given number of seconds from now.
Refresh Sandbox
Extend a sandbox’s time to live to keep it alive.
Update Sandbox Network
Replace the egress network rules on a running sandbox.
Get Sandbox Logs
Read a sandbox’s log stream with cursor, direction, level and search filters.
Get Sandbox Metrics
Return the CPU, memory and disk time series for one sandbox.
List Sandbox Metrics
Return metrics for several sandboxes in a single call.
Create Snapshot
Capture a sandbox’s current state as a persistent snapshot that outlives the sandbox.
List Snapshots
List the team’s snapshots, optionally filtered by source sandbox or name.
List Secrets
List the project’s secrets, returning metadata only.
Get Secret
Get one secret’s metadata by identifier or name.
Create Secret
Create a secret by storing a runtime marker as its first version.
Update Secret
Rotate a secret by appending a new version of its stored marker.
Delete Secret
Revoke a secret and schedule its versions for cleanup.
List Template Tags
List all tags pointing at builds of one template.
Assign Tags
Assign one or more tags to a template build.
Delete Tags
Delete one or more tags from a template.
Get Team Metrics
Return the team’s concurrent-sandbox and sandbox-start-rate time series over an interval.
Get Team Metrics Max
Return the peak value of one team metric over an interval.
List Templates
List the team’s template definitions.
Check Template Alias
Check whether a template exists under a given alias.
List Template Builds
List all builds for one template.
Create Template
Create a new sandbox template and its initial build record.
Update Template
Update a template’s settings, such as whether it is public.
Delete Template
Delete a template and its builds.
Get Build Upload Link
Get a presigned upload link for a tar file of template build layer files.
Start Build
Start building a template image from a base image or template and a list of steps.
Get Build Status
Get the status of one template build, with a slice of its logs.
Get Build Logs
Read a template build’s log stream with cursor, direction, level and source filters.
List Volumes
List the team’s persistent volumes.
Get Volume
Get one persistent volume by ID.
Create Volume
Create a new persistent volume for the team.
Delete Volume
Delete a persistent volume from the team.