Skip to content

Commit

Permalink
API docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Victor Castell committed Jun 29, 2015
1 parent 1885bae commit 142574c
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions docs/user-guide/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,6 @@ Get a job name from the job listing above. Then:
- Endpoint: /jobs/jobName
- Method: DELETE
- Example: curl -L -X DELETE dcron-node:8080/job/aggregate_stats
- Response: HTTP 204

## Manually Starting a Job

Expand All @@ -42,5 +41,9 @@ You can manually start a job by issuing an HTTP request.
- Query string parameters: arguments - optional string with a list of command line arguments that is appended to job's command
- Example: curl -L -X PUT dcron-node:8080/jobs/aggregate_stats
- Example: curl -L -X PUT dcron-node:8080/jobs/aggregate_stats?arguments=-debug
- Response: HTTP 204

## Get job executions

- Endpoint: /executions/job
- Method: GET
- Example: curl -L -X GET dcron-node:8080/executions/aggregate_stats

0 comments on commit 142574c

Please sign in to comment.