{
"code": "INTERNAL_SERVER_ERROR",
"message": "Internal server error",
"issues": []
}
Rentals
Create a rental
Rent a virtual machine or a bare metal server. rentalType decides which machine-type-specific fields apply; sending a field for the other type is a BAD_REQUEST (INVALID_INPUT_FOR_RENTAL_TYPE).
Any whole number of days from 1 to 30 where custom reservation lengths are enabled for your account; otherwise one of the standard terms in options from GET /v2/on-demand/reserve-options.
Virtual machines only. Opt the rental out of Hyperbolic telemetry: the GPU health and system metrics (CPU, memory, root filesystem, network interfaces) Hyperbolic collects from inside the virtual machine to detect hardware faults. No logs, process lists or file contents are collected. Omitted or false leaves collection on. Only standalone virtual machine rentals in supported regions can opt out; elsewhere true gets a 400.
The managed Kubernetes cluster a rental is a node pool of.
Show child attributes
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Hyperbolic Labs","colors":{"primary":"#5B25D4","light":"#FFFFFF","dark":"#242424"},"logo":{"light":"https://mintcdn.com/hyperboliclabs/Vc2Wh0-_YkdmKob6/images/Hyperbolic-Logo-Light-Mode.svg?fit=max\u0026auto=format\u0026n=Vc2Wh0-_YkdmKob6\u0026q=85\u0026s=da9c4e64931e88f9797c1ad9d2aaa86f","dark":"https://mintcdn.com/hyperboliclabs/Vc2Wh0-_YkdmKob6/images/Hyperbolic-Logo-Dark-Mode.svg?fit=max\u0026auto=format\u0026n=Vc2Wh0-_YkdmKob6\u0026q=85\u0026s=93834e7f0525f8348c9284e1f0f50c28"},"favicon":"https://mintcdn.com/hyperboliclabs/p9MF9bY81jprqIgN/favicon.png?fit=max\u0026auto=format\u0026n=p9MF9bY81jprqIgN\u0026q=85\u0026s=8aa322bdab6908c40e7de239746ec532","navbar":{"links":[{"href":"mailto:support@hyperbolic.ai","label":"Support"}],"primary":{"type":"button","label":"Dashboard","href":"https://app.hyperbolic.ai"}},"footer":{"socials":{"x":"https://x.com/hyperbolic_labs","github":"https://github.com/HyperbolicLabs","linkedin":"https://linkedin.com/company/hyperbolic-labs"}},"seo":{"metatags":{"canonical":"https://hyperbolic.ai/docs"}},"integrations":{"ga4":{"measurementId":"G-W6V5M79LWK"}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"styling":{"latex":true},"navigation":{"global":{"anchors":[{"anchor":"Blog","icon":"newspaper","href":"https://hyperbolic.ai/blog"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"hyperboliclabs","hasAudioNarration":false,"actualSubdomain":"hyperboliclabs","customDomains":["hyperbolic.ai"],"gitSource":{"type":"github","owner":"hyperboliclabs","repo":"mintlify-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6af39f6673060632d44fc847","clientVersion":"0.0.4102","searchFilterCounts":[{"language":"default","tag":"API Reference","count":68},{"language":"default","tag":"Rentals","count":25},{"language":"default","tag":"GPUs","count":15},{"language":"default","tag":"Storage Volumes","count":12},{"language":"default","tag":"Users","count":8},{"language":"default","tag":"Virtual Machine Rentals (Deprecated)","count":7},{"language":"default","tag":"Bare Metal Rentals (Deprecated)","count":6},{"language":"default","tag":"SSH Keys","count":5},{"language":"default","tag":"Overview","count":4},{"language":"default","tag":"Account \u0026 Billing","count":4}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"/docs","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","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":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","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":"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":"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":"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":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","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":"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":"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":"turbopuffer-dual-write","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},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"#sidebar li[data-group-tag]>button span,li[data-group-tag]>button span{font-weight:700}"}],"page":{"pagePath":"api-reference/rentals/create-a-rental","slug":"/api-reference/rentals/create-a-rental","pageMetadata":{"title":"Create a rental","description":"Rent a virtual machine or a bare metal server. `rentalType` decides which machine-type-specific fields apply; sending a field for the other type is a BAD_REQUEST (INVALID_INPUT_FOR_RENTAL_TYPE).","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v2/on-demand/rentals","href":"/api-reference/rentals/create-a-rental","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: [\"Rent a virtual machine or a bare metal server. \", _jsx(_components.code, {\n children: \"rentalType\"\n }), \" decides which machine-type-specific fields apply; sending a field for the other type is a BAD_REQUEST (INVALID_INPUT_FOR_RENTAL_TYPE).\"]\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 rental","description":"Rent a virtual machine or a bare metal server. `rentalType` decides which machine-type-specific fields apply; sending a field for the other type is a BAD_REQUEST (INVALID_INPUT_FOR_RENTAL_TYPE).","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v2/on-demand/rentals","href":"/api-reference/rentals/create-a-rental","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"ondemand-createRental","summary":"Create a rental","description":"Rent a virtual machine or a bare metal server. `rentalType` decides which machine-type-specific fields apply; sending a field for the other type is a BAD_REQUEST (INVALID_INPUT_FOR_RENTAL_TYPE).","tags":["rentals"],"security":["0f1fea06-45c3-4316-9ab2-b9c99abbc1c8"],"parameters":[],"requestBody":"1f909f49-7bfb-4121-810a-bea33a405786","responses":{"200":"f641ab0d-7f67-4706-b942-daaa731705f1","400":"c9df2462-3324-49e5-942f-c06eb4667d8c","401":"67d67928-2bbd-4013-82cf-2b5ef829f196","403":"0b0b45cc-909a-4ac8-af5a-f391d20b2603","500":"3770f5c5-f50a-406f-9ae6-bd717dff567d"},"method":"post","type":"path","servers":["c36ff8a7-1340-4c27-9a97-aced91c3a779","a9ff1d3c-51ba-446a-9f9d-0348b78b2a24"],"path":"/v2/on-demand/rentals","baseUrlOptions":["https://api.hyperbolic.ai","https://api.hyperbolic.xyz"],"title":"Create a rental","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"rentalType":{"type":"string","enum":["virtual-machine","bare-metal"],"description":"The machine type to rent. Fields marked for one machine type are rejected for the other.","isRequired":true,"uniqueKey":"rentalType","typeLabel":"enum\u003cstring>"},"gpuCount":{"type":"number","description":"GPUs to rent. Bare metal rents whole nodes, so a multiple of 8.","isRequired":true,"uniqueKey":"gpuCount","typeLabel":"number"},"networkType":{"description":"Required for bare metal. Virtual machines default to `ethernet`.","type":"string","enum":["infiniband","ethernet"],"uniqueKey":"networkType","typeLabel":"enum\u003cstring>"},"region":{"oneOf":[{"type":"string","description":"A region that offers the chosen machine type.","default":"us-central-1","enum":["us-central-1","us-central-2","eu-north-2","eu-west-2","eu-north-4","eu-north-5","us-east-1","us-east-2","ca-east-3","eu-north-6","eu-north-7","eu-north-8","eu-north-9","ca-west-1","ca-east-1","us-central-3","us-southeast-1","me-central-1","ca-east-2","eu-west-1","us-southeast-2","jp-east-1","us-southeast-3","eu-west-5","us-east-3"],"uniqueKey":"region.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","description":"A region that offers the chosen machine type.","default":"us-central-1","enum":["us-central-1","uk-central-3","uk-southeast-3","eu-southwest-3","eu-southwest-3-1","eu-west-3","eu-west-4"],"uniqueKey":"region.oneOf.1","typeLabel":"enum\u003cstring>"}],"uniqueKey":"region","typeLabel":"enum\u003cstring>"},"gpuType":{"default":"h100","type":"string","enum":["h100","h200","b200","rtx-6000-pro"],"uniqueKey":"gpuType","typeLabel":"enum\u003cstring>"},"label":{"type":"string","uniqueKey":"label","typeLabel":"string"},"termType":{"default":"on-demand","type":"string","enum":["on-demand","reserved"],"uniqueKey":"termType","typeLabel":"enum\u003cstring>"},"termPeriodDays":{"type":"integer","minimum":1,"maximum":30,"description":"Any whole number of days from 1 to 30 where custom reservation lengths are enabled for your account; otherwise one of the standard terms in `options` from `GET /v2/on-demand/reserve-options`.","uniqueKey":"termPeriodDays","typeLabel":"integer"},"discountPercentage":{"default":0,"type":"number","uniqueKey":"discountPercentage","typeLabel":"number"},"convertToOnDemandOnExpiry":{"default":true,"type":"boolean","uniqueKey":"convertToOnDemandOnExpiry","typeLabel":"boolean"},"monitoringEnabled":{"type":"boolean","uniqueKey":"monitoringEnabled","typeLabel":"boolean"},"sshPublicKeyId":{"description":"The saved SSH key to authorize on the rental. Defaults to the most recently added key.","type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"uniqueKey":"sshPublicKeyId","typeLabel":"integer"},"sshPublicKeyIds":{"description":"The saved SSH keys to authorize on the rental.","minItems":1,"type":"array","items":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"uniqueKey":"sshPublicKeyIds.items.[INDEX]","typeLabel":"integer"},"uniqueKey":"sshPublicKeyIds","typeLabel":"integer[]"},"customPorts":{"description":"Virtual machines only.","maxItems":20,"type":"array","items":{"type":"integer","minimum":1,"maximum":65535,"uniqueKey":"customPorts.items.[INDEX]","typeLabel":"integer"},"uniqueKey":"customPorts","typeLabel":"integer[]"},"monitoringOptOut":{"description":"Virtual machines only. Opt the rental out of Hyperbolic telemetry: the GPU health and system metrics (CPU, memory, root filesystem, network interfaces) Hyperbolic collects from inside the virtual machine to detect hardware faults. No logs, process lists or file contents are collected. Omitted or `false` leaves collection on. Only standalone virtual machine rentals in supported regions can opt out; elsewhere `true` gets a 400.","type":"boolean","uniqueKey":"monitoringOptOut","typeLabel":"boolean"},"cudaVersion":{"description":"Bare metal only.","type":"string","enum":["cuda12.8","cuda12.9"],"uniqueKey":"cudaVersion","typeLabel":"enum\u003cstring>"},"storageVolume":{"oneOf":[{"type":"object","description":"Bare metal only.","required":["isNew","id"],"properties":{"isNew":{"type":"boolean","const":false,"isRequired":true,"uniqueKey":"storageVolume.oneOf.0.isNew","typeLabel":"boolean"},"id":{"oneOf":[{"type":"integer","maximum":9007199254740991,"minimum":0,"exclusiveMinimum":true,"isRequired":true,"uniqueKey":"storageVolume.oneOf.0.id.oneOf.0","typeLabel":"integer"},{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"storageVolume.oneOf.0.id.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"storageVolume.oneOf.0.id","typeLabel":"integer | string"}},"uniqueKey":"storageVolume.oneOf.0","typeLabel":"object"},{"type":"object","description":"Bare metal only.","required":["isNew","label","sizeInGb"],"properties":{"isNew":{"type":"boolean","const":true,"isRequired":true,"uniqueKey":"storageVolume.oneOf.1.isNew","typeLabel":"boolean"},"label":{"type":"string","minLength":4,"maxLength":255,"pattern":"^[a-zA-Z0-9_-]+$","isRequired":true,"uniqueKey":"storageVolume.oneOf.1.label","typeLabel":"string"},"sizeInGb":{"type":"integer","minimum":256,"maximum":64000,"isRequired":true,"uniqueKey":"storageVolume.oneOf.1.sizeInGb","typeLabel":"integer"}},"uniqueKey":"storageVolume.oneOf.1","typeLabel":"object"}],"uniqueKey":"storageVolume","typeLabel":"object"}},"required":["rentalType","gpuCount"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"gpuCount":123,"region":"us-central-1","gpuType":"h100","label":"\u003cstring>","termType":"on-demand","termPeriodDays":15,"discountPercentage":0,"convertToOnDemandOnExpiry":true,"monitoringEnabled":true,"sshPublicKeyId":0,"sshPublicKeyIds":[0],"customPorts":[32768],"monitoringOptOut":true,"storageVolume":{"isNew":false,"id":4503599627370495}}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"f641ab0d-7f67-4706-b942-daaa731705f1":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"rentalId":{"type":"string","isRequired":true,"uniqueKey":"rentalId","typeLabel":"string"},"name":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"name.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"name","typeLabel":"string | null"},"label":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"label.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"label.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"label","typeLabel":"string | null"},"rentalType":{"type":"string","enum":["virtual-machine","bare-metal"],"isRequired":true,"uniqueKey":"rentalType","typeLabel":"enum\u003cstring>"},"region":{"type":"string","enum":["us-central-1","us-central-2","eu-north-2","eu-west-2","eu-north-4","eu-north-5","us-east-1","us-east-2","ca-east-3","eu-north-6","eu-north-7","eu-north-8","eu-north-9","ca-west-1","ca-east-1","us-central-3","us-southeast-1","me-central-1","ca-east-2","eu-west-1","us-southeast-2","jp-east-1","us-southeast-3","eu-west-5","us-east-3","uk-central-3","uk-southeast-3","eu-southwest-3","eu-southwest-3-1","eu-west-3","eu-west-4","private-cloud"],"isRequired":true,"uniqueKey":"region","typeLabel":"enum\u003cstring>"},"gpuType":{"type":"string","enum":["h100","h200","b200","rtx-6000-pro"],"isRequired":true,"uniqueKey":"gpuType","typeLabel":"enum\u003cstring>"},"gpuCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"isRequired":true,"uniqueKey":"gpuCount","typeLabel":"integer"},"gpuFormFactor":{"type":"string","enum":["sxm5","sxm6","pcie"],"isRequired":true,"uniqueKey":"gpuFormFactor","typeLabel":"enum\u003cstring>"},"connectionType":{"type":"string","enum":["infiniband","ethernet"],"isRequired":true,"uniqueKey":"connectionType","typeLabel":"enum\u003cstring>"},"ethernetVariant":{"oneOf":[{"type":"string","enum":["normal","rocev2"],"isRequired":true,"uniqueKey":"ethernetVariant.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","isRequired":true,"uniqueKey":"ethernetVariant.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"ethernetVariant","typeLabel":"enum\u003cstring> | null"},"nodes":{"type":"array","items":{"type":"object","properties":{"cpuModel":{"type":"string","isRequired":true,"uniqueKey":"nodes.items.[INDEX].cpuModel","typeLabel":"string"},"cpuCount":{"oneOf":[{"type":"number","isRequired":true,"uniqueKey":"nodes.items.[INDEX].cpuCount.oneOf.0","typeLabel":"number"},{"type":"null","isRequired":true,"uniqueKey":"nodes.items.[INDEX].cpuCount.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"nodes.items.[INDEX].cpuCount","typeLabel":"number | null"},"vcpuCount":{"oneOf":[{"type":"number","isRequired":true,"uniqueKey":"nodes.items.[INDEX].vcpuCount.oneOf.0","typeLabel":"number"},{"type":"null","isRequired":true,"uniqueKey":"nodes.items.[INDEX].vcpuCount.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"nodes.items.[INDEX].vcpuCount","typeLabel":"number | null"},"gpuCount":{"type":"number","isRequired":true,"uniqueKey":"nodes.items.[INDEX].gpuCount","typeLabel":"number"},"ramGb":{"type":"number","isRequired":true,"uniqueKey":"nodes.items.[INDEX].ramGb","typeLabel":"number"},"storageGb":{"type":"number","isRequired":true,"uniqueKey":"nodes.items.[INDEX].storageGb","typeLabel":"number"}},"required":["cpuModel","cpuCount","vcpuCount","gpuCount","ramGb","storageGb"],"additionalProperties":false,"description":"Hardware of one node of a rental, normalised across machine types.","uniqueKey":"nodes.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"nodes","typeLabel":"object[]"},"sshEndpoints":{"type":"array","items":{"type":"object","properties":{"host":{"type":"string","isRequired":true,"uniqueKey":"sshEndpoints.items.[INDEX].host","typeLabel":"string"},"port":{"type":"number","isRequired":true,"uniqueKey":"sshEndpoints.items.[INDEX].port","typeLabel":"number"},"user":{"type":"string","isRequired":true,"uniqueKey":"sshEndpoints.items.[INDEX].user","typeLabel":"string"}},"required":["host","port","user"],"additionalProperties":false,"description":"Where to connect to a rental over SSH.","uniqueKey":"sshEndpoints.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"sshEndpoints","typeLabel":"object[]"},"networkInterfaces":{"type":"array","items":{"type":"object","properties":{"publicIp":{"type":"string","isRequired":true,"uniqueKey":"networkInterfaces.items.[INDEX].publicIp","typeLabel":"string"},"privateIp":{"type":"string","isRequired":true,"uniqueKey":"networkInterfaces.items.[INDEX].privateIp","typeLabel":"string"}},"required":["publicIp","privateIp"],"additionalProperties":false,"description":"The public and private addresses of one node of a rental.","uniqueKey":"networkInterfaces.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"networkInterfaces","typeLabel":"object[]"},"portMappings":{"type":"array","items":{"type":"object","properties":{"externalPort":{"type":"number","isRequired":true,"uniqueKey":"portMappings.items.[INDEX].externalPort","typeLabel":"number"},"internalPort":{"type":"number","isRequired":true,"uniqueKey":"portMappings.items.[INDEX].internalPort","typeLabel":"number"}},"required":["externalPort","internalPort"],"additionalProperties":false,"description":"A port reachable from outside, and the port it reaches inside the machine.","uniqueKey":"portMappings.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"portMappings","typeLabel":"object[]"},"supportsPortForwarding":{"type":"boolean","isRequired":true,"uniqueKey":"supportsPortForwarding","typeLabel":"boolean"},"exposedPorts":{"type":"array","items":{"type":"number","uniqueKey":"exposedPorts.items.[INDEX]","typeLabel":"number"},"isRequired":true,"uniqueKey":"exposedPorts","typeLabel":"number[]"},"supportsCustomPorts":{"type":"boolean","isRequired":true,"uniqueKey":"supportsCustomPorts","typeLabel":"boolean"},"supportsMultipleSshKeys":{"type":"boolean","isRequired":true,"uniqueKey":"supportsMultipleSshKeys","typeLabel":"boolean"},"supportsSshKeyUpdates":{"type":"boolean","isRequired":true,"uniqueKey":"supportsSshKeyUpdates","typeLabel":"boolean"},"attachedStorage":{"type":"array","items":{"type":"object","properties":{"storageVolumeId":{"type":"string","isRequired":true,"uniqueKey":"attachedStorage.items.[INDEX].storageVolumeId","typeLabel":"string"},"label":{"type":"string","isRequired":true,"uniqueKey":"attachedStorage.items.[INDEX].label","typeLabel":"string"},"sizeInGb":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"isRequired":true,"uniqueKey":"attachedStorage.items.[INDEX].sizeInGb","typeLabel":"integer"},"virtualIp":{"type":"string","isRequired":true,"uniqueKey":"attachedStorage.items.[INDEX].virtualIp","typeLabel":"string"},"costPerHourCents":{"type":"number","isRequired":true,"uniqueKey":"attachedStorage.items.[INDEX].costPerHourCents","typeLabel":"number"}},"required":["storageVolumeId","label","sizeInGb","virtualIp","costPerHourCents"],"additionalProperties":false,"description":"A storage volume as seen from a rental it is attached to.","uniqueKey":"attachedStorage.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"attachedStorage","typeLabel":"object[]"},"supportsAttachedStorage":{"type":"boolean","isRequired":true,"uniqueKey":"supportsAttachedStorage","typeLabel":"boolean"},"monitoringEnabled":{"type":"boolean","isRequired":true,"uniqueKey":"monitoringEnabled","typeLabel":"boolean"},"convertToOnDemandOnExpiry":{"oneOf":[{"type":"boolean","isRequired":true,"uniqueKey":"convertToOnDemandOnExpiry.oneOf.0","typeLabel":"boolean"},{"type":"null","isRequired":true,"uniqueKey":"convertToOnDemandOnExpiry.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"convertToOnDemandOnExpiry","typeLabel":"boolean | null"},"terminationReason":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"terminationReason.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"terminationReason.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"terminationReason","typeLabel":"string | null"},"currentTerm":{"oneOf":[{"type":"object","required":["effectiveAt","termType","costPerHour","reservedUntil","reservationEndsAt","termPeriodDays","discountPercentage","originalCostPerHour"],"properties":{"effectiveAt":{"type":"string","format":"date-time","example":"2025-01-31T12:00:00.000Z","isRequired":true,"uniqueKey":"currentTerm.oneOf.0.effectiveAt","typeLabel":"string\u003cdate-time>"},"termType":{"type":"string","const":"on-demand","isRequired":true,"uniqueKey":"currentTerm.oneOf.0.termType","typeLabel":"string"},"costPerHour":{"type":"number","isRequired":true,"uniqueKey":"currentTerm.oneOf.0.costPerHour","typeLabel":"number"},"reservedUntil":{"type":"null","isRequired":true,"uniqueKey":"currentTerm.oneOf.0.reservedUntil","typeLabel":"null"},"reservationEndsAt":{"type":"null","isRequired":true,"uniqueKey":"currentTerm.oneOf.0.reservationEndsAt","typeLabel":"null"},"termPeriodDays":{"type":"null","isRequired":true,"uniqueKey":"currentTerm.oneOf.0.termPeriodDays","typeLabel":"null"},"discountPercentage":{"type":"null","isRequired":true,"uniqueKey":"currentTerm.oneOf.0.discountPercentage","typeLabel":"null"},"originalCostPerHour":{"type":"null","isRequired":true,"uniqueKey":"currentTerm.oneOf.0.originalCostPerHour","typeLabel":"null"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"currentTerm.oneOf.0","typeLabel":"object"},{"type":"object","required":["effectiveAt","termType","costPerHour","reservedUntil","reservationEndsAt","termPeriodDays","discountPercentage","originalCostPerHour"],"properties":{"effectiveAt":{"type":"string","format":"date-time","example":"2025-01-31T12:00:00.000Z","isRequired":true,"uniqueKey":"currentTerm.oneOf.1.effectiveAt","typeLabel":"string\u003cdate-time>"},"termType":{"type":"string","const":"reserved","isRequired":true,"uniqueKey":"currentTerm.oneOf.1.termType","typeLabel":"string"},"costPerHour":{"type":"number","isRequired":true,"uniqueKey":"currentTerm.oneOf.1.costPerHour","typeLabel":"number"},"reservedUntil":{"oneOf":[{"type":"string","format":"date-time","example":"2025-01-31T12:00:00.000Z","isRequired":true,"uniqueKey":"currentTerm.oneOf.1.reservedUntil.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","isRequired":true,"uniqueKey":"currentTerm.oneOf.1.reservedUntil.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"currentTerm.oneOf.1.reservedUntil","typeLabel":"string\u003cdate-time> | null"},"reservationEndsAt":{"oneOf":[{"type":"string","format":"date-time","example":"2025-01-31T12:00:00.000Z","isRequired":true,"uniqueKey":"currentTerm.oneOf.1.reservationEndsAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","isRequired":true,"uniqueKey":"currentTerm.oneOf.1.reservationEndsAt.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"currentTerm.oneOf.1.reservationEndsAt","typeLabel":"string\u003cdate-time> | null"},"termPeriodDays":{"type":"number","isRequired":true,"uniqueKey":"currentTerm.oneOf.1.termPeriodDays","typeLabel":"number"},"discountPercentage":{"type":"number","isRequired":true,"uniqueKey":"currentTerm.oneOf.1.discountPercentage","typeLabel":"number"},"originalCostPerHour":{"type":"number","isRequired":true,"uniqueKey":"currentTerm.oneOf.1.originalCostPerHour","typeLabel":"number"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"currentTerm.oneOf.1","typeLabel":"object"},{"type":"object","required":["effectiveAt","termType","costPerHour","reservedUntil","reservationEndsAt","termPeriodDays","discountPercentage","originalCostPerHour"],"properties":{"effectiveAt":{"type":"string","format":"date-time","example":"2025-01-31T12:00:00.000Z","isRequired":true,"uniqueKey":"currentTerm.oneOf.2.effectiveAt","typeLabel":"string\u003cdate-time>"},"termType":{"type":"string","const":"private-cloud","isRequired":true,"uniqueKey":"currentTerm.oneOf.2.termType","typeLabel":"string"},"costPerHour":{"type":"number","isRequired":true,"uniqueKey":"currentTerm.oneOf.2.costPerHour","typeLabel":"number"},"reservedUntil":{"type":"null","isRequired":true,"uniqueKey":"currentTerm.oneOf.2.reservedUntil","typeLabel":"null"},"reservationEndsAt":{"type":"null","isRequired":true,"uniqueKey":"currentTerm.oneOf.2.reservationEndsAt","typeLabel":"null"},"termPeriodDays":{"type":"null","isRequired":true,"uniqueKey":"currentTerm.oneOf.2.termPeriodDays","typeLabel":"null"},"discountPercentage":{"type":"null","isRequired":true,"uniqueKey":"currentTerm.oneOf.2.discountPercentage","typeLabel":"null"},"originalCostPerHour":{"type":"null","isRequired":true,"uniqueKey":"currentTerm.oneOf.2.originalCostPerHour","typeLabel":"null"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"currentTerm.oneOf.2","typeLabel":"object"}],"isRequired":true,"uniqueKey":"currentTerm","typeLabel":"object"},"createdAt":{"type":"string","format":"date-time","example":"2025-01-31T12:00:00.000Z","isRequired":true,"uniqueKey":"createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"oneOf":[{"type":"string","format":"date-time","example":"2025-01-31T12:00:00.000Z","isRequired":true,"uniqueKey":"updatedAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","isRequired":true,"uniqueKey":"updatedAt.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"updatedAt","typeLabel":"string\u003cdate-time> | null"},"startedAt":{"oneOf":[{"type":"string","format":"date-time","example":"2025-01-31T12:00:00.000Z","isRequired":true,"uniqueKey":"startedAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","isRequired":true,"uniqueKey":"startedAt.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"startedAt","typeLabel":"string\u003cdate-time> | null"},"terminatedAt":{"oneOf":[{"type":"string","format":"date-time","example":"2025-01-31T12:00:00.000Z","isRequired":true,"uniqueKey":"terminatedAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","isRequired":true,"uniqueKey":"terminatedAt.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"terminatedAt","typeLabel":"string\u003cdate-time> | null"},"userId":{"type":"string","isRequired":true,"uniqueKey":"userId","typeLabel":"string"},"orgId":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"orgId.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"orgId.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"orgId","typeLabel":"string | null"},"createdBy":{"type":"object","properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"createdBy.id","typeLabel":"string"},"name":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"createdBy.name.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"createdBy.name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"createdBy.name","typeLabel":"string | null"},"email":{"type":"string","isRequired":true,"uniqueKey":"createdBy.email","typeLabel":"string"},"picture":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"createdBy.picture.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"createdBy.picture.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"createdBy.picture","typeLabel":"string | null"}},"required":["id","name","email","picture"],"additionalProperties":false,"description":"The user who created a rental.","isRequired":true,"uniqueKey":"createdBy","typeLabel":"object"},"privateCluster":{"oneOf":[{"type":"object","description":"The topology of a dedicated private cluster.","required":["gpuModel","location","sshUser","sshPort","nodes","handover"],"properties":{"gpuModel":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"privateCluster.oneOf.0.gpuModel.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"privateCluster.oneOf.0.gpuModel.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"privateCluster.oneOf.0.gpuModel","typeLabel":"string | null"},"location":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"privateCluster.oneOf.0.location.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"privateCluster.oneOf.0.location.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"privateCluster.oneOf.0.location","typeLabel":"string | null"},"sshUser":{"type":"string","isRequired":true,"uniqueKey":"privateCluster.oneOf.0.sshUser","typeLabel":"string"},"sshPort":{"oneOf":[{"type":"number","isRequired":true,"uniqueKey":"privateCluster.oneOf.0.sshPort.oneOf.0","typeLabel":"number"},{"type":"null","isRequired":true,"uniqueKey":"privateCluster.oneOf.0.sshPort.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"privateCluster.oneOf.0.sshPort","typeLabel":"number | null"},"nodes":{"type":"array","items":{"type":"object","properties":{"role":{"type":"string","enum":["login","head","compute"],"isRequired":true,"uniqueKey":"privateCluster.oneOf.0.nodes.items.[INDEX].role","typeLabel":"enum\u003cstring>"},"hostname":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"privateCluster.oneOf.0.nodes.items.[INDEX].hostname.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"privateCluster.oneOf.0.nodes.items.[INDEX].hostname.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"privateCluster.oneOf.0.nodes.items.[INDEX].hostname","typeLabel":"string | null"},"publicIp":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"privateCluster.oneOf.0.nodes.items.[INDEX].publicIp.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"privateCluster.oneOf.0.nodes.items.[INDEX].publicIp.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"privateCluster.oneOf.0.nodes.items.[INDEX].publicIp","typeLabel":"string | null"},"privateIp":{"type":"string","isRequired":true,"uniqueKey":"privateCluster.oneOf.0.nodes.items.[INDEX].privateIp","typeLabel":"string"}},"required":["role","hostname","publicIp","privateIp"],"additionalProperties":false,"description":"One machine of a dedicated private cluster.","uniqueKey":"privateCluster.oneOf.0.nodes.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"privateCluster.oneOf.0.nodes","typeLabel":"object[]"},"handover":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"oneOf":[{}],"uniqueKey":"privateCluster.oneOf.0.handover.additionalProperties","typeLabel":"any"},"isRequired":true,"uniqueKey":"privateCluster.oneOf.0.handover","typeLabel":"object"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"privateCluster.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"privateCluster.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"privateCluster","typeLabel":"object | null"},"managedCluster":{"oneOf":[{"type":"object","description":"The managed Kubernetes cluster a rental is a node pool of.","required":["name","label"],"properties":{"name":{"type":"string","isRequired":true,"uniqueKey":"managedCluster.oneOf.0.name","typeLabel":"string"},"label":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"managedCluster.oneOf.0.label.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"managedCluster.oneOf.0.label.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"managedCluster.oneOf.0.label","typeLabel":"string | null"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"managedCluster.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"managedCluster.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"managedCluster","typeLabel":"object | null"}},"required":["rentalId","name","label","rentalType","region","gpuType","gpuCount","gpuFormFactor","connectionType","ethernetVariant","nodes","sshEndpoints","networkInterfaces","portMappings","supportsPortForwarding","exposedPorts","supportsCustomPorts","supportsMultipleSshKeys","supportsSshKeyUpdates","attachedStorage","supportsAttachedStorage","monitoringEnabled","convertToOnDemandOnExpiry","terminationReason","currentTerm","createdAt","updatedAt","startedAt","terminatedAt","userId","orgId","createdBy","privateCluster","managedCluster"],"additionalProperties":false,"description":"A GPU rental.","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"rentalId":"\u003cstring>","name":"\u003cstring>","label":"\u003cstring>","rentalType":"virtual-machine","region":"us-central-1","gpuType":"h100","gpuCount":0,"gpuFormFactor":"sxm5","connectionType":"infiniband","ethernetVariant":"normal","nodes":[{"cpuModel":"\u003cstring>","cpuCount":123,"vcpuCount":123,"gpuCount":123,"ramGb":123,"storageGb":123}],"sshEndpoints":[{"host":"\u003cstring>","port":123,"user":"\u003cstring>"}],"networkInterfaces":[{"publicIp":"\u003cstring>","privateIp":"\u003cstring>"}],"portMappings":[{"externalPort":123,"internalPort":123}],"supportsPortForwarding":true,"exposedPorts":[123],"supportsCustomPorts":true,"supportsMultipleSshKeys":true,"supportsSshKeyUpdates":true,"attachedStorage":[{"storageVolumeId":"\u003cstring>","label":"\u003cstring>","sizeInGb":0,"virtualIp":"\u003cstring>","costPerHourCents":123}],"supportsAttachedStorage":true,"monitoringEnabled":true,"convertToOnDemandOnExpiry":true,"terminationReason":"\u003cstring>","currentTerm":{"effectiveAt":"2025-01-31T12:00:00.000Z","termType":"on-demand","costPerHour":123,"reservedUntil":null,"reservationEndsAt":null,"termPeriodDays":null,"discountPercentage":null,"originalCostPerHour":null},"createdAt":"2025-01-31T12:00:00.000Z","updatedAt":"2025-01-31T12:00:00.000Z","startedAt":"2025-01-31T12:00:00.000Z","terminatedAt":"2025-01-31T12:00:00.000Z","userId":"\u003cstring>","orgId":"\u003cstring>","createdBy":{"id":"\u003cstring>","name":"\u003cstring>","email":"\u003cstring>","picture":"\u003cstring>"},"privateCluster":{"gpuModel":"\u003cstring>","location":"\u003cstring>","sshUser":"\u003cstring>","sshPort":123,"nodes":[{"role":"login","hostname":"\u003cstring>","publicIp":"\u003cstring>","privateIp":"\u003cstring>"}],"handover":{}},"managedCluster":{"name":"\u003cstring>","label":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"c9df2462-3324-49e5-942f-c06eb4667d8c":{"description":"Invalid input data","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"The error message","example":"Invalid input data","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"code":{"type":"string","description":"The error code","example":"BAD_REQUEST","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"issues":{"description":"An array of issues that were responsible for the error","example":[],"type":"array","items":{"type":"object","properties":{"message":{"type":"string","isRequired":true,"uniqueKey":"issues.items.[INDEX].message","typeLabel":"string"}},"required":["message"],"additionalProperties":false,"uniqueKey":"issues.items.[INDEX]","typeLabel":"object"},"uniqueKey":"issues","typeLabel":"object[]"}},"required":["message","code"],"additionalProperties":false,"title":"Invalid input data error (400)","description":"The error information","example":{"code":"BAD_REQUEST","message":"Invalid input data","issues":[]},"uniqueKey":"","typeLabel":"Invalid input data error (400) · object"},"examples":{"Example":{"title":"Example","value":{"code":"BAD_REQUEST","message":"Invalid input data","issues":[]}}},"exampleType":"generated"}},"exampleType":"generated"},"67d67928-2bbd-4013-82cf-2b5ef829f196":{"description":"Authorization not provided","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"The error message","example":"Authorization not provided","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"code":{"type":"string","description":"The error code","example":"UNAUTHORIZED","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"issues":{"description":"An array of issues that were responsible for the error","example":[],"type":"array","items":{"type":"object","properties":{"message":{"type":"string","isRequired":true,"uniqueKey":"issues.items.[INDEX].message","typeLabel":"string"}},"required":["message"],"additionalProperties":false,"uniqueKey":"issues.items.[INDEX]","typeLabel":"object"},"uniqueKey":"issues","typeLabel":"object[]"}},"required":["message","code"],"additionalProperties":false,"title":"Authorization not provided error (401)","description":"The error information","example":{"code":"UNAUTHORIZED","message":"Authorization not provided","issues":[]},"uniqueKey":"","typeLabel":"Authorization not provided error (401) · object"},"examples":{"Example":{"title":"Example","value":{"code":"UNAUTHORIZED","message":"Authorization not provided","issues":[]}}},"exampleType":"generated"}},"exampleType":"generated"},"0b0b45cc-909a-4ac8-af5a-f391d20b2603":{"description":"Insufficient access","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"The error message","example":"Insufficient access","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"code":{"type":"string","description":"The error code","example":"FORBIDDEN","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"issues":{"description":"An array of issues that were responsible for the error","example":[],"type":"array","items":{"type":"object","properties":{"message":{"type":"string","isRequired":true,"uniqueKey":"issues.items.[INDEX].message","typeLabel":"string"}},"required":["message"],"additionalProperties":false,"uniqueKey":"issues.items.[INDEX]","typeLabel":"object"},"uniqueKey":"issues","typeLabel":"object[]"}},"required":["message","code"],"additionalProperties":false,"title":"Insufficient access error (403)","description":"The error information","example":{"code":"FORBIDDEN","message":"Insufficient access","issues":[]},"uniqueKey":"","typeLabel":"Insufficient access error (403) · object"},"examples":{"Example":{"title":"Example","value":{"code":"FORBIDDEN","message":"Insufficient access","issues":[]}}},"exampleType":"generated"}},"exampleType":"generated"},"3770f5c5-f50a-406f-9ae6-bd717dff567d":{"description":"Internal server error","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"The error message","example":"Internal server error","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"code":{"type":"string","description":"The error code","example":"INTERNAL_SERVER_ERROR","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"issues":{"description":"An array of issues that were responsible for the error","example":[],"type":"array","items":{"type":"object","properties":{"message":{"type":"string","isRequired":true,"uniqueKey":"issues.items.[INDEX].message","typeLabel":"string"}},"required":["message"],"additionalProperties":false,"uniqueKey":"issues.items.[INDEX]","typeLabel":"object"},"uniqueKey":"issues","typeLabel":"object[]"}},"required":["message","code"],"additionalProperties":false,"title":"Internal server error error (500)","description":"The error information","example":{"code":"INTERNAL_SERVER_ERROR","message":"Internal server error","issues":[]},"uniqueKey":"","typeLabel":"Internal server error error (500) · object"},"examples":{"Example":{"title":"Example","value":{"code":"INTERNAL_SERVER_ERROR","message":"Internal server error","issues":[]}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"0f1fea06-45c3-4316-9ab2-b9c99abbc1c8":{"Authorization":{"type":"http","scheme":"bearer","scopes":[],"schemeName":"Authorization"}}},"servers":{"c36ff8a7-1340-4c27-9a97-aced91c3a779":{"url":"https://api.hyperbolic.ai","description":"Production"},"a9ff1d3c-51ba-446a-9f9d-0348b78b2a24":{"url":"https://api.hyperbolic.xyz","description":"Legacy host — the same API on Hyperbolic's original domain, kept for existing integrations."}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","scopes":[],"schemeName":"Authorization"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"Authorization","name":"Authorization"}],"title":"Authorization"}]},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"hyperboliclabs","siteName":"Hyperbolic Labs","title":"Create a rental - Hyperbolic Labs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-10T20:51:10.832Z","originalFileLocation":"api-reference/rentals/create-a-rental.mdx"},"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=\"Rent a virtual machine or a bare metal server. rentalType decides which machine-type-specific fields apply; sending a field for the other type is a BAD_REQUEST (INVALID_INPUT_FOR_RENTAL_TYPE).\">\u003cmeta data-mint-head name=\"application-name\" content=\"Hyperbolic Labs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/hyperboliclabs/4vNPomPXX705C6y_/_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=\"/docs/mintlify-assets/_mintlify/favicons/hyperboliclabs/4vNPomPXX705C6y_/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/hyperboliclabs/4vNPomPXX705C6y_/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/hyperboliclabs/4vNPomPXX705C6y_/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/hyperboliclabs/4vNPomPXX705C6y_/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/hyperboliclabs/4vNPomPXX705C6y_/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/hyperboliclabs/4vNPomPXX705C6y_/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/hyperboliclabs/4vNPomPXX705C6y_/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/hyperboliclabs/4vNPomPXX705C6y_/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create a rental - Hyperbolic Labs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Rent a virtual machine or a bare metal server. rentalType decides which machine-type-specific fields apply; sending a field for the other type is a BAD_REQUEST (INVALID_INPUT_FOR_RENTAL_TYPE).\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Hyperbolic Labs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://hyperbolic.ai/docs/api-reference/rentals/create-a-rental\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://hyperboliclabs.mintlify.site/docs/_mintlify/api/og/v2?division=Rentals\u0026amp;title=Create+a+rental\u0026amp;description=Rent+a+virtual+machine+or+a+bare+metal+server.+%60rentalType%60+decides+which+machine-type-specific+fields+apply%3B+sending+a+field+for+the+other+type+is+a+BAD_REQUES\u0026amp;theme=72aae6d4e0f054f690bb2d14\u0026amp;signature=dd5cadb9bdfa6161fa39aafc25a4b3423912a0ec2db96341c9022b2ddbda5e51\">\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 rental - Hyperbolic Labs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Rent a virtual machine or a bare metal server. rentalType decides which machine-type-specific fields apply; sending a field for the other type is a BAD_REQUEST (INVALID_INPUT_FOR_RENTAL_TYPE).\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://hyperboliclabs.mintlify.site/docs/_mintlify/api/og/v2?division=Rentals\u0026amp;title=Create+a+rental\u0026amp;description=Rent+a+virtual+machine+or+a+bare+metal+server.+%60rentalType%60+decides+which+machine-type-specific+fields+apply%3B+sending+a+field+for+the+other+type+is+a+BAD_REQUES\u0026amp;theme=72aae6d4e0f054f690bb2d14\u0026amp;signature=dd5cadb9bdfa6161fa39aafc25a4b3423912a0ec2db96341c9022b2ddbda5e51\">\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=\"/docs/mintlify-assets/_mintlify/favicons/hyperboliclabs/4vNPomPXX705C6y_/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Hyperbolic Labs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#5B25D4\">\u003clink data-mint-head rel=\"canonical\" href=\"https://hyperbolic.ai/docs/api-reference/rentals/create-a-rental\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/docs/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/docs/api-reference/rentals/create-a-rental.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://hyperbolic.ai/#organization\",\"name\":\"Hyperbolic Labs\",\"url\":\"https://hyperbolic.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/hyperboliclabs/Vc2Wh0-_YkdmKob6/images/Hyperbolic-Logo-Light-Mode.svg?fit=max\u0026auto=format\u0026n=Vc2Wh0-_YkdmKob6\u0026q=85\u0026s=da9c4e64931e88f9797c1ad9d2aaa86f\"}},{\"@type\":\"WebSite\",\"@id\":\"https://hyperbolic.ai/docs#website\",\"name\":\"Hyperbolic Labs\",\"url\":\"https://hyperbolic.ai/docs\",\"publisher\":{\"@id\":\"https://hyperbolic.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://hyperbolic.ai/docs/api-reference/rentals/create-a-rental#webpage\",\"url\":\"https://hyperbolic.ai/docs/api-reference/rentals/create-a-rental\",\"name\":\"Create a rental\",\"description\":\"Rent a virtual machine or a bare metal server. rentalType decides which machine-type-specific fields apply; sending a field for the other type is a BAD_REQUEST (INVALID_INPUT_FOR_RENTAL_TYPE).\",\"dateModified\":\"2026-11-10T20:51:10.832Z\",\"isPartOf\":{\"@id\":\"https://hyperbolic.ai/docs#website\"},\"breadcrumb\":{\"@id\":\"https://hyperbolic.ai/docs/api-reference/rentals/create-a-rental#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://hyperbolic.ai/docs/api-reference/rentals/create-a-rental#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API Reference\",\"item\":\"https://hyperbolic.ai/docs/api-reference/openapi/get-the-public-api-specification\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Create a rental\",\"item\":\"https://hyperbolic.ai/docs/api-reference/rentals/create-a-rental\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://hyperbolic.ai/docs/api-reference/rentals/create-a-rental#apireference\",\"headline\":\"Create a rental\",\"name\":\"Create a rental\",\"description\":\"Rent a virtual machine or a bare metal server. rentalType decides which machine-type-specific fields apply; sending a field for the other type is a BAD_REQUEST (INVALID_INPUT_FOR_RENTAL_TYPE).\",\"url\":\"https://hyperbolic.ai/docs/api-reference/rentals/create-a-rental\",\"mainEntityOfPage\":{\"@id\":\"https://hyperbolic.ai/docs/api-reference/rentals/create-a-rental#webpage\"},\"dateModified\":\"2026-11-10T20:51:10.832Z\",\"publisher\":{\"@id\":\"https://hyperbolic.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://hyperbolic.ai/docs#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Hyperbolic Labs\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Hyperbolic Labs\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/docs/api-reference/rentals/create-a-rental.md","siteName":"Hyperbolic Labs","nav":{"global":{"anchors":[{"anchor":"Blog","icon":"newspaper","href":"https://hyperbolic.ai/blog"}]},"groups":[{"group":"Overview","pages":[{"title":"Welcome to Hyperbolic","sidebarTitle":"Platform Overview","icon":"globe","href":"/overview/overview"},{"title":"Getting Started","icon":"rocket","href":"/overview/quickstart"},{"title":"Platform Comparison","icon":"scale-balanced","href":"/overview/platform-comparison"},{"title":"Changelog","icon":"clock-rotate-left","href":"/changelog"}]},{"group":"GPUs","pages":[{"title":"Pricing","icon":"tag","href":"/on-demand/pricing"},{"title":"Availability Alerts","icon":"bell","href":"/on-demand/availability-alerts"},{"title":"Managing Instances","icon":"server","sidebarTitle":"Managing Instances","href":"/on-demand/managing-instances"},{"title":"Storage and Port Configuration","icon":"hard-drive","href":"/on-demand/storage-and-ports"},{"title":"Verifying Instance Performance","icon":"gauge-high","href":"/on-demand/verifying-performance"},{"title":"GPU Monitoring","icon":"chart-line","href":"/on-demand/monitoring"},{"title":"Maintenance and Data Safety","icon":"wrench","href":"/on-demand/maintenance"},{"title":"Troubleshooting","icon":"wrench","href":"/on-demand/troubleshooting"},{"group":"On-Demand","expanded":true,"pages":[{"title":"On-Demand GPU Overview","icon":"server","sidebarTitle":"Overview","href":"/on-demand/overview"},{"title":"On-Demand GPU Quick Start","icon":"play","sidebarTitle":"Getting Started","href":"/on-demand/quickstart"}]},{"group":"Reserved","expanded":true,"pages":[{"title":"Reserved Overview","sidebarTitle":"Overview","icon":"calendar-check","href":"/reserved/overview"},{"title":"Reserved Getting Started","sidebarTitle":"Getting Started","icon":"rocket","href":"/reserved/getting-started"}]},{"group":"Private Cloud","expanded":true,"pages":[{"title":"Private Cloud Overview","icon":"cloud","sidebarTitle":"Overview","href":"/private-cloud/overview"},{"title":"Cluster Configuration","sidebarTitle":"Configuration","icon":"sliders","href":"/private-cloud/configuration"},{"title":"Cluster Handover","icon":"clipboard-check","href":"/private-cloud/handover"}]}]},{"group":"Managed Kubernetes","pages":[{"title":"Managed Kubernetes","icon":"dharmachakra","href":"/on-demand/managed-kubernetes"},{"title":"Connect to a Managed Kubernetes Cluster","icon":"circle-nodes","sidebarTitle":"Connect with kubectl","href":"/managed-kubernetes/kubectl-access"}]},{"group":"Rental Operator","pages":[{"title":"Rental Operator","sidebarTitle":"Overview","icon":"cubes","href":"/rental-operator/overview"},{"title":"Rental Operator Quick Start","sidebarTitle":"Getting Started","icon":"play","href":"/rental-operator/quickstart"}]},{"group":"Inference","pages":[{"title":"Inference overview","sidebarTitle":"Overview","icon":"bolt","href":"/inference/overview"},{"title":"Inference quick start","sidebarTitle":"Quick start","icon":"rocket","href":"/inference/quickstart"},{"title":"Chat completions","icon":"message","href":"/inference/text-apis"},{"title":"Inference errors","sidebarTitle":"Errors","icon":"triangle-exclamation","href":"/inference/errors"}]},{"group":"Account \u0026 Billing","pages":[{"title":"Account Management","icon":"user","href":"/general/account-management"},{"title":"Organizations","icon":"users","href":"/general/organizations"},{"title":"Billing and Payments","icon":"credit-card","href":"/general/billing-payments"},{"title":"Auto Top-Up","icon":"arrows-rotate","href":"/general/auto-top-up"}]},{"group":"API Reference","pages":[{"group":"OpenAPI","pages":[{"title":"Get the public API specification","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v2/openapi.json","href":"/api-reference/openapi/get-the-public-api-specification"}]},{"group":"Storage Volumes","pages":[{"title":"Attach a storage volume to bare metal instance(s)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v2/on-demand/storage-volumes/attach","href":"/api-reference/storage-volumes/attach-a-storage-volume-to-bare-metal-instances"},{"title":"Get a list of storage volumes","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v2/on-demand/storage-volumes","href":"/api-reference/storage-volumes/get-a-list-of-storage-volumes"},{"title":"Create a storage volume","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v2/on-demand/storage-volumes","href":"/api-reference/storage-volumes/create-a-storage-volume"},{"title":"Terminate a storage volume","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v2/on-demand/storage-volumes/terminate","href":"/api-reference/storage-volumes/terminate-a-storage-volume"},{"title":"Update a storage volume","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v2/on-demand/storage-volumes/update","href":"/api-reference/storage-volumes/update-a-storage-volume"},{"title":"Get a list of storage volume options","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v2/on-demand/storage-volume-options","href":"/api-reference/storage-volumes/get-a-list-of-storage-volume-options"},{"title":"Get a list of storage volume options","deprecated":true,"version":null,"openapi":"/api-reference/openapi.json get /v2/alpha/on-demand/storage-volume-options","href":"/api-reference/storage-volumes/get-a-list-of-storage-volume-options-1"},{"title":"Get a list of storage volumes","deprecated":true,"version":null,"openapi":"/api-reference/openapi.json get /v2/alpha/on-demand/storage-volumes","href":"/api-reference/storage-volumes/get-a-list-of-storage-volumes-1"},{"title":"Create a storage volume","deprecated":true,"version":null,"openapi":"/api-reference/openapi.json post /v2/alpha/on-demand/storage-volumes","href":"/api-reference/storage-volumes/create-a-storage-volume-1"},{"title":"Attach a storage volume to bare metal instance(s)","deprecated":true,"version":null,"openapi":"/api-reference/openapi.json post /v2/alpha/on-demand/storage-volumes/attach","href":"/api-reference/storage-volumes/attach-a-storage-volume-to-bare-metal-instances-1"},{"title":"Terminate a storage volume","deprecated":true,"version":null,"openapi":"/api-reference/openapi.json post /v2/alpha/on-demand/storage-volumes/terminate","href":"/api-reference/storage-volumes/terminate-a-storage-volume-1"},{"title":"Update a storage volume","deprecated":true,"version":null,"openapi":"/api-reference/openapi.json post /v2/alpha/on-demand/storage-volumes/update","href":"/api-reference/storage-volumes/update-a-storage-volume-1"}]},{"group":"Bare Metal Rentals (Deprecated)","pages":[{"title":"Get a list of active bare metal rentals","deprecated":true,"version":null,"openapi":"/api-reference/openapi.json get /v2/on-demand/bare-metal-rentals","href":"/api-reference/bare-metal-rentals/get-a-list-of-active-bare-metal-rentals"},{"title":"Create a bare metal rental","deprecated":true,"version":null,"openapi":"/api-reference/openapi.json post /v2/on-demand/bare-metal-rentals","href":"/api-reference/bare-metal-rentals/create-a-bare-metal-rental"},{"title":"Terminate a bare metal rental","deprecated":true,"version":null,"openapi":"/api-reference/openapi.json post /v2/on-demand/bare-metal-rentals/terminate","href":"/api-reference/bare-metal-rentals/terminate-a-bare-metal-rental"},{"title":"Get a list of active bare metal rentals","deprecated":true,"version":null,"openapi":"/api-reference/openapi.json get /v2/alpha/on-demand/bare-metal-rentals","href":"/api-reference/bare-metal-rentals/get-a-list-of-active-bare-metal-rentals-1"},{"title":"Create a bare metal rental","deprecated":true,"version":null,"openapi":"/api-reference/openapi.json post /v2/alpha/on-demand/bare-metal-rentals","href":"/api-reference/bare-metal-rentals/create-a-bare-metal-rental-1"},{"title":"Terminate a bare metal rental","description":"**Deprecated.** This path is the pre-`/v2/` URL for `/v2/on-demand/bare-metal-rentals/terminate` and is kept only so existing integrations keep working. It behaves identically, responds with a `Sunset` header, and stops being served on 2027-03-01. Move to `/v2/on-demand/bare-metal-rentals/terminate`.\n\n**Deprecated.** Use `POST /v2/on-demand/rentals/terminate`, which terminates either machine type.","deprecated":true,"version":null,"openapi":"/api-reference/openapi.json post /v2/alpha/on-demand/bare-metal-rentals/terminate","href":"/api-reference/bare-metal-rentals/terminate-a-bare-metal-rental-1"}]},{"group":"Rentals","pages":[{"title":"Create a rental","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v2/on-demand/rentals","href":"/api-reference/rentals/create-a-rental"},{"title":"Convert a rental to a reserved term","description":"Convert a rental to a reserved term","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v2/on-demand/convert-to-reserved","href":"/api-reference/rentals/convert-a-rental-to-a-reserved-term"},{"title":"Request a reservation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v2/on-demand/request-reservation","href":"/api-reference/rentals/request-a-reservation"},{"title":"Extend a reserved rental","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v2/on-demand/extend-reserved","href":"/api-reference/rentals/extend-a-reserved-rental"},{"title":"Get a summary of active rentals","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v2/on-demand/active-rental-summary","href":"/api-reference/rentals/get-a-summary-of-active-rentals"},{"title":"Get a rental","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v2/on-demand/rental","href":"/api-reference/rentals/get-a-rental"},{"title":"Get a list of past rentals","deprecated":true,"version":null,"openapi":"/api-reference/openapi.json get /v2/on-demand/rental-history","href":"/api-reference/rentals/get-a-list-of-past-rentals"},{"title":"List active rentals","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v2/on-demand/rentals/active","href":"/api-reference/rentals/list-active-rentals"},{"title":"List past rentals","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v2/on-demand/rentals/history","href":"/api-reference/rentals/list-past-rentals"},{"title":"Get a list of rental options","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v2/on-demand/rental-options","href":"/api-reference/rentals/get-a-list-of-rental-options"},{"title":"Get a reservation extension quote","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v2/on-demand/get-reservation-extension-quote","href":"/api-reference/rentals/get-a-reservation-extension-quote"},{"title":"Get a reserved conversion quote","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v2/on-demand/get-reserved-conversion-quote","href":"/api-reference/rentals/get-a-reserved-conversion-quote"},{"title":"Get a list of reserve options","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v2/on-demand/reserve-options","href":"/api-reference/rentals/get-a-list-of-reserve-options"},{"title":"Check whether any past rentals exist","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v2/on-demand/has-rental-history","href":"/api-reference/rentals/check-whether-any-past-rentals-exist"},{"title":"Reboot a single instance within a rental","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v2/on-demand/rentals/reboot-instance","href":"/api-reference/rentals/reboot-a-single-instance-within-a-rental"},{"title":"Terminate a rental","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v2/on-demand/rentals/terminate","href":"/api-reference/rentals/terminate-a-rental"},{"title":"Update a rental","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v2/on-demand/rentals/update","href":"/api-reference/rentals/update-a-rental"},{"title":"Attach an SSH key to a rental","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v2/on-demand/rentals/ssh-keys/attach","href":"/api-reference/rentals/attach-an-ssh-key-to-a-rental"},{"title":"Detach an SSH key from a rental","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v2/on-demand/rentals/ssh-keys/detach","href":"/api-reference/rentals/detach-an-ssh-key-from-a-rental"},{"title":"Opt a rental in or out of Hyperbolic telemetry","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v2/on-demand/rentals/monitoring-opt-out","href":"/api-reference/rentals/opt-a-rental-in-or-out-of-hyperbolic-telemetry"},{"title":"Get a list of past rentals","deprecated":true,"version":null,"openapi":"/api-reference/openapi.json get /v2/alpha/on-demand/rental-history","href":"/api-reference/rentals/get-a-list-of-past-rentals-1"},{"title":"Get a list of rental options","deprecated":true,"version":null,"openapi":"/api-reference/openapi.json get /v2/alpha/on-demand/rental-options","href":"/api-reference/rentals/get-a-list-of-rental-options-1"},{"title":"Update a rental","deprecated":true,"version":null,"openapi":"/api-reference/openapi.json post /v2/alpha/on-demand/rentals/update","href":"/api-reference/rentals/update-a-rental-1"},{"title":"Request a reservation","deprecated":true,"version":null,"openapi":"/api-reference/openapi.json post /v2/alpha/on-demand/request-reservation","href":"/api-reference/rentals/request-a-reservation-1"},{"title":"Get a list of reserve options","deprecated":true,"version":null,"openapi":"/api-reference/openapi.json get /v2/alpha/on-demand/reserve-options","href":"/api-reference/rentals/get-a-list-of-reserve-options-1"}]},{"group":"Virtual Machine Rentals (Deprecated)","pages":[{"title":"Get a list of active virtual machine rentals","deprecated":true,"version":null,"openapi":"/api-reference/openapi.json get /v2/on-demand/virtual-machine-rentals","href":"/api-reference/virtual-machine-rentals/get-a-list-of-active-virtual-machine-rentals"},{"title":"Create a virtual machine rental","deprecated":true,"version":null,"openapi":"/api-reference/openapi.json post /v2/on-demand/virtual-machine-rentals","href":"/api-reference/virtual-machine-rentals/create-a-virtual-machine-rental"},{"title":"Reboot a single instance within a virtual machine rental","deprecated":true,"version":null,"openapi":"/api-reference/openapi.json post /v2/on-demand/virtual-machine-rentals/reboot-instance","href":"/api-reference/virtual-machine-rentals/reboot-a-single-instance-within-a-virtual-machine-rental"},{"title":"Terminate a virtual machine rental","deprecated":true,"version":null,"openapi":"/api-reference/openapi.json post /v2/on-demand/virtual-machine-rentals/terminate","href":"/api-reference/virtual-machine-rentals/terminate-a-virtual-machine-rental"},{"title":"Get a list of active virtual machine rentals","deprecated":true,"version":null,"openapi":"/api-reference/openapi.json get /v2/alpha/on-demand/virtual-machine-rentals","href":"/api-reference/virtual-machine-rentals/get-a-list-of-active-virtual-machine-rentals-1"},{"title":"Create a virtual machine rental","deprecated":true,"version":null,"openapi":"/api-reference/openapi.json post /v2/alpha/on-demand/virtual-machine-rentals","href":"/api-reference/virtual-machine-rentals/create-a-virtual-machine-rental-1"},{"title":"Terminate a virtual machine rental","deprecated":true,"version":null,"openapi":"/api-reference/openapi.json post /v2/alpha/on-demand/virtual-machine-rentals/terminate","href":"/api-reference/virtual-machine-rentals/terminate-a-virtual-machine-rental-1"}]},{"group":"Users","pages":[{"title":"Get the current user","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v2/users/me","href":"/api-reference/users/get-the-current-user"},{"title":"Update the current user","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /v2/users/me","href":"/api-reference/users/update-the-current-user"},{"title":"Delete the current user","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v2/users/me","href":"/api-reference/users/delete-the-current-user"},{"title":"Verify a phone number","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /v2/users/me/verify-phone-number","href":"/api-reference/users/verify-a-phone-number"},{"title":"Get the current user","deprecated":true,"version":null,"openapi":"/api-reference/openapi.json get /users/me","href":"/api-reference/users/get-the-current-user-1"},{"title":"Update the current user","deprecated":true,"version":null,"openapi":"/api-reference/openapi.json put /users/me","href":"/api-reference/users/update-the-current-user-1"},{"title":"Delete the current user","deprecated":true,"version":null,"openapi":"/api-reference/openapi.json delete /users/me","href":"/api-reference/users/delete-the-current-user-1"},{"title":"Verify a phone number","deprecated":true,"version":null,"openapi":"/api-reference/openapi.json put /users/me/verify-phone-number","href":"/api-reference/users/verify-a-phone-number-1"}]},{"group":"API Keys","pages":[{"title":"List all API keys for the current user or organization","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v2/api-keys/list","href":"/api-reference/api-keys/list-all-api-keys-for-the-current-user-or-organization"},{"title":"List all API keys for the current user or organization","deprecated":true,"version":null,"openapi":"/api-reference/openapi.json get /v2/alpha/api-keys/list","href":"/api-reference/api-keys/list-all-api-keys-for-the-current-user-or-organization-1"}]},{"group":"Balances","pages":[{"title":"Get the current user or organization account's balance","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v2/customer/balance","href":"/api-reference/balances/get-the-current-user-or-organization-accounts-balance"},{"title":"Get the current user or organization account's balance","deprecated":true,"version":null,"openapi":"/api-reference/openapi.json get /v2/alpha/customer/balance","href":"/api-reference/balances/get-the-current-user-or-organization-accounts-balance-1"}]},{"group":"SSH Keys","pages":[{"title":"List SSH public keys for the current user or organization","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v2/ssh-keys","href":"/api-reference/ssh-keys/list-ssh-public-keys-for-the-current-user-or-organization"},{"title":"Create an SSH public key for the current user or organization","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v2/ssh-keys","href":"/api-reference/ssh-keys/create-an-ssh-public-key-for-the-current-user-or-organization"},{"title":"List the SSH public keys attached to a rental","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v2/ssh-keys/rental","href":"/api-reference/ssh-keys/list-the-ssh-public-keys-attached-to-a-rental"},{"title":"Rename an SSH public key","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v2/ssh-keys/update","href":"/api-reference/ssh-keys/rename-an-ssh-public-key"},{"title":"Delete an SSH public key","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v2/ssh-keys/delete","href":"/api-reference/ssh-keys/delete-an-ssh-public-key"}]}]},{"group":"References","pages":[{"title":"Getting Support","icon":"headset","href":"/general/support"},{"title":"Security and Compliance","icon":"shield","href":"/general/security-compliance"},{"title":null,"href":"/private-cloud/security"}]},{"group":"Frequently Asked Questions","hidden":true,"pages":[{"title":"Frequently asked questions","icon":"circle-question","href":"/faq/index"},{"title":"Account and billing FAQ","icon":"wallet","href":"/faq/account-billing"},{"title":"GPU Marketplace FAQ","icon":"server","href":"/faq/gpu-marketplace"},{"title":"Inference and models FAQ","icon":"brain","href":"/faq/inference-models"},{"title":"Technical Issues FAQ","icon":"triangle-exclamation","href":"/faq/technical-issues"},{"title":"Security and compliance FAQ","icon":"lock","href":"/faq/security-compliance"},{"title":"Integrations FAQ","icon":"plug","href":"/faq/integrations"},{"title":"Policies FAQ","icon":"gavel","href":"/faq/policies"}]}]},"basePath":"","title":"Create a rental - Hyperbolic Labs","buildId":"dpl_2AK98Hxhwu4fUXpx9atbv41cC328","deploymentId":"dpl_2AK98Hxhwu4fUXpx9atbv41cC328","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-EBSrFTg1.js","utils-Y_7TcRh4.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-D1wvvkPH.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-aT0ty6oN.js","snippetPresets-DoNRuyJc.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-CXRajFpn.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BAyOsINj.js","shallow-CIcHqV1v.js","getApiPlaygroundDisplay-C5igZwEf.js","CodeSnippet-BFWnQLNh.js","CodeSnippets-Cx2mFgZW.js","Page-DCFaZE46.js","getPastedJson-BOy09PZp.js","icon-BwmYtB6R.js","MethodPill-DAIhq-iu.js","DuplicateIcon-DFM8Q3ph.js","createIcon-0UdvzB4Z.js","DynamicMarkdown-DYYZTGpa.js","SectionHeading-BFCDRUuH.js","axios-vUo_bRtp.js","Markdown-C6TcKjiR.js","clsx-Y_UC780V.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-PCbBHBTv.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-D4q_oRML.js"]}