API endpoints overview

This page lists every signageOS REST API endpoint grouped by resource. Each endpoint links to its full request and response reference in the REST API reference.

Account

Method	Endpoint	Description
POST	/v1/account/security-token	Create Account Security Token
DELETE	/v1/account/security-token	Delete All Account Security Tokens
DELETE	/v1/account/security-token/{token}	Delete One Account Security Token
GET	/v1/account	Get Account
PUT	/v1/account	Update Account

Alert

Method	Endpoint	Description
PUT	/v1/alert/{alertUid}/archive	Archive Alert
PUT	/v1/alert/{alertUid}/assign	Assigne Devices to Alert
POST	/v1/alert	Create Alert
GET	/v1/alert/{alertUid}	Get Alert
GET	/v1/alert	Get Alerts
PUT	/v1/alert/{alertUid}/snooze	Snooze Alert
POST	/v1/alert/{alertUid}/device-snooze/{deviceUid}	Snooze Device Alert
PUT	/v1/alert/{alertUid}/unarchive	Unarchive Alert
PUT	/v1/alert/{alertUid}/unassign	Unassigne Devices from Alert
PUT	/v1/alert/{alertUid}/unsnooze	Unsnooze Alert
DELETE	/v1/alert/{alertUid}/device-snooze/{deviceUid}	Unsnooze Device Alert
PUT	/v1/alert/{alertUid}	Update Alert Description

Alert/Rule

Method	Endpoint	Description
PUT	/v1/alert-rule/{alertRuleUid}/archive	Archive Alert Rule
POST	/v1/alert-rule	Create Alert Rule
GET	/v1/alert-rule/{alertRuleUid}	Get Alert Rule
GET	/v1/alert-rule	Get Alert Rules
PUT	/v1/alert-rule/{alertRuleUid}/pause	Pause Alert Rule
PUT	/v1/alert-rule/{alertRuleUid}/unarchive	Unarchive Alert Rule
PUT	/v1/alert-rule/{alertRuleUid}/unpause	Unpause Alert Rule
PUT	/v1/alert-rule/{alertRuleUid}	Update Alert Rule

Applet

Method	Endpoint	Description
GET	/v1/applet/count	Count Applets
POST	/v1/applet	Create Applet
POST	/v1/applet/{appletUid}/version	Create Applet Version
DELETE	/v1/applet/{appletUid}	Delete Applet
DELETE	/v1/applet/{appletUid}/version/{appletVersion}/file/{appletFileName}	Delete Applet Version File
POST	/v1/applet/{appletUid}/version/{appletVersion}/deprecate	Deprecate Applet Version
GET	/v1/applet/{appletUid}	Get Applet
GET	/v1/applet/{appletUid}/version/{appletVersion}	Get Applet Version
GET	/v1/applet/{appletUid}/version/{appletVersion}/config	Get Applet Version Config Definition
GET	/v1/applet/{appletUid}/version/{appletVersion}/file/{appletFileName}	Get Applet Version File
GET	/v1/applet/{appletUid}/version/{appletVersion}/file	Get Applet Version Files
GET	/v1/applet/{appletUid}/version/{appletVersion}/metadata	Get Applet Version Metadata
GET	/v1/applet/{appletUid}/version	Get Applet Versions
GET	/v1/applet	Get Applets
POST	/v1/applet/{appletUid}/version/{appletVersion}/publish	Publish Applet Version
POST	/v1/applet/{appletUid}/version/{appletVersion}/renew	Renew Applet Version
PUT	/v1/applet/{appletUid}/version/{appletVersion}	Update Applet Version
PUT	/v1/applet/{appletUid}/version/{appletVersion}/file/{appletFileName}	Upload and Update Applet Version Files
POST	/v1/applet/{appletUid}/version/{appletVersion}/file/{appletFileName}	Upload and Update Applet Version Files
POST	/v1/applet/{appletUid}/version/{appletVersion}/file	Upload Applet Version Files

Applet/Applet Tests

Method	Endpoint	Description
POST	/v1/applet/{appletUid}/version/{appletVersion}/test	Test Applet By Version
GET	/v1/applet/{appletUid}/version/{appletVersion}/test	Test Applet By Version
PUT	/v1/applet/{appletUid}/version/{appletVersion}/test/{testIdentifier}	Test Applet By Version And Identifier
DELETE	/v1/applet/{appletUid}/version/{appletVersion}/test/{testIdentifier}	Test Applet By Version And Identifier
GET	/v1/applet/{appletUid}/version/{appletVersion}/test/{testIdentifier}	Test Applet By Version and Test Identifier

Applet/Command

Method	Endpoint	Description
GET	/v1/applet/{appletUid}/command	Get Applet Commands
GET	/v1/applet/command	Get Applet Commands

Bulk Operation

Method	Endpoint	Description
PUT	/v1/bulk-operation/{bulkOperationUid}/archive	Archive bulk operation
POST	/v1/bulk-operation	Create bulk operation
GET	/v1/bulk-operation/{bulkOperationUid}	Get bulk operation
GET	/v1/bulk-operation	Get bulk operations
PUT	/v1/bulk-operation/{bulkOperationUid}/pause	Pause bulk operation
POST	/v1/bulk-operation/preview	Preview bulk operation impact before creation
PUT	/v1/bulk-operation/{bulkOperationUid}/resume	Resume bulk operation
PUT	/v1/bulk-operation/{bulkOperationUid}/stop	Stop bulk operation

BulkProvisioning/Recipe

Method	Endpoint	Description
POST	/v1/bulk-provisioning/recipe	Create Provision recipe
DELETE	/v1/bulk-provisioning/recipe/{recipeUid}	Delete Provision recipe
GET	/v1/bulk-provisioning/recipe/count	Get Count of Provision recipes
GET	/v1/bulk-provisioning/recipe/{recipeUid}	Get Provision recipe
GET	/v1/bulk-provisioning/recipe	Get Provision recipes
PUT	/v1/bulk-provisioning/recipe/{recipeUid}	Update Provision recipe
POST	/v1/bulk-provisioning/recipe/csv	Upload provisioning recipes via CSV file

Company

Method	Endpoint	Description
GET	/v1/company/count	Count Companies
POST	/v1/company	Create Company
GET	/v1/company	Get Companies
GET	/v1/company/{companyUid}	Get Company
PUT	/v1/company/{companyUid}/support-access-permission	Set Company Support Access Permission

Company/Credit Transaction

Method	Endpoint	Description
GET	/v1/company/{companyUid}/credit-transaction/count	Count company credit transactions
GET	/v1/company/{companyUid}/credit-transaction/{creditTransactionUid}	Get company credit transaction
GET	/v1/company/{companyUid}/credit-transaction	Get company credit transactions

Company/Member

Method	Endpoint	Description
POST	/v1/company/{companyUid}/member	Add company member
GET	/v1/company/{companyUid}/member/count	Count company members
DELETE	/v1/company/{companyUid}/member/{memberUid}	Delete company member
PUT	/v1/company/{companyUid}/member/{memberUid}	Edit company member
GET	/v1/company/{companyUid}/member/{memberUid}	Get company member
GET	/v1/company/{companyUid}/member	Get company members
POST	/v1/company/{companyUid}/member/{memberUid}/invite	Resend company member invite

Company/Public Key

Method	Endpoint	Description
GET	/v1/company/{companyUid}/public-key	Get company's public key

ContentGuard/AIHelper

Method	Endpoint	Description
POST	/v1/content-guard/ai-helper/analyze-prompt	Analyze Content Guard Prompt
POST	/v1/content-guard/ai-helper/finalize	Finalize Content Guard Item Generation
POST	/v1/content-guard/ai-helper/generate-description	Generate Description for Content Guard Item
POST	/v1/content-guard/ai-helper/generate-prompt	Generate Prompt for Content Guard Item
POST	/v1/content-guard/ai-helper/image	Upload Temporary Image for Content Guard Item. That will be used to generate description.

ContentGuard/Category

Method	Endpoint	Description
GET	/v1/content-guard/category/count	Count Content Guard Categories
POST	/v1/content-guard/category	Create Content Guard Category
DELETE	/v1/content-guard/category/{contentGuardCategoryUid}	Delete Content Guard Category
GET	/v1/content-guard/category	Get Content Guard Categories
GET	/v1/content-guard/category/{contentGuardCategoryUid}	Get Content Guard Category
GET	/v1/content-guard/managed/category	Get Managed Content Guard Categories
GET	/v1/content-guard/managed/category/{contentGuardCategoryUid}	Get Managed Content Guard Category
PUT	/v1/content-guard/category/{contentGuardCategoryUid}	Update Content Guard Category

ContentGuard/Item

Method	Endpoint	Description
PUT	/v1/content-guard/item/{contentGuardItemUid}/tag/{tagUid}	Assign organization tag to the content guard item.
DELETE	/v1/content-guard/item/bulk	Bulk Delete Content Guard Items
PUT	/v1/content-guard/item/bulk	Bulk Update Content Guard Item Category
GET	/v1/content-guard/item/count	Count Content Guard Items
POST	/v1/content-guard/item	Create Content Guard Item
DELETE	/v1/content-guard/item/{contentGuardItemUid}	Delete Content Guard Item
POST	/v1/content-guard/item/{contentGuardItemUid}/image-upload/finish	Finish Content Guard Item Image Upload
GET	/v1/content-guard/item/{contentGuardItemUid}	Get Content Guard Item
GET	/v1/content-guard/item	Get Content Guard Items
GET	/v1/content-guard/managed/item/{contentGuardItemUid}	Get Managed Content Guard Item
GET	/v1/content-guard/managed/item	Get Managed Content Guard Items
POST	/v1/content-guard/item/{contentGuardItemUid}/image-upload	Start Content Guard Item Image Upload
DELETE	/v1/content-guard/item/{contentGuardItemUid}/tag/{tagUid}	Unassign organization tag which is assigned to the content guard item.
PUT	/v1/content-guard/item/{contentGuardItemUid}	Update Content Guard Item

ContentGuard/PredefinedPrompt

Method	Endpoint	Description
POST	/v1/content-guard/managed/predefined-prompt	Create Content Guard Predefined Prompt
GET	/v1/content-guard/managed/predefined-prompt/{contentGuardPredefinedPromptUid}	Get Managed Content Guard Predefined Prompt
GET	/v1/content-guard/managed/predefined-prompt	Get Managed Content Guard Predefined Prompts
PUT	/v1/content-guard/managed/predefined-prompt/{contentGuardPredefinedPromptUid}	Update Content Guard Predefined Prompt

CustomScript

Method	Endpoint	Description
GET	/v1/custom-script/count	Count Custom Scripts
POST	/v1/custom-script	Create Custom Script
POST	/v1/custom-script/managed	Create Managed Custom Script
DELETE	/v1/custom-script/{customScriptUid}	Delete Custom Script
DELETE	/v1/custom-script/managed/{customScriptUid}	Delete Managed Custom Script
GET	/v1/custom-script/{customScriptUid}	Get Custom Script
GET	/v1/custom-script	Get Custom Scripts
GET	/v1/custom-script/managed/{customScriptUid}	Get Managed Custom Script
GET	/v1/custom-script/managed	Get Managed Custom Scripts
PUT	/v1/custom-script/{customScriptUid}	Update Custom Script
PUT	/v1/custom-script/managed/{customScriptUid}	Update Managed Custom Script

CustomScript/Version

Method	Endpoint	Description
GET	/v1/custom-script/{customScriptUid}/version/count	Count Custom Script Versions
POST	/v1/custom-script/{customScriptUid}/version	Create Custom Script Version
DELETE	/v1/custom-script/{customScriptUid}/version/{version}	Delete Custom Script Version
GET	/v1/custom-script/{customScriptUid}/version/{version}	Get Custom Script Version
GET	/v1/custom-script/{customScriptUid}/version	Get Custom Script Versions
PUT	/v1/custom-script/{customScriptUid}/version/{version}	Update Custom Script Version

CustomScript/Version/Platform

Method	Endpoint	Description
POST	/v1/custom-script/{customScriptUid}/version/{version}/platform	Create Custom Script Version Platform
DELETE	/v1/custom-script/{customScriptUid}/version/{version}/platform/{platform}	Delete Custom Script Version Platform
GET	/v1/custom-script/{customScriptUid}/version/{version}/platform/{platform}	Get Custom Script Version Platform
GET	/v1/custom-script/{customScriptUid}/version/{version}/platform	Get Custom Script Version Platforms
POST	/v1/custom-script/{customScriptUid}/version/{version}/platform/{platform}/archive	Get presigned URL to upload Custom Script Version Platform archive
PUT	/v1/custom-script/{customScriptUid}/version/{version}/platform/{platform}	Update Custom Script Version Platform

Device

Method	Endpoint	Description
PUT	/v2/device/{deviceUid}	Configure Device
GET	/v1/device/application-types	Get Device Application Types
GET	/v1/device/{deviceUid}/authentication	Get Device Authentication Hash
GET	/v1/device/brands	Get Device Brands
GET	/v1/device/authentication/{deviceAuthHash}	Get Device by Authentication Hash
GET	/v1/device/models	Get Device Models
GET	/v1/device/{deviceUid}	Get Device v1 (deprecated)
GET	/v2/device/{deviceUid}	Get Device V2
GET	/v1/device	Get Devices v1 (deprecated)
GET	/v1/device/count	Get Devices v1 count (deprecated)
GET	/v2/device	Get Devices V2
GET	/v2/device/count	Get Devices V2 count
PUT	/v1/device/{deviceUid}	Update Device Name (deprecated)

Device/ActionLog (Device History)

Method	Endpoint	Description
GET	/v1/device/{deviceUid}/action-log/export	Export Action Logs as CSV
GET	/v1/device/{deviceUid}/action-log	Get device history
GET	/v1/device/{deviceUid}/action-log/{actionUid}	Get single action log entry
GET	/v1/device/{deviceUid}/action-log/types	Get Unique Action Log Types

Device/Alive

Method	Endpoint	Description
GET	/v1/device/{deviceUid}/alive	Get Device Last Alive
GET	/v1/device/alive	Get Devices Last Alive
GET	/v1/device/alive/count	Get Devices Last Alive Count

Device/Applet

Method	Endpoint	Description
POST	/v1/device/{deviceUid}/applet	Assign an applet to a device
GET	/v1/device/{deviceUid}/applet/count	Count Applets assigned to a device
DELETE	/v1/device/{deviceUid}/applet/{assignmentUid}	Delete Applet Assignment
GET	/v1/device/{deviceUid}/applet/{assignmentUid}	Get Applet Assignment
GET	/v1/device/{deviceUid}/applet	Get Applets assigned to a device
GET	/v1/device/applet	Get devices with their applet assignments
GET	/v1/device/applet/count	Get devices with their applet assignments
PUT	/v1/device/{deviceUid}/applet/{assignmentUid}	Update Applet Assignment

Device/Applet Command

Method	Endpoint	Description
POST	/v1/device/{deviceUid}/applet/{appletUid}/command	Create Applet Command
GET	/v1/device/{deviceUid}/applet/{appletUid}/command/{commandUid}	Get Applet Command By Command UID
GET	/v1/device/{deviceUid}/applet/command/types	Get Applet Command Types
GET	/v1/device/{deviceUid}/applet/{appletUid}/command	Get Applet Commands
GET	/v1/device/{deviceUid}/applet/command	Get Applet Commands

Device/Application Version and update

Method	Endpoint	Description
GET	/v1/device/{deviceUid}/application/version/count	Count Device Application Version Changes
GET	/v1/device/{deviceUid}/application/version	Get History of Device Application Version Changes
GET	/v1/device/{deviceUid}/application/version/latest	Get latest Device Application Version Change
GET	/v1/device/application/version/latest	Get latest Device Application Version Changes
PUT	/v1/device/{deviceUid}/application/{applicationType}/version	Update Core App Version

Device/AutoRecovery

Method	Endpoint	Description
GET	/v1/device/{deviceUid}/auto-recovery	Get Device Auto Recovery
PUT	/v1/device/{deviceUid}/auto-recovery	Set Device Auto Recovery

Device/Brightness

Method	Endpoint	Description
GET	/v1/device/{deviceUid}/brightness	Get Device Brightness
PUT	/v1/device/{deviceUid}/brightness	Update Device Brightness

Device/Configuration

Method	Endpoint	Description
GET	/v1/device/configuration/telemetry-intervals/count	Count telemetry intervals
GET	/v1/device/configuration/{deviceUid}/telemetry-intervals	Get telemetry intervals
POST	/v1/device/configuration/{deviceUid}/telemetry-cache/invalidate	Invalidate device telemetry cache
GET	/v1/device/configuration/telemetry-intervals	List telemetry intervals
PUT	/v1/device/configuration/{deviceUid}/telemetry-intervals	Set telemetry intervals

Device/Connect

Method	Endpoint	Description
POST	/v1/device/{deviceUid}/connect	Connect a device to an applet
POST	/v1/device/{deviceUid}/disconnect	Disconnect a device from an applet

Device/Custom Script

Method	Endpoint	Description
GET	/v1/device/{deviceUid}/custom-script/count	Count Device Custom Script Executions
PUT	/v1/device/{deviceUid}/custom-script	Execute Device Custom on Device
GET	/v1/device/{deviceUid}/custom-script	Get History of Device Custom Script Executions
GET	/v1/device/{deviceUid}/custom-script/latest	Get latest Device Custom Script Execution
POST	/v1/device/{deviceUid}/custom-script/latest	Get latest Device Custom Script Execution per Custom Script
GET	/v1/device/custom-script/latest	Get latest Device Custom Script Executions

Device/Debug

Method	Endpoint	Description
GET	/v1/device/{deviceUid}/debug	Get Device Debug
PUT	/v1/device/{deviceUid}/debug	Set Device Debug

Device/Extended Management Remote Server

Method	Endpoint	Description
GET	/v1/device/{deviceUid}/extended-management	Get extended management remote server URL
PUT	/v1/device/{deviceUid}/extended-management	Update extended management remote server URL

Device/Firmware

Method	Endpoint	Description
GET	/v1/device/{deviceUid}/firmware/count	Count device firmware version changes
GET	/v1/device/{deviceUid}/firmware	Get Device Firmware
PUT	/v1/device/{deviceUid}/firmware	Update Device Firmware (deprecated)
PUT	/v2/device/{deviceUid}/firmware	Update Device Firmware (V2)

Device/Kiosk mode & IR Remote Control

Method	Endpoint	Description
GET	/v1/device/{deviceUid}/remote-control	Get Device Kiosk Mode / IR Remote Control Status
PUT	/v1/device/{deviceUid}/remote-control	Update Device Kiosk Mode/IR Remote Control

Device/Location

Method	Endpoint	Description
PUT	/v1/device/{deviceUid}/location/{locationUid}	Assign Device to Location
GET	/v1/device/{deviceUid}/location/{locationUid}	Get Location for Device
DELETE	/v1/device/{deviceUid}/location/{locationUid}	Unassign Location from Device

Device/Monitoring

Method	Endpoint	Description
GET	/v1/device/{deviceUid}/hourly-connected-status	Get Device Hourly Connected Status (deprecated) (deprecated)
GET	/v1/device/{deviceUid}/temperature	Get Device Temperature

Device/Organization

Method	Endpoint	Description
PUT	/v1/device/{deviceUid}/organization	Set Device Organization

Device/Orientation and Resolution

Method	Endpoint	Description
GET	/v1/device/{deviceUid}/resolution	Get Device Orientation and Resolution
PUT	/v1/device/{deviceUid}/resolution	Set Device Orientation and Resolution

Device/Packages

Method	Endpoint	Description
PUT	/v1/device/{deviceUid}/package-clear-data	Clear Device Package Data
GET	/v1/device/{deviceUid}/package-clear-data	Get Device Package Clear Data History
GET	/v1/device/{deviceUid}/package-install	Get Installed Device Packages
GET	/v1/device/{deviceUid}/package-start	Get Started Device Packages
GET	/v1/device/{deviceUid}/package-stop	Get Stopped Device Packages
PUT	/v1/device/{deviceUid}/package-install	Install Device Package
PUT	/v1/device/{deviceUid}/package-start	Start Installed Device Package
PUT	/v1/device/{deviceUid}/package-stop	Stop Installed Device Package

Device/PeerRecovery

Method	Endpoint	Description
GET	/v1/device/{deviceUid}/peer-recovery	Get Device Peer Recovery
PUT	/v1/device/{deviceUid}/peer-recovery	Update Device Peer Recovery

Device/Pin code and security

Method	Endpoint	Description
POST	/v1/device/{deviceUid}/pin-code	(coming soon)
GET	/v1/device/{deviceUid}/pin-code	Get Device Pin

Device/Plugin

Method	Endpoint	Description
POST	/v1/device/{deviceUid}/plugin	Assign plugin to device
DELETE	/v1/device/{deviceUid}/plugin/{assignmentUid}	Delete Plugin Assignment
GET	/v1/device/{deviceUid}/plugin/{assignmentUid}	Get Plugin Assignment
PUT	/v1/device/{deviceUid}/get-plugin/{pluginUid}	Get Plugin property from Device
GET	/v1/device/{deviceUid}/plugin	List device plugins
PUT	/v1/device/{deviceUid}/set-plugin/{pluginUid}	Set Plugin property on Device
PUT	/v1/device/{deviceUid}/plugin/{assignmentUid}	Update Plugin Assignment

Device/Policy

Method	Endpoint	Description
POST	/v1/device/{deviceUid}/policy	Assign Policy to Device
GET	/v1/device/policy/count	Count Device Policies
GET	/v1/device/{deviceUid}/policy	Get Device Policies
GET	/v1/device/policy	Get Device Policies
GET	/v1/device/{deviceUid}/policy/{policyUid}	Get Device Policy
DELETE	/v1/device/{deviceUid}/policy/{policyUid}	Unassign Policy from Device

Device/Policy Status

Method	Endpoint	Description
GET	/v1/device/{deviceUid}/policy-status/{policyUid}/item/{itemType}	Get Device Policy Status
GET	/v1/device/{deviceUid}/policy-status	Get Device Policy Status List
GET	/v1/device/{deviceUid}/policy-merged	Get Merged Policy Items for Device

Device/Power Actions

Method	Endpoint	Description
POST	/v1/device/{deviceUid}/power-action	Create Device Power Action
POST	/v1/device/{deviceUid}/scheduled-power-action	Create Device Scheduled Power Action
DELETE	/v1/device/{deviceUid}/scheduled-power-action/{scheduledActionUid}	Delete Device Scheduled Power Action
GET	/v1/device/{deviceUid}/power-action/count	Get Count of Performed Device Power Actions
GET	/v1/device/{deviceUid}/scheduled-power-action	Get Device Scheduled Power Actions
GET	/v1/device/{deviceUid}/power-action	Get Performed Device Power Actions

Device/Provisioning, Adding and removing devices

Method	Endpoint	Description
PUT	/v1/device/{deviceUid}/deprovision	Deprovision/remove Device
POST	/v1/device/deprovision	Deprovision/remove Device
GET	/v1/device/verification/{deviceVerificationUid}	Get Device Verification
POST	/v1/device/verification	Verify Device via Verification Hash

Device/Revoke Key

Method	Endpoint	Description
GET	/v1/device/{deviceUid}/revoke-key/count	Count device public key revocations
GET	/v1/device/{deviceUid}/revoke-key	Get history of device public key revocations
GET	/v1/device/{deviceUid}/revoke-key/latest	Get latest device public key revocation
PUT	/v1/device/{deviceUid}/revoke-key	Revokes public key on the device

Device/Runner

Method	Endpoint	Description
POST	/v1/device/{deviceUid}/runner	Assign runner to device
DELETE	/v1/device/{deviceUid}/runner/{assignmentUid}	Delete Runner Assignment
GET	/v1/device/{deviceUid}/runner/{assignmentUid}	Get Runner Assignment
PUT	/v1/device/{deviceUid}/get-runner/{runnerUid}	Get Runner property from Device
GET	/v1/device/{deviceUid}/runner	List device runners
PUT	/v1/device/{deviceUid}/set-runner/{runnerUid}	Set Runner property on Device
PUT	/v1/device/{deviceUid}/runner/{assignmentUid}	Update Runner Assignment

Device/Screen Capture

Method	Endpoint	Description
PUT	/v1/device/{deviceUid}/screen-capture	Enable/disable Device Screen Capture
GET	/v1/device/{deviceUid}/screen-capture	Get Device Screen Capture status

Device/Screenshots

Method	Endpoint	Description
GET	/v1/device/{deviceUid}/screenshot/count	Count Device Screenshots
GET	/v1/device/screenshot/count	Count Last Screenshot By Devices
GET	/v1/device/{deviceUid}/screenshot	Get Device Screenshots
GET	/v1/device/screenshot	Get Last Screenshot By Devices
POST	/v1/device/{deviceUid}/screenshot	Request New Device Screenshot

Device/Security

Method	Endpoint	Description
GET	/v1/device/{deviceUid}/security	Get Device Security
PUT	/v1/device/{deviceUid}/security	Update Device Security

Device/Storage

Method	Endpoint	Description
GET	/v1/device/{deviceUid}/storage	Get Device Storage

Device/System Log

Method	Endpoint	Description
GET	/v1/device/{deviceUid}/system-log/export	Export System Logs as CSV
GET	/v1/device/{deviceUid}/system-log	Get Device System Logs

Device/Tag (Device Tags)

Method	Endpoint	Description
POST	/v1/device/{deviceUid}/tag/{tagUid}	Assign organization tag to the device.
GET	/v1/device/tag/count	Get count of devices with tags
GET	/v1/device/{deviceUid}/tag/count	Get count of tags assigned to the device
GET	/v1/device/tag	Get devices with tags
GET	/v1/device/{deviceUid}/tag	Get tags assigned to the device
DELETE	/v1/device/{deviceUid}/tag/{tagUid}	Unassign organization tag which is assigned to the device.

Device/Telemetry

Method	Endpoint	Description
GET	/v1/device/{deviceUid}/telemetry/{telemetryType}/count	Count Device Telemetry History by Type
GET	/v1/device/telemetry/latest/count	Get Count of Devices Latest Telemetries
GET	/v1/device/{deviceUid}/telemetry/latest	Get Device Latest Telemetries
GET	/v1/device/{deviceUid}/telemetry/{telemetryType}/latest	Get Device Latest Telemetry by Type
GET	/v1/device/{deviceUid}/telemetry/{telemetryType}	Get Device Telemetry History by Type
GET	/v1/device/telemetry/latest	Get Devices Latest Telemetries

Device/Tests

Method	Endpoint	Description
GET	/v1/device/{deviceUid}/applet-test/{appletUid}/{appletVersion}	Get Device Applet Test By UID And Applet Version
GET	/v1/device/{deviceUid}/feature-test	Get Device Feature Test
PUT	/v1/device/{deviceUid}/applet-test/{appletUid}/{appletVersion}	Put Device Applet Test with Applet UID and Applet Version
PUT	/v1/device/{deviceUid}/feature-test	Put Device Feature Test

Device/Time

Method	Endpoint	Description
GET	/v1/device/{deviceUid}/time	Get Device Time, Date and Timezone
PUT	/v1/device/{deviceUid}/time	Update Device Time, Date and Timezone

Device/Timers

Method	Endpoint	Description
POST	/v2/device/{deviceUid}/timer-settings	Create Device Timer V2
PUT	/v1/device/{deviceUid}/timer-settings	Create, Update and Remove Device Timer (deprecated) (deprecated)
GET	/v2/device/{deviceUid}/timer-settings/count	Get Count of Device Timer Requests
GET	/v2/device/{deviceUid}/timer-settings	Get Device Timer Requests V2
GET	/v1/device/{deviceUid}/timer-settings	Get Device Timers (deprecated) (deprecated)
DELETE	/v2/device/{deviceUid}/timer-settings/{timerLevel}/{timerType}	Remove Device Timer V2
PUT	/v2/device/{deviceUid}/timer-settings/{timerLevel}/{timerType}	Update Device Timer V2

Device/Volume

Method	Endpoint	Description
PUT	/v1/device/{deviceUid}/volume	Change Device Volume on Device
GET	/v1/device/{deviceUid}/volume/count	Count Device Volume Changes
GET	/v1/device/{deviceUid}/volume	Get History of Device Volume Changes
GET	/v1/device/{deviceUid}/volume/latest	Get latest Device Volume Change
GET	/v1/device/volume/latest	Get latest Device Volume Changes

Device/VPN

Method	Endpoint	Description
GET	/v1/device/{deviceUid}/vpn	Get VPN settings
PUT	/v1/device/{deviceUid}/vpn	Update VPN settings

Emulator

Method	Endpoint	Description
POST	/v1/emulator	Create new emulator
GET	/v1/emulator	Get list of emulators
DELETE	/v1/emulator/{emulatorUid}	Remove emulator

Event Stream

Method	Endpoint	Description
GET	/v1/event-stream/exporter/count	Count Exporter Configurations
POST	/v1/event-stream/exporter	Create Exporter Configuration
DELETE	/v1/event-stream/exporter/{exporterConfigUid}	Delete Exporter Configuration
GET	/v1/event-stream/exporter/{exporterConfigUid}	Get Exporter Configuration
GET	/v1/event-stream/exporter	Get Exporter Configurations
PUT	/v1/event-stream/exporter/{exporterConfigUid}	Update Exporter Configuration

Export

Method	Endpoint	Description
GET	/v1/export/{uid}	Get export
POST	/v1/export/device	Request export of list of devices

Firmware

Method	Endpoint	Description
GET	/v2/firmware/{firmwareVersionUid}	Get Firmware (V2)
GET	/v2/firmware/count	Get Firmware Count (V2)
GET	/v1/firmware/version	Get Firmwares (deprecated) (deprecated)
GET	/v2/firmware	Get Firmwares (V2)

Front Applet

Method	Endpoint	Description
GET	/v1/js-sdk/version	Get JS API Versions

License

Method	Endpoint	Description
GET	/v1/license/count	Count licenses
POST	/v1/license	Create license
DELETE	/v1/license/{licenseUid}	Delete one license
GET	/v1/license/{licenseUid}	Get license
GET	/v1/license	Get licenses
POST	/v1/license/redeem	Redeem license

Location

Method	Endpoint	Description
PUT	/v1/location/{locationUid}/add-attachment	Add Attachment to Location
PUT	/v1/location/{locationUid}/archive	Archive Location (deprecated)
GET	/v1/location/{locationUid}/organization-tag/count	Count location tags
GET	/v1/location/organization-tags/count	Count location tags
GET	/v1/location/count	Count Locations
POST	/v1/location	Create Location
DELETE	/v1/location/{locationUid}	Delete Location
GET	/v1/location/{locationUid}	Get Location
GET	/v1/location/{locationUid}/organization-tag	Get location tags
GET	/v1/location/organization-tags	Get location tags
GET	/v1/location	Get Locations
PUT	/v1/location/{locationUid}/remove-attachments	Remove Attachments from Location
PUT	/v1/location/{locationUid}/restore	Restore Location
PUT	/v1/location/{locationUid}/unarchive	Unarchive Location (deprecated)
PUT	/v1/location/{locationUid}	Update Location

Location/Tag

Method	Endpoint	Description
PUT	/v1/location/{locationUid}/organization-tag/{tagUid}	Assign tag to location
DELETE	/v1/location/{locationUid}/organization-tag/{tagUid}	Remove tag from location

Organization

Method	Endpoint	Description
POST	/v1/organization	Create Organization
POST	/v1/organization/{organizationUID}/security-token	Create organization token
DELETE	/v1/organization/{organizationUid}	Delete Organization
DELETE	/v1/organization/{organizationUid}/security-token/{organizationSecurityTokenID}	Delete organization token
GET	/v1/organization/{organizationUid}	Get Organization
GET	/v1/organization/{organizationUid}/device-plan-history	Get Organization Device Plan History
GET	/v1/organization/{organizationUid}/devicesCount	Get organization devices count
GET	/v1/organization/{organizationUID}/security-token	Get organization tokens
GET	/v1/organization	Get Organizations
GET	/v1/organization/count	Get Organizations
PUT	/v1/organization/{organizationUid}	Update Organization
PUT	/v1/organization/{organizationUID}/subscriptionType/{subscriptiontype}	Update Organization Device Plan

Organization/Member

Method	Endpoint	Description
POST	/v1/organization/{organizationUid}/member	Add organization member
GET	/v1/organization/{organizationUid}/member/count	Count organization members
DELETE	/v1/organization/{organizationUid}/member/{memberUid}	Delete organization member
PUT	/v1/organization/{organizationUid}/member/{memberUid}	Edit organization member
GET	/v1/organization/{organizationUid}/member/{memberUid}	Get organization member
GET	/v1/organization/{organizationUid}/member	Get organization members
POST	/v1/organization/{organizationUid}/member/{memberUid}/invite	Resend organization member invite

Organization/System Log

Method	Endpoint	Description
GET	/v1/system-log	Get Organization System Logs

Organization/VPN

Method	Endpoint	Description
POST	/v1/organization/{organizationUid}/client-vpn-config	Generate vpn client vpn configuration and add it to VPN server
GET	/v1/organization/{organizationUid}/client-vpn-config/{uid}	Get VPN configuration
GET	/v1/organization/{organizationUid}/client-vpn-config	Get VPN configuration list
DELETE	/v1/organization/{organizationUid}/client-vpn-config/{uid}	Revoke VPN configuration

Package

Method	Endpoint	Description
GET	/v1/package/count	Count Packages
POST	/v1/package	Create New Package
DELETE	/v1/package/{packageUid}	Delete one Package
GET	/v1/package/{packageUid}	Get One Package
GET	/v1/package	Get Packages
PUT	/v1/package/{packageUid}	Update one Package

Package/Version

Method	Endpoint	Description
POST	/v1/package/{packageUid}/version	Create New Package Version
DELETE	/v1/package/{packageUid}/version/{packageVersionUid}	Delete one Package Version
GET	/v1/package/{packageUid}/version/{packageVersionUid}	Get One Package Version
GET	/v1/package/{packageUid}/version/{packageVersionUid}/file	Get Package Version Binary
GET	/v1/package/{packageUid}/version/{packageVersionUid}/icon	Get Package Version Icon
GET	/v1/package/{packageUid}/version	Get Package Versions
PUT	/v1/package/{packageUid}/version/{packageVersionUid}/publish	Publish Package Version
PUT	/v1/package/{packageUid}/version/{packageVersionUid}/unpublish	Unpublish Package Version
PUT	/v1/package/{packageUid}/version/{packageVersionUid}	Update one Package Version

Plugin

Method	Endpoint	Description
GET	/v1/plugin/count	Count Plugins
POST	/v1/plugin	Create plugin
DELETE	/v1/plugin/{pluginUid}	Delete plugin
GET	/v1/plugin/{pluginUid}	Get plugin
GET	/v1/plugin	List plugins
PUT	/v1/plugin/{pluginUid}	Update plugin

Plugin/Version

Method	Endpoint	Description
GET	/v1/plugin/{pluginUid}/version/count	Count Plugin Versions
POST	/v1/plugin/{pluginUid}/version	Create plugin version
DELETE	/v1/plugin/{pluginUid}/version/{version}	Delete plugin version
GET	/v1/plugin/{pluginUid}/version/{version}	Get plugin version by uid
GET	/v1/plugin/{pluginUid}/version	List plugin versions
PUT	/v1/plugin/{pluginUid}/version/{version}	Update plugin version

Plugin/Version/Platform

Method	Endpoint	Description
POST	/v1/plugin/{pluginUid}/version/{version}/platform	Create Plugin Version Platform
DELETE	/v1/plugin/{pluginUid}/version/{version}/platform/{platform}	Delete Plugin Version Platform
GET	/v1/plugin/{pluginUid}/version/{version}/platform/{platform}	Get Plugin Version Platform
GET	/v1/plugin/{pluginUid}/version/{version}/platform	Get Plugin Version Platforms
POST	/v1/plugin/{pluginUid}/version/{version}/platform/{platform}/archive	Get presigned URL to upload Plugin Version Platform archive
PUT	/v1/plugin/{pluginUid}/version/{version}/platform/{platform}	Update Plugin Version Platform

Policy

Method	Endpoint	Description
PUT	/v1/policy/{policyUid}/archive	Archive Policy
PUT	/v1/policy/{policyUid}/clone	Clone Policy
GET	/v1/policy/count	Count Policies
POST	/v1/policy	Create Policy
GET	/v1/policy	Get Policies
GET	/v1/policy/{policyUid}	Get Policy
PUT	/v1/policy/{policyUid}	Update Policy

Policy/Tag

Method	Endpoint	Description
PUT	/v1/policy/{policyUid}/tag/{tagUid}	Assign organization tag to the policy.
PUT	/v1/policy/{policyUid}/tag	Set organization tags on the policy.
DELETE	/v1/policy/{policyUid}/tag/{tagUid}	Unassign organization tag from the policy.

Runner

Method	Endpoint	Description
GET	/v1/runner/count	Count Runners
POST	/v1/runner	Create runner
DELETE	/v1/runner/{runnerUid}	Delete runner
GET	/v1/runner/{runnerUid}	Get runner
GET	/v1/runner	List runners
PUT	/v1/runner/{runnerUid}	Update runner

Runner/Version

Method	Endpoint	Description
GET	/v1/runner/{runnerUid}/version/count	Count Runner Versions
POST	/v1/runner/{runnerUid}/version	Create runner version
DELETE	/v1/runner/{runnerUid}/version/{version}	Delete runner version
GET	/v1/runner/{runnerUid}/version/{version}	Get runner version by uid
GET	/v1/runner/{runnerUid}/version	List runner versions
PUT	/v1/runner/{runnerUid}/version/{version}	Update runner version

Runner/Version/Platform

Method	Endpoint	Description
POST	/v1/runner/{runnerUid}/version/{version}/platform	Create Runner Version Platform
DELETE	/v1/runner/{runnerUid}/version/{version}/platform/{platform}	Delete Runner Version Platform
POST	/v1/runner/{runnerUid}/version/{version}/platform/{platform}/archive	Get presigned URL to upload Runner Version Platform archive
GET	/v1/runner/{runnerUid}/version/{version}/platform/{platform}	Get Runner Version Platform
GET	/v1/runner/{runnerUid}/version/{version}/platform	Get Runner Version Platforms
PUT	/v1/runner/{runnerUid}/version/{version}/platform/{platform}	Update Runner Version Platform

Tag

Method	Endpoint	Description
GET	/v1/organization-tag/count	Count organization tags
POST	/v1/organization-tag	Create tag
DELETE	/v1/organization-tag/{uid}	Delete Tag
GET	/v1/organization-tag/{uid}	Get Organization Tag
GET	/v1/organization-tag/tree	Get organization tag tree
GET	/v1/organization-tag/tree/latest	Get organization tag tree metadata
GET	/v1/organization-tag	Get tags
PUT	/v1/organization-tag/{uid}	Update Tag

Timing

Method	Endpoint	Description
GET	/v1/timing/count	Count Timings (deprecated)
POST	/v1/timing	Create Timing (deprecated)
DELETE	/v1/timing/{timingUid}	Delete Timing (deprecated)
GET	/v1/timing/{timingUid}	Get Timing (deprecated)
GET	/v1/timing	Get Timings (deprecated)
PUT	/v1/timing/{timingUid}	Update Timing (deprecated)

Uptime

Method	Endpoint	Description
GET	/v1/uptime	Get uptime stats

White Label

Method	Endpoint	Description
GET	/v1/white-label-settings/public	Get public white label settings