From c620a2341216d5cf0a7e421a6cc3e9627f26e20d Mon Sep 17 00:00:00 2001 From: Alex Dadgar Date: Mon, 31 Jul 2017 14:03:35 -0700 Subject: [PATCH] Document Purge parameter on deregister request This PR documents the purge parameter when deregistering a job. --- website/source/api/jobs.html.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/website/source/api/jobs.html.md b/website/source/api/jobs.html.md index c86fdab89..9733f82c5 100644 --- a/website/source/api/jobs.html.md +++ b/website/source/api/jobs.html.md @@ -1454,7 +1454,7 @@ $ curl \ } ``` -## Delete a Job +## Stop a Job This endpoint deregisters a job, and stops all allocations part of it. @@ -1475,12 +1475,16 @@ 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 + immediately. This means the job will not be queryable after being stopped. If + not set, the job will be purged by the garbage collector. + ### Sample Request ```text $ curl \ --request DELETE \ - https://nomad.rocks/v1/job/my-job + https://nomad.rocks/v1/job/my-job?purge=true ``` ### Sample Response