Feature Request: Schedules API

[ranjithrajv]

Is this feature request related to a problem?

The current(v47) Rundeck API lacks access to schedule information, making it difficult to automate job documentation that includes associated schedules. This is a challenge for users who need to generate reports containing both job details and their scheduled execution times. Manually gathering this information is inefficient and error-prone for large deployments.

Proposed Solution

This request proposes adding an API for managing schedules associated with jobs within Rundeck. This API would enable programmatic retrieval, creation, update, and deletion of these schedules.

Alternatives Considered

Manually collecting schedule information from the Rundeck UI (time-consuming and impractical for large deployments).
Developing custom scripts to scrape schedule data (complex and requires ongoing maintenance).

Proposed API Endpoints:

• (GET): /jobs/{id}/schedules - Retrieve all schedules associated with a specific job by its ID.
• (POST): /jobs/{id}/schedules - Create a new schedule associated with a specific job by its ID. (This functionality can be implemented in the future to allow programmatic schedule creation.)
• (PUT): /jobs/{id}/schedules/{scheduleId} - Update an existing schedule associated with a specific job by its ID and schedule ID.
• (DELETE): /jobs/{id}/schedules/{scheduleId} - Delete a specific schedule associated with a job by its ID and schedule ID.

Additional Context

An API for managing job-related schedules would benefit users by:

• Enabling automated generation of comprehensive job documentation, including associated schedules.
• Improving integration with external tools for managing job lifecycles and documentation.
• Increasing efficiency and accuracy in documenting scheduled jobs.
• Providing the potential for future programmatic creation of schedules.

Note:

• Rundeck currently focuses on schedule configuration through the UI. This proposal prioritizes initial functionalities for retrieving, updating, and deleting job schedules. The POST endpoint for creating schedules is included for future consideration.
• Clear and concise API documentation for developers is requested.
• Authentication method (e.g., API keys, OAuth) can be discussed further.
• Error handling with expected error codes and responses is essential.

Implementing this API would make Rundeck even more valuable for managing and documenting complex job schedules.