Management API Documentation - PHP SDK

This document covers the management API capabilities available in the PHP SDK, which correspond to the features available in the backend management UI.

Note: All management API operations require superuser authentication (🔐).

Table of Contents

Settings Service

The Settings Service provides comprehensive management of application settings.

Get Application Settings

$settings = $pb->settings->getApplicationSettings();
// Returns: ['meta' => ..., 'trustedProxy' => ..., 'rateLimits' => ..., 'batch' => ...]

Update Application Settings

$pb->settings->updateApplicationSettings([
    'meta' => [
        'appName' => 'My App',
        'appURL' => 'https://example.com',
        'hideControls' => false,
    ],
    'trustedProxy' => [
        'headers' => ['X-Forwarded-For'],
        'useLeftmostIP' => true,
    ],
    'rateLimits' => [
        'enabled' => true,
        'rules' => [
            [
                'label' => 'api/users',
                'duration' => 3600,
                'maxRequests' => 100,
            ],
        ],
    ],
    'batch' => [
        'enabled' => true,
        'maxRequests' => 100,
        'interval' => 200,
    ],
]);

Backup Service

See Backups API for detailed documentation.

Log Service

See Logs API for detailed documentation.

Cron Service

See Crons API for detailed documentation.

Health Service

See Health API for detailed documentation.

Collection Service

See Collection API and Collections for detailed documentation.