Skip to content

Commit

Permalink
Merge pull request #2940 from hashicorp/d-purge
Browse files Browse the repository at this point in the history
Document Purge parameter on deregister request
  • Loading branch information
dadgar committed Aug 1, 2017
2 parents ffdb86d + c620a23 commit 3895ae1
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions website/source/api/jobs.html.md
Original file line number Diff line number Diff line change
Expand Up @@ -1454,7 +1454,7 @@ $ curl \
}
```

## Delete a Job
## Stop a Job

This endpoint deregisters a job, and stops all allocations part of it.

Expand All @@ -1475,12 +1475,16 @@ 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
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
Expand Down

0 comments on commit 3895ae1

Please sign in to comment.