Every request to the Vast.ai API must include an API key. This page covers how to create keys, how to include them in requests, and key lifecycle details.
Create an API Key
Generate a key from the Keys page in the web console:
Click +New.
Give the key a name (optional but recommended, e.g. “CI pipeline” or “notebook”).
Copy the key immediately, you’ll only see it once.
A common pattern is to store your key in an environment variable:
export VAST_API_KEY="your-api-key-here"
This keeps the key out of your code and makes it easy to rotate.
If you get a 401 Unauthorized or 403 Forbidden response, double-check your API key. The most common causes are a typo, an expired key, or a scoped key that lacks the required permission for the endpoint you’re calling.
Verify Your Key
A quick way to confirm your key works is to fetch your account info:
By default, the web console creates a full-access key. For CI/CD pipelines, shared tooling, or team environments, you should create scoped keys that restrict access to only the permissions you need.For example, a key that can only read and manage instances (but cannot access billing):
See the Permissions page for the full list of permission categories, endpoint mappings, constraint syntax, and advanced examples.
Key Expiration
API keys do not expire by default. You can revoke a key at any time from the Keys page or by calling the Delete API Key endpoint.
Treat your API key like a password. Do not commit keys to version control or share them in plaintext. If a key is compromised, revoke it immediately and create a new one.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Vast.ai Documentation: Affordable GPU Cloud Marketplace","colors":{"primary":"#315FFF","light":"#315FFF","dark":"#315FFF"},"logo":{"light":"https://mintcdn.com/vastai-80aa3a82/lDYZh_6OFg5OOaSN/logo/light.svg?fit=max\u0026auto=format\u0026n=lDYZh_6OFg5OOaSN\u0026q=85\u0026s=7f79454b79a0cfc463ec063cd29faea0","dark":"https://mintcdn.com/vastai-80aa3a82/lDYZh_6OFg5OOaSN/logo/dark.svg?fit=max\u0026auto=format\u0026n=lDYZh_6OFg5OOaSN\u0026q=85\u0026s=a0ab9c5200d0f126bb744a83bc1b1ee2"},"favicon":"https://mintcdn.com/vastai-80aa3a82/1e4lY_zkN1CU9p24/favicon.svg?fit=max\u0026auto=format\u0026n=1e4lY_zkN1CU9p24\u0026q=85\u0026s=0d6a4623043c830bd4703fe39c7c8dc3","navbar":{"links":[{"href":"/guides/reference/faq","label":"FAQ"},{"href":"https://discord.gg/vast","label":"Discord"}],"primary":{"type":"button","label":"Console","href":"https://cloud.vast.ai/"}},"footer":{"socials":{"x":"https://x.com/vast_ai","github":"https://github.com/vast-ai","youtube":"https://www.youtube.com/@vast_ai/videos"}},"seo":{"metatags":{"indexing":"all","author":"Vast.ai Team","robots":"index, follow","googlebot":"index, follow","google":"notranslate","google-site-verification":"WHKqvZxf1snX5HX4y0luN_AnAvAPGoSjUcMv03b_NsI","generator":"Mintlify","theme-color":"#000000","color-scheme":"light dark","format-detection":"telephone=no","referrer":"origin","rating":"general","revisit-after":"7 days","language":"en","copyright":"Copyright 2025","reply-to":"contact@vast.ai","distribution":"global","coverage":"Worldwide","category":"Developer Documentation","target":"all","HandheldFriendly":"True","MobileOptimized":"320","apple-mobile-web-app-capable":"yes","apple-mobile-web-app-status-bar-style":"black","og:locale":"en_US","twitter:card":"summary_large_image","twitter:site":"@vast_ai","twitter:creator":"@vast_ai"}},"integrations":{"ga4":{"measurementId":"G-DG15WC8WXG"}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"styling":{"latex":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"vastai-80aa3a82","hasAudioNarration":false,"actualSubdomain":"vastai-80aa3a82","customDomains":["docs.vast.ai"],"gitSource":{"type":"github","owner":"vast-ai","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"feedback":{"edits":true,"issues":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6af626d42d34b58e26d64304","clientVersion":"0.0.4143","searchFilterCounts":[{"language":"default","tag":"CLI \u0026 SDK","count":258},{"language":"default","tag":"CLI","count":148},{"language":"default","tag":"SDK","count":143},{"language":"default","tag":"API","count":108},{"language":"default","tag":"Guides","count":102},{"language":"default","tag":"Endpoints","count":100},{"language":"default","tag":"Instances","count":94},{"language":"default","tag":"Host","count":87},{"language":"default","tag":"Serverless","count":81},{"language":"default","tag":"Accounts","count":58}]},"assistantConfig":{"enableStarterQuestions":false},"basePath":"","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":"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},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"@media (min-width: 1024px){div:has(>nav#sidebar){max-width:none!important}#navbar>div{max-width:none!important}#content-area>#header,#content-area>#content{max-width:900px;margin-left:auto;margin-right:auto}}.table-column-dividers th+th,.table-column-dividers td+td{border-left:1px solid color-mix(in srgb, currentColor 20%, transparent)}"}],"page":{"pagePath":"api-reference/authentication","slug":"/api-reference/authentication","pageMetadata":{"title":"Authentication","sidebarTitle":"Authentication","description":null,"href":"/api-reference/authentication"},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,li:`li`,ol:`ol`,p:`p`,pre:`pre`,span:`span`,strong:`strong`,..._provideComponents(),...props.components},{CodeBlock,CodeGroup,Heading,Note,Tip,Warning}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!CodeGroup)_missingMdxReference(`CodeGroup`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Note)_missingMdxReference(`Note`,true);if(!Tip)_missingMdxReference(`Tip`,true);if(!Warning)_missingMdxReference(`Warning`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`Every request to the Vast.ai API must include an API key. This page covers how to create keys, how to include them in requests, and key lifecycle details.`}),`\n`,_jsx(Heading,{level:`2`,id:`create-an-api-key`,children:`Create an API Key`}),`\n`,_jsxs(_components.p,{children:[`Generate a key from the `,_jsx(_components.a,{href:`https://cloud.vast.ai/manage-keys/`,children:`Keys page`}),` in the web console:`]}),`\n`,_jsxs(_components.ol,{children:[`\n`,_jsxs(_components.li,{children:[`Click `,_jsx(_components.strong,{children:`+New`}),`.`]}),`\n`,_jsx(_components.li,{children:`Give the key a name (optional but recommended, e.g. “CI pipeline” or “notebook”).`}),`\n`,_jsx(_components.li,{children:`Copy the key immediately, you’ll only see it once.`}),`\n`]}),`\n`,_jsx(Tip,{children:_jsxs(_components.p,{children:[`You can also create keys programmatically via the API (`,_jsx(_components.a,{href:`/api-reference/accounts/create-api-key`,children:`Create API Key`}),`), CLI (`,_jsx(_components.a,{href:`/cli/reference/create-api-key`,children:_jsx(_components.code,{children:`vastai create api-key`})}),`), or SDK (`,_jsx(_components.a,{href:`/sdk/python/reference/create-api-key`,children:_jsx(_components.code,{children:`vast.create_api_key()`})}),`).`]})}),`\n`,_jsx(Heading,{level:`2`,id:`use-an-api-key`,children:`Use an API Key`}),`\n`,_jsxs(_components.p,{children:[`Include your key as a Bearer token in the `,_jsx(_components.code,{children:`Authorization`}),` header:`]}),`\n`,_jsxs(CodeGroup,{children:[_jsx(CodeBlock,{filename:`cURL`,numberOfLines:`2`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`2`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`curl`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -s`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Authorization: Bearer `}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`$VAST_API_KEY`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"https://console.vast.ai/api/v0/users/current/\"`})}),`\n`]})})}),_jsx(CodeBlock,{filename:`Python`,numberOfLines:`6`,language:`python`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`python`,children:_jsxs(_components.code,{language:`python`,numberOfLines:`6`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`import`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` os`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`import`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` requests`})]}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`headers `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` {`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Authorization\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`f`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Bearer `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`{`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`os.environ[`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`'VAST_API_KEY'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`]`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`}`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`resp `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` requests.get(`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"https://console.vast.ai/api/v0/users/current/\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:`headers`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`headers)`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#DCDCAA`},children:`print`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`(resp.json())`})]}),`\n`]})})})]}),`\n`,_jsx(_components.p,{children:`A common pattern is to store your key in an environment variable:`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`1`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`export`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` VAST_API_KEY`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"your-api-key-here\"`})]}),`\n`]})})}),`\n`,_jsx(_components.p,{children:`This keeps the key out of your code and makes it easy to rotate.`}),`\n`,_jsx(Note,{children:_jsxs(_components.p,{children:[`If you get a `,_jsx(_components.code,{children:`401 Unauthorized`}),` or `,_jsx(_components.code,{children:`403 Forbidden`}),` response, double-check your API key. The most common causes are a typo, an expired key, or a scoped key that lacks the required permission for the endpoint you’re calling.`]})}),`\n`,_jsx(Heading,{level:`2`,id:`verify-your-key`,children:`Verify Your Key`}),`\n`,_jsx(_components.p,{children:`A quick way to confirm your key works is to fetch your account info:`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`2`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`2`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`curl`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -s`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Authorization: Bearer `}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`$VAST_API_KEY`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"https://console.vast.ai/api/v0/users/current/\"`})}),`\n`]})})}),`\n`,_jsx(_components.p,{children:`A successful response includes your user ID, email, balance, and SSH key:`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`6`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`6`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"id\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`123456`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"email\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"you@example.com\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"credit\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`25.00`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"ssh_key\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"ssh-rsa AAAAB3...\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),`\n`,_jsx(Heading,{level:`2`,id:`scoped-keys-and-permissions`,children:`Scoped Keys and Permissions`}),`\n`,_jsxs(_components.p,{children:[`By default, the web console creates a `,_jsx(_components.strong,{children:`full-access`}),` key. For CI/CD pipelines, shared tooling, or team environments, you should create `,_jsx(_components.strong,{children:`scoped keys`}),` that restrict access to only the permissions you need.`]}),`\n`,_jsx(_components.p,{children:`For example, a key that can only read and manage instances (but cannot access billing):`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`8`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`8`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"api\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"misc\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {},`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"user_read\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {},`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"instance_read\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {},`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"instance_write\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {}`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),`\n`,_jsxs(_components.p,{children:[`See the `,_jsx(_components.a,{href:`/api-reference/permissions`,children:`Permissions`}),` page for the full list of permission categories, endpoint mappings, constraint syntax, and advanced examples.`]}),`\n`,_jsx(Heading,{level:`2`,id:`key-expiration`,children:`Key Expiration`}),`\n`,_jsxs(_components.p,{children:[`API keys do not expire by default. You can revoke a key at any time from the `,_jsx(_components.a,{href:`https://cloud.vast.ai/manage-keys/`,children:`Keys page`}),` or by calling the `,_jsx(_components.a,{href:`/api-reference/accounts/delete-api-key`,children:`Delete API Key`}),` endpoint.`]}),`\n`,_jsx(Warning,{children:_jsx(_components.p,{children:`Treat your API key like a password. Do not commit keys to version control or share them in plaintext. If a key is compromised, revoke it immediately and create a new one.`})})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Authentication","sidebarTitle":"Authentication","description":null,"href":"/api-reference/authentication"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Create an API Key","slug":"create-an-api-key","depth":2,"children":[]},{"title":"Use an API Key","slug":"use-an-api-key","depth":2,"children":[]},{"title":"Verify Your Key","slug":"verify-your-key","depth":2,"children":[]},{"title":"Scoped Keys and Permissions","slug":"scoped-keys-and-permissions","depth":2,"children":[]},{"title":"Key Expiration","slug":"key-expiration","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":["/_mintlify/custom/vastai-80aa3a82/54e4ee435ab02cb8/structured-data.js"],"subdomain":"vastai-80aa3a82","siteName":"Vast.ai Documentation: Affordable GPU Cloud Marketplace","title":"Authentication - Vast.ai Documentation: Affordable GPU Cloud Marketplace","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-12T20:52:04.268Z","originalFileLocation":"api-reference/authentication.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=\"application-name\" content=\"Vast.ai Documentation: Affordable GPU Cloud Marketplace\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003cmeta data-mint-head name=\"robots\" content=\"index, follow\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/vastai-80aa3a82/Xpia3h5CJX2PzgYG/_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/vastai-80aa3a82/Xpia3h5CJX2PzgYG/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/vastai-80aa3a82/Xpia3h5CJX2PzgYG/_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/vastai-80aa3a82/Xpia3h5CJX2PzgYG/_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/vastai-80aa3a82/Xpia3h5CJX2PzgYG/_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/vastai-80aa3a82/Xpia3h5CJX2PzgYG/_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/vastai-80aa3a82/Xpia3h5CJX2PzgYG/_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/vastai-80aa3a82/Xpia3h5CJX2PzgYG/_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/vastai-80aa3a82/Xpia3h5CJX2PzgYG/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Authentication - Vast.ai Documentation: Affordable GPU Cloud Marketplace\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Vast.ai Documentation: Affordable GPU Cloud Marketplace\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.vast.ai/api-reference/authentication\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://vastai-80aa3a82.mintlify.site/_mintlify/api/og/v2?division=Overview\u0026amp;title=Authentication\u0026amp;theme=4a1be6b54b856d24d77d481a\u0026amp;signature=25fb5b14e16ec2736e606d0c00ad53d63d67fa3cf8168ce40cde6f96b19d3814\">\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=\"Authentication - Vast.ai Documentation: Affordable GPU Cloud Marketplace\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://vastai-80aa3a82.mintlify.site/_mintlify/api/og/v2?division=Overview\u0026amp;title=Authentication\u0026amp;theme=4a1be6b54b856d24d77d481a\u0026amp;signature=25fb5b14e16ec2736e606d0c00ad53d63d67fa3cf8168ce40cde6f96b19d3814\">\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/vastai-80aa3a82/Xpia3h5CJX2PzgYG/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Vast.ai Documentation: Affordable GPU Cloud Marketplace\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#315FFF\">\u003cmeta data-mint-head name=\"og:locale\" content=\"en_US\">\u003cmeta data-mint-head name=\"indexing\" content=\"all\">\u003cmeta data-mint-head name=\"author\" content=\"Vast.ai Team\">\u003cmeta data-mint-head name=\"googlebot\" content=\"index, follow\">\u003cmeta data-mint-head name=\"google\" content=\"notranslate\">\u003cmeta data-mint-head name=\"google-site-verification\" content=\"WHKqvZxf1snX5HX4y0luN_AnAvAPGoSjUcMv03b_NsI\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003cmeta data-mint-head name=\"theme-color\" content=\"#000000\">\u003cmeta data-mint-head name=\"color-scheme\" content=\"light dark\">\u003cmeta data-mint-head name=\"format-detection\" content=\"telephone=no\">\u003cmeta data-mint-head name=\"referrer\" content=\"origin\">\u003cmeta data-mint-head name=\"rating\" content=\"general\">\u003cmeta data-mint-head name=\"revisit-after\" content=\"7 days\">\u003cmeta data-mint-head name=\"language\" content=\"en\">\u003cmeta data-mint-head name=\"copyright\" content=\"Copyright 2025\">\u003cmeta data-mint-head name=\"reply-to\" content=\"contact@vast.ai\">\u003cmeta data-mint-head name=\"distribution\" content=\"global\">\u003cmeta data-mint-head name=\"coverage\" content=\"Worldwide\">\u003cmeta data-mint-head name=\"category\" content=\"Developer Documentation\">\u003cmeta data-mint-head name=\"target\" content=\"all\">\u003cmeta data-mint-head name=\"HandheldFriendly\" content=\"True\">\u003cmeta data-mint-head name=\"MobileOptimized\" content=\"320\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-capable\" content=\"yes\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-status-bar-style\" content=\"black\">\u003cmeta data-mint-head name=\"twitter:creator\" content=\"@vast_ai\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.vast.ai/api-reference/authentication\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/authentication.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.vast.ai/#organization\",\"name\":\"Vast.ai Documentation: Affordable GPU Cloud Marketplace\",\"url\":\"https://docs.vast.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/vastai-80aa3a82/lDYZh_6OFg5OOaSN/logo/light.svg?fit=max\u0026auto=format\u0026n=lDYZh_6OFg5OOaSN\u0026q=85\u0026s=7f79454b79a0cfc463ec063cd29faea0\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.vast.ai#website\",\"name\":\"Vast.ai Documentation: Affordable GPU Cloud Marketplace\",\"url\":\"https://docs.vast.ai\",\"publisher\":{\"@id\":\"https://docs.vast.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.vast.ai/api-reference/authentication#webpage\",\"url\":\"https://docs.vast.ai/api-reference/authentication\",\"name\":\"Authentication\",\"dateModified\":\"2026-11-12T20:52:04.268Z\",\"isPartOf\":{\"@id\":\"https://docs.vast.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.vast.ai/api-reference/authentication#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.vast.ai/api-reference/authentication#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Overview\",\"item\":\"https://docs.vast.ai/api-reference/hello-world\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Authentication\",\"item\":\"https://docs.vast.ai/api-reference/authentication\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.vast.ai/api-reference/authentication#article\",\"headline\":\"Authentication\",\"name\":\"Authentication\",\"url\":\"https://docs.vast.ai/api-reference/authentication\",\"mainEntityOfPage\":{\"@id\":\"https://docs.vast.ai/api-reference/authentication#webpage\"},\"dateModified\":\"2026-11-12T20:52:04.268Z\",\"publisher\":{\"@id\":\"https://docs.vast.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.vast.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Vast.ai Documentation: Affordable GPU Cloud Marketplace\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Vast.ai Documentation: Affordable GPU Cloud Marketplace\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/authentication.md","siteName":"Vast.ai Documentation: Affordable GPU Cloud Marketplace","nav":{"global":null,"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":"/guides/get-started"}]},{"tab":"CLI \u0026 SDK","pages":[{"title":"CLI \u0026 SDK","href":"/cli/hello-world"}]},{"tab":"API","groups":[{"group":"Overview","icon":"book","pages":[{"title":"API Hello World","sidebarTitle":"API","href":"/api-reference/hello-world"},{"title":"API Reference","sidebarTitle":"Introduction","description":"REST API for managing GPU instances, machines, templates, volumes, serverless endpoints, and billing on Vast.ai.","href":"/api-reference/introduction"},{"title":"Authentication","sidebarTitle":"Authentication","href":"/api-reference/authentication"},{"title":"Permissions","sidebarTitle":"Permissions","description":null,"href":"/api-reference/permissions"},{"title":"Two-Factor Authentication Endpoints","href":"/api-reference/two-factor-authentication-endpoints"},{"title":"Rate Limits and Errors","href":"/api-reference/rate-limits-and-errors"}]},{"group":"Common workflows","icon":"list-check","pages":[{"title":"Creating Instances with the API","sidebarTitle":"Instances","href":"/api-reference/creating-instances-with-api"},{"title":"Creating and Using Templates with API","sidebarTitle":"Templates","href":"/api-reference/creating-and-using-templates-with-api"}]},{"group":"Endpoints","icon":"webhook","pages":[{"group":"Instances","pages":[{"title":"show ssh-keys","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /api/v0/instances/{id}/ssh","href":"/api-reference/instances/show-ssh-keys"},{"title":"attach ssh-key","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /api/v0/instances/{id}/ssh","href":"/api-reference/instances/attach-ssh-key"},{"title":"copy","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml put /api/v0/commands/copy_direct","href":"/api-reference/instances/copy"},{"title":"cancel copy","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /api/v0/commands/copy_direct","href":"/api-reference/instances/cancel-copy"},{"title":"cloud copy","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /api/v0/commands/rclone","href":"/api-reference/instances/cloud-copy"},{"title":"cancel sync","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /api/v0/commands/rclone","href":"/api-reference/instances/cancel-sync"},{"title":"change bid","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml put /api/v0/instances/bid_price/{id}","href":"/api-reference/instances/change-bid"},{"title":"create instance","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml put /api/v0/asks/{id}","href":"/api-reference/instances/create-instance"},{"title":"show instance","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /api/v0/instances/{id}","href":"/api-reference/instances/show-instance"},{"title":"manage instance","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml put /api/v0/instances/{id}","href":"/api-reference/instances/manage-instance"},{"title":"destroy instance","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /api/v0/instances/{id}","href":"/api-reference/instances/destroy-instance"},{"title":"detach ssh-key","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /api/v0/instances/{id}/ssh/{ssh_key_id}","href":"/api-reference/instances/detach-ssh-key"},{"title":"execute","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml put /api/v0/instances/command/{id}","href":"/api-reference/instances/execute"},{"title":"show logs","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml put /api/v0/instances/request_logs/{id}","href":"/api-reference/instances/show-logs"},{"title":"prepay instance","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml put /api/v0/instances/prepay/{id}","href":"/api-reference/instances/prepay-instance"},{"title":"reboot instance","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml put /api/v0/instances/reboot/{id}","href":"/api-reference/instances/reboot-instance"},{"title":"recycle instance","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml put /api/v0/instances/recycle/{id}","href":"/api-reference/instances/recycle-instance"},{"title":"show instances","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /api/v1/instances","href":"/api-reference/instances/show-instances"}]},{"group":"Machines","pages":[{"title":"cancel maint","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml put /api/v0/machines/{machine_id}/cancel_maint","href":"/api-reference/machines/cancel-maint"},{"title":"cleanup machine","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml put /api/v0/machines/{machine_id}/cleanup","href":"/api-reference/machines/cleanup-machine"},{"title":"list machine","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml put /api/v0/machines/create_asks","href":"/api-reference/machines/list-machine"},{"title":"show gpu metrics","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /api/v0/metrics/gpu/current","href":"/api-reference/machines/show-gpu-metrics"},{"title":"show gpu locations","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /api/v0/metrics/gpu/locations","href":"/api-reference/machines/show-gpu-locations"},{"title":"show gpu trends","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /api/v0/metrics/gpu/history","href":"/api-reference/machines/show-gpu-trends"},{"title":"remove defjob","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /api/v0/machines/{machine_id}/defjob","href":"/api-reference/machines/remove-defjob"},{"title":"show reports","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /api/v0/machines/{machine_id}/reports","href":"/api-reference/machines/show-reports"},{"title":"schedule maint","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml put /api/v0/machines/{machine_id}/dnotify","href":"/api-reference/machines/schedule-maint"},{"title":"set defjob","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml put /api/v0/machines/create_bids","href":"/api-reference/machines/set-defjob"},{"title":"set min-bid","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml put /api/v0/machines/{machine_id}/minbid","href":"/api-reference/machines/set-min-bid"},{"title":"show machines","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /api/v0/machines","href":"/api-reference/machines/show-machines"},{"title":"unlist machine","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /api/v0/machines/{machine_id}/asks","href":"/api-reference/machines/unlist-machine"}]},{"group":"Accounts","pages":[{"title":"show api keys","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /api/v0/auth/apikeys","href":"/api-reference/accounts/show-api-keys"},{"title":"create api-key","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /api/v0/auth/apikeys","href":"/api-reference/accounts/create-api-key"},{"title":"show env vars","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /api/v0/secrets","href":"/api-reference/accounts/show-env-vars"},{"title":"update env var","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml put /api/v0/secrets","href":"/api-reference/accounts/update-env-var"},{"title":"create env-var","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /api/v0/secrets","href":"/api-reference/accounts/create-env-var"},{"title":"delete env var","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /api/v0/secrets","href":"/api-reference/accounts/delete-env-var"},{"title":"show ssh keys","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /api/v0/ssh","href":"/api-reference/accounts/show-ssh-keys"},{"title":"create ssh-key","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /api/v0/ssh","href":"/api-reference/accounts/create-ssh-key"},{"title":"set user","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml put /api/v0/users","href":"/api-reference/accounts/set-user"},{"title":"create subaccount","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /api/v0/users","href":"/api-reference/accounts/create-subaccount"},{"title":"delete api key","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /api/v0/auth/apikeys/{id}","href":"/api-reference/accounts/delete-api-key"},{"title":"update ssh key","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml put /api/v0/ssh/{id}","href":"/api-reference/accounts/update-ssh-key"},{"title":"delete ssh key","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /api/v0/ssh/{id}","href":"/api-reference/accounts/delete-ssh-key"},{"title":"show connections","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /api/v0/users/cloud_integrations","href":"/api-reference/accounts/show-connections"},{"title":"show ipaddrs","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /api/v0/users/{user_id}/ipaddrs","href":"/api-reference/accounts/show-ipaddrs"},{"title":"show subaccounts","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /api/v0/subaccounts","href":"/api-reference/accounts/show-subaccounts"},{"title":"show user","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /api/v0/users/current","href":"/api-reference/accounts/show-user"},{"title":"transfer credit","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml put /api/v0/commands/transfer_credit","href":"/api-reference/accounts/transfer-credit"}]},{"group":"Serverless","pages":[{"title":"show workergroup","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /api/v0/workergroups","href":"/api-reference/serverless/show-workergroup"},{"title":"create workergroup","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /api/v0/workergroups","href":"/api-reference/serverless/create-workergroup"},{"title":"show endpoints","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /api/v0/endptjobs","href":"/api-reference/serverless/show-endpoints"},{"title":"create endpoint","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /api/v0/endptjobs","href":"/api-reference/serverless/create-endpoint"},{"title":"update workergroup","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml put /api/v0/workergroups/{id}","href":"/api-reference/serverless/update-workergroup"},{"title":"delete workergroup","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /api/v0/workergroups/{id}","href":"/api-reference/serverless/delete-workergroup"},{"title":"update endpoint","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml put /api/v0/endptjobs/{id}","href":"/api-reference/serverless/update-endpoint"},{"title":"delete endpoint","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /api/v0/endptjobs/{id}","href":"/api-reference/serverless/delete-endpoint"},{"title":"get workergroup logs","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /get_workergroup_logs","href":"/api-reference/serverless/get-workergroup-logs"},{"title":"get workergroup workers","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /get_workergroup_workers","href":"/api-reference/serverless/get-workergroup-workers"},{"title":"get endpoint logs","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /get_endpoint_logs","href":"/api-reference/serverless/get-endpoint-logs"},{"title":"get endpoint workers","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /get_endpoint_workers","href":"/api-reference/serverless/get-endpoint-workers"},{"title":"route","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /route","href":"/api-reference/serverless/route"},{"title":"show deployment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /api/v0/deployment/{id}","href":"/api-reference/serverless/show-deployment"},{"title":"show deployments","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /api/v0/deployments","href":"/api-reference/serverless/show-deployments"},{"title":"start deployment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /api/v0/deployment/{id}/start","href":"/api-reference/serverless/start-deployment"},{"title":"stop deployment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /api/v0/deployment/{id}/stop","href":"/api-reference/serverless/stop-deployment"}]},{"group":"Team","pages":[{"title":"create team","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /api/v0/team","href":"/api-reference/team/create-team"},{"title":"destroy team","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /api/v0/team","href":"/api-reference/team/destroy-team"},{"title":"create team role","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /api/v0/team/roles","href":"/api-reference/team/create-team-role"},{"title":"invite team member","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /api/v0/team/invite","href":"/api-reference/team/invite-team-member"},{"title":"remove team member","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /api/v0/team/members/{id}","href":"/api-reference/team/remove-team-member"},{"title":"show team role","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /api/v0/team/roles/{name}","href":"/api-reference/team/show-team-role"},{"title":"update team role","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml put /api/v0/team/roles/{name}","href":"/api-reference/team/update-team-role"},{"title":"remove team role","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /api/v0/team/roles/{name}","href":"/api-reference/team/remove-team-role"},{"title":"show team members","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /api/v0/team/members","href":"/api-reference/team/show-team-members"},{"title":"show team roles","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /api/v0/team/roles-full","href":"/api-reference/team/show-team-roles"}]},{"group":"Search","pages":[{"title":"search templates","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /api/v0/template","href":"/api-reference/search/search-templates"},{"title":"search benchmarks","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /api/v0/benchmarks","href":"/api-reference/search/search-benchmarks"},{"title":"search offers","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /api/v0/bundles","href":"/api-reference/search/search-offers"}]},{"group":"Templates","pages":[{"title":"create template","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /api/v0/template","href":"/api-reference/templates/create-template"},{"title":"delete template","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /api/v0/template","href":"/api-reference/templates/delete-template"},{"title":"edit template","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml put /api/v1/template","href":"/api-reference/templates/edit-template"}]},{"group":"Volumes","pages":[{"title":"list volumes","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /api/v0/volumes","href":"/api-reference/volumes/list-volumes"},{"title":"rent volume","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml put /api/v0/volumes","href":"/api-reference/volumes/rent-volume"},{"title":"delete volume","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /api/v0/volumes","href":"/api-reference/volumes/delete-volume"},{"title":"search volumes","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /api/v0/volumes/search","href":"/api-reference/volumes/search-volumes"},{"title":"unlist volume","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /api/v0/volumes/unlist","href":"/api-reference/volumes/unlist-volume"}]},{"group":"Notifications","pages":[{"title":"list notification types","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /api/v0/notification-types","href":"/api-reference/notifications/list-notification-types"},{"title":"get notification preferences","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /api/v0/users/{user_id}/notification-prefs","href":"/api-reference/notifications/get-notification-preferences"},{"title":"update notification preferences","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml put /api/v0/users/{user_id}/notification-prefs","href":"/api-reference/notifications/update-notification-preferences"},{"title":"list notification webhooks","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /api/v0/webhooks","href":"/api-reference/notifications/list-notification-webhooks"},{"title":"create notification webhook","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /api/v0/webhooks","href":"/api-reference/notifications/create-notification-webhook"},{"title":"update notification webhook","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml put /api/v0/webhooks/{id}","href":"/api-reference/notifications/update-notification-webhook"},{"title":"delete notification webhook","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /api/v0/webhooks/{id}","href":"/api-reference/notifications/delete-notification-webhook"},{"title":"rotate notification webhook secret","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /api/v0/webhooks/{id}/rotate-secret","href":"/api-reference/notifications/rotate-notification-webhook-secret"},{"title":"test notification webhook","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /api/v0/webhooks/{id}/test","href":"/api-reference/notifications/test-notification-webhook"}]},{"group":"Billing","pages":[{"title":"show charges","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /api/v0/charges","href":"/api-reference/billing/show-charges"},{"title":"show deposit","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /api/v0/instances/balance/{id}","href":"/api-reference/billing/show-deposit"},{"title":"show earnings","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /api/v0/users/{user_id}/machine-earnings","href":"/api-reference/billing/show-earnings"},{"title":"show invoices","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /api/v1/invoices","href":"/api-reference/billing/show-invoices"}]}]}]},{"tab":"Host","pages":[{"title":"Host","href":"/host/hosting-overview"}]},{"tab":"Examples","pages":[{"title":"Examples","href":"/pytorch"}]}]},"basePath":"","title":"Authentication - Vast.ai Documentation: Affordable GPU Cloud Marketplace","buildId":"dpl_Fyv1NbzwP68g2bEH2Roy98uY1zmE","deploymentId":"dpl_Fyv1NbzwP68g2bEH2Roy98uY1zmE","dynamics":[],"chunks":[]}