Valstorm LogoDev

sandbox Endpoints

All endpoints for the sandbox API group. Great for feeding into an LLM context.

GET

/v1/sandbox

List Sandboxes

Lists all sandbox environments associated with the active production organization. Only accessible by production organization administrators.

Responses
200
Successful Response
application/json
{
  "items": {
    "$ref": "#/components/schemas/SandboxResponse"
  },
  "type": "array",
  "title": "Response List Sandboxes V1 Sandbox Get"
}
404
Not found
API Runner
POST

/v1/sandbox

Create Sandbox

Creates a new isolated sandbox environment by copying production configurations, schemas, and users. Only accessible by production organization administrators.

Request Body
{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/SandboxCreateRequest"
      }
    }
  },
  "required": true
}
Responses
201
Successful Response
application/json
{
  "$ref": "#/components/schemas/SandboxResponse"
}
404
Not found
422
Validation Error
application/json
{
  "$ref": "#/components/schemas/HTTPValidationError"
}
API Runner
POST

/v1/sandbox/{name}/refresh

Refresh Sandbox

Wipes and refreshes an existing sandbox environment, restoring it to match the production state. Only accessible by production organization administrators.

Parameters
name*
in: path
type: string
Responses
200
Successful Response
application/json
{
  "$ref": "#/components/schemas/SandboxResponse"
}
404
Not found
422
Validation Error
application/json
{
  "$ref": "#/components/schemas/HTTPValidationError"
}
API Runner
DELETE

/v1/sandbox/{name}

Delete Sandbox

Permanently deletes a sandbox environment and all its isolated databases and configurations. Only accessible by production organization administrators.

Parameters
name*
in: path
type: string
Responses
200
Successful Response
application/json
{}
404
Not found
422
Validation Error
application/json
{
  "$ref": "#/components/schemas/HTTPValidationError"
}
API Runner
POST

/v1/sandbox/{name}/users

Add Users To Sandbox

Adds one or more users to a sandbox environment. Only accessible by production organization administrators.

Parameters
name*
in: path
type: string
Request Body
{
  "required": true,
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/SandboxUserRequest"
      }
    }
  }
}
Responses
200
Successful Response
application/json
{
  "$ref": "#/components/schemas/SandboxUserResponse"
}
404
Not found
422
Validation Error
application/json
{
  "$ref": "#/components/schemas/HTTPValidationError"
}
API Runner
DELETE

/v1/sandbox/{name}/users

Remove Users From Sandbox

Removes one or more users from a sandbox environment. Only accessible by production organization administrators.

Parameters
name*
in: path
type: string
Request Body
{
  "required": true,
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/SandboxUserRequest"
      }
    }
  }
}
Responses
200
Successful Response
application/json
{
  "$ref": "#/components/schemas/SandboxUserRemoveResponse"
}
404
Not found
422
Validation Error
application/json
{
  "$ref": "#/components/schemas/HTTPValidationError"
}
API Runner
POST

/v1/sandbox/{sandbox_name}/app/{app_name}/push

Push App From Sandbox

Extracts an app's configuration from the sandbox and deploys it to the target environment.

Parameters
sandbox_name*
in: path
type: string
app_name*
in: path
type: string
target
in: query

Optional target environment ID or database name

type: any
Responses
200
Successful Response
application/json
{}
404
Not found
422
Validation Error
application/json
{
  "$ref": "#/components/schemas/HTTPValidationError"
}
API Runner