REST API Reference

API Documentation

Explore the LightUp.Cloud REST API. Select an OpenAPI YAML file below to view the complete specification.

AI Media Search

Search AI-indexed media with text, vector, hybrid, facet, and browse endpoints.

Authentication & Authorization

OAuth2 grants, PKCE, device authorization, login, sessions, and token lifecycle.

Browse bucket roots and virtual directories with filtering and access control.

Resumable multipart uploads with chunks, DVV conflict handling, and MD5 validation.

Scale images and video previews with crop, masks, watermarks, and custom dimensions.

Create, validate, accept, list, inspect, and revoke tenant invitations.

GETPOSTPATCHDELETE

Object & Directory Copy

Copy objects and pseudo-directories across buckets or within a bucket.

Object Download

Stream objects securely with bearer, cookie, signed-URL, and range support.

Object Management

Create directories, lock or restore objects, and soft-delete files and directories.

PATCHPOSTDELETE

Object & Directory Move

Move objects and pseudo-directories by copying and deleting source entries.

Object & Directory Rename

Rename files or recursively rename pseudo-directories while preserving metadata.

Retrieve manifests and stream incremental change events for synchronization clients.

Inspect S3, gen_servers, system resources, and optional OpenSearch health.

Tenant Management

Create and manage tenants, projects, plans, memberships, storage, and buckets.

GETPOSTPATCHDELETE

Users & OAuth Clients

Manage users, roles, tenant membership, and OAuth2 client credentials.

GETPOSTPATCHDELETE

Inspect object DVVs and restore a previous object version.

Stream generated WebM previews with HTTP range support.

Retrieve, upload, and delete bucket watermark PNGs.

Stream complete directories as ZIP64 archives without storing the archive on disk.