WP REST API Explorer — Examples

Hands-on runs with the WP REST API Explorer: a first check, a DDEV site before go-live, closing user enumeration, a login test and a client report.

Back to the overview: WP REST API Explorer · Open the tool: www.jpkc.com/tools/wp-api/

The manual covers setup, the check run and every tab in detail. This page adds concrete workflows, step by step. The interface is in English, so tab and button names appear exactly as you'll see them in the live tool. All addresses, numbers and findings here are examples, not fixed values of the tool. And as always: only check sites you own or are allowed to test.

Example 1: First check of a site you've taken over

You've taken over maintenance of https://example.com and want to know what the site reveals through its API.

  1. Download localproxy for your system from the GitHub releases (step 1 of the guide in the tool) and start it with the command from step 2, on Linux for instance:

    ./localproxy --origin "https://www.jpkc.com" --port 8765
  2. If your browser asks for access to the local network, choose Allow. The first connection always fails when that happens; the tool tries again shortly afterwards.

  3. Copy the proxy's startup box into Or paste the proxy's startup text and click Connect. The status line reports "Local proxy ready" with the version.

  4. Enter https://example.com under Site address and click Check site. The run strip shows the phases from Discovery to Final probes and the request counter, against a default limit of 500.

  5. When it's done, read the Quick Check: the headline tells you whether anything needs action and how much could be checked. If it says something like "We found nothing that needs action in the content we looked at (…)", that rests on a sample — not on every single item.

  6. Expand the groups under Security. Good to know is rarely empty on a standard installation: a public user list or a readable WordPress version is WordPress default behaviour, but worth knowing about.

  7. For your records, save the current state in the Snapshots tab with Save snapshot. You'll compare against this file later to see what has changed.

Example 2: Checking a DDEV site before go-live

The new site runs locally at https://example.ddev.site, and you want to check it before it goes public. Without permission, the proxy blocks private addresses, so you need localproxy 1.4.0 and --allow-local.

  1. Enter the local address in the address field first — the guide copies the host into the command under Optional → Local sites:

    ./localproxy --origin "https://www.jpkc.com" --port 8765 --allow-local "example.ddev.site"
  2. If DDEV runs over HTTPS, run mkcert -install once on the computer the proxy runs on. Otherwise the proxy rejects the certificate — it verifies TLS for local targets too, and that can't be switched off.

  3. After Connect, the status line should mention "local sites". If it doesn't, the diagnosis will later report "This local address is not on the proxy's allow list."

  4. Check site. Now Diagnosis is worth a look: "Home page and API answer normally." is what you want to see. If it says "Front end broken, API fine.", the theme or a plugin is breaking the home page; "WordPress thinks its address starts with http://. …" means the WordPress address is still set to http.

  5. Plugins & Theme shows what strangers will later be able to tell about your plugin setup. Every trace — a generator tag, say, or ?ver= on files — is listed there with its signal.

If you check several local projects, --allow-local "*.ddev.site" allows all DDEV projects at once. Only run the proxy with --allow-local while you're testing.

Example 3: Closing user enumeration and verifying the fix

The Security tab reports "User names are public" under Good to know: through /wp/v2/users, anyone can read the authors' short names — the first building block for login attacks.

  1. Open the finding in the Security tab. Under "What you can do" you'll find the advice, and below it the link Open the matching snippet: Hide the user list from the REST API. It opens the snippet in the WP Code Generator in a new tab.
  2. Generate the snippet there as a must-use plugin, put it in wp-content/mu-plugins/ and test it on the site.
  3. Before checking again, save the old state with Save snapshot.
  4. Check site once more. Now a new finding may show up: "User list is hidden, but names are visible elsewhere" (Worth reviewing). Probes P3 (the ?author= redirect), P6 (user sitemap) and P7 (embed data) show where the names still leak.
  5. For this, the card links two more snippets: Stop author redirects (?author=) and Remove the user sitemap. Apply them, then check again.
  6. Under Snapshots → Compare, compare the saved state with Current data. In the Findings row, Removed means "resolved" — provided both states really saw the item; otherwise it appears under Not comparable with a reason.

A word of caution: on sites that block scans for user names, P1 and P3 can get your IP blocked. If you check your own freshly hardened site several times in a row, its security plugin may lock you out — the diagnosis then says "Your IP may have been blocked by the site's firewall (user enumeration protection)."

Example 4: What does a subscriber see? A check with a login

Form or shop plugins sometimes store data in a way that lets logged-in users with a low role read more than visitors can. You can test that with a test account.

  1. In WordPress, create a test account with the Subscriber role and generate an application password in its profile. WordPress accepts application passwords only over HTTPS, local sites excepted.
  2. Check the site without a login first, using Check site — only after that can you use Apply.
  3. Open Credentials, choose Application password, enter the user name and application password and click Apply. The tool sends one request to users/me and reports whether the login works. If the browser offers to save it: Never.
  4. Check site again. After the public pass, Logged-in extras, Logged-in inventory and Logged-in sample run; the request limit is split 40 to 60. At the end, the Credentials area says "This check ran with your login · role: subscriber".
  5. In the Security tab, both login checks have now run: whether accounts with few rights can see plugin abilities, and whether they can read personal data or secrets that visitors can't. An Action needed here deserves to be taken seriously.
  6. Afterwards, click Forget — or reload the page. The credentials appear in no report, no export and no snapshot. Delete the application password in WordPress once you no longer need it.

Example 5: "The response is not a valid JSON response" in the block editor

A client reports that the editor shows this message when saving.

  1. Run Check site on her site. The Diagnosis tab gives the verdict: "The API answers, but PHP messages come before the data. The block editor then shows 'The response is not a valid JSON response.'"
  2. The Requests card shows the diagnosis requests; the rows marked "evidence" carry the verdict, with their excerpts shown as plain text.
  3. If the PHP message contains a file path, the Security tab additionally reports a finding from the check "Error responses show PHP file paths" (here in the variant "API answers show PHP file paths"). The advice there: switch off the display of PHP errors (display_errors, WP_DEBUG_DISPLAY) and fix the message itself.
  4. A related case is a BOM in front of the data: "The API answers with a byte order mark (BOM) before the data." Browsers and the editor don't mind, but server-side clients such as PHP's json_decode after wp_remote_get do — typically caused by a PHP file saved with a BOM.

Example 6: A report for the client

After a maintenance job, you want to document where the site stands.

  1. Check the site fully and wait until the run reports "Finished". If you stop earlier, the report only contains what had loaded by then.
  2. In the Reports tab, What these reports cover shows what was checked and what's still open. If probes are listed under "Still open", send them now or leave them out deliberately.
  3. Enter your agency name under Prepared by. It appears only in the customer report.
  4. Switch to Customer report and read the Preview: plain language, only counts and affected content types, no routes, no names, no evidence. The headline sentence is the same as in the Quick Check.
  5. Download report pack (ZIP) gives you the README, the technical report and the customer report in one package. Keep the technical report for yourself or the developers; it names routes, evidence and field paths, but masks e-mail addresses, phone numbers, bank details and keys.
  6. If you need the loaded content as a spreadsheet, choose CSV in the Export tab: one table per content type, plus findings and the request log. Make umlauts work in Excel (adds a BOM) is on by default; leave it on if the client opens the files in Excel.

For the strategy behind it — how to read levels and samples, and where the limits are — see the tips & tricks.