Browse the docs
Reference
WP-CLI commands, REST API endpoints and every Offloft setting, with its default and what it does, all in one place.
In this section
01WP-CLI commandsEvery wp offloft command: status, scan, offload, verify, restore, issues, fix, jobs and more.
Offloft's WP-CLI commands start with wp offloft. They cover 18 tasks, including status, scan, offload, verify, restore, issues, fix and job control. Run wp help offloft on your server for every option of a command. They're in the free plugin, so no license is needed.
Read the full page02REST APIThe offloft/v1 REST routes for status, files, issues, jobs, settings and more.
Offloft's REST API lives under /wp-json/offloft/v1 and has 38 routes. It uses WordPress's own authentication, such as an application password, and needs the same permission as Offloft's screens. The plugin's own screens use these routes too.
Read the full page03Settings, every option explainedEach Offloft setting in one list, with its default value and what it does when you change it.
Settings live under Offloft → Settings and save automatically. The defaults suit most sites, and you can leave anything in Advanced alone unless support asks. Number settings stay within an allowed range, and each one notes when it only applies to files offloaded from then on.
Read the full page04Site Health testsThe four tests Offloft adds to Tools → Site Health, and what each result means.
Offloft adds four tests to Tools → Site Health: your connection to storage, background tasks, delivery, and open issues. They read Offloft's stored state, so they add no requests to your provider when they run. A problem here means Offloft's work is affected. Your site keeps loading media from a working copy.
Read the full page