unraid / unraid/api

Invoke Mover though API

Open
#1,873 1 comment 3 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
TypeScript
Stars
113
Forks
22
Avg merge
10h 40m
Merged PRs (30d)
13

Description

Is your feature request related to a problem?

I often manually invoke the mover before I expect to move over a large file or I see my cache is getting full. The API currently does not have an option to invoke it remotely. This is especially helpful for 3rd Party Apps which rely on the the API or to create options which would look at storage and start the mover.

Describe the solution you'd like

A mutation to invoke the mover and return it's status.

mutation SetState($initiateMover: initiateMover!) {
  initiateMover(input: $initiateMover) {
    status
  }
}

There is already a mutation to initiateFlashBackup and this would be similar but would just initiate the mover.

Describe alternatives you've considered

N/A

Additional context

N?A

Environment (if relevant)

Unraid OS Version:

N/A

Pre-submission Checklist

  • I have searched existing issues to ensure this feature hasn't already been requested
  • This is not an Unraid Connect related feature (if it is, please submit via the support form instead)
  • I have provided clear examples or use cases for the feature

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the existing initiateFlashBackup mutation and follow its implementation and status handling. Add the analogous mover-invocation mutation so it returns status, then run the relevant API or GraphQL tests and verify the mutation can initiate the mover remotely.

Written by the indexing model from the issue text.

Assessment

Tech stack
graphql, typescript
Domain
api
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
56/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.