Admin, System & Files SDK Reference — ApexKit Docs

# Admin, System & Files SDK Reference The `apex.admins`, `apex.files`, `apex.logs`, and `apex.sites` namespaces provide complete administrative, system diagnostics, S3/Local file attachments, and static site deployment features. --- ## 1. Collection & Schema Management The `admins` namespace allows platform administrators to programmatically manipulate schemas and trigger system-wide index maintenance. ### Method Signatures - `admins.listCollections()` - `admins.getCollection(id)` - `admins.createCollection(name, schema)` - `admins.updateCollection(id, payload)` - `admins.patchCollection(id, payload)` - `admins.deleteCollection(id)` - `admins.reIndex(collectionId?)` - `admins.revectorizeCollection(collectionId, force?)` - `admins.importSchema(file, strategy?)` - `admins.exportSchema()` --- ## 2. Configuration Store Manage persistent server settings securely. ### Method Signatures - `admins.listConfigs()` - `admins.setConfig(key, value, encrypt)` - `admins.deleteConfig(key)` --- ## 3. User & Role Management Query, create, update, or revoke user accounts. ### Method Signatures - `admins.listUsers(options?)` - `admins.registerUser(email, password?, role?, metadata?)` - `admins.updateUser(id, email?, password?, role?, metadata?)` - `admins.deleteUser(id)` ```typescript // Create a new Administrator user const user = await apex.admins.registerUser( 'staff@my-saas.com', 'ultraSecurePass1!', 'admin', { department: 'finance' } ); ``` --- ## 4. Multi-Tenant Operations (Root Scoped) Create and manage isolated customer databases. Typically requires a `root` authenticated JWT. ### Method Signatures - `admins.listTenants()` - `admins.createTenant(tenantId)` - `admins.updateTenant(id, data)` - `admins.updateTenantStatus(id, status)` - `admins.deleteTenant(id)` ```typescript // Register new tenant "tenant-beta" await apex.admins.createTenant('tenant-beta'); // Suspend a tenant instantly (Disables database access) await apex.admins.updateTenantStatus('tenant-beta', 'suspended'); ``` --- ## 5. Ephemeral Sandboxes (Scout & Create) Create, delete, or publish isolated sandboxes programmatically. ### Method Signatures - `admins.listSandboxes()` - `admins.createSandbox(name, cloneStrategy, cloneRecordLimit?, model?, initialPrompt?, collections?, scripts?, templates?)` - `admins.deleteSandbox(id)` - `admins.publishSandbox(id)` ```typescript // Spin up a sandbox, copying schemas and up to 20 records per collection const sandbox = await apex.admins.createSandbox( 'Feature-Test-Sandbox', 'partial', 20 ); console.log(`Sandbox session created with ID: ${sandbox.id}`); ``` --- ## 6. S3 & Local Storage Files Upload and manage assets. ApexKit seamlessly handles public and signed URL generation, plus on-the-fly thumbnail transformations. ### Method Signatures - `files.list(page?, perPage?)` - `files.upload(file)` - `files.uploadResumable(file, options?)` - `files.delete(id)` - `files.getFileUrl(filename, options?)` - `files.getOpenGrap