keboola/sandboxes-service-api-client

Keboola Sandboxes Service API client

2.0.0 2026-06-19 13:59 UTC

Requires

• php: ^8.2
• guzzlehttp/guzzle: ^7.8
• keboola/php-api-client-base: *@dev
• monolog/monolog: ^2.0|^3.0
• webmozart/assert: ^1.11

Requires (Dev)

• infection/infection: ^0.27.9
• keboola/coding-standard: ^15.0
• phpstan/phpstan: ^1.10
• phpstan/phpstan-phpunit: ^1.3
• phpstan/phpstan-webmozart-assert: ^1.2
• sempro/phpunit-pretty-print: ^1.4
• symfony/http-client: ^6.4|^7.0

MIT

• Keboola

README

Installation

composer require keboola/sandboxes-service-api-client

Usage

Sandboxes API

use Keboola\SandboxesServiceApiClient\Sandboxes\SandboxesApiClient;

$client = new SandboxesApiClient(
    baseUrl: 'https://data-science.keboola.com',
    token: '{storage-api-token}',
    userAgent: 'My App',
);

$result = $client->createSandbox([
    'componentId' => 'keboola.data-apps',
    'configurationId' => '123',
    'configurationVersion' => '4',
    'type' => 'streamlit',
]);

Apps API

use Keboola\SandboxesServiceApiClient\Apps\AppsApiClient;

$client = new AppsApiClient(
    baseUrl: 'https://data-apps.keboola.com',
    token: '{storage-api-token}',
    userAgent: 'My App',
);

// List all apps
$apps = $client->listApps();

// Get specific app
$app = $client->getApp('app-id');

// Update app state
$client->patchApp('app-id', [
    'desiredState' => 'running',
    'restartIfRunning' => true,
]);

// Create new app (required fields only)
$app = $client->createApp([
    'type' => 'streamlit',
    'branchId' => '123', // use null for default branch
    'name' => 'My App',
]);

// Delete app
$client->deleteApp('app-id');

License

MIT licensed, see LICENSE file.