Provision a new VM. Charges the user wallet immediately for the first cycle (plus any addons) and enqueues the create action. Returns 202 with the VM detail and the action id to poll. Requires the vms:write scope.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"VMArea Developer Docs","colors":{"primary":"#3A8C6C","light":"#4FAB85","dark":"#6FCAA3"},"logo":{"light":"https://mintcdn.com/vmarea/a54eBxQHNJewkB-y/logo/light.svg?fit=max\u0026auto=format\u0026n=a54eBxQHNJewkB-y\u0026q=85\u0026s=aad92f10a1b334cd120092f26b4c1fdb","dark":"https://mintcdn.com/vmarea/a54eBxQHNJewkB-y/logo/dark.svg?fit=max\u0026auto=format\u0026n=a54eBxQHNJewkB-y\u0026q=85\u0026s=ab63f1d5cace880d6caeb3a754c9b26e"},"favicon":"https://mintcdn.com/vmarea/a54eBxQHNJewkB-y/favicon.svg?fit=max\u0026auto=format\u0026n=a54eBxQHNJewkB-y\u0026q=85\u0026s=a0aa077cdc03587b8760976753cb046d","navbar":{"links":[{"href":"https://vmarea.com/dashboard","label":"Dashboard"},{"href":"https://vmarea.com/login","label":"Sign in"}],"primary":{"type":"button","label":"Get started","href":"https://vmarea.com/register"}},"seo":{"metatags":{"description":"Complete API reference and guides for the VMArea platform — manage virtual machines, networks, firewalls, and billing programmatically."}},"styling":{"latex":false},"navigation":{"languages":[{"language":"en","default":true,"href":"en/introduction"},{"language":"pt","href":"pt/introduction"}]}},"deployment":{"deploymentMetadataValue":{"subdomain":"vmarea","hasAudioNarration":false,"actualSubdomain":"vmarea","customDomains":["docs.vmarea.com"],"gitSource":{"type":"github","owner":"0xpixelninja","repo":"vmarea-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6a20da33dc10703c7a4e6e14","collectionId":"6ab8a4fe-90e5-4c46-b2e8-aa9cbef270e6","schemaVersion":"v2"},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6a20da33dc10703c7a4e6e14:success","clientVersion":"0.0.3971","searchFilterCounts":[{"language":"default","tag":"Referência da API","count":68},{"language":"default","tag":"VMs","count":13},{"language":"default","tag":"Firewalls","count":11},{"language":"en","tag":"Guides","count":9},{"language":"pt","tag":"Guias","count":9},{"language":"default","tag":"Networks","count":8},{"language":"default","tag":"Webhooks","count":8},{"language":"default","tag":"Billing","count":7},{"language":"default","tag":"Catalog","count":6},{"language":"default","tag":"Backups","count":5},{"language":"default","tag":"Snapshots","count":5},{"language":"default","tag":"SSH Keys","count":5},{"language":"en","tag":"API conventions","count":4},{"language":"pt","tag":"Convenções da API","count":4},{"language":"en","tag":"Authentication","count":2},{"language":"en","tag":"Get started","count":2},{"language":"pt","tag":"Autenticação","count":2},{"language":"pt","tag":"Comece aqui","count":2},{"language":"en","tag":"Resources","count":1},{"language":"pt","tag":"Recursos","count":1}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-v7-file-tree","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"per-site-search-delta","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-private-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-nav-generations","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"isAtlas":false,"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/vms/create-a-virtual-machine","slug":"/api-reference/vms/create-a-virtual-machine","pageMetadata":{"title":"Create a virtual machine","description":"Provision a new VM. Charges the user wallet immediately for the first cycle (plus any addons) and enqueues the create action. Returns 202 with the VM detail and the action id to poll. Requires the `vms:write` scope.","deprecated":null,"version":null,"openapi":"https://api.vmarea.com/api/public/v1/openapi.json post /api/public/v1/vms","href":"/api-reference/vms/create-a-virtual-machine","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"Provision a new VM. Charges the user wallet immediately for the first cycle (plus any addons) and enqueues the create action. Returns 202 with the VM detail and the action id to poll. Requires the \", _jsx(_components.code, {\n children: \"vms:write\"\n }), \" scope.\"]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Create a virtual machine","description":"Provision a new VM. Charges the user wallet immediately for the first cycle (plus any addons) and enqueues the create action. Returns 202 with the VM detail and the action id to poll. Requires the `vms:write` scope.","deprecated":null,"version":null,"openapi":"https://api.vmarea.com/api/public/v1/openapi.json post /api/public/v1/vms","href":"/api-reference/vms/create-a-virtual-machine","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"createVm","summary":"Create a virtual machine","tags":["VMs"],"description":"Provision a new VM. Charges the user wallet immediately for the first cycle (plus any addons) and enqueues the create action. Returns 202 with the VM detail and the action id to poll. Requires the `vms:write` scope.","requestBody":"59b181f8-8294-4c72-8ca2-523d124ce807","security":["64fd9e18-3003-4df1-ad42-a026df65cce8"],"responses":{"202":"c1f7474f-ff04-4d71-b128-309022d52646","400":"ce65aef8-1ad3-4e53-9773-d350618c1bab","401":"4953f24e-87f6-471e-9f40-97f74e616bf7","402":"df26a716-a5c6-4c16-bf84-3d2296bc262f","403":"f812075e-6bf9-4af2-962a-0f1d9876e4e7","500":"b6b82feb-c8aa-4d8f-bef6-a8c1b1397a6b"},"method":"post","type":"path","servers":["a54231f6-3377-457d-85f6-930ae9086507"],"path":"/api/public/v1/vms","baseUrlOptions":["https://api.vmarea.com/api/v1"],"title":"Create a virtual machine","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"regionId":{"type":"string","pattern":"^[cC][^\\s-]{8,}$","isRequired":true,"uniqueKey":"regionId","typeLabel":"string"},"osTemplateId":{"type":"string","pattern":"^[cC][^\\s-]{8,}$","isRequired":true,"uniqueKey":"osTemplateId","typeLabel":"string"},"hostname":{"type":"string","minLength":1,"maxLength":63,"pattern":"^[a-zA-Z0-9]([a-zA-Z0-9-]*[a-zA-Z0-9])?$","isRequired":true,"uniqueKey":"hostname","typeLabel":"string"},"planId":{"type":"string","pattern":"^[cC][^\\s-]{8,}$","uniqueKey":"planId","typeLabel":"string"},"customConfig":{"type":"object","properties":{"vcpu":{"type":"integer","minimum":1,"maximum":64,"isRequired":true,"uniqueKey":"customConfig.vcpu","typeLabel":"integer"},"ram":{"type":"integer","minimum":512,"maximum":262144,"isRequired":true,"uniqueKey":"customConfig.ram","typeLabel":"integer"},"disk":{"type":"integer","minimum":10,"maximum":1024,"isRequired":true,"uniqueKey":"customConfig.disk","typeLabel":"integer"},"bandwidth":{"type":"integer","minimum":-1,"isRequired":true,"uniqueKey":"customConfig.bandwidth","typeLabel":"integer"}},"required":["vcpu","ram","disk","bandwidth"],"additionalProperties":false,"uniqueKey":"customConfig","typeLabel":"object"},"password":{"type":"string","minLength":8,"maxLength":128,"uniqueKey":"password","typeLabel":"string"},"sshKeyIds":{"type":"array","items":{"type":"string","pattern":"^[cC][^\\s-]{8,}$","uniqueKey":"sshKeyIds.items.[INDEX]","typeLabel":"string"},"maxItems":20,"uniqueKey":"sshKeyIds","typeLabel":"string[]"},"name":{"type":"string","minLength":1,"maxLength":100,"uniqueKey":"name","typeLabel":"string"},"dailyBackupEnabled":{"type":"boolean","default":false,"uniqueKey":"dailyBackupEnabled","typeLabel":"boolean"},"network10gEnabled":{"type":"boolean","default":false,"uniqueKey":"network10gEnabled","typeLabel":"boolean"},"isProtected":{"type":"boolean","default":false,"uniqueKey":"isProtected","typeLabel":"boolean"},"firewallIds":{"type":"array","items":{"type":"string","pattern":"^[cC][^\\s-]{8,}$","uniqueKey":"firewallIds.items.[INDEX]","typeLabel":"string"},"maxItems":10,"default":[],"uniqueKey":"firewallIds","typeLabel":"string[]"},"privateNetworkIds":{"type":"array","items":{"type":"string","pattern":"^[cC][^\\s-]{8,}$","uniqueKey":"privateNetworkIds.items.[INDEX]","typeLabel":"string"},"maxItems":5,"default":[],"uniqueKey":"privateNetworkIds","typeLabel":"string[]"}},"required":["regionId","osTemplateId","hostname"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"regionId":"\u003cstring>","osTemplateId":"\u003cstring>","hostname":"\u003cstring>","planId":"\u003cstring>","password":"\u003cstring>","sshKeyIds":["\u003cstring>"],"name":"\u003cstring>","dailyBackupEnabled":false,"network10gEnabled":false,"isProtected":false,"firewallIds":[],"privateNetworkIds":[]}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"c1f7474f-ff04-4d71-b128-309022d52646":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[true],"isRequired":true,"uniqueKey":"success","typeLabel":"enum\u003cboolean>"},"data":{"type":"object","properties":{"vm":{"oneOf":[{"type":"object","properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"data.vm.oneOf.0.id","typeLabel":"string"},"name":{"type":"string","isRequired":true,"uniqueKey":"data.vm.oneOf.0.name","typeLabel":"string"},"hostname":{"type":"string","isRequired":true,"uniqueKey":"data.vm.oneOf.0.hostname","typeLabel":"string"},"status":{"type":"string","isRequired":true,"uniqueKey":"data.vm.oneOf.0.status","typeLabel":"string"},"vcpu":{"type":"integer","isRequired":true,"uniqueKey":"data.vm.oneOf.0.vcpu","typeLabel":"integer"},"ram":{"type":"integer","isRequired":true,"uniqueKey":"data.vm.oneOf.0.ram","typeLabel":"integer"},"disk":{"type":"integer","isRequired":true,"uniqueKey":"data.vm.oneOf.0.disk","typeLabel":"integer"},"bandwidth":{"type":"integer","isRequired":true,"uniqueKey":"data.vm.oneOf.0.bandwidth","typeLabel":"integer"},"networkSpeed":{"type":"integer","isRequired":true,"uniqueKey":"data.vm.oneOf.0.networkSpeed","typeLabel":"integer"},"network10gEnabled":{"type":"boolean","isRequired":true,"uniqueKey":"data.vm.oneOf.0.network10gEnabled","typeLabel":"boolean"},"dailyBackupEnabled":{"type":"boolean","isRequired":true,"uniqueKey":"data.vm.oneOf.0.dailyBackupEnabled","typeLabel":"boolean"},"isProtected":{"type":"boolean","isRequired":true,"uniqueKey":"data.vm.oneOf.0.isProtected","typeLabel":"boolean"},"ipAddress":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"data.vm.oneOf.0.ipAddress.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"data.vm.oneOf.0.ipAddress.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.vm.oneOf.0.ipAddress","typeLabel":"string | null"},"region":{"oneOf":[{"type":"object","properties":{"slug":{"type":"string","isRequired":true,"uniqueKey":"data.vm.oneOf.0.region.oneOf.0.slug","typeLabel":"string"},"name":{"type":"string","isRequired":true,"uniqueKey":"data.vm.oneOf.0.region.oneOf.0.name","typeLabel":"string"}},"required":["slug","name"],"additionalProperties":false,"isRequired":true,"uniqueKey":"data.vm.oneOf.0.region.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"slug":{"type":"string"},"name":{"type":"string"}},"required":["slug","name"],"additionalProperties":false,"isRequired":true,"uniqueKey":"data.vm.oneOf.0.region.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.vm.oneOf.0.region","typeLabel":"object | null"},"plan":{"oneOf":[{"type":"object","properties":{"slug":{"type":"string","isRequired":true,"uniqueKey":"data.vm.oneOf.0.plan.oneOf.0.slug","typeLabel":"string"},"name":{"type":"string","isRequired":true,"uniqueKey":"data.vm.oneOf.0.plan.oneOf.0.name","typeLabel":"string"},"priceMonthly":{"oneOf":[{}],"uniqueKey":"data.vm.oneOf.0.plan.oneOf.0.priceMonthly","typeLabel":"any"}},"required":["slug","name"],"additionalProperties":false,"isRequired":true,"uniqueKey":"data.vm.oneOf.0.plan.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"slug":{"type":"string"},"name":{"type":"string"},"priceMonthly":{"oneOf":[{}]}},"required":["slug","name"],"additionalProperties":false,"isRequired":true,"uniqueKey":"data.vm.oneOf.0.plan.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.vm.oneOf.0.plan","typeLabel":"object | null"},"osTemplate":{"oneOf":[{"type":"object","properties":{"slug":{"type":"string","isRequired":true,"uniqueKey":"data.vm.oneOf.0.osTemplate.oneOf.0.slug","typeLabel":"string"},"name":{"type":"string","isRequired":true,"uniqueKey":"data.vm.oneOf.0.osTemplate.oneOf.0.name","typeLabel":"string"},"version":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"data.vm.oneOf.0.osTemplate.oneOf.0.version.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"data.vm.oneOf.0.osTemplate.oneOf.0.version.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.vm.oneOf.0.osTemplate.oneOf.0.version","typeLabel":"string | null"}},"required":["slug","name","version"],"additionalProperties":false,"isRequired":true,"uniqueKey":"data.vm.oneOf.0.osTemplate.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"slug":{"type":"string"},"name":{"type":"string"},"version":{"oneOf":[{"type":"string"},{"type":"null"}]}},"required":["slug","name","version"],"additionalProperties":false,"isRequired":true,"uniqueKey":"data.vm.oneOf.0.osTemplate.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.vm.oneOf.0.osTemplate","typeLabel":"object | null"},"billing":{"oneOf":[{"type":"object","properties":{"nextRenewalAt":{"oneOf":[{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"data.vm.oneOf.0.billing.oneOf.0.nextRenewalAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","isRequired":true,"uniqueKey":"data.vm.oneOf.0.billing.oneOf.0.nextRenewalAt.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.vm.oneOf.0.billing.oneOf.0.nextRenewalAt","typeLabel":"string\u003cdate-time> | null"},"status":{"type":"string","isRequired":true,"uniqueKey":"data.vm.oneOf.0.billing.oneOf.0.status","typeLabel":"string"},"priceMonthly":{"oneOf":[{}],"uniqueKey":"data.vm.oneOf.0.billing.oneOf.0.priceMonthly","typeLabel":"any"}},"required":["nextRenewalAt","status"],"additionalProperties":false,"isRequired":true,"uniqueKey":"data.vm.oneOf.0.billing.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"priceMonthly":{"oneOf":[{}]},"nextRenewalAt":{"oneOf":[{"type":"string","format":"date-time"},{"type":"null","format":"date-time"}]},"status":{"type":"string"}},"required":["nextRenewalAt","status"],"additionalProperties":false,"isRequired":true,"uniqueKey":"data.vm.oneOf.0.billing.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.vm.oneOf.0.billing","typeLabel":"object | null"},"createdAt":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"data.vm.oneOf.0.createdAt","typeLabel":"string\u003cdate-time>"},"bandwidthUsedBytes":{"type":"number","isRequired":true,"uniqueKey":"data.vm.oneOf.0.bandwidthUsedBytes","typeLabel":"number"},"bandwidthPackBytes":{"type":"string","isRequired":true,"uniqueKey":"data.vm.oneOf.0.bandwidthPackBytes","typeLabel":"string"},"sshKeys":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"data.vm.oneOf.0.sshKeys.items.[INDEX].id","typeLabel":"string"},"name":{"type":"string","isRequired":true,"uniqueKey":"data.vm.oneOf.0.sshKeys.items.[INDEX].name","typeLabel":"string"},"fingerprint":{"type":"string","isRequired":true,"uniqueKey":"data.vm.oneOf.0.sshKeys.items.[INDEX].fingerprint","typeLabel":"string"}},"required":["id","name","fingerprint"],"additionalProperties":false,"uniqueKey":"data.vm.oneOf.0.sshKeys.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"data.vm.oneOf.0.sshKeys","typeLabel":"object[]"},"firewalls":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"data.vm.oneOf.0.firewalls.items.[INDEX].id","typeLabel":"string"},"name":{"type":"string","isRequired":true,"uniqueKey":"data.vm.oneOf.0.firewalls.items.[INDEX].name","typeLabel":"string"}},"required":["id","name"],"additionalProperties":false,"uniqueKey":"data.vm.oneOf.0.firewalls.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"data.vm.oneOf.0.firewalls","typeLabel":"object[]"},"privateNetworks":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"data.vm.oneOf.0.privateNetworks.items.[INDEX].id","typeLabel":"string"},"name":{"type":"string","isRequired":true,"uniqueKey":"data.vm.oneOf.0.privateNetworks.items.[INDEX].name","typeLabel":"string"}},"required":["id","name"],"additionalProperties":false,"uniqueKey":"data.vm.oneOf.0.privateNetworks.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"data.vm.oneOf.0.privateNetworks","typeLabel":"object[]"},"updatedAt":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"data.vm.oneOf.0.updatedAt","typeLabel":"string\u003cdate-time>"}},"required":["id","name","hostname","status","vcpu","ram","disk","bandwidth","networkSpeed","network10gEnabled","dailyBackupEnabled","isProtected","ipAddress","region","plan","osTemplate","billing","createdAt","bandwidthUsedBytes","bandwidthPackBytes","sshKeys","firewalls","privateNetworks","updatedAt"],"additionalProperties":false,"isRequired":true,"uniqueKey":"data.vm.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"id":{"type":"string"},"name":{"type":"string"},"hostname":{"type":"string"},"status":{"type":"string"},"vcpu":{"type":"integer"},"ram":{"type":"integer"},"disk":{"type":"integer"},"bandwidth":{"type":"integer"},"networkSpeed":{"type":"integer"},"network10gEnabled":{"type":"boolean"},"dailyBackupEnabled":{"type":"boolean"},"isProtected":{"type":"boolean"},"ipAddress":{"oneOf":[{"type":"string"},{"type":"null"}]},"region":{"oneOf":[{"type":"object","properties":{"slug":{"type":"string"},"name":{"type":"string"}},"required":["slug","name"],"additionalProperties":false},{"type":"null","properties":{"slug":{"type":"string"},"name":{"type":"string"}},"required":["slug","name"],"additionalProperties":false}]},"plan":{"oneOf":[{"type":"object","properties":{"slug":{"type":"string"},"name":{"type":"string"},"priceMonthly":{"oneOf":[{}]}},"required":["slug","name"],"additionalProperties":false},{"type":"null","properties":{"slug":{"type":"string"},"name":{"type":"string"},"priceMonthly":{"oneOf":[{}]}},"required":["slug","name"],"additionalProperties":false}]},"osTemplate":{"oneOf":[{"type":"object","properties":{"slug":{"type":"string"},"name":{"type":"string"},"version":{"oneOf":[{"type":"string"},{"type":"null"}]}},"required":["slug","name","version"],"additionalProperties":false},{"type":"null","properties":{"slug":{"type":"string"},"name":{"type":"string"},"version":{"oneOf":[{"type":"string"},{"type":"null"}]}},"required":["slug","name","version"],"additionalProperties":false}]},"billing":{"oneOf":[{"type":"object","properties":{"priceMonthly":{"oneOf":[{}]},"nextRenewalAt":{"oneOf":[{"type":"string","format":"date-time"},{"type":"null","format":"date-time"}]},"status":{"type":"string"}},"required":["nextRenewalAt","status"],"additionalProperties":false},{"type":"null","properties":{"priceMonthly":{"oneOf":[{}]},"nextRenewalAt":{"oneOf":[{"type":"string","format":"date-time"},{"type":"null","format":"date-time"}]},"status":{"type":"string"}},"required":["nextRenewalAt","status"],"additionalProperties":false}]},"createdAt":{"type":"string","format":"date-time"},"bandwidthUsedBytes":{"type":"number"},"bandwidthPackBytes":{"type":"string"},"sshKeys":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"fingerprint":{"type":"string"}},"required":["id","name","fingerprint"],"additionalProperties":false}},"firewalls":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"],"additionalProperties":false}},"privateNetworks":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"],"additionalProperties":false}},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","name","hostname","status","vcpu","ram","disk","bandwidth","networkSpeed","network10gEnabled","dailyBackupEnabled","isProtected","ipAddress","region","plan","osTemplate","billing","createdAt","bandwidthUsedBytes","bandwidthPackBytes","sshKeys","firewalls","privateNetworks","updatedAt"],"additionalProperties":false,"isRequired":true,"uniqueKey":"data.vm.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.vm","typeLabel":"object | null"},"actionId":{"type":"string","isRequired":true,"uniqueKey":"data.actionId","typeLabel":"string"}},"required":["vm","actionId"],"additionalProperties":false,"isRequired":true,"uniqueKey":"data","typeLabel":"object"}},"required":["success","data"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"success":true,"data":{"vm":{"id":"\u003cstring>","name":"\u003cstring>","hostname":"\u003cstring>","status":"\u003cstring>","vcpu":123,"ram":123,"disk":123,"bandwidth":123,"networkSpeed":123,"network10gEnabled":true,"dailyBackupEnabled":true,"isProtected":true,"ipAddress":"\u003cstring>","region":{"slug":"\u003cstring>","name":"\u003cstring>"},"plan":{"slug":"\u003cstring>","name":"\u003cstring>","priceMonthly":"\u003cunknown>"},"osTemplate":{"slug":"\u003cstring>","name":"\u003cstring>","version":"\u003cstring>"},"billing":{"nextRenewalAt":"2023-11-07T05:31:56Z","status":"\u003cstring>","priceMonthly":"\u003cunknown>"},"createdAt":"2023-11-07T05:31:56Z","bandwidthUsedBytes":123,"bandwidthPackBytes":"\u003cstring>","sshKeys":[{"id":"\u003cstring>","name":"\u003cstring>","fingerprint":"\u003cstring>"}],"firewalls":[{"id":"\u003cstring>","name":"\u003cstring>"}],"privateNetworks":[{"id":"\u003cstring>","name":"\u003cstring>"}],"updatedAt":"2023-11-07T05:31:56Z"},"actionId":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"ce65aef8-1ad3-4e53-9773-d350618c1bab":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[false],"isRequired":true,"uniqueKey":"success","typeLabel":"enum\u003cboolean>"},"error":{"type":"string","isRequired":true,"uniqueKey":"error","typeLabel":"string"}},"required":["success","error"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"success":false,"error":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"4953f24e-87f6-471e-9f40-97f74e616bf7":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[false],"isRequired":true,"uniqueKey":"success","typeLabel":"enum\u003cboolean>"},"error":{"type":"string","isRequired":true,"uniqueKey":"error","typeLabel":"string"}},"required":["success","error"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"success":false,"error":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"df26a716-a5c6-4c16-bf84-3d2296bc262f":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[false],"isRequired":true,"uniqueKey":"success","typeLabel":"enum\u003cboolean>"},"error":{"type":"string","isRequired":true,"uniqueKey":"error","typeLabel":"string"}},"required":["success","error"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"success":false,"error":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"f812075e-6bf9-4af2-962a-0f1d9876e4e7":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[false],"isRequired":true,"uniqueKey":"success","typeLabel":"enum\u003cboolean>"},"error":{"type":"string","isRequired":true,"uniqueKey":"error","typeLabel":"string"}},"required":["success","error"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"success":false,"error":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"b6b82feb-c8aa-4d8f-bef6-a8c1b1397a6b":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[false],"isRequired":true,"uniqueKey":"success","typeLabel":"enum\u003cboolean>"},"error":{"type":"string","isRequired":true,"uniqueKey":"error","typeLabel":"string"}},"required":["success","error"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"success":false,"error":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"64fd9e18-3003-4df1-ad42-a026df65cce8":{"ApiKey":{"type":"apiKey","name":"x-api-key","in":"header","description":"Long-lived API token created at https://vmarea.com/dashboard/settings/api-keys. Tokens are scope-restricted; this spec lists the scope each endpoint requires.","scopes":[]}}},"servers":{"a54231f6-3377-457d-85f6-930ae9086507":{"url":"https://api.vmarea.com/api/v1","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","name":"x-api-key","in":"header","description":"Long-lived API token created at https://vmarea.com/dashboard/settings/api-keys. Tokens are scope-restricted; this spec lists the scope each endpoint requires.","scopes":[]},"schema":{"title":"x-api-key","type":"string","description":"Long-lived API token created at https://vmarea.com/dashboard/settings/api-keys. Tokens are scope-restricted; this spec lists the scope each endpoint requires.","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"ApiKey","name":"x-api-key"}],"title":"ApiKey"}]},"originalFileLocation":"https://api.vmarea.com/api/public/v1/openapi.json"},"subdomain":"vmarea","siteName":"VMArea Developer Docs","title":"Create a virtual machine - VMArea Developer Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{"en":{"href":"/api-reference/vms/create-a-virtual-machine","matchLevel":0},"pt":{"href":"/api-reference/vms/create-a-virtual-machine","matchLevel":0}}},"lastModified":"2026-05-04T13:53:20.682Z","originalFileLocation":"api-reference/vms/create-a-virtual-machine.mdx","locale":"en"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Provision a new VM. Charges the user wallet immediately for the first cycle (plus any addons) and enqueues the create action. Returns 202 with the VM detail and the action id to poll. Requires the vms:write scope.\">\u003cmeta data-mint-head name=\"application-name\" content=\"VMArea Developer Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/vmarea/Op6IiFhCU_phuicN/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/vmarea/Op6IiFhCU_phuicN/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/vmarea/Op6IiFhCU_phuicN/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/vmarea/Op6IiFhCU_phuicN/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/vmarea/Op6IiFhCU_phuicN/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/vmarea/Op6IiFhCU_phuicN/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/vmarea/Op6IiFhCU_phuicN/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/vmarea/Op6IiFhCU_phuicN/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/vmarea/Op6IiFhCU_phuicN/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create a virtual machine - VMArea Developer Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Provision a new VM. Charges the user wallet immediately for the first cycle (plus any addons) and enqueues the create action. Returns 202 with the VM detail and the action id to poll. Requires the vms:write scope.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"VMArea Developer Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.vmarea.com/api-reference/vms/create-a-virtual-machine\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://vmarea.mintlify.app/_mintlify/api/og/v2?division=VMs\u0026amp;title=Create+a+virtual+machine\u0026amp;description=Provision+a+new+VM.+Charges+the+user+wallet+immediately+for+the+first+cycle+%28plus+any+addons%29+and+enqueues+the+create+action.+Returns+202+with+the+VM+detail+and\u0026amp;theme=2d661f6d7cd8e1e097b1a727\u0026amp;signature=240270b9830a9748eab6ab8a2313a6524d7e56df30d9e87f8080602a20701f08\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Create a virtual machine - VMArea Developer Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Provision a new VM. Charges the user wallet immediately for the first cycle (plus any addons) and enqueues the create action. Returns 202 with the VM detail and the action id to poll. Requires the vms:write scope.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://vmarea.mintlify.app/_mintlify/api/og/v2?division=VMs\u0026amp;title=Create+a+virtual+machine\u0026amp;description=Provision+a+new+VM.+Charges+the+user+wallet+immediately+for+the+first+cycle+%28plus+any+addons%29+and+enqueues+the+create+action.+Returns+202+with+the+VM+detail+and\u0026amp;theme=2d661f6d7cd8e1e097b1a727\u0026amp;signature=240270b9830a9748eab6ab8a2313a6524d7e56df30d9e87f8080602a20701f08\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/vmarea/Op6IiFhCU_phuicN/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"VMArea Developer Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#3A8C6C\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.vmarea.com/api-reference/vms/create-a-virtual-machine\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/vms/create-a-virtual-machine.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.vmarea.com/#organization\",\"name\":\"VMArea Developer Docs\",\"url\":\"https://docs.vmarea.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/vmarea/a54eBxQHNJewkB-y/logo/light.svg?fit=max\u0026auto=format\u0026n=a54eBxQHNJewkB-y\u0026q=85\u0026s=aad92f10a1b334cd120092f26b4c1fdb\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.vmarea.com#website\",\"name\":\"VMArea Developer Docs\",\"url\":\"https://docs.vmarea.com\",\"publisher\":{\"@id\":\"https://docs.vmarea.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.vmarea.com/api-reference/vms/create-a-virtual-machine#webpage\",\"url\":\"https://docs.vmarea.com/api-reference/vms/create-a-virtual-machine\",\"name\":\"Create a virtual machine\",\"description\":\"Provision a new VM. Charges the user wallet immediately for the first cycle (plus any addons) and enqueues the create action. Returns 202 with the VM detail and the action id to poll. Requires the vms:write scope.\",\"dateModified\":\"2026-05-04T13:53:20.682Z\",\"isPartOf\":{\"@id\":\"https://docs.vmarea.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.vmarea.com/api-reference/vms/create-a-virtual-machine#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.vmarea.com/api-reference/vms/create-a-virtual-machine#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"VMs\",\"item\":\"https://docs.vmarea.com/api-reference/vms/list-virtual-machines\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Create a virtual machine\",\"item\":\"https://docs.vmarea.com/api-reference/vms/create-a-virtual-machine\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.vmarea.com/api-reference/vms/create-a-virtual-machine#apireference\",\"headline\":\"Create a virtual machine\",\"name\":\"Create a virtual machine\",\"description\":\"Provision a new VM. Charges the user wallet immediately for the first cycle (plus any addons) and enqueues the create action. Returns 202 with the VM detail and the action id to poll. Requires the vms:write scope.\",\"url\":\"https://docs.vmarea.com/api-reference/vms/create-a-virtual-machine\",\"mainEntityOfPage\":{\"@id\":\"https://docs.vmarea.com/api-reference/vms/create-a-virtual-machine#webpage\"},\"dateModified\":\"2026-05-04T13:53:20.682Z\",\"publisher\":{\"@id\":\"https://docs.vmarea.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.vmarea.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"VMArea Developer Docs\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"VMArea Developer Docs","nav":{"global":null,"languages":[{"language":"en","default":true,"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":"/en/introduction"}]},{"tab":"API Reference","groups":[{"group":"VMs","pages":[{"title":"List virtual machines","description":"Paginated list of VMs owned by the authenticated token's user. Requires the `vms:read` scope.","deprecated":null,"version":null,"openapi":"https://api.vmarea.com/api/public/v1/openapi.json get /api/public/v1/vms","href":"/api-reference/vms/list-virtual-machines"},{"title":"Create a virtual machine","deprecated":null,"version":null,"openapi":"https://api.vmarea.com/api/public/v1/openapi.json post /api/public/v1/vms","href":"/api-reference/vms/create-a-virtual-machine"},{"title":"Get a virtual machine","description":"Fetch a single VM by id, including SSH keys, firewalls, and attached private networks. Requires the `vms:read` scope.","deprecated":null,"version":null,"openapi":"https://api.vmarea.com/api/public/v1/openapi.json get /api/public/v1/vms/{id}","href":"/api-reference/vms/get-a-virtual-machine"},{"title":"Delete a virtual machine","deprecated":null,"version":null,"openapi":"https://api.vmarea.com/api/public/v1/openapi.json delete /api/public/v1/vms/{id}","href":"/api-reference/vms/delete-a-virtual-machine"},{"title":"Update a virtual machine","deprecated":null,"version":null,"openapi":"https://api.vmarea.com/api/public/v1/openapi.json patch /api/public/v1/vms/{id}","href":"/api-reference/vms/update-a-virtual-machine"},{"title":"Start a virtual machine","deprecated":null,"version":null,"openapi":"https://api.vmarea.com/api/public/v1/openapi.json post /api/public/v1/vms/{id}/start","href":"/api-reference/vms/start-a-virtual-machine"},{"title":"Stop a virtual machine","deprecated":null,"version":null,"openapi":"https://api.vmarea.com/api/public/v1/openapi.json post /api/public/v1/vms/{id}/stop","href":"/api-reference/vms/stop-a-virtual-machine"},{"title":"Restart a virtual machine","deprecated":null,"version":null,"openapi":"https://api.vmarea.com/api/public/v1/openapi.json post /api/public/v1/vms/{id}/restart","href":"/api-reference/vms/restart-a-virtual-machine"},{"title":"Rebuild a virtual machine","deprecated":null,"version":null,"openapi":"https://api.vmarea.com/api/public/v1/openapi.json post /api/public/v1/vms/{id}/rebuild","href":"/api-reference/vms/rebuild-a-virtual-machine"},{"title":"Upgrade a VM to a larger plan","deprecated":null,"version":null,"openapi":"https://api.vmarea.com/api/public/v1/openapi.json post /api/public/v1/vms/{id}/upgrade","href":"/api-reference/vms/upgrade-a-vm-to-a-larger-plan"},{"title":"Reset a VM's root password","deprecated":null,"version":null,"openapi":"https://api.vmarea.com/api/public/v1/openapi.json post /api/public/v1/vms/{id}/password-reset","href":"/api-reference/vms/reset-a-vms-root-password"},{"title":"List actions for a VM","deprecated":null,"version":null,"openapi":"https://api.vmarea.com/api/public/v1/openapi.json get /api/public/v1/vms/{id}/actions","href":"/api-reference/vms/list-actions-for-a-vm"},{"title":"Get a single VM action","deprecated":null,"version":null,"openapi":"https://api.vmarea.com/api/public/v1/openapi.json get /api/public/v1/vms/{id}/actions/{actionId}","href":"/api-reference/vms/get-a-single-vm-action"}]},{"group":"Backups","pages":[{"title":"List backups for a VM","deprecated":null,"version":null,"openapi":"https://api.vmarea.com/api/public/v1/openapi.json get /api/public/v1/vms/{vmId}/backups","href":"/api-reference/backups/list-backups-for-a-vm"},{"title":"Create a manual backup","deprecated":null,"version":null,"openapi":"https://api.vmarea.com/api/public/v1/openapi.json post /api/public/v1/vms/{vmId}/backups","href":"/api-reference/backups/create-a-manual-backup"},{"title":"Get a single backup","deprecated":null,"version":null,"openapi":"https://api.vmarea.com/api/public/v1/openapi.json get /api/public/v1/vms/{vmId}/backups/{id}","href":"/api-reference/backups/get-a-single-backup"},{"title":"Delete a backup","deprecated":null,"version":null,"openapi":"https://api.vmarea.com/api/public/v1/openapi.json delete /api/public/v1/vms/{vmId}/backups/{id}","href":"/api-reference/backups/delete-a-backup"},{"title":"Restore a backup over the source VM","deprecated":null,"version":null,"openapi":"https://api.vmarea.com/api/public/v1/openapi.json post /api/public/v1/vms/{vmId}/backups/{id}/restore","href":"/api-reference/backups/restore-a-backup-over-the-source-vm"}]},{"group":"Snapshots","pages":[{"title":"List snapshots for a VM","deprecated":null,"version":null,"openapi":"https://api.vmarea.com/api/public/v1/openapi.json get /api/public/v1/vms/{vmId}/snapshots","href":"/api-reference/snapshots/list-snapshots-for-a-vm"},{"title":"Create a snapshot","deprecated":null,"version":null,"openapi":"https://api.vmarea.com/api/public/v1/openapi.json post /api/public/v1/vms/{vmId}/snapshots","href":"/api-reference/snapshots/create-a-snapshot"},{"title":"Get a single snapshot","deprecated":null,"version":null,"openapi":"https://api.vmarea.com/api/public/v1/openapi.json get /api/public/v1/vms/{vmId}/snapshots/{id}","href":"/api-reference/snapshots/get-a-single-snapshot"},{"title":"Delete a snapshot","deprecated":null,"version":null,"openapi":"https://api.vmarea.com/api/public/v1/openapi.json delete /api/public/v1/vms/{vmId}/snapshots/{id}","href":"/api-reference/snapshots/delete-a-snapshot"},{"title":"Roll a VM back to a snapshot","deprecated":null,"version":null,"openapi":"https://api.vmarea.com/api/public/v1/openapi.json post /api/public/v1/vms/{vmId}/snapshots/{id}/rollback","href":"/api-reference/snapshots/roll-a-vm-back-to-a-snapshot"}]},{"group":"Networks","pages":[{"title":"List private networks","deprecated":null,"version":null,"openapi":"https://api.vmarea.com/api/public/v1/openapi.json get /api/public/v1/networks","href":"/api-reference/networks/list-private-networks"},{"title":"Create a private network","deprecated":null,"version":null,"openapi":"https://api.vmarea.com/api/public/v1/openapi.json post /api/public/v1/networks","href":"/api-reference/networks/create-a-private-network"},{"title":"Get a private network","deprecated":null,"version":null,"openapi":"https://api.vmarea.com/api/public/v1/openapi.json get /api/public/v1/networks/{id}","href":"/api-reference/networks/get-a-private-network"},{"title":"Delete a private network","deprecated":null,"version":null,"openapi":"https://api.vmarea.com/api/public/v1/openapi.json delete /api/public/v1/networks/{id}","href":"/api-reference/networks/delete-a-private-network"},{"title":"Rename a private network","deprecated":null,"version":null,"openapi":"https://api.vmarea.com/api/public/v1/openapi.json patch /api/public/v1/networks/{id}","href":"/api-reference/networks/rename-a-private-network"},{"title":"List VMs attached to a network","deprecated":null,"version":null,"openapi":"https://api.vmarea.com/api/public/v1/openapi.json get /api/public/v1/networks/{id}/attachments","href":"/api-reference/networks/list-vms-attached-to-a-network"},{"title":"Attach a VM to a private network","deprecated":null,"version":null,"openapi":"https://api.vmarea.com/api/public/v1/openapi.json post /api/public/v1/networks/{id}/attachments","href":"/api-reference/networks/attach-a-vm-to-a-private-network"},{"title":"Detach a VM from a private network","deprecated":null,"version":null,"openapi":"https://api.vmarea.com/api/public/v1/openapi.json delete /api/public/v1/networks/{id}/attachments/{vmId}","href":"/api-reference/networks/detach-a-vm-from-a-private-network"}]},{"group":"Firewalls","pages":[{"title":"List firewalls","deprecated":null,"version":null,"openapi":"https://api.vmarea.com/api/public/v1/openapi.json get /api/public/v1/firewalls","href":"/api-reference/firewalls/list-firewalls"},{"title":"Create a firewall","deprecated":null,"version":null,"openapi":"https://api.vmarea.com/api/public/v1/openapi.json post /api/public/v1/firewalls","href":"/api-reference/firewalls/create-a-firewall"},{"title":"Get a firewall","deprecated":null,"version":null,"openapi":"https://api.vmarea.com/api/public/v1/openapi.json get /api/public/v1/firewalls/{id}","href":"/api-reference/firewalls/get-a-firewall"},{"title":"Delete a firewall","deprecated":null,"version":null,"openapi":"https://api.vmarea.com/api/public/v1/openapi.json delete /api/public/v1/firewalls/{id}","href":"/api-reference/firewalls/delete-a-firewall"},{"title":"Rename or re-describe a firewall","deprecated":null,"version":null,"openapi":"https://api.vmarea.com/api/public/v1/openapi.json patch /api/public/v1/firewalls/{id}","href":"/api-reference/firewalls/rename-or-re-describe-a-firewall"},{"title":"List rules for a firewall","deprecated":null,"version":null,"openapi":"https://api.vmarea.com/api/public/v1/openapi.json get /api/public/v1/firewalls/{id}/rules","href":"/api-reference/firewalls/list-rules-for-a-firewall"},{"title":"Add a rule to a firewall","deprecated":null,"version":null,"openapi":"https://api.vmarea.com/api/public/v1/openapi.json post /api/public/v1/firewalls/{id}/rules","href":"/api-reference/firewalls/add-a-rule-to-a-firewall"},{"title":"Delete a firewall rule","deprecated":null,"version":null,"openapi":"https://api.vmarea.com/api/public/v1/openapi.json delete /api/public/v1/firewalls/{id}/rules/{ruleId}","href":"/api-reference/firewalls/delete-a-firewall-rule"},{"title":"Update a firewall rule","deprecated":null,"version":null,"openapi":"https://api.vmarea.com/api/public/v1/openapi.json patch /api/public/v1/firewalls/{id}/rules/{ruleId}","href":"/api-reference/firewalls/update-a-firewall-rule"},{"title":"Bind a firewall to a VM","deprecated":null,"version":null,"openapi":"https://api.vmarea.com/api/public/v1/openapi.json post /api/public/v1/firewalls/{id}/bindings","href":"/api-reference/firewalls/bind-a-firewall-to-a-vm"},{"title":"Unbind a firewall from a VM","deprecated":null,"version":null,"openapi":"https://api.vmarea.com/api/public/v1/openapi.json delete /api/public/v1/firewalls/{id}/bindings/{vmId}","href":"/api-reference/firewalls/unbind-a-firewall-from-a-vm"}]},{"group":"SSH Keys","pages":[{"title":"List SSH keys","deprecated":null,"version":null,"openapi":"https://api.vmarea.com/api/public/v1/openapi.json get /api/public/v1/ssh-keys","href":"/api-reference/ssh-keys/list-ssh-keys"},{"title":"Add SSH key","deprecated":null,"version":null,"openapi":"https://api.vmarea.com/api/public/v1/openapi.json post /api/public/v1/ssh-keys","href":"/api-reference/ssh-keys/add-ssh-key"},{"title":"Get SSH key","deprecated":null,"version":null,"openapi":"https://api.vmarea.com/api/public/v1/openapi.json get /api/public/v1/ssh-keys/{id}","href":"/api-reference/ssh-keys/get-ssh-key"},{"title":"Delete SSH key","deprecated":null,"version":null,"openapi":"https://api.vmarea.com/api/public/v1/openapi.json delete /api/public/v1/ssh-keys/{id}","href":"/api-reference/ssh-keys/delete-ssh-key"},{"title":"Rename SSH key","deprecated":null,"version":null,"openapi":"https://api.vmarea.com/api/public/v1/openapi.json patch /api/public/v1/ssh-keys/{id}","href":"/api-reference/ssh-keys/rename-ssh-key"}]},{"group":"Webhooks","pages":[{"title":"List webhook subscriptions","deprecated":null,"version":null,"openapi":"https://api.vmarea.com/api/public/v1/openapi.json get /api/public/v1/webhooks","href":"/api-reference/webhooks/list-webhook-subscriptions"},{"title":"Create a webhook subscription","deprecated":null,"version":null,"openapi":"https://api.vmarea.com/api/public/v1/openapi.json post /api/public/v1/webhooks","href":"/api-reference/webhooks/create-a-webhook-subscription"},{"title":"Get a webhook subscription","deprecated":null,"version":null,"openapi":"https://api.vmarea.com/api/public/v1/openapi.json get /api/public/v1/webhooks/{id}","href":"/api-reference/webhooks/get-a-webhook-subscription"},{"title":"Delete a webhook subscription","deprecated":null,"version":null,"openapi":"https://api.vmarea.com/api/public/v1/openapi.json delete /api/public/v1/webhooks/{id}","href":"/api-reference/webhooks/delete-a-webhook-subscription"},{"title":"Update a webhook subscription","deprecated":null,"version":null,"openapi":"https://api.vmarea.com/api/public/v1/openapi.json patch /api/public/v1/webhooks/{id}","href":"/api-reference/webhooks/update-a-webhook-subscription"},{"title":"Send a test event","deprecated":null,"version":null,"openapi":"https://api.vmarea.com/api/public/v1/openapi.json post /api/public/v1/webhooks/{id}/test","href":"/api-reference/webhooks/send-a-test-event"},{"title":"List delivery history for a webhook","deprecated":null,"version":null,"openapi":"https://api.vmarea.com/api/public/v1/openapi.json get /api/public/v1/webhooks/{id}/deliveries","href":"/api-reference/webhooks/list-delivery-history-for-a-webhook"},{"title":"Get a single webhook delivery","deprecated":null,"version":null,"openapi":"https://api.vmarea.com/api/public/v1/openapi.json get /api/public/v1/webhooks/{id}/deliveries/{deliveryId}","href":"/api-reference/webhooks/get-a-single-webhook-delivery"}]},{"group":"Billing","pages":[{"title":"Get wallet","deprecated":null,"version":null,"openapi":"https://api.vmarea.com/api/public/v1/openapi.json get /api/public/v1/wallet","href":"/api-reference/billing/get-wallet"},{"title":"List wallet transactions","deprecated":null,"version":null,"openapi":"https://api.vmarea.com/api/public/v1/openapi.json get /api/public/v1/wallet/transactions","href":"/api-reference/billing/list-wallet-transactions"},{"title":"List invoices","deprecated":null,"version":null,"openapi":"https://api.vmarea.com/api/public/v1/openapi.json get /api/public/v1/invoices","href":"/api-reference/billing/list-invoices"},{"title":"Get invoice","deprecated":null,"version":null,"openapi":"https://api.vmarea.com/api/public/v1/openapi.json get /api/public/v1/invoices/{id}","href":"/api-reference/billing/get-invoice"},{"title":"Download invoice PDF","deprecated":null,"version":null,"openapi":"https://api.vmarea.com/api/public/v1/openapi.json get /api/public/v1/invoices/{id}/pdf","href":"/api-reference/billing/download-invoice-pdf"},{"title":"Get bandwidth usage","deprecated":null,"version":null,"openapi":"https://api.vmarea.com/api/public/v1/openapi.json get /api/public/v1/bandwidth","href":"/api-reference/billing/get-bandwidth-usage"},{"title":"List VM bandwidth packs","deprecated":null,"version":null,"openapi":"https://api.vmarea.com/api/public/v1/openapi.json get /api/public/v1/vms/{vmId}/bandwidth/packs","href":"/api-reference/billing/list-vm-bandwidth-packs"}]},{"group":"Catalog","pages":[{"title":"List plans","deprecated":null,"version":null,"openapi":"https://api.vmarea.com/api/public/v1/openapi.json get /api/public/v1/plans","href":"/api-reference/catalog/list-plans"},{"title":"Get plan","deprecated":null,"version":null,"openapi":"https://api.vmarea.com/api/public/v1/openapi.json get /api/public/v1/plans/{slug}","href":"/api-reference/catalog/get-plan"},{"title":"List regions","deprecated":null,"version":null,"openapi":"https://api.vmarea.com/api/public/v1/openapi.json get /api/public/v1/regions","href":"/api-reference/catalog/list-regions"},{"title":"Get region","deprecated":null,"version":null,"openapi":"https://api.vmarea.com/api/public/v1/openapi.json get /api/public/v1/regions/{slug}","href":"/api-reference/catalog/get-region"},{"title":"List OS templates","deprecated":null,"version":null,"openapi":"https://api.vmarea.com/api/public/v1/openapi.json get /api/public/v1/os-templates","href":"/api-reference/catalog/list-os-templates"},{"title":"Get OS template","deprecated":null,"version":null,"openapi":"https://api.vmarea.com/api/public/v1/openapi.json get /api/public/v1/os-templates/{slug}","href":"/api-reference/catalog/get-os-template"}]}]}]},{"language":"pt","tabs":[{"tab":"Guias","pages":[{"title":"Guias","href":"/pt/introduction"}]},{"tab":"Referência da API","groups":[{"group":"VMs","pages":[{"title":"List virtual machines","description":"Paginated list of VMs owned by the authenticated token's user. Requires the `vms:read` scope.","deprecated":null,"version":null,"openapi":"https://api.vmarea.com/api/public/v1/openapi.json get /api/public/v1/vms","href":"/api-reference/vms/list-virtual-machines"},{"title":"Create a virtual machine","deprecated":null,"version":null,"openapi":"https://api.vmarea.com/api/public/v1/openapi.json post /api/public/v1/vms","href":"/api-reference/vms/create-a-virtual-machine"},{"title":"Get a virtual machine","description":"Fetch a single VM by id, including SSH keys, firewalls, and attached private networks. Requires the `vms:read` scope.","deprecated":null,"version":null,"openapi":"https://api.vmarea.com/api/public/v1/openapi.json get /api/public/v1/vms/{id}","href":"/api-reference/vms/get-a-virtual-machine"},{"title":"Delete a virtual machine","deprecated":null,"version":null,"openapi":"https://api.vmarea.com/api/public/v1/openapi.json delete /api/public/v1/vms/{id}","href":"/api-reference/vms/delete-a-virtual-machine"},{"title":"Update a virtual machine","deprecated":null,"version":null,"openapi":"https://api.vmarea.com/api/public/v1/openapi.json patch /api/public/v1/vms/{id}","href":"/api-reference/vms/update-a-virtual-machine"},{"title":"Start a virtual machine","deprecated":null,"version":null,"openapi":"https://api.vmarea.com/api/public/v1/openapi.json post /api/public/v1/vms/{id}/start","href":"/api-reference/vms/start-a-virtual-machine"},{"title":"Stop a virtual machine","deprecated":null,"version":null,"openapi":"https://api.vmarea.com/api/public/v1/openapi.json post /api/public/v1/vms/{id}/stop","href":"/api-reference/vms/stop-a-virtual-machine"},{"title":"Restart a virtual machine","deprecated":null,"version":null,"openapi":"https://api.vmarea.com/api/public/v1/openapi.json post /api/public/v1/vms/{id}/restart","href":"/api-reference/vms/restart-a-virtual-machine"},{"title":"Rebuild a virtual machine","deprecated":null,"version":null,"openapi":"https://api.vmarea.com/api/public/v1/openapi.json post /api/public/v1/vms/{id}/rebuild","href":"/api-reference/vms/rebuild-a-virtual-machine"},{"title":"Upgrade a VM to a larger plan","deprecated":null,"version":null,"openapi":"https://api.vmarea.com/api/public/v1/openapi.json post /api/public/v1/vms/{id}/upgrade","href":"/api-reference/vms/upgrade-a-vm-to-a-larger-plan"},{"title":"Reset a VM's root password","deprecated":null,"version":null,"openapi":"https://api.vmarea.com/api/public/v1/openapi.json post /api/public/v1/vms/{id}/password-reset","href":"/api-reference/vms/reset-a-vms-root-password"},{"title":"List actions for a VM","deprecated":null,"version":null,"openapi":"https://api.vmarea.com/api/public/v1/openapi.json get /api/public/v1/vms/{id}/actions","href":"/api-reference/vms/list-actions-for-a-vm"},{"title":"Get a single VM action","deprecated":null,"version":null,"openapi":"https://api.vmarea.com/api/public/v1/openapi.json get /api/public/v1/vms/{id}/actions/{actionId}","href":"/api-reference/vms/get-a-single-vm-action"}]},{"group":"Backups","pages":[{"title":"List backups for a VM","deprecated":null,"version":null,"openapi":"https://api.vmarea.com/api/public/v1/openapi.json get /api/public/v1/vms/{vmId}/backups","href":"/api-reference/backups/list-backups-for-a-vm"},{"title":"Create a manual backup","deprecated":null,"version":null,"openapi":"https://api.vmarea.com/api/public/v1/openapi.json post /api/public/v1/vms/{vmId}/backups","href":"/api-reference/backups/create-a-manual-backup"},{"title":"Get a single backup","deprecated":null,"version":null,"openapi":"https://api.vmarea.com/api/public/v1/openapi.json get /api/public/v1/vms/{vmId}/backups/{id}","href":"/api-reference/backups/get-a-single-backup"},{"title":"Delete a backup","deprecated":null,"version":null,"openapi":"https://api.vmarea.com/api/public/v1/openapi.json delete /api/public/v1/vms/{vmId}/backups/{id}","href":"/api-reference/backups/delete-a-backup"},{"title":"Restore a backup over the source VM","deprecated":null,"version":null,"openapi":"https://api.vmarea.com/api/public/v1/openapi.json post /api/public/v1/vms/{vmId}/backups/{id}/restore","href":"/api-reference/backups/restore-a-backup-over-the-source-vm"}]},{"group":"Snapshots","pages":[{"title":"List snapshots for a VM","deprecated":null,"version":null,"openapi":"https://api.vmarea.com/api/public/v1/openapi.json get /api/public/v1/vms/{vmId}/snapshots","href":"/api-reference/snapshots/list-snapshots-for-a-vm"},{"title":"Create a snapshot","deprecated":null,"version":null,"openapi":"https://api.vmarea.com/api/public/v1/openapi.json post /api/public/v1/vms/{vmId}/snapshots","href":"/api-reference/snapshots/create-a-snapshot"},{"title":"Get a single snapshot","deprecated":null,"version":null,"openapi":"https://api.vmarea.com/api/public/v1/openapi.json get /api/public/v1/vms/{vmId}/snapshots/{id}","href":"/api-reference/snapshots/get-a-single-snapshot"},{"title":"Delete a snapshot","deprecated":null,"version":null,"openapi":"https://api.vmarea.com/api/public/v1/openapi.json delete /api/public/v1/vms/{vmId}/snapshots/{id}","href":"/api-reference/snapshots/delete-a-snapshot"},{"title":"Roll a VM back to a snapshot","deprecated":null,"version":null,"openapi":"https://api.vmarea.com/api/public/v1/openapi.json post /api/public/v1/vms/{vmId}/snapshots/{id}/rollback","href":"/api-reference/snapshots/roll-a-vm-back-to-a-snapshot"}]},{"group":"Networks","pages":[{"title":"List private networks","deprecated":null,"version":null,"openapi":"https://api.vmarea.com/api/public/v1/openapi.json get /api/public/v1/networks","href":"/api-reference/networks/list-private-networks"},{"title":"Create a private network","deprecated":null,"version":null,"openapi":"https://api.vmarea.com/api/public/v1/openapi.json post /api/public/v1/networks","href":"/api-reference/networks/create-a-private-network"},{"title":"Get a private network","deprecated":null,"version":null,"openapi":"https://api.vmarea.com/api/public/v1/openapi.json get /api/public/v1/networks/{id}","href":"/api-reference/networks/get-a-private-network"},{"title":"Delete a private network","deprecated":null,"version":null,"openapi":"https://api.vmarea.com/api/public/v1/openapi.json delete /api/public/v1/networks/{id}","href":"/api-reference/networks/delete-a-private-network"},{"title":"Rename a private network","deprecated":null,"version":null,"openapi":"https://api.vmarea.com/api/public/v1/openapi.json patch /api/public/v1/networks/{id}","href":"/api-reference/networks/rename-a-private-network"},{"title":"List VMs attached to a network","deprecated":null,"version":null,"openapi":"https://api.vmarea.com/api/public/v1/openapi.json get /api/public/v1/networks/{id}/attachments","href":"/api-reference/networks/list-vms-attached-to-a-network"},{"title":"Attach a VM to a private network","deprecated":null,"version":null,"openapi":"https://api.vmarea.com/api/public/v1/openapi.json post /api/public/v1/networks/{id}/attachments","href":"/api-reference/networks/attach-a-vm-to-a-private-network"},{"title":"Detach a VM from a private network","deprecated":null,"version":null,"openapi":"https://api.vmarea.com/api/public/v1/openapi.json delete /api/public/v1/networks/{id}/attachments/{vmId}","href":"/api-reference/networks/detach-a-vm-from-a-private-network"}]},{"group":"Firewalls","pages":[{"title":"List firewalls","deprecated":null,"version":null,"openapi":"https://api.vmarea.com/api/public/v1/openapi.json get /api/public/v1/firewalls","href":"/api-reference/firewalls/list-firewalls"},{"title":"Create a firewall","deprecated":null,"version":null,"openapi":"https://api.vmarea.com/api/public/v1/openapi.json post /api/public/v1/firewalls","href":"/api-reference/firewalls/create-a-firewall"},{"title":"Get a firewall","deprecated":null,"version":null,"openapi":"https://api.vmarea.com/api/public/v1/openapi.json get /api/public/v1/firewalls/{id}","href":"/api-reference/firewalls/get-a-firewall"},{"title":"Delete a firewall","deprecated":null,"version":null,"openapi":"https://api.vmarea.com/api/public/v1/openapi.json delete /api/public/v1/firewalls/{id}","href":"/api-reference/firewalls/delete-a-firewall"},{"title":"Rename or re-describe a firewall","deprecated":null,"version":null,"openapi":"https://api.vmarea.com/api/public/v1/openapi.json patch /api/public/v1/firewalls/{id}","href":"/api-reference/firewalls/rename-or-re-describe-a-firewall"},{"title":"List rules for a firewall","deprecated":null,"version":null,"openapi":"https://api.vmarea.com/api/public/v1/openapi.json get /api/public/v1/firewalls/{id}/rules","href":"/api-reference/firewalls/list-rules-for-a-firewall"},{"title":"Add a rule to a firewall","deprecated":null,"version":null,"openapi":"https://api.vmarea.com/api/public/v1/openapi.json post /api/public/v1/firewalls/{id}/rules","href":"/api-reference/firewalls/add-a-rule-to-a-firewall"},{"title":"Delete a firewall rule","deprecated":null,"version":null,"openapi":"https://api.vmarea.com/api/public/v1/openapi.json delete /api/public/v1/firewalls/{id}/rules/{ruleId}","href":"/api-reference/firewalls/delete-a-firewall-rule"},{"title":"Update a firewall rule","deprecated":null,"version":null,"openapi":"https://api.vmarea.com/api/public/v1/openapi.json patch /api/public/v1/firewalls/{id}/rules/{ruleId}","href":"/api-reference/firewalls/update-a-firewall-rule"},{"title":"Bind a firewall to a VM","deprecated":null,"version":null,"openapi":"https://api.vmarea.com/api/public/v1/openapi.json post /api/public/v1/firewalls/{id}/bindings","href":"/api-reference/firewalls/bind-a-firewall-to-a-vm"},{"title":"Unbind a firewall from a VM","deprecated":null,"version":null,"openapi":"https://api.vmarea.com/api/public/v1/openapi.json delete /api/public/v1/firewalls/{id}/bindings/{vmId}","href":"/api-reference/firewalls/unbind-a-firewall-from-a-vm"}]},{"group":"SSH Keys","pages":[{"title":"List SSH keys","deprecated":null,"version":null,"openapi":"https://api.vmarea.com/api/public/v1/openapi.json get /api/public/v1/ssh-keys","href":"/api-reference/ssh-keys/list-ssh-keys"},{"title":"Add SSH key","deprecated":null,"version":null,"openapi":"https://api.vmarea.com/api/public/v1/openapi.json post /api/public/v1/ssh-keys","href":"/api-reference/ssh-keys/add-ssh-key"},{"title":"Get SSH key","deprecated":null,"version":null,"openapi":"https://api.vmarea.com/api/public/v1/openapi.json get /api/public/v1/ssh-keys/{id}","href":"/api-reference/ssh-keys/get-ssh-key"},{"title":"Delete SSH key","deprecated":null,"version":null,"openapi":"https://api.vmarea.com/api/public/v1/openapi.json delete /api/public/v1/ssh-keys/{id}","href":"/api-reference/ssh-keys/delete-ssh-key"},{"title":"Rename SSH key","deprecated":null,"version":null,"openapi":"https://api.vmarea.com/api/public/v1/openapi.json patch /api/public/v1/ssh-keys/{id}","href":"/api-reference/ssh-keys/rename-ssh-key"}]},{"group":"Webhooks","pages":[{"title":"List webhook subscriptions","deprecated":null,"version":null,"openapi":"https://api.vmarea.com/api/public/v1/openapi.json get /api/public/v1/webhooks","href":"/api-reference/webhooks/list-webhook-subscriptions"},{"title":"Create a webhook subscription","deprecated":null,"version":null,"openapi":"https://api.vmarea.com/api/public/v1/openapi.json post /api/public/v1/webhooks","href":"/api-reference/webhooks/create-a-webhook-subscription"},{"title":"Get a webhook subscription","deprecated":null,"version":null,"openapi":"https://api.vmarea.com/api/public/v1/openapi.json get /api/public/v1/webhooks/{id}","href":"/api-reference/webhooks/get-a-webhook-subscription"},{"title":"Delete a webhook subscription","deprecated":null,"version":null,"openapi":"https://api.vmarea.com/api/public/v1/openapi.json delete /api/public/v1/webhooks/{id}","href":"/api-reference/webhooks/delete-a-webhook-subscription"},{"title":"Update a webhook subscription","deprecated":null,"version":null,"openapi":"https://api.vmarea.com/api/public/v1/openapi.json patch /api/public/v1/webhooks/{id}","href":"/api-reference/webhooks/update-a-webhook-subscription"},{"title":"Send a test event","deprecated":null,"version":null,"openapi":"https://api.vmarea.com/api/public/v1/openapi.json post /api/public/v1/webhooks/{id}/test","href":"/api-reference/webhooks/send-a-test-event"},{"title":"List delivery history for a webhook","deprecated":null,"version":null,"openapi":"https://api.vmarea.com/api/public/v1/openapi.json get /api/public/v1/webhooks/{id}/deliveries","href":"/api-reference/webhooks/list-delivery-history-for-a-webhook"},{"title":"Get a single webhook delivery","deprecated":null,"version":null,"openapi":"https://api.vmarea.com/api/public/v1/openapi.json get /api/public/v1/webhooks/{id}/deliveries/{deliveryId}","href":"/api-reference/webhooks/get-a-single-webhook-delivery"}]},{"group":"Billing","pages":[{"title":"Get wallet","deprecated":null,"version":null,"openapi":"https://api.vmarea.com/api/public/v1/openapi.json get /api/public/v1/wallet","href":"/api-reference/billing/get-wallet"},{"title":"List wallet transactions","deprecated":null,"version":null,"openapi":"https://api.vmarea.com/api/public/v1/openapi.json get /api/public/v1/wallet/transactions","href":"/api-reference/billing/list-wallet-transactions"},{"title":"List invoices","deprecated":null,"version":null,"openapi":"https://api.vmarea.com/api/public/v1/openapi.json get /api/public/v1/invoices","href":"/api-reference/billing/list-invoices"},{"title":"Get invoice","deprecated":null,"version":null,"openapi":"https://api.vmarea.com/api/public/v1/openapi.json get /api/public/v1/invoices/{id}","href":"/api-reference/billing/get-invoice"},{"title":"Download invoice PDF","deprecated":null,"version":null,"openapi":"https://api.vmarea.com/api/public/v1/openapi.json get /api/public/v1/invoices/{id}/pdf","href":"/api-reference/billing/download-invoice-pdf"},{"title":"Get bandwidth usage","deprecated":null,"version":null,"openapi":"https://api.vmarea.com/api/public/v1/openapi.json get /api/public/v1/bandwidth","href":"/api-reference/billing/get-bandwidth-usage"},{"title":"List VM bandwidth packs","deprecated":null,"version":null,"openapi":"https://api.vmarea.com/api/public/v1/openapi.json get /api/public/v1/vms/{vmId}/bandwidth/packs","href":"/api-reference/billing/list-vm-bandwidth-packs"}]},{"group":"Catalog","pages":[{"title":"List plans","deprecated":null,"version":null,"openapi":"https://api.vmarea.com/api/public/v1/openapi.json get /api/public/v1/plans","href":"/api-reference/catalog/list-plans"},{"title":"Get plan","deprecated":null,"version":null,"openapi":"https://api.vmarea.com/api/public/v1/openapi.json get /api/public/v1/plans/{slug}","href":"/api-reference/catalog/get-plan"},{"title":"List regions","deprecated":null,"version":null,"openapi":"https://api.vmarea.com/api/public/v1/openapi.json get /api/public/v1/regions","href":"/api-reference/catalog/list-regions"},{"title":"Get region","deprecated":null,"version":null,"openapi":"https://api.vmarea.com/api/public/v1/openapi.json get /api/public/v1/regions/{slug}","href":"/api-reference/catalog/get-region"},{"title":"List OS templates","deprecated":null,"version":null,"openapi":"https://api.vmarea.com/api/public/v1/openapi.json get /api/public/v1/os-templates","href":"/api-reference/catalog/list-os-templates"},{"title":"Get OS template","deprecated":null,"version":null,"openapi":"https://api.vmarea.com/api/public/v1/openapi.json get /api/public/v1/os-templates/{slug}","href":"/api-reference/catalog/get-os-template"}]}]}]}]},"title":"Create a virtual machine - VMArea Developer Docs","buildId":"dpl_DFJrtvUi8HS5F9nkooKuDJsuD5BM","deploymentId":"dpl_DFJrtvUi8HS5F9nkooKuDJsuD5BM","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-rfhihCWU.js","utils-BmH1XFxk.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-BcNsxPKB.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-BAES3tkd.js","snippetPresets-DCMQBKLP.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-D6l_bzE9.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BOktbnNh.js","shallow-BCs8SgM7.js","getApiPlaygroundDisplay-DEmW5bJB.js","CodeSnippet-CpZOpB9C.js","CodeSnippets-BOBDqibl.js","Page-D5fEM6aW.js","getPastedJson-DH2JBvmr.js","icon-BBJH-kKh.js","MethodPill-D2Sd5NLC.js","DuplicateIcon-CGgfL2qN.js","createIcon-BKudBBzi.js","DynamicMarkdown-85clUA0i.js","SectionHeading-D0JiMgDx.js","axios-vUo_bRtp.js","Markdown-Cfiy0xZO.js","clsx-rL8ZCCw4.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-aeztFa9U.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BywkCr5C.js"]}