Repository navigation
PDOCS-4764: Add MicroVMs Public Preview API - #1257
Merged
Merged
Conversation
apinonformoso
approved these changes
Oct 8, 2026
apinonformoso
left a comment
Contributor
There was a problem hiding this comment.
LGTM, Paths and methods match the mvm product publicapi implementation 1:1
RohithSangati
approved these changes
Oct 9, 2026
This was referenced Oct 9, 2026
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.
Summary
Adds the MicroVMs API for the public preview launch on 2026-10-09, under a new
MicroVMs [Public Preview]tag in the Public APIs group. This covers 13 operations: list, create, get, delete, pause, resume, exec, console, options, plus checkpoint create, list, get, and delete.The spec is adapted from the private preview API doc and checked against the live API on 2026-10-08.
Jira: PDOCS-4764
Verified against the live API
201, delete returns204.200with themicrovmobject, including when the MicroVM is already paused.201with thecheckpointobject inCHECKPOINT_CREATING. Checkpoint delete returns204.INVALID_SIZE,INVALID_AUTO_PAUSE,FAILED_PRECONDITION(deleting a checkpoint that is still capturing), andNOT_FOUND.http_protocolisnullin responses when it is not set at creation, so the response schema marks it nullable.Needs engineering confirmation
503during testing, and new MicroVMs in MKC1 failed to start. I assumed it mirrors pause (200with themicrovmobject).503came back as{"id": "Service Unavailable", "message": "Server Error"}, not the{"code", "message"}shape. Gateway-level errors can use the standard DigitalOcean API error body.PERMISSION_DENIEDandUNAVAILABLEexamples are still guesses.GET /v2/microvms/{microvm_id}/consoledocuments a101 Switching ProtocolsWebSocket upgrade. Spectral warns that it has no 2xx response, the same warning the existinggen-ai/models/api_keysoperation already has.VPC Routes [Public Preview]precedent, so the tag slug changes when the suffix is dropped at GA.Test plan
make lint: 0 errors. The only new warning is the console one above.