List site-manager jobs

GET

/wp-json/wp2/site-manager/v1/jobs

curl --request GET \
  --url 'https://example.com/wp-json/wp2/site-manager/v1/jobs?type=site_manager.&limit=20' \
  --header 'X-WP-Nonce: <X-WP-Nonce>'

Current user’s jobs with type prefix site_manager. (duplicates and bulk). A super admin does not see others’ jobs here — list_for_user filters by user_id. Requires manage_network or manage_options.

Authorizations

• cookie
• applicationPassword

Parameters

Query Parameters

status

string

Filter by job status (pending, running, completed, failed, cancelled). Empty — all statuses.

type

string

default: site_manager.

Type prefix (str_starts_with). Default site_manager. — all module jobs. Narrow with e.g. site_manager.bulk.

limit

integer

default: 20 <= 100

Max jobs in items. PHP: max(1, min(100, limit ?: 20)).

Responses

200

Object with an items array (not a bare array).

Media typeapplication/json

object

items

Current user’s Site Manager jobs, newer closer to the start of the index.

Array<object>

object

job_id

Job UUID (PlatformJob::$job_id). Site Manager GET returns 404 job_not_found if the type does not start with site_manager. or the row is missing.

string format: uuid

type

Machine job type. Site Manager: site_manager.create_from_source, site_manager.bulk. Site Duplicator uses its own prefixes of the same PlatformJob.

string

status

Lifecycle status (pending / running / completed / failed; PHP may also return cancelled as terminal).

string

Allowed values: pending running completed failed

phase

Current worker phase (short progress label, e.g. bulk), not an HTTP status.

string

progress

Progress counters (percent / current / total) as the worker stored them in PlatformJob::$progress.

object

percent

Percent complete 0–100, if the worker writes it.

integer

current

How many units have been processed.

integer

total

How many units in total (e.g. number of blog_ids in bulk).

integer

message

Human-readable worker status (not a PIN and not a WP-CLI log).

string

user_id

Who enqueued the job. GET of another user’s job without manage_network — 403 forbidden. The jobs list returns only the current user’s jobs.

integer

network_id

Network where the job was created. Another network — 404 job_not_in_network (message “Job not found.”).

integer

payload

Worker input (for bulk — blog_ids/action/patch/drop_tables; for create_from_source — source_blog_id and new-site fields).

object

result

Result after completed (for bulk — succeeded/failed/total/processed). null until the job finishes successfully.

object

error

Error on failed. PHP stores {code, message} in PlatformJob::$error; null if it did not fail.

string

nullable

created_at

Job created time (GMT, gmdate('c')).

string format: date-time

updated_at

Last progress/status update time.

string format: date-time

completed_at

Time of transition to a terminal status; null while the job is running.

string format: date-time

nullable

Example

{
  "items": [
    {
      "job_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
      "type": "site_manager.bulk",
      "status": "pending",
      "phase": "",
      "message": "",
      "user_id": 1,
      "network_id": 1
    }
  ]
}

401

Not authenticated. DualRest: rest_forbidden (status 401) when there is no cookie session. 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

Missing manage_network/manage_options or invalid REST 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": {}
}