Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Document Purge parameter on deregister request #2940

Merged
merged 1 commit into from
Aug 1, 2017
Merged

Document Purge parameter on deregister request #2940

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions website/source/api/jobs.html.md
View file
Open in desktop
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