Skip to content

Instantly share code, notes, and snippets.

@ahonor
Forked from gschueler/Rundeck API URL strawmen
Created February 1, 2011 18:31
Show Gist options
  • Save ahonor/806332 to your computer and use it in GitHub Desktop.
Save ahonor/806332 to your computer and use it in GitHub Desktop.
* Jobs
** List jobs
+ [[https://gist.github.com/785084][Query rundeck jobs list for a project, optionally save the xml file]]
+ Existing URL: "/menu/workflows.xml?projFilter={project}"
+ Proposed 1.2:
+ Summary: /api/jobs?project={project}
+ Exporting: /api/jobs/export?project={project}&format={format}
+ Importing: "POST /api/jobs/import?format={format} + (job content)
** Run a job
+ [[https://gist.github.com/783971][How to run a job using curl]]
+ Existing URL: "/scheduledExecution/runJobByName.xml?id={jobId}"
+ Proposed 1.2:
+ /api/job/{jobId}/run
** Job export
+ Proposed 1.2:
+ /api/job/{id}
* Executions
** Plural
+ [[https://gist.github.com/785055][Script to query queue using curl]]
+ Existing URL: "/menu/queueList.xml?id={jobId}"
+ Proposed 1.2:
+ /api/executions/running
** Singular
+ Proposed 1.2:
+ /api/execution/{id}
+ /api/execution/{id}/abort
* Ad hoc commands (run and forget)
** Run a command
+ [[https://gist.github.com/790341][Dispatch execution using curl]]
+ Existing URL: "POST /scheduledExecution/uploadAndExecute.xml"
+ Proposed 1.2:
+ GET/POST /api/run/command?exec={commands}&project={project}
+ POST /api/run/script?project={project} + (script content)
* Projects
** Project listing
+ Proposed 1.2:
+ GET /api/projects
** Project info
+ GET /api/projects/{project} (includes: description, resource
model provider)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment