Skip to content
How to install

Sites hosted elsewhere

Connect a WordPress site hosted elsewhere through the WPL7 Connect plugin: create a connection, install its plugin on the site, then add the site. The last three endpoints are the plugin’s own.

Reading needs Read only and changes need Manage, unless an endpoint says otherwise. How to read this page.

List the connections that are not a site yet, newest first.

  • Level: Read only
  • Returns: {items: ConnectionSummaryDto[]}

Start connecting a site: it enrolls with the plugin this hands out.

  • Level: Manage
  • Input: {sourceUrl?, allowHttp?: false}
  • Returns: 201 ConnectionDto

One connection in full: the site’s report, its warnings and what Add site starts with.

  • Level: Read only
  • Returns: ConnectionDto

Download WPL7 Connect for this connection, to install on the site.

A zip file: the plugin with this connection’s file in it.

  • Level: Manage. It holds the token the site enrolls with
  • Notes: Not over MCP
  • Returns: application/zip

The panel address and connection code, for the plugin’s form when it came without its connection file.

  • Level: Manage. The code is the token the site enrolls with
  • Notes: Not over MCP
  • Returns: ConnectionCodeDto

Check that the panel reaches the plugin on the site now.

  • Level: Manage
  • Returns: ConnectionDto

Add the site: list it under External and take its first backup.

  • Level: Manage
  • Input: {slug?, title?, storageServerId?, actAs?, backups?: true}
  • Returns: 201 {site: SiteSummary, jobs: Job[]}

Delete a connection that is not a site.

  • Level: Manage
  • Notes: Destructive
  • Returns: 204

Change who an external site acts as, where its backups are kept, or take its new address.

  • Level: Manage
  • Input: {actAs?, storageServerId? (needs Full), useNewHome?: true}
  • Returns: SiteDetail

POST /api/sites/:slug/connection/reconnect

Section titled “POST /api/sites/:slug/connection/reconnect”

A new plugin download for an external site: its keys change when that plugin connects.

  • Level: Manage
  • Returns: 201 ConnectionDto

POST /api/sites/:slug/connection/disconnect

Section titled “POST /api/sites/:slug/connection/disconnect”

Disconnect an external site; it stays listed, with its backups, and can reconnect.

  • Level: Manage
  • Notes: Destructive
  • Returns: SiteDetail

The plugin reports the site; the connection’s token goes in X-WPL7-Connect-Token.

  • Level: No key
  • Notes: Not over MCP
  • Input: the report (docs/internal/connect-protocol.md)

WPL7 Connect for a site to update itself, through a link the panel signed.

  • Level: No key
  • Notes: Not over MCP
  • Input: ?v&e&s
  • Returns: application/zip

A catalog zip for one install on a site, through a link the panel signed.

  • Level: No key
  • Notes: Not over MCP
  • Input: ?site&e&s
  • Returns: application/zip