Skip to content

docs: Update runpodctl reference for the REST v2 migration (breaking flag and output changes) - #912

Merged
lavanya-gunreddi merged 2 commits into
mainfrom
promptless/runpodctl-rest-v2-migration
Oct 17, 2026
Merged

lavanya-gunreddi merged 2 commits into
mainfrom
promptless/runpodctl-rest-v2-migration

Conversation

@promptless

@promptless promptless Bot commented Oct 17, 2026

Copy link
Copy Markdown
Contributor

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: removes pod reset and --public-ip. Documents that --gpu-id is required for GPU Pods, that the default pod list also shows Pods in an error state, how Pods are named when --name is omitted, and the new limits on --volume-in-gb, --country-code, and --compliance. Adds the pod get flags, including the reduced --include-machine output.
  • billing: removes --grouping and --gpu-id and describes the new per-record fields (startTime, endTime, totalAmount, and the cost breakdown) for Pods, Serverless, and network volumes.
  • datacenter: only deployable datacenters are listed, and location is now a region such as NORTH_AMERICA.
  • gpu: availability now counts Community Cloud stock.
  • serverless: --include-template now prints the endpoint's container configuration (and may expose env secrets); templateId is no longer shown.
  • ssh: documents adding several keys at once, fingerprint de-duplication, and the new --invalid and --remove-invalid flags for clearing saved entries that aren't valid keys.
  • network-volume: --size range is now 10–4096 GB.

The deprecated create pod/create pods flags 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 main at 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.

Comment thread runpodctl/reference/runpodctl-pod.mdx
@mintlify

mintlify Bot commented Oct 17, 2026 •

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated
runpod-docs 🟢 Ready View Preview Oct 17, 2026, 3:32 AM

💡 Tip: Enable Automations to automatically generate PRs for you.

Comment thread runpodctl/reference/runpodctl-pod.mdx
Comment thread runpodctl/reference/runpodctl-pod.mdx
Comment thread runpodctl/reference/runpodctl-pod.mdx
Comment thread runpodctl/reference/runpodctl-pod.mdx Outdated
Comment thread runpodctl/reference/runpodctl-pod.mdx
Comment thread runpodctl/reference/runpodctl-pod.mdx
Comment thread runpodctl/reference/runpodctl-billing.mdx
Comment thread runpodctl/reference/runpodctl-billing.mdx
Comment thread runpodctl/reference/runpodctl-billing.mdx
Comment thread runpodctl/reference/runpodctl-billing.mdx
Comment thread runpodctl/reference/runpodctl-datacenter.mdx
Comment thread runpodctl/reference/runpodctl-datacenter.mdx
Comment thread runpodctl/reference/runpodctl-gpu.mdx
Comment thread runpodctl/reference/runpodctl-serverless.mdx
Comment thread runpodctl/reference/runpodctl-serverless.mdx
Comment thread runpodctl/reference/runpodctl-ssh.mdx
Comment thread runpodctl/reference/runpodctl-ssh.mdx
Comment thread runpodctl/reference/runpodctl-ssh.mdx
Comment thread runpodctl/reference/runpodctl-network-volume.mdx
@lavanya-gunreddi
lavanya-gunreddi merged commit d267bc5 into main Oct 17, 2026
2 checks passed
@lavanya-gunreddi
lavanya-gunreddi deleted the promptless/runpodctl-rest-v2-migration branch October 17, 2026 03:33

This branch was successfully deployed

1 active deployment
staging — 886d10e8 Deployed Oct 17, 2026 by mintlify[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant