Add PATCH method support to the api command#156
Merged
githubsaturn merged 1 commit intocaprover:masterfrom Feb 8, 2026
Merged
Conversation
The CapRover server now supports PATCH for partial app definition updates (caprover/caprover#2372), but the CLI only allows GET and POST. This adds PATCH as a valid method for the `caprover api` command, enabling safe partial updates like scaling without wiping other fields. Changes: - Constants.ts: add 'PATCH' to API_METHODS - HttpClient.ts: add patchReq() and PATCH dispatch in fetchInternal() - ApiManager.ts: widen callApi() type to accept 'PATCH'
Collaborator
|
Thanks! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Problem
The CapRover server now supports
PATCHfor partial app definition updates (merged in caprover/caprover#2372), but the CLI'sapicommand only allowsGETandPOSTmethods. This means users cannot usecaprover apito make partial updates — they must use external tools likecurl.Solution
Add
PATCHas a valid HTTP method for thecaprover apicommand, so the CLI stays in sync with the server's capabilities.Example usage
Scale an app without touching any other settings:
caprover api -n my-machine -t /user/apps/appDefinitions/update -m PATCH -d '{"appName": "my-app", "instanceCount": 1}'Changes
src/utils/Constants.ts— add'PATCH'toAPI_METHODSsrc/api/HttpClient.ts— addpatchReq()method andPATCHdispatch infetchInternal()src/api/ApiManager.ts— widencallApi()type signature to accept'PATCH'Backward compatibility
GETandPOSTbehavior is completely unchangedPATCHis only available when explicitly specified via--method PATCH