From 663698db95bd7f3769016c9cee38b8762150c49a Mon Sep 17 00:00:00 2001 From: James Rasell Date: Fri, 19 Nov 2021 13:45:24 +0100 Subject: [PATCH] docs: add global query param to API job deregister endpoint. --- website/content/api-docs/jobs.mdx | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/website/content/api-docs/jobs.mdx b/website/content/api-docs/jobs.mdx index 3fffaf83f..f6853c7fa 100644 --- a/website/content/api-docs/jobs.mdx +++ b/website/content/api-docs/jobs.mdx @@ -2099,7 +2099,10 @@ The table below shows this endpoint's support for - `:job_id` `(string: )` - Specifies the ID of the job (as specified in the job file during submission). This is specified as part of the path. -- `purge` `(bool: false)` - Specifies that the job should stopped and purged +- `global` `(bool: false)` - Stop a multi-region job in all its regions. By default, + job stop will stop only a single region at a time. Ignored for single-region jobs. + +- `purge` `(bool: false)` - Specifies that the job should be stopped and purged immediately. This means the job will not be queryable after being stopped. If not set, the job will be purged by the garbage collector.