Skip to content

Commit

Permalink
Merge pull request #11541 from hashicorp/f-add-jobstopglobal-website-…
Browse files Browse the repository at this point in the history
…api-docs

docs: add global query param to API job deregister endpoint.
  • Loading branch information
jrasell authored Nov 19, 2021
2 parents 5a43a1a + 663698d commit 873b096
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion website/content/api-docs/jobs.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2099,7 +2099,10 @@ The table below shows this endpoint's support for
- `:job_id` `(string: <required>)` - 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.

Expand Down

0 comments on commit 873b096

Please sign in to comment.