List Local Sync projects (uploads)

GET

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

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

Sites available for Local Sync: uploads path, HTML page and knowledge file counts, section folders. On multisite this covers the network. Requires manage_network (MS) or edit_pages.

Authorizations

• cookie
• applicationPassword

Responses

200

Projects

Media typeapplication/json

object

projects

Local Sync project list.

Array<object>

object

blog_id

Network site ID. Optional on a single site.

integer

name

Human-readable name.

string

url

URL.

string

sync_path

Field “sync_path” as returned or accepted by PHP.

string

is_main

Field “is_main” as returned or accepted by PHP.

boolean

pages_files

Field “pages_files” as returned or accepted by PHP.

integer

knowledge_files

Field “knowledge_files” as returned or accepted by PHP.

integer

sections

Course Manager items.

Array<object>

object

title

Title.

string

id

Numeric entity id.

integer

slug

Slug (site, post, or section).

string

Example^generated

{
  "projects": [
    {
      "blog_id": 1,
      "name": "example",
      "url": "example",
      "sync_path": "example",
      "is_main": true,
      "pages_files": 1,
      "knowledge_files": 1,
      "sections": [
        {
          "title": "example",
          "id": 1,
          "slug": "example"
        }
      ]
    }
  ]
}

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": {}
}