The machine must belong to the authenticated organization.
Use the include parameter to fetch related resources in the response.
Related resources are returned in the included array following the JSON:API pattern.
Related resources requested via the include query parameter
Show child attributes
Was this page helpful?
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Cyberdesk Docs","colors":{"primary":"#3b82f6","light":"#dbeafe","dark":"#1d4ed8"},"logo":{"light":"https://mintcdn.com/cyberdesk/rrJLQX3349IKA_1Y/logo/wordmark-black.svg?fit=max\u0026auto=format\u0026n=rrJLQX3349IKA_1Y\u0026q=85\u0026s=70df31cd0fe9c8c03bd870850e6abad1","dark":"https://mintcdn.com/cyberdesk/rrJLQX3349IKA_1Y/logo/wordmark-white.svg?fit=max\u0026auto=format\u0026n=rrJLQX3349IKA_1Y\u0026q=85\u0026s=efb75dfc3af81651545ce4fb8a931f71"},"favicon":"https://mintcdn.com/cyberdesk/rrJLQX3349IKA_1Y/favicon.svg?fit=max\u0026auto=format\u0026n=rrJLQX3349IKA_1Y\u0026q=85\u0026s=63f8354d6cad976e700a748474e359d0","navbar":{"links":[{"href":"mailto:founders@cyberdesk.io","label":"Support"}],"primary":{"type":"button","label":"Dashboard","href":"https://cyberdesk.io/dashboard"}},"footer":{"socials":{"x":"https://x.com/cyberdeskhq","github":"https://github.com/cyberdesk-hq/cyberdriver","linkedin":"https://linkedin.com/company/cyberdeskhq"}},"contextual":{"options":["copy","view","chatgpt","mcp","cursor","vscode"],"display":"header"},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"Community","icon":"discord","href":"https://discord.gg/ws5ddx5yZ8"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"cyberdesk","hasAudioNarration":false,"actualSubdomain":"cyberdesk","customDomains":["docs.cyberdesk.io"],"gitSource":{"type":"github","owner":"cyberdesk-hq","repo":"cyberdesk-new","deployBranch":"main","contentDirectory":"apps/docs","isPrivate":true,"mountPath":"","label":""},"feedback":{"thumbs":true},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6abdedad7f9886e5779af640","clientVersion":"0.0.4094","searchFilterCounts":[{"language":"default","tag":"API reference","count":143},{"language":"default","tag":"Endpoints","count":142},{"language":"default","tag":"Guides","count":60},{"language":"default","tag":"Concepts","count":23},{"language":"default","tag":"computer","count":23},{"language":"default","tag":"cyberdriver-auth","count":19},{"language":"default","tag":"workflows","count":16},{"language":"default","tag":"Workflow Prompting","count":15},{"language":"default","tag":"Cyberdriver","count":11},{"language":"default","tag":"runs","count":11}]},"assistantConfig":{"deflection":{"enabled":true,"email":"founders@cyberdesk.io","showHelpButton":true}},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"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},{"name":"comment-mode","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/machines/get-machine","slug":"/api-reference/machines/get-machine","pageMetadata":{"title":"Get Machine","description":"Get a specific machine by ID.\n\nThe machine must belong to the authenticated organization.\n\nUse the `include` parameter to fetch related resources in the response.\nRelated resources are returned in the `included` array following the JSON:API pattern.","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/machines/{machine_id}","href":"/api-reference/machines/get-machine","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, 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(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"Get a specific machine by ID.\"\n }), \"\\n\", _jsx(_components.p, {\n children: \"The machine must belong to the authenticated organization.\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"Use the \", _jsx(_components.code, {\n children: \"include\"\n }), \" parameter to fetch related resources in the response.\\nRelated resources are returned in the \", _jsx(_components.code, {\n children: \"included\"\n }), \" array following the JSON:API pattern.\"]\n })]\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":"Get Machine","description":"Get a specific machine by ID.\n\nThe machine must belong to the authenticated organization.\n\nUse the `include` parameter to fetch related resources in the response.\nRelated resources are returned in the `included` array following the JSON:API pattern.","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/machines/{machine_id}","href":"/api-reference/machines/get-machine","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["machines"],"summary":"Get Machine","description":"Get a specific machine by ID.\n\nThe machine must belong to the authenticated organization.\n\nUse the `include` parameter to fetch related resources in the response.\nRelated resources are returned in the `included` array following the JSON:API pattern.","operationId":"get_machine_v1_machines__machine_id__get","security":["b1eb4427-da28-4856-8477-dc2aa3323d22"],"parameters":["b0e29298-016f-48ad-8900-d91023c16c67","07d504d5-d2eb-4566-920a-50c67615256a"],"responses":{"200":"96cddbf3-e462-4ee2-8fe8-3523d3744a80","422":"18c84da9-7aaf-439c-9c29-c79c17651bf6"},"method":"get","type":"path","servers":["5d9dc265-cc15-49a9-96d0-94b871d1e5eb","6170478c-28fa-47fc-a7ae-6562a2ecf335"],"path":"/v1/machines/{machine_id}","baseUrlOptions":["https://api.cyberdesk.io","https://cyberdesk-api-dev.fly.dev"],"title":"Get Machine","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"b0e29298-016f-48ad-8900-d91023c16c67":{"name":"machine_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Machine Id","isRequired":true,"uniqueKey":"","typeLabel":"string\u003cuuid>"}},"07d504d5-d2eb-4566-920a-50c67615256a":{"name":"include","in":"query","required":false,"schema":{"oneOf":[{"type":"string","title":"Include","description":"Comma-separated list of related resources to include. Allowed values: pools. Example: include=pools","uniqueKey":"oneOf.0","typeLabel":"string"},{"type":"null","title":"Include","description":"Comma-separated list of related resources to include. Allowed values: pools. Example: include=pools","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string | null"},"description":"Comma-separated list of related resources to include. Allowed values: pools. Example: include=pools"}},"responses":{"96cddbf3-e462-4ee2-8fe8-3523d3744a80":{"description":"Successful Response","content":{"application/json":{"schema":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","isRequired":true,"uniqueKey":"id","typeLabel":"string\u003cuuid>"},"unkey_key_id":{"type":"string","title":"Unkey Key Id","isRequired":true,"uniqueKey":"unkey_key_id","typeLabel":"string"},"status":{"type":"string","enum":["connected","disconnected","error"],"title":"MachineStatus","isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"is_available":{"type":"boolean","title":"Is Available","isRequired":true,"uniqueKey":"is_available","typeLabel":"boolean"},"alerts_enabled":{"type":"boolean","title":"Alerts Enabled","isRequired":true,"uniqueKey":"alerts_enabled","typeLabel":"boolean"},"created_at":{"type":"string","format":"date-time","title":"Created At","isRequired":true,"uniqueKey":"created_at","typeLabel":"string\u003cdate-time>"},"last_seen":{"type":"string","format":"date-time","title":"Last Seen","isRequired":true,"uniqueKey":"last_seen","typeLabel":"string\u003cdate-time>"},"user_id":{"oneOf":[{"type":"string","title":"User Id","format":"uuid","uniqueKey":"user_id.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","title":"User Id","uniqueKey":"user_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"user_id","typeLabel":"string\u003cuuid> | null"},"organization_id":{"oneOf":[{"type":"string","title":"Organization Id","uniqueKey":"organization_id.oneOf.0","typeLabel":"string"},{"type":"null","title":"Organization Id","uniqueKey":"organization_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"organization_id","typeLabel":"string | null"},"name":{"oneOf":[{"type":"string","title":"Name","uniqueKey":"name.oneOf.0","typeLabel":"string"},{"type":"null","title":"Name","uniqueKey":"name.oneOf.1","typeLabel":"null"}],"uniqueKey":"name","typeLabel":"string | null"},"version":{"oneOf":[{"type":"string","title":"Version","uniqueKey":"version.oneOf.0","typeLabel":"string"},{"type":"null","title":"Version","uniqueKey":"version.oneOf.1","typeLabel":"null"}],"uniqueKey":"version","typeLabel":"string | null"},"hostname":{"oneOf":[{"type":"string","title":"Hostname","uniqueKey":"hostname.oneOf.0","typeLabel":"string"},{"type":"null","title":"Hostname","uniqueKey":"hostname.oneOf.1","typeLabel":"null"}],"uniqueKey":"hostname","typeLabel":"string | null"},"os_info":{"oneOf":[{"type":"string","title":"Os Info","uniqueKey":"os_info.oneOf.0","typeLabel":"string"},{"type":"null","title":"Os Info","uniqueKey":"os_info.oneOf.1","typeLabel":"null"}],"uniqueKey":"os_info","typeLabel":"string | null"},"machine_parameters":{"oneOf":[{"type":"object","title":"Machine Parameters","additionalProperties":true,"uniqueKey":"machine_parameters.oneOf.0","typeLabel":"Machine Parameters · object"},{"type":"null","title":"Machine Parameters","uniqueKey":"machine_parameters.oneOf.1","typeLabel":"null"}],"uniqueKey":"machine_parameters","typeLabel":"Machine Parameters · object | null"},"machine_sensitive_parameters":{"oneOf":[{"type":"object","title":"Machine Sensitive Parameters","additionalProperties":{"type":"string","uniqueKey":"machine_sensitive_parameters.oneOf.0.additionalProperties","typeLabel":"string"},"uniqueKey":"machine_sensitive_parameters.oneOf.0","typeLabel":"Machine Sensitive Parameters · object"},{"type":"null","title":"Machine Sensitive Parameters","uniqueKey":"machine_sensitive_parameters.oneOf.1","typeLabel":"null"}],"uniqueKey":"machine_sensitive_parameters","typeLabel":"Machine Sensitive Parameters · object | null"},"reserved_session_id":{"oneOf":[{"type":"string","title":"Reserved Session Id","format":"uuid","uniqueKey":"reserved_session_id.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","title":"Reserved Session Id","uniqueKey":"reserved_session_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"reserved_session_id","typeLabel":"string\u003cuuid> | null"},"linked_keepalive_machine_id":{"oneOf":[{"type":"string","title":"Linked Keepalive Machine Id","format":"uuid","uniqueKey":"linked_keepalive_machine_id.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","title":"Linked Keepalive Machine Id","uniqueKey":"linked_keepalive_machine_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"linked_keepalive_machine_id","typeLabel":"string\u003cuuid> | null"},"physical_server_id":{"oneOf":[{"type":"string","title":"Physical Server Id","uniqueKey":"physical_server_id.oneOf.0","typeLabel":"string"},{"type":"null","title":"Physical Server Id","uniqueKey":"physical_server_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"physical_server_id","typeLabel":"string | null"},"pools":{"oneOf":[{"type":"array","items":{"properties":{"name":{"type":"string","maxLength":255,"minLength":1,"title":"Name","isRequired":true,"uniqueKey":"pools.oneOf.0.items.[INDEX].name","typeLabel":"string"},"id":{"type":"string","format":"uuid","title":"Id","isRequired":true,"uniqueKey":"pools.oneOf.0.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"organization_id":{"type":"string","title":"Organization Id","isRequired":true,"uniqueKey":"pools.oneOf.0.items.[INDEX].organization_id","typeLabel":"string"},"created_at":{"type":"string","format":"date-time","title":"Created At","isRequired":true,"uniqueKey":"pools.oneOf.0.items.[INDEX].created_at","typeLabel":"string\u003cdate-time>"},"updated_at":{"type":"string","format":"date-time","title":"Updated At","isRequired":true,"uniqueKey":"pools.oneOf.0.items.[INDEX].updated_at","typeLabel":"string\u003cdate-time>"},"description":{"oneOf":[{"type":"string","title":"Description","uniqueKey":"pools.oneOf.0.items.[INDEX].description.oneOf.0","typeLabel":"string"},{"type":"null","title":"Description","uniqueKey":"pools.oneOf.0.items.[INDEX].description.oneOf.1","typeLabel":"null"}],"uniqueKey":"pools.oneOf.0.items.[INDEX].description","typeLabel":"string | null"},"pool_parameters":{"oneOf":[{"type":"object","title":"Pool Parameters","description":"Pool-level input values that auto-populate runs selecting this pool","additionalProperties":true,"uniqueKey":"pools.oneOf.0.items.[INDEX].pool_parameters.oneOf.0","typeLabel":"Pool Parameters · object"},{"type":"null","title":"Pool Parameters","description":"Pool-level input values that auto-populate runs selecting this pool","uniqueKey":"pools.oneOf.0.items.[INDEX].pool_parameters.oneOf.1","typeLabel":"null"}],"uniqueKey":"pools.oneOf.0.items.[INDEX].pool_parameters","typeLabel":"Pool Parameters · object | null"},"pool_sensitive_parameters":{"oneOf":[{"type":"object","title":"Pool Sensitive Parameters","description":"Pool-level sensitive input aliases (stored in Basis Theory)","additionalProperties":{"type":"string","uniqueKey":"pools.oneOf.0.items.[INDEX].pool_sensitive_parameters.oneOf.0.additionalProperties","typeLabel":"string"},"uniqueKey":"pools.oneOf.0.items.[INDEX].pool_sensitive_parameters.oneOf.0","typeLabel":"Pool Sensitive Parameters · object"},{"type":"null","title":"Pool Sensitive Parameters","description":"Pool-level sensitive input aliases (stored in Basis Theory)","uniqueKey":"pools.oneOf.0.items.[INDEX].pool_sensitive_parameters.oneOf.1","typeLabel":"null"}],"uniqueKey":"pools.oneOf.0.items.[INDEX].pool_sensitive_parameters","typeLabel":"Pool Sensitive Parameters · object | null"},"machine_count":{"oneOf":[{"type":"integer","title":"Machine Count","description":"Number of machines in this pool","default":0,"uniqueKey":"pools.oneOf.0.items.[INDEX].machine_count.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Machine Count","description":"Number of machines in this pool","default":0,"uniqueKey":"pools.oneOf.0.items.[INDEX].machine_count.oneOf.1","typeLabel":"null"}],"uniqueKey":"pools.oneOf.0.items.[INDEX].machine_count","typeLabel":"integer | null"}},"type":"object","required":["name","id","organization_id","created_at","updated_at"],"title":"PoolResponse","description":"Pool response schema","uniqueKey":"pools.oneOf.0.items.[INDEX]","typeLabel":"PoolResponse · object"},"title":"Pools","uniqueKey":"pools.oneOf.0","typeLabel":"PoolResponse · object[]"},{"type":"null","title":"Pools","uniqueKey":"pools.oneOf.1","typeLabel":"null"}],"uniqueKey":"pools","typeLabel":"PoolResponse · object[] | null"},"included":{"oneOf":[{"type":"array","items":{"properties":{"type":{"type":"string","title":"Type","description":"Resource type (e.g., 'workflow', 'machine', 'pool')","isRequired":true,"uniqueKey":"included.oneOf.0.items.[INDEX].type","typeLabel":"string"},"id":{"type":"string","format":"uuid","title":"Id","description":"Resource UUID","isRequired":true,"uniqueKey":"included.oneOf.0.items.[INDEX].id","typeLabel":"string\u003cuuid>"}},"additionalProperties":true,"type":"object","required":["type","id"],"title":"IncludedResource","description":"A resource in the JSON:API-style included array.\n\nEach included resource has a `type` field indicating what kind of resource it is\n(e.g., \"workflow\", \"machine\", \"pool\") and an `id` field with the resource's UUID.\nAll other fields from the resource's response model are included.\n\nExample:\n {\n \"type\": \"workflow\",\n \"id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"name\": \"My Workflow\",\n \"main_prompt\": \"Do something...\",\n \"created_at\": \"2024-01-15T10:30:00Z\"\n }","uniqueKey":"included.oneOf.0.items.[INDEX]","typeLabel":"IncludedResource · object"},"title":"Included","description":"Related resources requested via the `include` query parameter","uniqueKey":"included.oneOf.0","typeLabel":"IncludedResource · object[]"},{"type":"null","title":"Included","description":"Related resources requested via the `include` query parameter","uniqueKey":"included.oneOf.1","typeLabel":"null"}],"uniqueKey":"included","typeLabel":"IncludedResource · object[] | null"}},"type":"object","required":["id","unkey_key_id","status","is_available","alerts_enabled","created_at","last_seen"],"title":"MachineResponseWithIncludes","description":"Machine response with optional included related resources.","uniqueKey":"","typeLabel":"MachineResponseWithIncludes · object"},"examples":{"Example":{"title":"Example","value":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","unkey_key_id":"\u003cstring>","status":"connected","is_available":true,"alerts_enabled":true,"created_at":"2023-11-07T05:31:56Z","last_seen":"2023-11-07T05:31:56Z","user_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","organization_id":"\u003cstring>","name":"\u003cstring>","version":"\u003cstring>","hostname":"\u003cstring>","os_info":"\u003cstring>","machine_parameters":{},"machine_sensitive_parameters":{},"reserved_session_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","linked_keepalive_machine_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","physical_server_id":"\u003cstring>","pools":[{"name":"\u003cstring>","id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","organization_id":"\u003cstring>","created_at":"2023-11-07T05:31:56Z","updated_at":"2023-11-07T05:31:56Z","description":"\u003cstring>","pool_parameters":{},"pool_sensitive_parameters":{},"machine_count":0}],"included":[{"type":"\u003cstring>","id":"3c90c3cc-0d44-4b50-8888-8dd25736052a"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"18c84da9-7aaf-439c-9c29-c79c17651bf6":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"oneOf":[{"type":"string","uniqueKey":"detail.items.[INDEX].loc.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"integer","uniqueKey":"detail.items.[INDEX].loc.items.[INDEX].oneOf.1","typeLabel":"integer"}],"uniqueKey":"detail.items.[INDEX].loc.items.[INDEX]","typeLabel":"string | integer"},"type":"array","title":"Location","isRequired":true,"uniqueKey":"detail.items.[INDEX].loc","typeLabel":"(string | integer)[]"},"msg":{"type":"string","title":"Message","isRequired":true,"uniqueKey":"detail.items.[INDEX].msg","typeLabel":"string"},"type":{"type":"string","title":"Error Type","isRequired":true,"uniqueKey":"detail.items.[INDEX].type","typeLabel":"string"},"input":{"oneOf":[{"title":"Input"}],"uniqueKey":"detail.items.[INDEX].input","typeLabel":"any"},"ctx":{"type":"object","additionalProperties":true,"title":"Context","uniqueKey":"detail.items.[INDEX].ctx","typeLabel":"Context · object"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError","uniqueKey":"detail.items.[INDEX]","typeLabel":"ValidationError · object"},"type":"array","title":"Detail","uniqueKey":"detail","typeLabel":"ValidationError · object[]"}},"type":"object","title":"HTTPValidationError","uniqueKey":"","typeLabel":"HTTPValidationError · object"},"examples":{"Example":{"title":"Example","value":{"detail":[{"loc":["\u003cstring>"],"msg":"\u003cstring>","type":"\u003cstring>","input":"\u003cunknown>","ctx":{}}]}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"b1eb4427-da28-4856-8477-dc2aa3323d22":{"HTTPBearer":{"type":"http","scheme":"bearer","scopes":[]}}},"servers":{"5d9dc265-cc15-49a9-96d0-94b871d1e5eb":{"url":"https://api.cyberdesk.io","description":"Production server"},"6170478c-28fa-47fc-a7ae-6562a2ecf335":{"url":"https://cyberdesk-api-dev.fly.dev","description":"Development server"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","scopes":[]},"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":"HTTPBearer","name":"Authorization"}],"title":"HTTPBearer"}]},"originalFileLocation":"openapi.json"},"subdomain":"cyberdesk","siteName":"Cyberdesk Docs","title":"Get Machine - Cyberdesk Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-01T05:20:52.218Z","originalFileLocation":"api-reference/machines/get-machine.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=\"Get a specific machine by ID. The machine must belong to the authenticated organization. Use the include parameter to fetch related resources in the response. Related resources are returned in the included array following the JSON:API pattern.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Cyberdesk Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/cyberdesk/sGMCV_-i4-RJ8wWw/_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/cyberdesk/sGMCV_-i4-RJ8wWw/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/cyberdesk/sGMCV_-i4-RJ8wWw/_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/cyberdesk/sGMCV_-i4-RJ8wWw/_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/cyberdesk/sGMCV_-i4-RJ8wWw/_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/cyberdesk/sGMCV_-i4-RJ8wWw/_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/cyberdesk/sGMCV_-i4-RJ8wWw/_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/cyberdesk/sGMCV_-i4-RJ8wWw/_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/cyberdesk/sGMCV_-i4-RJ8wWw/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get Machine - Cyberdesk Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Get a specific machine by ID. The machine must belong to the authenticated organization. Use the include parameter to fetch related resources in the response. Related resources are returned in the included array following the JSON:API pattern.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Cyberdesk Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.cyberdesk.io/api-reference/machines/get-machine\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://cyberdesk.mintlify.site/_mintlify/api/og/v2?division=machines\u0026amp;title=Get+Machine\u0026amp;description=Get+a+specific+machine+by+ID.%0A%0AThe+machine+must+belong+to+the+authenticated+organization.%0A%0AUse+the+%60include%60+parameter+to+fetch+related+resources+in+the+respons\u0026amp;theme=86fdfaa1df5f230cdbe8aef2\u0026amp;signature=d12645d919a2a68893877618aeed49cfd9d3754e5b7fe1f015ef23d3244b7fea\">\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=\"Get Machine - Cyberdesk Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Get a specific machine by ID. The machine must belong to the authenticated organization. Use the include parameter to fetch related resources in the response. Related resources are returned in the included array following the JSON:API pattern.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://cyberdesk.mintlify.site/_mintlify/api/og/v2?division=machines\u0026amp;title=Get+Machine\u0026amp;description=Get+a+specific+machine+by+ID.%0A%0AThe+machine+must+belong+to+the+authenticated+organization.%0A%0AUse+the+%60include%60+parameter+to+fetch+related+resources+in+the+respons\u0026amp;theme=86fdfaa1df5f230cdbe8aef2\u0026amp;signature=d12645d919a2a68893877618aeed49cfd9d3754e5b7fe1f015ef23d3244b7fea\">\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/cyberdesk/sGMCV_-i4-RJ8wWw/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Cyberdesk Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#3b82f6\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.cyberdesk.io/api-reference/machines/get-machine\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/machines/get-machine.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.cyberdesk.io/#organization\",\"name\":\"Cyberdesk Docs\",\"url\":\"https://docs.cyberdesk.io\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/cyberdesk/rrJLQX3349IKA_1Y/logo/wordmark-black.svg?fit=max\u0026auto=format\u0026n=rrJLQX3349IKA_1Y\u0026q=85\u0026s=70df31cd0fe9c8c03bd870850e6abad1\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.cyberdesk.io#website\",\"name\":\"Cyberdesk Docs\",\"url\":\"https://docs.cyberdesk.io\",\"publisher\":{\"@id\":\"https://docs.cyberdesk.io/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.cyberdesk.io/api-reference/machines/get-machine#webpage\",\"url\":\"https://docs.cyberdesk.io/api-reference/machines/get-machine\",\"name\":\"Get Machine\",\"description\":\"Get a specific machine by ID. The machine must belong to the authenticated organization. Use the include parameter to fetch related resources in the response. Related resources are returned in the included array following the JSON:API pattern.\",\"dateModified\":\"2026-10-01T05:20:52.218Z\",\"isPartOf\":{\"@id\":\"https://docs.cyberdesk.io#website\"},\"breadcrumb\":{\"@id\":\"https://docs.cyberdesk.io/api-reference/machines/get-machine#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.cyberdesk.io/api-reference/machines/get-machine#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Endpoints\",\"item\":\"https://docs.cyberdesk.io/api-reference/health/health-check\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"machines\",\"item\":\"https://docs.cyberdesk.io/api-reference/machines/list-machines\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Get Machine\",\"item\":\"https://docs.cyberdesk.io/api-reference/machines/get-machine\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.cyberdesk.io/api-reference/machines/get-machine#apireference\",\"headline\":\"Get Machine\",\"name\":\"Get Machine\",\"description\":\"Get a specific machine by ID. The machine must belong to the authenticated organization. Use the include parameter to fetch related resources in the response. Related resources are returned in the included array following the JSON:API pattern.\",\"url\":\"https://docs.cyberdesk.io/api-reference/machines/get-machine\",\"mainEntityOfPage\":{\"@id\":\"https://docs.cyberdesk.io/api-reference/machines/get-machine#webpage\"},\"dateModified\":\"2026-10-01T05:20:52.218Z\",\"publisher\":{\"@id\":\"https://docs.cyberdesk.io/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.cyberdesk.io#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Cyberdesk Docs\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Cyberdesk Docs","nav":{"global":{"anchors":[{"anchor":"Community","icon":"discord","href":"https://discord.gg/ws5ddx5yZ8"}]},"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":""}]},{"tab":"API reference","groups":[{"group":"API documentation","pages":[{"title":"API Reference","href":"/api-reference/introduction"}]},{"group":"Endpoints","pages":[{"group":"health","pages":[{"title":"Health Check","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/health","href":"/api-reference/health/health-check"},{"title":"Database Health Check","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/health/db","href":"/api-reference/health/database-health-check"},{"title":"Health Machines","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/health/machines","href":"/api-reference/health/health-machines"}]},{"group":"machines","pages":[{"title":"List Machines","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/machines","href":"/api-reference/machines/list-machines"},{"title":"Create Machine","description":"Create a new machine.\n\nThe machine will be associated with the authenticated organization.","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/machines","href":"/api-reference/machines/create-machine"},{"title":"Get Machine","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/machines/{machine_id}","href":"/api-reference/machines/get-machine"},{"title":"Delete Machine","description":"Delete a machine.\n\nAssociated runs are PRESERVED with machine_id set to NULL.\nThis ensures run history is never lost when a machine is deleted.\nConnections and request logs are cascade deleted.\n\nThe machine must belong to the authenticated organization.","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/machines/{machine_id}","href":"/api-reference/machines/delete-machine"},{"title":"Update Machine","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/machines/{machine_id}","href":"/api-reference/machines/update-machine"},{"title":"Create Cyberdriver Web Session","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/machines/{machine_id}/cyberdriver/web-session","href":"/api-reference/machines/create-cyberdriver-web-session"},{"title":"Get Machine Pools","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/machines/{machine_id}/pools","href":"/api-reference/machines/get-machine-pools"},{"title":"Update Machine Pools","deprecated":null,"version":null,"openapi":"/openapi.json put /v1/machines/{machine_id}/pools","href":"/api-reference/machines/update-machine-pools"}]},{"group":"pools","pages":[{"title":"List Pools","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/pools","href":"/api-reference/pools/list-pools"},{"title":"Create Pool","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/pools","href":"/api-reference/pools/create-pool"},{"title":"Get Pool","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/pools/{pool_id}","href":"/api-reference/pools/get-pool"},{"title":"Delete Pool","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/pools/{pool_id}","href":"/api-reference/pools/delete-pool"},{"title":"Update Pool","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/pools/{pool_id}","href":"/api-reference/pools/update-pool"},{"title":"Add Machines To Pool","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/pools/{pool_id}/machines","href":"/api-reference/pools/add-machines-to-pool"},{"title":"Remove Machines From Pool","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/pools/{pool_id}/machines","href":"/api-reference/pools/remove-machines-from-pool"}]},{"group":"workflows","pages":[{"title":"List Workflows","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/workflows","href":"/api-reference/workflows/list-workflows"},{"title":"Create Workflow","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/workflows","href":"/api-reference/workflows/create-workflow"},{"title":"Bulk add tags to multiple workflows","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/workflows/bulk/tags","href":"/api-reference/workflows/bulk-add-tags-to-multiple-workflows"},{"title":"Get Workflow","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/workflows/{workflow_id}","href":"/api-reference/workflows/get-workflow"},{"title":"Delete Workflow","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/workflows/{workflow_id}","href":"/api-reference/workflows/delete-workflow"},{"title":"Update Workflow","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/workflows/{workflow_id}","href":"/api-reference/workflows/update-workflow"},{"title":"Duplicate Workflow","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/workflows/{workflow_id}/duplicate","href":"/api-reference/workflows/duplicate-workflow"},{"title":"Merge Workflow","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/workflows/{workflow_id}/merge","href":"/api-reference/workflows/merge-workflow"},{"title":"Get Workflow Versions","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/workflows/{workflow_id}/versions","href":"/api-reference/workflows/get-workflow-versions"},{"title":"Upload a workflow prompt image","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/workflows/prompt-image","href":"/api-reference/workflows/upload-a-workflow-prompt-image"},{"title":"Delete a workflow prompt image","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/workflows/prompt-image","href":"/api-reference/workflows/delete-a-workflow-prompt-image"},{"title":"List workflow prompt images","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/workflows/prompt-images","href":"/api-reference/workflows/list-workflow-prompt-images"},{"title":"Get signed URL for a prompt image","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/workflows/prompt-image/signed-url","href":"/api-reference/workflows/get-signed-url-for-a-prompt-image"},{"title":"Get tags for a workflow","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/workflows/{workflow_id}/tags","href":"/api-reference/workflows/get-tags-for-a-workflow"},{"title":"Add tags to a workflow","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/workflows/{workflow_id}/tags","href":"/api-reference/workflows/add-tags-to-a-workflow"},{"title":"Remove a tag from a workflow","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/workflows/{workflow_id}/tags/{tag_id}","href":"/api-reference/workflows/remove-a-tag-from-a-workflow"}]},{"group":"workflow-tags","pages":[{"title":"List Tags","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/workflow-tags","href":"/api-reference/workflow-tags/list-tags"},{"title":"Create Tag","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/workflow-tags","href":"/api-reference/workflow-tags/create-tag"},{"title":"Get Tag","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/workflow-tags/{tag_id}","href":"/api-reference/workflow-tags/get-tag"},{"title":"Delete Tag","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/workflow-tags/{tag_id}","href":"/api-reference/workflow-tags/delete-tag"},{"title":"Update Tag","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/workflow-tags/{tag_id}","href":"/api-reference/workflow-tags/update-tag"},{"title":"Archive Tag","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/workflow-tags/{tag_id}/archive","href":"/api-reference/workflow-tags/archive-tag"},{"title":"Unarchive Tag","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/workflow-tags/{tag_id}/unarchive","href":"/api-reference/workflow-tags/unarchive-tag"},{"title":"Reorder Tags","deprecated":null,"version":null,"openapi":"/openapi.json put /v1/workflow-tags/reorder","href":"/api-reference/workflow-tags/reorder-tags"}]},{"group":"workflow-tag-groups","pages":[{"title":"List Tag Groups","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/workflow-tag-groups","href":"/api-reference/workflow-tag-groups/list-tag-groups"},{"title":"Create Tag Group","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/workflow-tag-groups","href":"/api-reference/workflow-tag-groups/create-tag-group"},{"title":"Get Tag Group","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/workflow-tag-groups/{group_id}","href":"/api-reference/workflow-tag-groups/get-tag-group"},{"title":"Delete Tag Group","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/workflow-tag-groups/{group_id}","href":"/api-reference/workflow-tag-groups/delete-tag-group"},{"title":"Update Tag Group","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/workflow-tag-groups/{group_id}","href":"/api-reference/workflow-tag-groups/update-tag-group"},{"title":"Reorder Tag Groups","deprecated":null,"version":null,"openapi":"/openapi.json put /v1/workflow-tag-groups/reorder","href":"/api-reference/workflow-tag-groups/reorder-tag-groups"}]},{"group":"model-configurations","pages":[{"title":"List Model Configurations","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/model-configurations","href":"/api-reference/model-configurations/list-model-configurations"},{"title":"Create Model Configuration","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/model-configurations","href":"/api-reference/model-configurations/create-model-configuration"},{"title":"Get Model Configuration","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/model-configurations/{model_configuration_id}","href":"/api-reference/model-configurations/get-model-configuration"},{"title":"Delete Model Configuration","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/model-configurations/{model_configuration_id}","href":"/api-reference/model-configurations/delete-model-configuration"},{"title":"Update Model Configuration","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/model-configurations/{model_configuration_id}","href":"/api-reference/model-configurations/update-model-configuration"}]},{"group":"provider-credentials","pages":[{"title":"List Provider Credentials","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/provider-credentials","href":"/api-reference/provider-credentials/list-provider-credentials"},{"title":"Upsert Provider Credential","deprecated":null,"version":null,"openapi":"/openapi.json put /v1/provider-credentials/{slot}","href":"/api-reference/provider-credentials/upsert-provider-credential"},{"title":"Delete Provider Credential","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/provider-credentials/{slot}","href":"/api-reference/provider-credentials/delete-provider-credential"},{"title":"Validate Provider Credential","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/provider-credentials/{slot}/validate","href":"/api-reference/provider-credentials/validate-provider-credential"}]},{"group":"runs","pages":[{"title":"List Runs","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/runs","href":"/api-reference/runs/list-runs"},{"title":"Create Run","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/runs","href":"/api-reference/runs/create-run"},{"title":"Get Run","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/runs/{run_id}","href":"/api-reference/runs/get-run"},{"title":"Delete Run","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/runs/{run_id}","href":"/api-reference/runs/delete-run"},{"title":"Update Run","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/runs/{run_id}","href":"/api-reference/runs/update-run"},{"title":"Get Run Image Signed Url","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/runs/{run_id}/image/signed-url","href":"/api-reference/runs/get-run-image-signed-url"},{"title":"Get Run Trajectory","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/runs/{run_id}/trajectory","href":"/api-reference/runs/get-run-trajectory"},{"title":"Generate Run Trajectory","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/runs/{run_id}/generate-trajectory","href":"/api-reference/runs/generate-run-trajectory"},{"title":"Create Run Chain","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/runs/chain","href":"/api-reference/runs/create-run-chain"},{"title":"Bulk Create Runs","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/runs/bulk","href":"/api-reference/runs/bulk-create-runs"},{"title":"Retry Run","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/runs/{run_id}/retry","href":"/api-reference/runs/retry-run"}]},{"group":"run-attachments","pages":[{"title":"List Run Attachments","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/run-attachments","href":"/api-reference/run-attachments/list-run-attachments"},{"title":"Create Run Attachment","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/run-attachments","href":"/api-reference/run-attachments/create-run-attachment"},{"title":"Get Run Attachment","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/run-attachments/{attachment_id}","href":"/api-reference/run-attachments/get-run-attachment"},{"title":"Update Run Attachment","deprecated":null,"version":null,"openapi":"/openapi.json put /v1/run-attachments/{attachment_id}","href":"/api-reference/run-attachments/update-run-attachment"},{"title":"Delete Run Attachment","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/run-attachments/{attachment_id}","href":"/api-reference/run-attachments/delete-run-attachment"},{"title":"Get Run Attachment Download Url","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/run-attachments/{attachment_id}/download-url","href":"/api-reference/run-attachments/get-run-attachment-download-url"},{"title":"Download Run Attachment","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/run-attachments/{attachment_id}/download","href":"/api-reference/run-attachments/download-run-attachment"}]},{"group":"connections","pages":[{"title":"List Connections","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/connections","href":"/api-reference/connections/list-connections"},{"title":"Create Connection","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/connections","href":"/api-reference/connections/create-connection"},{"title":"Get Connection","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/connections/{connection_id}","href":"/api-reference/connections/get-connection"},{"title":"Delete Connection","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/connections/{connection_id}","href":"/api-reference/connections/delete-connection"},{"title":"Update Connection","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/connections/{connection_id}","href":"/api-reference/connections/update-connection"}]},{"group":"request-logs","pages":[{"title":"List Request Logs","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/request-logs","href":"/api-reference/request-logs/list-request-logs"},{"title":"Create Request Log","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/request-logs","href":"/api-reference/request-logs/create-request-log"},{"title":"Get Request Log","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/request-logs/{log_id}","href":"/api-reference/request-logs/get-request-log"},{"title":"Delete Request Log","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/request-logs/{log_id}","href":"/api-reference/request-logs/delete-request-log"},{"title":"Update Request Log","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/request-logs/{log_id}","href":"/api-reference/request-logs/update-request-log"}]},{"group":"trajectories","pages":[{"title":"List Trajectories","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/trajectories","href":"/api-reference/trajectories/list-trajectories"},{"title":"Create Trajectory","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/trajectories","href":"/api-reference/trajectories/create-trajectory"},{"title":"Get Trajectory","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/trajectories/{trajectory_id}","href":"/api-reference/trajectories/get-trajectory"},{"title":"Delete Trajectory","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/trajectories/{trajectory_id}","href":"/api-reference/trajectories/delete-trajectory"},{"title":"Update Trajectory","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/trajectories/{trajectory_id}","href":"/api-reference/trajectories/update-trajectory"},{"title":"Duplicate Trajectory","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/trajectories/{trajectory_id}/duplicate","href":"/api-reference/trajectories/duplicate-trajectory"},{"title":"Get Latest Trajectory For Workflow","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/workflows/{workflow_id}/latest-trajectory","href":"/api-reference/trajectories/get-latest-trajectory-for-workflow"}]},{"group":"computer","pages":[{"title":"Take a screenshot","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/computer/{machine_id}/display/screenshot","href":"/api-reference/computer/take-a-screenshot"},{"title":"Get display dimensions","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/computer/{machine_id}/display/dimensions","href":"/api-reference/computer/get-display-dimensions"},{"title":"Type text","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/computer/{machine_id}/input/keyboard/type","href":"/api-reference/computer/type-text"},{"title":"Send key combination","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/computer/{machine_id}/input/keyboard/key","href":"/api-reference/computer/send-key-combination"},{"title":"Copy to clipboard via Ctrl+C","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/computer/{machine_id}/copy_to_clipboard","href":"/api-reference/computer/copy-to-clipboard-via-ctrl+c"},{"title":"Get mouse position","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/computer/{machine_id}/input/mouse/position","href":"/api-reference/computer/get-mouse-position"},{"title":"Move mouse cursor","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/computer/{machine_id}/input/mouse/move","href":"/api-reference/computer/move-mouse-cursor"},{"title":"Click mouse button","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/computer/{machine_id}/input/mouse/click","href":"/api-reference/computer/click-mouse-button"},{"title":"Scroll mouse wheel","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/computer/{machine_id}/input/mouse/scroll","href":"/api-reference/computer/scroll-mouse-wheel"},{"title":"Drag mouse (native)","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/computer/{machine_id}/input/mouse/drag","href":"/api-reference/computer/drag-mouse-native"},{"title":"List directory contents","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/computer/{machine_id}/fs/list","href":"/api-reference/computer/list-directory-contents"},{"title":"Read file contents","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/computer/{machine_id}/fs/read","href":"/api-reference/computer/read-file-contents"},{"title":"Write file contents","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/computer/{machine_id}/fs/write","href":"/api-reference/computer/write-file-contents"},{"title":"Run PowerShell simple smoke command","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/computer/{machine_id}/shell/powershell/simple","href":"/api-reference/computer/run-powershell-simple-smoke-command"},{"title":"Run PowerShell test smoke command","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/computer/{machine_id}/shell/powershell/test","href":"/api-reference/computer/run-powershell-test-smoke-command"},{"title":"Execute PowerShell command","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/computer/{machine_id}/shell/powershell/exec","href":"/api-reference/computer/execute-powershell-command"},{"title":"Manage PowerShell session","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/computer/{machine_id}/shell/powershell/session","href":"/api-reference/computer/manage-powershell-session"},{"title":"Get Cyberdriver diagnostics","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/computer/{machine_id}/internal/diagnostics","href":"/api-reference/computer/get-cyberdriver-diagnostics"},{"title":"Record remote keepalive activity","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/computer/{machine_id}/internal/keepalive/remote/activity","href":"/api-reference/computer/record-remote-keepalive-activity"},{"title":"Enable remote keepalive","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/computer/{machine_id}/internal/keepalive/remote/enable","href":"/api-reference/computer/enable-remote-keepalive"},{"title":"Disable remote keepalive","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/computer/{machine_id}/internal/keepalive/remote/disable","href":"/api-reference/computer/disable-remote-keepalive"},{"title":"Self-update Cyberdriver","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/computer/{machine_id}/internal/update","href":"/api-reference/computer/self-update-cyberdriver"},{"title":"Shutdown Cyberdriver via tunnel","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/machines/{machine_id}/cyberdriver/shutdown","href":"/api-reference/computer/shutdown-cyberdriver-via-tunnel"}]},{"group":"usage","pages":[{"title":"Get Usage Aggregate","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/usage/aggregate","href":"/api-reference/usage/get-usage-aggregate"}]},{"group":"cyberdriver-auth","pages":[{"title":"Login Options","deprecated":null,"version":null,"openapi":"/openapi.json get /api/login-options","href":"/api-reference/cyberdriver-auth/login-options"},{"title":"Oidc Auth","deprecated":null,"version":null,"openapi":"/openapi.json post /api/oidc/auth","href":"/api-reference/cyberdriver-auth/oidc-auth"},{"title":"Oidc Callback","deprecated":null,"version":null,"openapi":"/openapi.json get /api/oidc/callback","href":"/api-reference/cyberdriver-auth/oidc-callback"},{"title":"Oidc Confirm","deprecated":null,"version":null,"openapi":"/openapi.json post /api/oidc/confirm","href":"/api-reference/cyberdriver-auth/oidc-confirm"},{"title":"Oidc Auth Query","deprecated":null,"version":null,"openapi":"/openapi.json get /api/oidc/auth-query","href":"/api-reference/cyberdriver-auth/oidc-auth-query"},{"title":"Current User","deprecated":null,"version":null,"openapi":"/openapi.json post /api/currentUser","href":"/api-reference/cyberdriver-auth/current-user"},{"title":"Authorize Cyberdriver Connection","deprecated":null,"version":null,"openapi":"/openapi.json post /api/cyberdriver/authorize-connection","href":"/api-reference/cyberdriver-auth/authorize-cyberdriver-connection"},{"title":"Mint Cyberdriver Connection Token","deprecated":null,"version":null,"openapi":"/openapi.json post /api/cyberdriver/connection-token","href":"/api-reference/cyberdriver-auth/mint-cyberdriver-connection-token"},{"title":"Heartbeat","deprecated":null,"version":null,"openapi":"/openapi.json get /api/heartbeat","href":"/api-reference/cyberdriver-auth/heartbeat"},{"title":"Peers","deprecated":null,"version":null,"openapi":"/openapi.json get /api/peers","href":"/api-reference/cyberdriver-auth/peers"},{"title":"Users","deprecated":null,"version":null,"openapi":"/openapi.json get /api/users","href":"/api-reference/cyberdriver-auth/users"},{"title":"Device Group Accessible","deprecated":null,"version":null,"openapi":"/openapi.json get /api/device-group/accessible","href":"/api-reference/cyberdriver-auth/device-group-accessible"},{"title":"Address Book Personal","deprecated":null,"version":null,"openapi":"/openapi.json post /api/ab/personal","href":"/api-reference/cyberdriver-auth/address-book-personal"},{"title":"Address Book Settings","deprecated":null,"version":null,"openapi":"/openapi.json post /api/ab/settings","href":"/api-reference/cyberdriver-auth/address-book-settings"},{"title":"Address Book Shared Profiles","deprecated":null,"version":null,"openapi":"/openapi.json post /api/ab/shared/profiles","href":"/api-reference/cyberdriver-auth/address-book-shared-profiles"},{"title":"Address Book Peers","deprecated":null,"version":null,"openapi":"/openapi.json post /api/ab/peers","href":"/api-reference/cyberdriver-auth/address-book-peers"},{"title":"Address Book Tags","deprecated":null,"version":null,"openapi":"/openapi.json post /api/ab/tags/{_profile_guid}","href":"/api-reference/cyberdriver-auth/address-book-tags"},{"title":"Legacy Address Book","deprecated":null,"version":null,"openapi":"/openapi.json get /api/ab","href":"/api-reference/cyberdriver-auth/legacy-address-book"},{"title":"Save Legacy Address Book","deprecated":null,"version":null,"openapi":"/openapi.json post /api/ab","href":"/api-reference/cyberdriver-auth/save-legacy-address-book"}]},{"group":"API Reference","pages":[{"title":"Root","deprecated":null,"version":null,"openapi":"/openapi.json get /","href":"/api-reference/root"},{"title":"Health Live","deprecated":null,"version":null,"openapi":"/openapi.json get /health/live","href":"/api-reference/health-live"},{"title":"Health Ready","deprecated":null,"version":null,"openapi":"/openapi.json get /health/ready","href":"/api-reference/health-ready"},{"title":"Health","deprecated":null,"version":null,"openapi":"/openapi.json get /health","href":"/api-reference/health"},{"title":"Health Db","deprecated":null,"version":null,"openapi":"/openapi.json get /health/db","href":"/api-reference/health-db"},{"title":"Run complete webhook","version":null,"deprecated":null,"openapi":"/openapi.json webhook run_complete","href":"/api-reference/run-complete-webhook"},{"title":"Downed machines webhook","version":null,"deprecated":null,"openapi":"/openapi.json webhook downed_machines","href":"/api-reference/downed-machines-webhook"}]}]}]}]},"basePath":"","title":"Get Machine - Cyberdesk Docs","buildId":"dpl_42LwxxU1kGN114H4XzwGYXa9ZDah","deploymentId":"dpl_42LwxxU1kGN114H4XzwGYXa9ZDah","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-C-hEh3I2.js","utils-CnF4QiUD.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-C7PVNbel.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-8ytevL2A.js","snippetPresets-BT1alx3v.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-BLXC0i_W.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-CyLIGI9_.js","shallow-DC0lGVIW.js","getApiPlaygroundDisplay-CgDQ85tN.js","CodeSnippet-6-I-Gpv9.js","CodeSnippets-BAk1kDdu.js","Page-C945cI-W.js","getPastedJson-B276RuWN.js","icon-BqP8etTm.js","MethodPill-DM6sbxG1.js","DuplicateIcon-PyJglOaE.js","createIcon-CMeOMAc_.js","DynamicMarkdown-BoyYAA8K.js","SectionHeading-DAYv3gvZ.js","axios-vUo_bRtp.js","Markdown-BhTTmazV.js","clsx-CR-RHrVC.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CBUH0-zX.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BmARFYNC.js"]}