Run filesystem ↔ WordPress sync

POST

/wp-json/wp2/local-sync/v1/sync

curl --request POST \
  --url https://example.com/wp-json/wp2/local-sync/v1/sync \
  --header 'X-WP-Nonce: <X-WP-Nonce>'

Two-way sync between the Local Sync directory and WordPress: export sections, import changed HTML into posts, export missing files. No request body; choose the site with query blog_id.

Authorizations

• cookie
• applicationPassword

Parameters

Query Parameters

blog_id

integer

Network site ID. Optional on a single site.

Responses

200

Sync result

Media typeapplication/json

object

imported

How many files were imported into WP.

integer

skipped

How many files were skipped.

integer

exported

How many posts were exported to files.

integer

errors

Error list.

Array<string>

orphans

Orphan report object (posts_without_files, folders_without_terms, …).

object

posts_without_files

Array<string>

folders_without_terms

Array<string>

key

additional properties

any

ok

Whether the operation succeeded.

boolean

blog_id

Network site ID. Optional on a single site.

integer

base_path

Field “base_path” as returned or accepted by PHP.

string

Example^generated

{
  "imported": 1,
  "skipped": 1,
  "exported": 1,
  "errors": [
    "example"
  ],
  "orphans": {
    "posts_without_files": [
      "example"
    ],
    "folders_without_terms": [
      "example"
    ]
  },
  "ok": true,
  "blog_id": 1,
  "base_path": "example"
}

400

Wp2lms_local_sync_invalid_blog

Media typeapplication/json

object

code

Machine-readable error or event code.

string

message

Message text (log, PIN, or password reset).

string

data

Extra WP_Error or license payload.

object

Example^generated

{
  "code": "example",
  "message": "example",
  "data": {}
}

401

Not authenticated. WordPress REST: rest_not_logged_in / rest_forbidden. Use cookie + X-WP-Nonce or Application Password.

Media typeapplication/json

object

code

Machine-readable error or event code.

string

message

Message text (log, PIN, or password reset).

string

data

Extra WP_Error or license payload.

object

Example^generated

{
  "code": "example",
  "message": "example",
  "data": {}
}

403

Insufficient capability or invalid REST nonce. WordPress REST: rest_forbidden / rest_cookie_invalid_nonce.

Media typeapplication/json

object

code

Machine-readable error or event code.

string

message

Message text (log, PIN, or password reset).

string

data

Extra WP_Error or license payload.

object

Example^generated

{
  "code": "example",
  "message": "example",
  "data": {}
}

404

Wp2lms_local_sync_unknown_blog

Media typeapplication/json

object

code

Machine-readable error or event code.

string

message

Message text (log, PIN, or password reset).

string

data

Extra WP_Error or license payload.

object

Example^generated

{
  "code": "example",
  "message": "example",
  "data": {}
}