Repository navigation
docs: Update runpodctl reference for the REST v2 migration (breaking flag and output changes) - #912
Merged
Conversation
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Automations to automatically generate PRs for you. |
lavanya-gunreddi
approved these changes
Oct 17, 2026
This branch was successfully deployed
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
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.
Open in Promptless
runpodctl moved its registry, network volume, billing, template, catalog, SSH key, Pod, and Serverless commands from GraphQL and REST v1 to REST v2 (runpodctl PRs #360–#368, now on
main). Several of those changes remove flags or change output, so the runpodctl reference pages no longer match what the CLI does.This updates the runpodctl reference to the new behavior:
pod resetand--public-ip. Documents that--gpu-idis required for GPU Pods, that the defaultpod listalso shows Pods in an error state, how Pods are named when--nameis omitted, and the new limits on--volume-in-gb,--country-code, and--compliance. Adds thepod getflags, including the reduced--include-machineoutput.--groupingand--gpu-idand describes the new per-record fields (startTime,endTime,totalAmount, and the cost breakdown) for Pods, Serverless, and network volumes.locationis now a region such asNORTH_AMERICA.--include-templatenow prints the endpoint's container configuration (and may expose env secrets);templateIdis no longer shown.--invalidand--remove-invalidflags for clearing saved entries that aren't valid keys.--sizerange is now 10–4096 GB.The deprecated
create pod/create podsflags removed in #368 (--cost,--mem,--vcpu) and the template/registry changes (#360, #363) need no docs changes: those flags weren't documented and the other output is unchanged.Verified against runpodctl
mainat 1f31629 (command flag definitions, README, and the v2 client code).Trigger Events
...and 4 more trigger events. See the Promptless dashboard for full details.
Tip: Planning a big docs refactor? Use Deep Analysis to get help with the heavy lifting.