---
title: "Check whether a Sitejet publish is running"
method: GET
path: "/Sitejet/is_publish_in_progress"
tags: ["Sitejet"]
---

# Check whether a Sitejet publish is running

`GET /Sitejet/is_publish_in_progress`

## Request

- Base URL: `https://cpanel-server.tld:2083/execute`
- URL: `https://cpanel-server.tld:2083/execute/Sitejet/is_publish_in_progress`
- Auth: HTTP basic

This function reports whether a Sitejet publish is currently running for a domain, and under which process ID.

## Query parameters

- `domain` string, required

## Response `200`

HTTP Request was successful.

- object
  - `apiversion` integer: The version of the API.
  - `func` string: The name of the method called.
  - `module` string: The name of the module called.
  - `result` object
    - `data` object
      - `in_progress` 1 | 0: - `1` - A publish is currently running for the domain. - `0` - No publish is running for the domain. `0` does not mean a publish can be started. A website migration holds the same lock without recording a publish and also reports `0`, and `start_publish` then fails with a migration error. Read `0` as "no publish to follow", not as "safe to publish".
      - `pid` integer: The running publish process's ID. The system only returns this field when `in_progress` is `1` and the publish daemon has started; while a publish is still starting up, `in_progress` is `1` without a `pid` - poll again. Pass it to the `poll_publish` function to follow the publish's progress.
    - `errors` string[], nullable: List of errors if the API failed.
    - `messages` string[], nullable: List of messages generated by the API.
    - `metadata` object
      - `transformed` 1: Post-processing may have transformed the data.
    - `status` 1 | 0: - `1` - Success. - `0` - Failed: Check the `errors` field for more details.
    - `warnings` string[], nullable: List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running an API.

## Changes

- **2026-09-12** `99adb57e7a5d`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/cpanel/apis/cpanel-uapi/changes/Sitejet/is_publish_in_progress/get.md)

---

[API](https://skmtc.dev/cpanel/apis/cpanel-uapi.md) - [All operations](https://skmtc.dev/cpanel/apis/cpanel-uapi/llms.txt) - [OpenAPI document](https://skmtc.dev/cpanel/apis/cpanel-uapi/revisions/05239220da37?raw)