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.

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

Add missing JSON API requests to Readme.md #1182

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
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
15 changes: 14 additions & 1 deletion Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -677,7 +677,7 @@ You can also use [Kue-UI](https://github.com/StreetHub/kue-ui) web interface con

## JSON API

Along with the UI Kue also exposes a JSON API, which is utilized by the UI.
Along with the UI Kue also exposes a JSON API, which is utilized by the UI. The UI server has to be queried.

### GET /job/search?q=

Expand Down Expand Up @@ -757,6 +757,19 @@ Same as above, restricting by `:state` which is one of:

Same as above, however restricted to `:type` and `:state`.

### PUT /job/:id/state/:state

Change the state of a given `:job`. `:state` can be one of:

- active
- inactive
- failed
- complete

### PUT /job/:id/priority/:priority

Change the priority of a given `:job`. `:priority` is a numerical value (integer).

### DELETE /job/:id

Delete job `:id`:
Expand Down