Получить задание управления сайтами

GET

/wp-json/wp2/site-manager/v1/jobs/{job_id}

curl --request GET \
  --url https://example.com/wp-json/wp2/site-manager/v1/jobs/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'X-WP-Nonce: <X-WP-Nonce>'

Состояние одного задания Site Manager. Тип должен начинаться с site_manager.; иначе 404 job_not_found (в т.ч. чужой модуль). Query wait > 0 — long-poll до изменения или таймаута (wait_for_change, clamp 1–30 с). Нужны manage_network или manage_options; чужое задание без manage_network — 403 forbidden.

Authorizations

• cookie
• applicationPassword

Parameters

Path Parameters

job_id

required

string format: uuid

UUID задания. Нет записи, тип не site_manager.* или другая сеть — 404 job_not_found / job_not_in_network.

Query Parameters

wait

integer

<= 30

Секунды long-poll, если задание ещё не терминальное. PHP clamp 1–30. 0 или нет параметра — отдать текущее состояние сразу.

Responses

200

Тело — PlatformJob::to_array.

Media typeapplication/json

object

job_id

UUID задания (PlatformJob::$job_id). В Site Manager GET отдаёт 404 job_not_found, если тип не начинается с site_manager. или записи нет.

string format: uuid

type

Машинный тип задания. Site Manager: site_manager.create_from_source, site_manager.bulk. Site Duplicator использует свои префиксы того же PlatformJob.

string

status

Статус жизненного цикла (pending / running / completed / failed; PHP также может отдать cancelled как терминальный).

string

Allowed values: pending running completed failed

phase

Текущая фаза воркера (короткая метка прогресса, например bulk), не HTTP-статус.

string

progress

Счётчики прогресса (percent / current / total), как сложил воркер в PlatformJob::$progress.

object

percent

Процент выполнения 0–100, если воркер его пишет.

integer

current

Сколько единиц уже обработано.

integer

total

Сколько единиц всего (например число blog_ids в bulk).

integer

message

Человекочитаемый статус воркера (не PIN и не лог WP-CLI).

string

user_id

Кто поставил задание. GET чужого job без manage_network — 403 forbidden. Список jobs отдаёт только задания текущего пользователя.

integer

network_id

Сеть, в которой создали задание. Чужая сеть — 404 job_not_in_network (текст «Job not found.»).

integer

payload

Вход воркера (для bulk — blog_ids/action/patch/drop_tables; для create_from_source — source_blog_id и поля нового сайта).

object

result

Результат после completed (для bulk — succeeded/failed/total/processed). null, пока задание не закончено успешно.

object

error

Ошибка при failed. PHP кладёт массив {code, message} в PlatformJob::$error; null, если не падало.

string

nullable

created_at

Время создания задания (GMT, gmdate('c')).

string format: date-time

updated_at

Время последнего обновления прогресса/статуса.

string format: date-time

completed_at

Время перехода в терминальный статус; null, пока задание идёт.

string format: date-time

nullable

Example

{
  "status": "pending"
}

401

Не аутентифицирован. DualRest: rest_forbidden (status 401), если нет cookie-сессии. Cookie + X-WP-Nonce или Application Password.

Media typeapplication/json

object

code

Машинный код ошибки или события.

string

message

Текст сообщения (лог, PIN, сброс пароля).

string

data

Дополнительные данные WP_Error или лицензии.

object

Example^generated

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

403

Forbidden — задание другого пользователя без manage_network; либо невалидный REST nonce.

Media typeapplication/json

object

code

Машинный код ошибки или события.

string

message

Текст сообщения (лог, PIN, сброс пароля).

string

data

Дополнительные данные WP_Error или лицензии.

object

Example^generated

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

404

Job_not_found / job_not_in_network (текст «Job not found.»).

Media typeapplication/json

object

code

Машинный код ошибки или события.

string

message

Текст сообщения (лог, PIN, сброс пароля).

string

data

Дополнительные данные WP_Error или лицензии.

object

Example^generated

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