kemko/nomad
1
0
Fork 0
mirror of https://github.com/kemko/nomad.git synced 2026-01-08 11:25:41 +03:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #11541 from hashicorp/f-add-jobstopglobal-website-api-docs

Browse Source 
docs: add global query param to API job deregister endpoint.
This commit is contained in:
James Rasell
2021-11-19 15:17:05 +01:00
committed by GitHub
parent 5a43a1af28 663698db95
commit 873b0969e0
1 changed files with 4 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
website/content/api-docs/jobs.mdx
View File

@@ -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.