summaryrefslogtreecommitdiffstats
path: root/docs/en/rst
diff options
context:
space:
mode:
authorIsrael Madueme <purelogiq@gmail.com>2018-04-05 22:23:43 +0200
committerDylan William Hardison <dylan@hardison.net>2018-04-05 22:23:43 +0200
commit755bc194dcea3481fa41b5884a98a5aa086fe09e (patch)
tree37d05c7b269ce615c92014ac057b97291768d255 /docs/en/rst
parent412052f3c46e05b19104622157c38b669fc00118 (diff)
downloadbugzilla-755bc194dcea3481fa41b5884a98a5aa086fe09e.tar.gz
bugzilla-755bc194dcea3481fa41b5884a98a5aa086fe09e.tar.xz
Bug 1449282 - add jobqueue_status api
Diffstat (limited to 'docs/en/rst')
-rw-r--r--docs/en/rst/api/core/v1/bugzilla.rst29
1 files changed, 29 insertions, 0 deletions
diff --git a/docs/en/rst/api/core/v1/bugzilla.rst b/docs/en/rst/api/core/v1/bugzilla.rst
index 2dd40e0cb..e43472c30 100644
--- a/docs/en/rst/api/core/v1/bugzilla.rst
+++ b/docs/en/rst/api/core/v1/bugzilla.rst
@@ -300,3 +300,32 @@ name type description
=============== ====== ====================================================
last_audit_time string The maximum of the at_time from the audit_log.
=============== ====== ====================================================
+
+Job Queue Status
+----------------
+
+Reports the status of the job queue.
+
+**Request**
+
+.. code-block:: text
+
+ GET /rest/jobqueue_status
+
+This method requires an authenticated user.
+
+**Response**
+
+.. code-block:: js
+
+ {
+ "total": 12,
+ "errors": 0
+ }
+
+=============== ======= ====================================================
+name type description
+=============== ======= ====================================================
+total integer The total number of jobs in the job queue.
+errors integer The number of errors produced by jobs in the queue.
+=============== ======= ==================================================== \ No newline at end of file