{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Bytebeam Docs","colors":{"primary":"#3573FF","light":"#3573FF","dark":"#3573FF"},"logo":{"light":"https://mintcdn.com/bytebeamio/WfNer47CK6ltJlI6/logo/light.svg?fit=max\u0026auto=format\u0026n=WfNer47CK6ltJlI6\u0026q=85\u0026s=f41016c84deff3a16c7cb944cf3fec9f","dark":"https://mintcdn.com/bytebeamio/WfNer47CK6ltJlI6/logo/dark.svg?fit=max\u0026auto=format\u0026n=WfNer47CK6ltJlI6\u0026q=85\u0026s=079cf44736ca5cd2c04fadb006ef87b9"},"favicon":"/favicon.svg","navbar":{"links":[{"href":"mailto:support@bytebeam.io","label":"Support"}],"primary":{"type":"button","label":"Get Access","href":"https://cal.com/kraviteja/bytebeam-101"}},"footer":{"socials":{"github":"https://github.com/bytebeamio","linkedin":"https://www.linkedin.com/company/bytebeam"}},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"Bytebeam","icon":"book-open-cover","href":"https://bytebeam.io"},{"anchor":"Community","icon":"discord","href":"https://discord.com/channels/1306597396544884736/1306597837777277000"},{"anchor":"Blog","icon":"newspaper","href":"https://bytebeam.io/blog/"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"bytebeamio","hasAudioNarration":false,"actualSubdomain":"bytebeamio","customDomains":["bytebeam.io"],"gitSource":{"type":"github","owner":"bytebeamio","repo":"bytebeam-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6a21e64f94a5dc2e6daf395d","collectionId":"4327b2aa-746d-44e6-8282-cd3273e0b9cc","schemaVersion":"v2"},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6a21e64f94a5dc2e6daf395d:success","clientVersion":"0.0.4044","searchFilterCounts":[{"language":"default","tag":"API Reference","count":247},{"language":"default","tag":"Platform Guide","count":246},{"language":"default","tag":"Release Notes","count":72},{"language":"default","tag":"devices","count":48},{"language":"default","tag":"Settings","count":43},{"language":"default","tag":"Actions","count":32},{"language":"default","tag":"admin","count":31},{"language":"default","tag":"Dashboards","count":29},{"language":"default","tag":"Inventory management","count":22},{"language":"default","tag":"Linux Integration","count":21}]},"assistantConfig":{},"basePath":"/docs","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":"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":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"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":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/devices/get-action-for-device","slug":"/api-reference/devices/get-action-for-device","pageMetadata":{"openapi":"get /api/v1/actions/{id}","title":"Get action for device","description":null,"href":"/api-reference/devices/get-action-for-device","hidden":false},"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":{"openapi":"get /api/v1/actions/{id}","title":"Get action for device","description":null,"href":"/api-reference/devices/get-action-for-device","hidden":false}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["devices"],"summary":"Get action for device","parameters":["b521426f-1cce-4a2c-9cd9-f3c0d69ad9c1"],"responses":{"200":"23734f99-8e09-4abf-8b15-178b40a6f084"},"method":"get","type":"path","servers":["b258fc3e-e306-4c2d-a92a-847daa1419db"],"security":["a77689de-6c95-4d4a-86cb-1c2261fb329b"],"path":"/api/v1/actions/{id}","baseUrlOptions":["https://cloud.bytebeam.io/"],"title":"Get action for device","description":"","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"b521426f-1cce-4a2c-9cd9-f3c0d69ad9c1":{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64","isRequired":true,"uniqueKey":"","typeLabel":"integer\u003cint64>"}}},"responses":{"23734f99-8e09-4abf-8b15-178b40a6f084":{"description":"","content":{"application/json":{"schema":{"required":["action_id","created_at","payload_type","statuses","statuses_phased","type","user_email","user_name"],"type":"object","properties":{"payload_type":{"type":"string","enum":["json","none","text","file"],"isRequired":true,"uniqueKey":"payload_type","typeLabel":"enum\u003cstring>"},"type":{"type":"string","isRequired":true,"uniqueKey":"type","typeLabel":"string"},"user_email":{"type":"string","isRequired":true,"uniqueKey":"user_email","typeLabel":"string"},"action_id":{"type":"integer","format":"int64","isRequired":true,"uniqueKey":"action_id","typeLabel":"integer\u003cint64>"},"user_name":{"type":"string","isRequired":true,"uniqueKey":"user_name","typeLabel":"string"},"created_at":{"type":"object","isRequired":true,"uniqueKey":"created_at","typeLabel":"object"},"statuses":{"type":"object","additionalProperties":{"type":"integer","format":"int64","uniqueKey":"statuses.additionalProperties","typeLabel":"integer\u003cint64>"},"isRequired":true,"uniqueKey":"statuses","typeLabel":"object"},"statuses_phased":{"type":"object","additionalProperties":{"type":"object","additionalProperties":{"type":"integer","format":"int64","uniqueKey":"statuses_phased.additionalProperties.additionalProperties","typeLabel":"integer\u003cint64>"},"uniqueKey":"statuses_phased.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"statuses_phased","typeLabel":"object"},"schedule":{"required":["end_timestamp","id","next_phase_index","phases","phases_triggered","retry_on_failure_until","status","tenant_id"],"type":"object","properties":{"phases_triggered":{"type":"array","items":{"type":"boolean","uniqueKey":"schedule.phases_triggered.items.[INDEX]","typeLabel":"boolean"},"isRequired":true,"uniqueKey":"schedule.phases_triggered","typeLabel":"boolean[]"},"next_phase_index":{"type":"integer","format":"int64","isRequired":true,"uniqueKey":"schedule.next_phase_index","typeLabel":"integer\u003cint64>"},"end_timestamp":{"type":"integer","format":"int64","isRequired":true,"uniqueKey":"schedule.end_timestamp","typeLabel":"integer\u003cint64>"},"retry_on_failure_until":{"type":"integer","format":"int64","isRequired":true,"uniqueKey":"schedule.retry_on_failure_until","typeLabel":"integer\u003cint64>"},"phases":{"type":"array","items":{"required":["info","name","trigger_on"],"type":"object","properties":{"name":{"type":"string","isRequired":true,"uniqueKey":"schedule.phases.items.[INDEX].name","typeLabel":"string"},"trigger_on":{"type":"object","x-oneOf":[{"$ref":"#/components/schemas/ActionsRequestSchedulePhasesTriggerOn"},{"$ref":"#/components/schemas/ActionsRequestSchedulePhasesTriggerOn"}],"isRequired":true,"uniqueKey":"schedule.phases.items.[INDEX].trigger_on","typeLabel":"object"},"info":{"type":"object","x-oneOf":[{"$ref":"#/components/schemas/ActionsRequestSchedulePhasesInfo"},{"$ref":"#/components/schemas/ActionsRequestSchedulePhasesInfo"}],"isRequired":true,"uniqueKey":"schedule.phases.items.[INDEX].info","typeLabel":"object"}},"additionalProperties":false,"uniqueKey":"schedule.phases.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"schedule.phases","typeLabel":"object[]"},"status":{"type":"string","isRequired":true,"uniqueKey":"schedule.status","typeLabel":"string"},"id":{"type":"integer","format":"int64","isRequired":true,"uniqueKey":"schedule.id","typeLabel":"integer\u003cint64>"},"tenant_id":{"type":"string","isRequired":true,"uniqueKey":"schedule.tenant_id","typeLabel":"string"},"release_notes":{"type":"string","uniqueKey":"schedule.release_notes","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"schedule","typeLabel":"object"}},"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"payload_type":"json","type":"\u003cstring>","user_email":"\u003cstring>","action_id":123,"user_name":"\u003cstring>","created_at":{},"statuses":{},"statuses_phased":{},"schedule":{"phases_triggered":[true],"next_phase_index":123,"end_timestamp":123,"retry_on_failure_until":123,"phases":[{"name":"\u003cstring>","trigger_on":{},"info":{}}],"status":"\u003cstring>","id":123,"tenant_id":"\u003cstring>","release_notes":"\u003cstring>"}}}},"exampleType":"generated"},"application/transit+msgpack":{"schema":{"required":["action_id","created_at","payload_type","statuses","statuses_phased","type","user_email","user_name"],"type":"object","properties":{"payload_type":{"type":"string","enum":["json","none","text","file"],"isRequired":true,"uniqueKey":"payload_type","typeLabel":"enum\u003cstring>"},"type":{"type":"string","isRequired":true,"uniqueKey":"type","typeLabel":"string"},"user_email":{"type":"string","isRequired":true,"uniqueKey":"user_email","typeLabel":"string"},"action_id":{"type":"integer","format":"int64","isRequired":true,"uniqueKey":"action_id","typeLabel":"integer\u003cint64>"},"user_name":{"type":"string","isRequired":true,"uniqueKey":"user_name","typeLabel":"string"},"created_at":{"type":"object","isRequired":true,"uniqueKey":"created_at","typeLabel":"object"},"statuses":{"type":"object","additionalProperties":{"type":"integer","format":"int64","uniqueKey":"statuses.additionalProperties","typeLabel":"integer\u003cint64>"},"isRequired":true,"uniqueKey":"statuses","typeLabel":"object"},"statuses_phased":{"type":"object","additionalProperties":{"type":"object","additionalProperties":{"type":"integer","format":"int64","uniqueKey":"statuses_phased.additionalProperties.additionalProperties","typeLabel":"integer\u003cint64>"},"uniqueKey":"statuses_phased.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"statuses_phased","typeLabel":"object"},"schedule":{"required":["end_timestamp","id","next_phase_index","phases","phases_triggered","retry_on_failure_until","status","tenant_id"],"type":"object","properties":{"phases_triggered":{"type":"array","items":{"type":"boolean","uniqueKey":"schedule.phases_triggered.items.[INDEX]","typeLabel":"boolean"},"isRequired":true,"uniqueKey":"schedule.phases_triggered","typeLabel":"boolean[]"},"next_phase_index":{"type":"integer","format":"int64","isRequired":true,"uniqueKey":"schedule.next_phase_index","typeLabel":"integer\u003cint64>"},"end_timestamp":{"type":"integer","format":"int64","isRequired":true,"uniqueKey":"schedule.end_timestamp","typeLabel":"integer\u003cint64>"},"retry_on_failure_until":{"type":"integer","format":"int64","isRequired":true,"uniqueKey":"schedule.retry_on_failure_until","typeLabel":"integer\u003cint64>"},"phases":{"type":"array","items":{"required":["info","name","trigger_on"],"type":"object","properties":{"name":{"type":"string","isRequired":true,"uniqueKey":"schedule.phases.items.[INDEX].name","typeLabel":"string"},"trigger_on":{"type":"object","x-oneOf":[{"$ref":"#/components/schemas/ActionsRequestSchedulePhasesTriggerOn"},{"$ref":"#/components/schemas/ActionsRequestSchedulePhasesTriggerOn"}],"isRequired":true,"uniqueKey":"schedule.phases.items.[INDEX].trigger_on","typeLabel":"object"},"info":{"type":"object","x-oneOf":[{"$ref":"#/components/schemas/ActionsRequestSchedulePhasesInfo"},{"$ref":"#/components/schemas/ActionsRequestSchedulePhasesInfo"}],"isRequired":true,"uniqueKey":"schedule.phases.items.[INDEX].info","typeLabel":"object"}},"additionalProperties":false,"uniqueKey":"schedule.phases.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"schedule.phases","typeLabel":"object[]"},"status":{"type":"string","isRequired":true,"uniqueKey":"schedule.status","typeLabel":"string"},"id":{"type":"integer","format":"int64","isRequired":true,"uniqueKey":"schedule.id","typeLabel":"integer\u003cint64>"},"tenant_id":{"type":"string","isRequired":true,"uniqueKey":"schedule.tenant_id","typeLabel":"string"},"release_notes":{"type":"string","uniqueKey":"schedule.release_notes","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"schedule","typeLabel":"object"}},"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"payload_type":"json","type":"\u003cstring>","user_email":"\u003cstring>","action_id":123,"user_name":"\u003cstring>","created_at":{},"statuses":{},"statuses_phased":{},"schedule":{"phases_triggered":[true],"next_phase_index":123,"end_timestamp":123,"retry_on_failure_until":123,"phases":[{"name":"\u003cstring>","trigger_on":{},"info":{}}],"status":"\u003cstring>","id":123,"tenant_id":"\u003cstring>","release_notes":"\u003cstring>"}}}},"exampleType":"generated"},"application/transit+json":{"schema":{"required":["action_id","created_at","payload_type","statuses","statuses_phased","type","user_email","user_name"],"type":"object","properties":{"payload_type":{"type":"string","enum":["json","none","text","file"],"isRequired":true,"uniqueKey":"payload_type","typeLabel":"enum\u003cstring>"},"type":{"type":"string","isRequired":true,"uniqueKey":"type","typeLabel":"string"},"user_email":{"type":"string","isRequired":true,"uniqueKey":"user_email","typeLabel":"string"},"action_id":{"type":"integer","format":"int64","isRequired":true,"uniqueKey":"action_id","typeLabel":"integer\u003cint64>"},"user_name":{"type":"string","isRequired":true,"uniqueKey":"user_name","typeLabel":"string"},"created_at":{"type":"object","isRequired":true,"uniqueKey":"created_at","typeLabel":"object"},"statuses":{"type":"object","additionalProperties":{"type":"integer","format":"int64","uniqueKey":"statuses.additionalProperties","typeLabel":"integer\u003cint64>"},"isRequired":true,"uniqueKey":"statuses","typeLabel":"object"},"statuses_phased":{"type":"object","additionalProperties":{"type":"object","additionalProperties":{"type":"integer","format":"int64","uniqueKey":"statuses_phased.additionalProperties.additionalProperties","typeLabel":"integer\u003cint64>"},"uniqueKey":"statuses_phased.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"statuses_phased","typeLabel":"object"},"schedule":{"required":["end_timestamp","id","next_phase_index","phases","phases_triggered","retry_on_failure_until","status","tenant_id"],"type":"object","properties":{"phases_triggered":{"type":"array","items":{"type":"boolean","uniqueKey":"schedule.phases_triggered.items.[INDEX]","typeLabel":"boolean"},"isRequired":true,"uniqueKey":"schedule.phases_triggered","typeLabel":"boolean[]"},"next_phase_index":{"type":"integer","format":"int64","isRequired":true,"uniqueKey":"schedule.next_phase_index","typeLabel":"integer\u003cint64>"},"end_timestamp":{"type":"integer","format":"int64","isRequired":true,"uniqueKey":"schedule.end_timestamp","typeLabel":"integer\u003cint64>"},"retry_on_failure_until":{"type":"integer","format":"int64","isRequired":true,"uniqueKey":"schedule.retry_on_failure_until","typeLabel":"integer\u003cint64>"},"phases":{"type":"array","items":{"required":["info","name","trigger_on"],"type":"object","properties":{"name":{"type":"string","isRequired":true,"uniqueKey":"schedule.phases.items.[INDEX].name","typeLabel":"string"},"trigger_on":{"type":"object","x-oneOf":[{"$ref":"#/components/schemas/ActionsRequestSchedulePhasesTriggerOn"},{"$ref":"#/components/schemas/ActionsRequestSchedulePhasesTriggerOn"}],"isRequired":true,"uniqueKey":"schedule.phases.items.[INDEX].trigger_on","typeLabel":"object"},"info":{"type":"object","x-oneOf":[{"$ref":"#/components/schemas/ActionsRequestSchedulePhasesInfo"},{"$ref":"#/components/schemas/ActionsRequestSchedulePhasesInfo"}],"isRequired":true,"uniqueKey":"schedule.phases.items.[INDEX].info","typeLabel":"object"}},"additionalProperties":false,"uniqueKey":"schedule.phases.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"schedule.phases","typeLabel":"object[]"},"status":{"type":"string","isRequired":true,"uniqueKey":"schedule.status","typeLabel":"string"},"id":{"type":"integer","format":"int64","isRequired":true,"uniqueKey":"schedule.id","typeLabel":"integer\u003cint64>"},"tenant_id":{"type":"string","isRequired":true,"uniqueKey":"schedule.tenant_id","typeLabel":"string"},"release_notes":{"type":"string","uniqueKey":"schedule.release_notes","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"schedule","typeLabel":"object"}},"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"payload_type":"json","type":"\u003cstring>","user_email":"\u003cstring>","action_id":123,"user_name":"\u003cstring>","created_at":{},"statuses":{},"statuses_phased":{},"schedule":{"phases_triggered":[true],"next_phase_index":123,"end_timestamp":123,"retry_on_failure_until":123,"phases":[{"name":"\u003cstring>","trigger_on":{},"info":{}}],"status":"\u003cstring>","id":123,"tenant_id":"\u003cstring>","release_notes":"\u003cstring>"}}}},"exampleType":"generated"},"application/edn":{"schema":{"required":["action_id","created_at","payload_type","statuses","statuses_phased","type","user_email","user_name"],"type":"object","properties":{"payload_type":{"type":"string","enum":["json","none","text","file"],"isRequired":true,"uniqueKey":"payload_type","typeLabel":"enum\u003cstring>"},"type":{"type":"string","isRequired":true,"uniqueKey":"type","typeLabel":"string"},"user_email":{"type":"string","isRequired":true,"uniqueKey":"user_email","typeLabel":"string"},"action_id":{"type":"integer","format":"int64","isRequired":true,"uniqueKey":"action_id","typeLabel":"integer\u003cint64>"},"user_name":{"type":"string","isRequired":true,"uniqueKey":"user_name","typeLabel":"string"},"created_at":{"type":"object","isRequired":true,"uniqueKey":"created_at","typeLabel":"object"},"statuses":{"type":"object","additionalProperties":{"type":"integer","format":"int64","uniqueKey":"statuses.additionalProperties","typeLabel":"integer\u003cint64>"},"isRequired":true,"uniqueKey":"statuses","typeLabel":"object"},"statuses_phased":{"type":"object","additionalProperties":{"type":"object","additionalProperties":{"type":"integer","format":"int64","uniqueKey":"statuses_phased.additionalProperties.additionalProperties","typeLabel":"integer\u003cint64>"},"uniqueKey":"statuses_phased.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"statuses_phased","typeLabel":"object"},"schedule":{"required":["end_timestamp","id","next_phase_index","phases","phases_triggered","retry_on_failure_until","status","tenant_id"],"type":"object","properties":{"phases_triggered":{"type":"array","items":{"type":"boolean","uniqueKey":"schedule.phases_triggered.items.[INDEX]","typeLabel":"boolean"},"isRequired":true,"uniqueKey":"schedule.phases_triggered","typeLabel":"boolean[]"},"next_phase_index":{"type":"integer","format":"int64","isRequired":true,"uniqueKey":"schedule.next_phase_index","typeLabel":"integer\u003cint64>"},"end_timestamp":{"type":"integer","format":"int64","isRequired":true,"uniqueKey":"schedule.end_timestamp","typeLabel":"integer\u003cint64>"},"retry_on_failure_until":{"type":"integer","format":"int64","isRequired":true,"uniqueKey":"schedule.retry_on_failure_until","typeLabel":"integer\u003cint64>"},"phases":{"type":"array","items":{"required":["info","name","trigger_on"],"type":"object","properties":{"name":{"type":"string","isRequired":true,"uniqueKey":"schedule.phases.items.[INDEX].name","typeLabel":"string"},"trigger_on":{"type":"object","x-oneOf":[{"$ref":"#/components/schemas/ActionsRequestSchedulePhasesTriggerOn"},{"$ref":"#/components/schemas/ActionsRequestSchedulePhasesTriggerOn"}],"isRequired":true,"uniqueKey":"schedule.phases.items.[INDEX].trigger_on","typeLabel":"object"},"info":{"type":"object","x-oneOf":[{"$ref":"#/components/schemas/ActionsRequestSchedulePhasesInfo"},{"$ref":"#/components/schemas/ActionsRequestSchedulePhasesInfo"}],"isRequired":true,"uniqueKey":"schedule.phases.items.[INDEX].info","typeLabel":"object"}},"additionalProperties":false,"uniqueKey":"schedule.phases.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"schedule.phases","typeLabel":"object[]"},"status":{"type":"string","isRequired":true,"uniqueKey":"schedule.status","typeLabel":"string"},"id":{"type":"integer","format":"int64","isRequired":true,"uniqueKey":"schedule.id","typeLabel":"integer\u003cint64>"},"tenant_id":{"type":"string","isRequired":true,"uniqueKey":"schedule.tenant_id","typeLabel":"string"},"release_notes":{"type":"string","uniqueKey":"schedule.release_notes","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"schedule","typeLabel":"object"}},"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"payload_type":"json","type":"\u003cstring>","user_email":"\u003cstring>","action_id":123,"user_name":"\u003cstring>","created_at":{},"statuses":{},"statuses_phased":{},"schedule":{"phases_triggered":[true],"next_phase_index":123,"end_timestamp":123,"retry_on_failure_until":123,"phases":[{"name":"\u003cstring>","trigger_on":{},"info":{}}],"status":"\u003cstring>","id":123,"tenant_id":"\u003cstring>","release_notes":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"a77689de-6c95-4d4a-86cb-1c2261fb329b":{"apiKeyAuth":{"type":"apiKey","name":"x-bytebeam-api-key","in":"header","description":"API key required to authenticate requests.","scopes":[]},"tenantAuth":{"type":"apiKey","name":"x-bytebeam-tenant","in":"header","description":"Tenant(Project) name required to identify the project.","scopes":[]}}},"servers":{"b258fc3e-e306-4c2d-a92a-847daa1419db":{"url":"https://cloud.bytebeam.io/"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","name":"x-bytebeam-api-key","in":"header","description":"API key required to authenticate requests.","scopes":[]},"schema":{"title":"x-bytebeam-api-key","type":"string","description":"API key required to authenticate requests.","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"apiKeyAuth","name":"x-bytebeam-api-key"},{"scheme":{"type":"apiKey","name":"x-bytebeam-tenant","in":"header","description":"Tenant(Project) name required to identify the project.","scopes":[]},"schema":{"title":"x-bytebeam-tenant","type":"string","description":"Tenant(Project) name required to identify the project.","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"tenantAuth","name":"x-bytebeam-tenant"}],"title":"apiKeyAuth \u0026 tenantAuth"}]},"originalFileLocation":"api-reference/openapi.yaml"},"subdomain":"bytebeamio","siteName":"Bytebeam Docs","title":"Get action for device - Bytebeam Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-03-03T13:15:17.560Z","originalFileLocation":"api-reference/devices/get-action-for-device.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=\"Bytebeam Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/bytebeamio/Et4_obTvFXed0p5n/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/docs/mintlify-assets/_mintlify/favicons/bytebeamio/Et4_obTvFXed0p5n/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/bytebeamio/Et4_obTvFXed0p5n/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/bytebeamio/Et4_obTvFXed0p5n/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/bytebeamio/Et4_obTvFXed0p5n/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/bytebeamio/Et4_obTvFXed0p5n/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/bytebeamio/Et4_obTvFXed0p5n/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/bytebeamio/Et4_obTvFXed0p5n/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/bytebeamio/Et4_obTvFXed0p5n/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get action for device - Bytebeam Docs\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Bytebeam Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://bytebeam.io/docs/api-reference/devices/get-action-for-device\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://bytebeamio.mintlify.app/_mintlify/api/og/v2?division=devices\u0026amp;title=Get+action+for+device\u0026amp;theme=88c16858a93f3aaa20738c7a\u0026amp;signature=b7642b77b8971cddc3b29a707a8ee9ceceddd0a73b2535b97f0b7239812a305b\">\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 action for device - Bytebeam Docs\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://bytebeamio.mintlify.app/_mintlify/api/og/v2?division=devices\u0026amp;title=Get+action+for+device\u0026amp;theme=88c16858a93f3aaa20738c7a\u0026amp;signature=b7642b77b8971cddc3b29a707a8ee9ceceddd0a73b2535b97f0b7239812a305b\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/docs/mintlify-assets/_mintlify/favicons/bytebeamio/Et4_obTvFXed0p5n/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Bytebeam Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#3573FF\">\u003clink data-mint-head rel=\"canonical\" href=\"https://bytebeam.io/docs/api-reference/devices/get-action-for-device\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/docs/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/docs/api-reference/devices/get-action-for-device.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://bytebeam.io/#organization\",\"name\":\"Bytebeam Docs\",\"url\":\"https://bytebeam.io\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/bytebeamio/WfNer47CK6ltJlI6/logo/light.svg?fit=max\u0026auto=format\u0026n=WfNer47CK6ltJlI6\u0026q=85\u0026s=f41016c84deff3a16c7cb944cf3fec9f\"}},{\"@type\":\"WebSite\",\"@id\":\"https://bytebeam.io/docs#website\",\"name\":\"Bytebeam Docs\",\"url\":\"https://bytebeam.io/docs\",\"publisher\":{\"@id\":\"https://bytebeam.io/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://bytebeam.io/docs/api-reference/devices/get-action-for-device#webpage\",\"url\":\"https://bytebeam.io/docs/api-reference/devices/get-action-for-device\",\"name\":\"Get action for device\",\"dateModified\":\"2026-03-03T13:15:17.560Z\",\"isPartOf\":{\"@id\":\"https://bytebeam.io/docs#website\"},\"breadcrumb\":{\"@id\":\"https://bytebeam.io/docs/api-reference/devices/get-action-for-device#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://bytebeam.io/docs/api-reference/devices/get-action-for-device#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"devices\",\"item\":\"https://bytebeam.io/docs/api-reference/devices/get-the-list-of-devices--paginated\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Get action for device\",\"item\":\"https://bytebeam.io/docs/api-reference/devices/get-action-for-device\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://bytebeam.io/docs/api-reference/devices/get-action-for-device#apireference\",\"headline\":\"Get action for device\",\"name\":\"Get action for device\",\"url\":\"https://bytebeam.io/docs/api-reference/devices/get-action-for-device\",\"mainEntityOfPage\":{\"@id\":\"https://bytebeam.io/docs/api-reference/devices/get-action-for-device#webpage\"},\"dateModified\":\"2026-03-03T13:15:17.560Z\",\"publisher\":{\"@id\":\"https://bytebeam.io/#organization\"},\"isPartOf\":{\"@id\":\"https://bytebeam.io/docs#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Bytebeam Docs\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Bytebeam Docs","nav":{"global":{"anchors":[{"anchor":"Bytebeam","icon":"book-open-cover","href":"https://bytebeam.io"},{"anchor":"Community","icon":"discord","href":"https://discord.com/channels/1306597396544884736/1306597837777277000"},{"anchor":"Blog","icon":"newspaper","href":"https://bytebeam.io/blog/"}]},"tabs":[{"tab":"Getting Started","pages":[{"title":"Getting Started","href":"/getting-started/signup"}]},{"tab":"Platform Guide","pages":[{"title":"Platform Guide","href":"/platform-guide/introduction"}]},{"tab":"MCU Integration","pages":[{"title":"MCU Integration","href":"/device-side-integrations/mcu/esp32/esp-idf/setting-up-bytebeam-esp-idf-sdk"}]},{"tab":"Linux Integration","pages":[{"title":"Linux Integration","href":"/device-side-integrations/linux/device-setup/raspberry-pi"}]},{"tab":"Android Integration","pages":[{"title":"Android Integration","href":"/device-side-integrations/android/device-setup"}]},{"tab":"Custom Integration","pages":[{"title":"Custom Integration","href":"/device-side-integrations/custom/connecting-to-bytebeam-cloud"}]},{"tab":"API Reference","groups":[{"group":"devices","pages":[{"openapi":"get /api/v1/devices","title":"Get the list of devices - paginated.","href":"/api-reference/devices/get-the-list-of-devices--paginated"},{"openapi":"get /api/v1/devices/count","title":"Return the count of devices for pagination","href":"/api-reference/devices/return-the-count-of-devices-for-pagination"},{"openapi":"put /api/v1/devices/{device-id}","title":"Allows update status of a device","href":"/api-reference/devices/allows-update-status-of-a-device"},{"openapi":"get /api/v1/devices/search","title":"Find devices by device state keys","href":"/api-reference/devices/find-devices-by-device-state-keys"},{"openapi":"post /api/v1/actions","title":"Trigger an action on a bunch of devices.","description":null,"href":"/api-reference/devices/trigger-an-action-on-a-bunch-of-devices"},{"openapi":"get /api/v1/actions/{id}","title":"Get action for device","href":"/api-reference/devices/get-action-for-device"},{"openapi":"get /api/v1/actions/{id}/params","title":"Get params for an action","description":null,"href":"/api-reference/devices/get-params-for-an-action"},{"openapi":"get /api/v1/actions/{id}/progress_histogram","title":"Return stats about the progress of various devices this action was triggered on","href":"/api-reference/devices/return-stats-about-the-progress-of-various-devices-this-action-was-triggered-on"},{"openapi":"get /api/v1/actions/{action-id}/device_actions/{device-id}/logs","title":"Return logs of actions per device","href":"/api-reference/devices/return-logs-of-actions-per-device"},{"openapi":"get /api/v1/actions/{id}/device_actions","title":"Return paginated progress of actions per device","href":"/api-reference/devices/return-paginated-progress-of-actions-per-device"},{"openapi":"post /api/v1/actions/request","title":"Request to trigger actions; someone with permission will approve","href":"/api-reference/devices/request-to-trigger-actions;-someone-with-permission-will-approve"},{"openapi":"put /api/v1/actions/{id}/approve","title":"Approve an action","href":"/api-reference/devices/approve-an-action"},{"openapi":"put /api/v1/actions/mark_as_completed","title":"Mark all actions for devices matching the filters as completed","href":"/api-reference/devices/mark-all-actions-for-devices-matching-the-filters-as-completed"},{"openapi":"put /api/v1/actions/{id}/mark_as_completed","title":"Mark a subset of devices for an action as completed","href":"/api-reference/devices/mark-a-subset-of-devices-for-an-action-as-completed"},{"openapi":"post /api/v1/actions/{action_id}/cancel","title":"Attempt cancelling this action","href":"/api-reference/devices/attempt-cancelling-this-action"},{"openapi":"get /api/v1/actions/{id}/error-stats","title":null,"href":"/api-reference/devices/get-apiv1actions-error-stats"},{"openapi":"post /api/v1/actions/{action_id}/device-latencies","title":null,"href":"/api-reference/devices/post-apiv1actions-device-latencies"},{"openapi":"get /api/v1/actions/{action-id}/device-latencies/states","title":null,"href":"/api-reference/devices/get-apiv1actions-device-latenciesstates"},{"openapi":"post /api/v1/actions/{action_id}/retry","title":"Retry an action on some devices","href":"/api-reference/devices/retry-an-action-on-some-devices"},{"openapi":"post /api/v1/pending-actions","title":"Return all pending actions for devices matching the given filters","href":"/api-reference/devices/return-all-pending-actions-for-devices-matching-the-given-filters"},{"openapi":"get /api/v1/action-types","title":"Returns a list of all action types","href":"/api-reference/devices/returns-a-list-of-all-action-types"},{"openapi":"post /api/v1/action-types","title":"Creates a new action-type","href":"/api-reference/devices/creates-a-new-action-type"},{"openapi":"put /api/v1/action-types/{action-type-name}/reactivate","title":"Updates an existing action type","href":"/api-reference/devices/updates-an-existing-action-type"},{"openapi":"put /api/v1/action-types/{action-type-name}","title":"Updates an existing action type","href":"/api-reference/devices/updates-an-existing-action-type-1"},{"openapi":"delete /api/v1/action-types/{action-type-name}","title":"Delete an action-type","href":"/api-reference/devices/delete-an-action-type"},{"openapi":"post /api/v1/devices/metadata","title":"Update metadata(s) for a device(s)","href":"/api-reference/devices/update-metadatas-for-a-devices"},{"openapi":"post /api/v1/devices/metadata-bulk","title":"Takes a csv file and updates the metadata for a device","href":"/api-reference/devices/takes-a-csv-file-and-updates-the-metadata-for-a-device"},{"openapi":"put /api/v1/devices/metadata-keys/{existing-key}/mark-as-serial","title":"Mark an existing metadata-key as serial number","href":"/api-reference/devices/mark-an-existing-metadata-key-as-serial-number"},{"openapi":"put /api/v1/devices/metadata-keys/{existing-key}/unmark-as-serial","title":"Mark an existing metadata-key as serial number","href":"/api-reference/devices/mark-an-existing-metadata-key-as-serial-number-1"},{"openapi":"get /api/v1/devices/metadata-bulk-template","title":"Returns a csv file template for updating metadata for a device","href":"/api-reference/devices/returns-a-csv-file-template-for-updating-metadata-for-a-device"},{"openapi":"get /api/v1/devices/metadata-keys","title":"Get a list of metadata-keys","href":"/api-reference/devices/get-a-list-of-metadata-keys"},{"openapi":"post /api/v1/devices/metadata-keys","title":"Create a metadata-key","href":"/api-reference/devices/create-a-metadata-key"},{"openapi":"delete /api/v1/devices/metadata-keys/{metadata-key}","title":"Delete a metadata-key","href":"/api-reference/devices/delete-a-metadata-key"},{"openapi":"post /api/v1/devices/provision","title":"Provision a device. returns cert \u0026 keys","href":"/api-reference/devices/provision-a-device-returns-cert-\u0026-keys"},{"openapi":"get /api/v1/devices/{device-id}/cert","title":"Download cert for a device given device-id","href":"/api-reference/devices/download-cert-for-a-device-given-device-id"},{"openapi":"get /api/v1/firmwares","title":"Return the list of all firmwares","href":"/api-reference/devices/return-the-list-of-all-firmwares"},{"openapi":"post /api/v1/firmwares","title":"Create firmware version","href":"/api-reference/devices/create-firmware-version"},{"openapi":"put /api/v1/firmwares/{version-number}","title":"Updates firmware version to be activated or deactivated ","href":"/api-reference/devices/updates-firmware-version-to-be-activated-or-deactivated"},{"openapi":"put /api/v1/firmwares/component/{component-name}/{version-number}","title":"Updates firmware version to be activated or deactivated ","href":"/api-reference/devices/updates-firmware-version-to-be-activated-or-deactivated-1"},{"openapi":"get /api/v1/firmwares/{version-number}/artifact","title":"Download a firmware by version","href":"/api-reference/devices/download-a-firmware-by-version"},{"openapi":"head /api/v1/firmwares/{version-number}/artifact","title":null,"href":"/api-reference/devices/head-endpoint-to-check-metadata-about-file-download"},{"openapi":"get /api/v1/firmwares/component/{component-name}/{version-number}/artifact","title":"Download a firmware by component name and version","href":"/api-reference/devices/download-a-firmware-by-component-name-and-version"},{"openapi":"head /api/v1/firmwares/component/{component-name}/{version-number}/artifact","title":null,"href":"/api-reference/devices/head-endpoint-to-check-metadata-about-file-download-1"},{"openapi":"get /api/v1/firmwares/components","title":"Return the list of firmwares for components","href":"/api-reference/devices/return-the-list-of-firmwares-for-components"},{"openapi":"get /api/v1/firmwares/component/{component-name}","title":"Return the list of all firmware versions of given component","href":"/api-reference/devices/return-the-list-of-all-firmware-versions-of-given-component"},{"openapi":"get /api/v1/device-configs","title":"Get the list of Device Configurations","href":"/api-reference/devices/get-the-list-of-device-configurations"},{"openapi":"post /api/v1/device-configs","title":"Create new Device Configuration","href":"/api-reference/devices/create-new-device-configuration"},{"openapi":"get /api/v1/device-configs/{version-name}","title":"Get device config by version name","href":"/api-reference/devices/get-device-config-by-version-name"}]},{"group":"API Reference","pages":[{"openapi":"get /api/v1/devices/state-keys","title":null,"href":"/api-reference/get-apiv1devicesstate-keys"},{"openapi":"post /api/v1/devices/search","title":"Search device by metadata","href":"/api-reference/search-device-by-metadata"},{"openapi":"post /api/v1/devices/action/status","title":"Updates the status of the action triggered on the device","href":"/api-reference/updates-the-status-of-the-action-triggered-on-the-device"},{"openapi":"get /api/v1/devices/filter-options","title":"Get metadata key and available options","href":"/api-reference/get-metadata-key-and-available-options"},{"openapi":"get /api/v1/devices/{device_id}/actions","title":"Get device actions given device id","href":"/api-reference/get-device-actions-given-device-id"},{"openapi":"get /api/v1/devices/{device_id}/actions/filter-options","title":"Returns available filters for searching actions of a device","href":"/api-reference/returns-available-filters-for-searching-actions-of-a-device"},{"openapi":"put /api/v1/devices/{id}/actions/mark_as_completed","title":"Mark all device actions given device id as completed","href":"/api-reference/mark-all-device-actions-given-device-id-as-completed"},{"openapi":"get /api/v1/device_components","title":"Get all device components","href":"/api-reference/get-all-device-components"},{"openapi":"get /api/v1/actions","title":"Show overall progress of actions triggered","href":"/api-reference/show-overall-progress-of-actions-triggered"},{"openapi":"get /api/v1/actions/filter-options","title":"Takes a filter and returns parameters matching that filter","href":"/api-reference/takes-a-filter-and-returns-parameters-matching-that-filter"},{"openapi":"get /api/v1/firmware-bundles","title":null,"href":"/api-reference/get-apiv1firmware-bundles"},{"openapi":"post /api/v1/firmware-bundles","title":null,"href":"/api-reference/post-apiv1firmware-bundles"},{"openapi":"get /api/v1/firmware-bundles/id/{firmware-bundle-id}","title":null,"href":"/api-reference/get-apiv1firmware-bundlesid"},{"openapi":"put /api/v1/firmware-bundles/id/{firmware-bundle-id}","title":null,"href":"/api-reference/put-apiv1firmware-bundlesid"},{"openapi":"delete /api/v1/firmware-bundles/id/{firmware-bundle-id}","title":null,"href":"/api-reference/delete-apiv1firmware-bundlesid"},{"openapi":"get /api/v1/firmware-bundles/version/{version}","title":null,"href":"/api-reference/get-apiv1firmware-bundlesversion"},{"openapi":"put /api/v1/firmware-bundles/version/{version}","title":null,"href":"/api-reference/put-apiv1firmware-bundlesversion"},{"openapi":"delete /api/v1/firmware-bundles/version/{version}","title":null,"href":"/api-reference/delete-apiv1firmware-bundlesversion"},{"openapi":"get /api/v1/firmware-bundles/{firmware-bundle-id}/artifact","title":null,"href":"/api-reference/get-apiv1firmware-bundles-artifact"},{"openapi":"head /api/v1/firmware-bundles/{firmware-bundle-id}/artifact","title":null,"href":"/api-reference/head-apiv1firmware-bundles-artifact"},{"openapi":"get /api/v1/tenants","title":"Returns list of tenants","href":"/api-reference/returns-list-of-tenants"},{"openapi":"post /api/v1/tenants","title":"Create a new tenant","href":"/api-reference/create-a-new-tenant"},{"openapi":"get /api/v1/tenants/{tenant-id}/auth","title":"Get auth details given tenant id","href":"/api-reference/get-auth-details-given-tenant-id"},{"openapi":"put /api/v1/tenants/{tenant-id}/auth","title":"Store tenant's end user authentication method","href":"/api-reference/store-tenants-end-user-authentication-method"},{"openapi":"post /api/v1/auth-end-user","title":"Request authorization for tenant","href":"/api-reference/request-authorization-for-tenant"},{"openapi":"get /api/v1/timezones","title":"Get list of timezones supported by dashboard CSV export","href":"/api-reference/get-list-of-timezones-supported-by-dashboard-csv-export"},{"openapi":"get /api/v1/log-tags","title":null,"href":"/api-reference/get-apiv1log-tags"},{"openapi":"post /api/v1/micelio-stats-panel-details","title":"Detailed data for micelio stats panel","href":"/api-reference/detailed-data-for-micelio-stats-panel"},{"openapi":"get /api/v1/dashboard-share-options","title":"Get share options for the user","href":"/api-reference/get-share-options-for-the-user"},{"openapi":"get /api/v1/stream_info","title":"Get tables and columns available for querying","href":"/api-reference/get-tables-and-columns-available-for-querying"},{"openapi":"get /api/v1/alert-types","title":"Get all alert types","href":"/api-reference/get-all-alert-types"},{"openapi":"get /api/v1/alert-rules","title":"Get all alert rules","href":"/api-reference/get-all-alert-rules"},{"openapi":"post /api/v1/alert-rules","title":"Create alert rule","href":"/api-reference/create-alert-rule"},{"openapi":"get /api/v1/alert-groups","title":"Get all alert groups","href":"/api-reference/get-all-alert-groups"},{"openapi":"get /api/v1/alert-rules/{alert-id}/alert-notification-rules/{notification-id}","title":"Get alert notification rule","href":"/api-reference/get-alert-notification-rule"},{"openapi":"put /api/v1/alert-rules/{alert-id}/alert-notification-rules/{notification-id}","title":"Update alert notification rule","href":"/api-reference/update-alert-notification-rule"},{"openapi":"delete /api/v1/alert-rules/{alert-id}/alert-notification-rules/{notification-id}","title":"Delete alert notification rule","href":"/api-reference/delete-alert-notification-rule"},{"openapi":"post /api/v1/alert-rules/{id}/alert-notification-rules","title":"Create alert notification rule","href":"/api-reference/create-alert-notification-rule"},{"openapi":"post /api/v1/alert-rules/{id}/test-alert-notification-rule","title":"Test alert notification rule","href":"/api-reference/test-alert-notification-rule"},{"openapi":"put /api/v1/alert-rules/{id}","title":"Update alert rule","href":"/api-reference/update-alert-rule"},{"openapi":"delete /api/v1/alert-rules/{id}","title":"Delete alert rule","href":"/api-reference/delete-alert-rule"},{"openapi":"put /api/v1/alert-rules/{id}/start","title":"Start alert rule","href":"/api-reference/start-alert-rule"},{"openapi":"put /api/v1/alert-rules/{id}/stop","title":"Stop alert rule","href":"/api-reference/stop-alert-rule"},{"openapi":"get /api/v1/session-types","title":"Get all session types","href":"/api-reference/get-all-session-types"},{"openapi":"post /api/v1/session-types","title":"Create session type","href":"/api-reference/create-session-type"},{"openapi":"put /api/v1/session-types/{name}/start","title":"Start session type","href":"/api-reference/start-session-type"},{"openapi":"put /api/v1/session-types/{name}/stop","title":"Stop session type","href":"/api-reference/stop-session-type"},{"openapi":"delete /api/v1/session-types/{name}","title":"Delete session type","href":"/api-reference/delete-session-type"},{"openapi":"post /api/v1/dkron/update-schedule-status/{action_id}","title":"Called by dkron repeatedly for a scheduled action until it is finished. It retries failed actions if needed and updates schedule status","href":"/api-reference/called-by-dkron-repeatedly-for-a-scheduled-action-until-it-is-finished-it-retries-failed-actions-if-needed-and-updates-schedule-status"},{"openapi":"post /api/v1/actions/{action_id}/append_phase","title":"append fixed-list phase to a schedule","href":"/api-reference/append-fixed-list-phase-to-a-schedule"},{"openapi":"get /api/v1/actions/{action_id}/schedule","title":"get schedule for an action","href":"/api-reference/get-schedule-for-an-action"},{"openapi":"get /api/v1/dbcs","title":"Get all DBCs for tenant","href":"/api-reference/get-all-dbcs-for-tenant"},{"openapi":"post /api/v1/dbcs","title":"Creates a DBC","href":"/api-reference/creates-a-dbc"},{"openapi":"post /api/v1/dbcs/{dbc-id}/diff","title":null,"href":"/api-reference/post-apiv1dbcs-diff"},{"openapi":"put /api/v1/dbcs/{dbc-id}/update","title":null,"href":"/api-reference/put-apiv1dbcs-update"},{"openapi":"get /api/v1/dbcs/{dbc-id}","title":"Get info about a single DBC given id","href":"/api-reference/get-info-about-a-single-dbc-given-id"},{"openapi":"put /api/v1/dbcs/{dbc-id}","title":"Update DBC settings","href":"/api-reference/update-dbc-settings"},{"openapi":"delete /api/v1/dbcs/{dbc-id}","title":"Delete a single DBC given id","href":"/api-reference/delete-a-single-dbc-given-id"},{"openapi":"get /api/v1/dbcs/{dbc-id}/dbc","title":"Get dbc file for a DBC given id","href":"/api-reference/get-dbc-file-for-a-dbc-given-id"},{"openapi":"get /api/v1/dbcs/{dbc-id}/json","title":"Get parsed version of a DBC given id","href":"/api-reference/get-parsed-version-of-a-dbc-given-id"},{"openapi":"put /api/v1/dbcs/{dbc-id}/start","title":"Start Parser","href":"/api-reference/start-parser"},{"openapi":"put /api/v1/dbcs/{dbc-id}/stop","title":"Stop Parser","href":"/api-reference/stop-parser"},{"openapi":"get /api/v2/devices","title":"Get the list of devices - paginated.","href":"/api-reference/get-the-list-of-devices--paginated"},{"openapi":"get /api/v2/devices/search","title":"Find devices by device state keys","href":"/api-reference/find-devices-by-device-state-keys"},{"openapi":"get /mock/test","title":"Just a test route","href":"/api-reference/just-a-test-route"},{"openapi":"get /mock/logs","title":"Get all audit Logs","href":"/api-reference/get-all-audit-logs"},{"openapi":"get /mock/logs/dashboard","title":"Get all the Dashboard logs","href":"/api-reference/get-all-the-dashboard-logs"},{"openapi":"get /mock/logs/dashboard/{dashboard-id}","title":"Get logs of a specific dashboard","href":"/api-reference/get-logs-of-a-specific-dashboard"},{"openapi":"get /mock/logs/metadata","title":"Get all the Metadata logs","href":"/api-reference/get-all-the-metadata-logs"},{"openapi":"get /mock/logs/metadata/{metadata-key}","title":"Get Metadata log for a key","href":"/api-reference/get-metadata-log-for-a-key"},{"openapi":"get /mock/logs/roles","title":"Get all Role logs","href":"/api-reference/get-all-role-logs"},{"openapi":"get /mock/logs/role/{role-name}","title":"Get logs of a role","href":"/api-reference/get-logs-of-a-role"},{"openapi":"get /mock/api/v1/actions/{id}","title":null,"href":"/api-reference/get-mockapiv1actions"},{"openapi":"post /mock/api/v1/actions","title":null,"href":"/api-reference/post-mockapiv1actions"},{"openapi":"post /mock/api/v2/actions","title":null,"href":"/api-reference/post-mockapiv2actions"},{"openapi":"get /logout","title":null,"href":"/api-reference/get-logout"},{"openapi":"get /ping","title":"Ping-pong end point","href":"/api-reference/ping-pong-end-point"},{"openapi":"get /metrics","title":null,"href":"/api-reference/get-metrics"}]},{"group":"data","pages":[{"openapi":"get /api/v1/file","title":"Return the list of all uploaded files (respects RBAC)","href":"/api-reference/data/return-the-list-of-all-uploaded-files-respects-rbac"},{"openapi":"post /api/v1/file","title":"Create a new file (respects RBAC)","href":"/api-reference/data/create-a-new-file-respects-rbac"},{"openapi":"get /api/v1/file/{id}/artifact","title":"The Endpoint the device hits to download the file (respects RBAC)","href":"/api-reference/data/the-endpoint-the-device-hits-to-download-the-file-respects-rbac"},{"openapi":"get /api/v1/dashboards","title":"Get dashboards API","href":"/api-reference/data/get-dashboards-api"},{"openapi":"post /api/v1/dashboards","title":"Create dashboard API","href":"/api-reference/data/create-dashboard-api"},{"openapi":"get /api/v1/dashboards/{id}","title":"Get dashboard API","href":"/api-reference/data/get-dashboard-api"},{"openapi":"post /api/v1/dashboards/{id}","title":"Update dashboard","href":"/api-reference/data/update-dashboard"},{"openapi":"delete /api/v1/dashboards/{id}","title":"Delete dashboard API","href":"/api-reference/data/delete-dashboard-api"},{"openapi":"post /api/v1/panel-data","title":"Get data for panels given in body","href":"/api-reference/data/get-data-for-panels-given-in-body"},{"openapi":"post /api/v1/panel-data-csv","title":"Get data for a single panel given in the body","href":"/api-reference/data/get-data-for-a-single-panel-given-in-the-body"}]},{"group":"admin","pages":[{"openapi":"get /api/v1/me","title":"Get current User object","href":"/api-reference/admin/get-current-user-object"},{"openapi":"get /api/v1/server/settings","title":"Get settings","href":"/api-reference/admin/get-settings"},{"openapi":"put /api/v1/me/settings","title":"Update user settings","href":"/api-reference/admin/update-user-settings"},{"openapi":"put /api/v1/me/tenant/settings","title":"Update tenant settings","href":"/api-reference/admin/update-tenant-settings"},{"openapi":"get /api/v1/users","title":"Get users and their roles","href":"/api-reference/admin/get-users-and-their-roles"},{"openapi":"post /api/v1/users","title":"Create a new user","href":"/api-reference/admin/create-a-new-user"},{"openapi":"get /api/v1/users/{user-id}","title":"Get user given existing id","href":"/api-reference/admin/get-user-given-existing-id"},{"openapi":"put /api/v1/users/{user-id}","title":"Update a user given existing id","href":"/api-reference/admin/update-a-user-given-existing-id"},{"openapi":"delete /api/v1/users/{user-id}","title":"Delete a user given existing id","href":"/api-reference/admin/delete-a-user-given-existing-id"},{"openapi":"get /api/v1/roles","title":"Get list of roles","href":"/api-reference/admin/get-list-of-roles"},{"openapi":"post /api/v1/roles","title":"Create role","href":"/api-reference/admin/create-role"},{"openapi":"get /api/v1/roles/{role-id}","title":"Get a single role given role-id","href":"/api-reference/admin/get-a-single-role-given-role-id"},{"openapi":"put /api/v1/roles/{role-id}","title":"Update role given role-id","href":"/api-reference/admin/update-role-given-role-id"},{"openapi":"delete /api/v1/roles/{role-id}","title":"Delete role given role-id","href":"/api-reference/admin/delete-role-given-role-id"},{"openapi":"get /api/v1/streams","title":"Get all existing streams in clickhouse database","href":"/api-reference/admin/get-all-existing-streams-in-clickhouse-database"},{"openapi":"post /api/v1/streams","title":"Creates a stream on clickhouse database","href":"/api-reference/admin/creates-a-stream-on-clickhouse-database"},{"openapi":"get /api/v1/streams/{stream-name}/fields","title":"Get all fields given existing stream name in clickhouse database","href":"/api-reference/admin/get-all-fields-given-existing-stream-name-in-clickhouse-database"},{"openapi":"delete /api/v1/streams/{stream-name}","title":"Delete a stream on clickhouse database","href":"/api-reference/admin/delete-a-stream-on-clickhouse-database"},{"openapi":"delete /api/v1/streams/{stream-name}/fields/{field-name}","title":"Delete a field given existing stream name in clickhouse database","href":"/api-reference/admin/delete-a-field-given-existing-stream-name-in-clickhouse-database"},{"openapi":"post /api/v1/streams/fields","title":"Create a field given a existing stream name in clickhouse database","href":"/api-reference/admin/create-a-field-given-a-existing-stream-name-in-clickhouse-database"},{"openapi":"put /api/v1/streams/{stream-name}/fields/{field-name}/rename","title":"Rename a stream field","href":"/api-reference/admin/rename-a-stream-field"},{"openapi":"post /api/v1/streams/fields/update","title":"Update an existing field's type","href":"/api-reference/admin/update-an-existing-fields-type"},{"openapi":"post /api/v1/streams/fixprotobuff","title":null,"href":"/api-reference/admin/post-apiv1streamsfixprotobuff"},{"openapi":"get /api/v1/streams/queries/{query-id}","title":null,"href":"/api-reference/admin/get-apiv1streamsqueries"},{"openapi":"get /api/v1/streams/queries","title":null,"href":"/api-reference/admin/get-apiv1streamsqueries-1"},{"openapi":"get /api/v1/streams/protobuff","title":"Return protobuff for all streams in clickhouse database","href":"/api-reference/admin/return-protobuff-for-all-streams-in-clickhouse-database"},{"openapi":"post /api/v1/streams/computed_streams","title":"Creates computed stream","href":"/api-reference/admin/creates-computed-stream"},{"openapi":"get /api/v1/streams/detailed","title":"Return full detail of streams with fields including if they are computed, along with their code and parent streams","href":"/api-reference/admin/return-full-detail-of-streams-with-fields-including-if-they-are-computed-along-with-their-code-and-parent-streams"},{"openapi":"get /api/v1/apikeys","title":"Get all apikeys","href":"/api-reference/admin/get-all-apikeys"},{"openapi":"post /api/v1/apikeys","title":"Create a new apikey","href":"/api-reference/admin/create-a-new-apikey"},{"openapi":"delete /api/v1/apikeys/{key-or-name}","title":"Deactivate an apikey; soft-delete","href":"/api-reference/admin/deactivate-an-apikey;-soft-delete"}]},{"group":"logs","pages":[{"openapi":"get /api/v1/logs/device-certs","title":"Logs for device certifactes","href":"/api-reference/logs/logs-for-device-certifactes"},{"openapi":"get /api/v1/logs/device-certs/{device-id}","title":"Logs for device certifactes by device id","href":"/api-reference/logs/logs-for-device-certifactes-by-device-id"}]}]},{"tab":"Release Notes","pages":[{"title":"Release Notes","href":"/release-notes/r36-03-dec-2025"}]}]},"basePath":"","title":"Get action for device - Bytebeam Docs","buildId":"dpl_6cCEiK8XNNvaLBBkWzcBhdE9QfLC","deploymentId":"dpl_6cCEiK8XNNvaLBBkWzcBhdE9QfLC","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CLz2_Z5D.js","utils-7A5jZhOT.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-BVWmkKuv.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-4SOfrh0F.js","snippetPresets-CMc8KicP.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-Ba9tX7z3.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-Be8krXvv.js","shallow-CBC3K1uB.js","getApiPlaygroundDisplay-4tKcUAYo.js","CodeSnippet-C1Xa06ft.js","CodeSnippets-vqiz27A_.js","Page-DeQN5MDd.js","getPastedJson-NUwRfM32.js","icon-DkIVqWh9.js","MethodPill-qmhT7_wz.js","DuplicateIcon-_gWp1vhn.js","createIcon-NA1p_TVA.js","DynamicMarkdown-Bas9A7wq.js","SectionHeading-a1cS-24U.js","axios-vUo_bRtp.js","Markdown-D3ZTwq_a.js","clsx-BcghKhHb.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-B66mVNPp.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-DmooSyTN.js"]}