Device management. Use this controller to get a device's configuration file, firmware image, or change the device's name.
Search devices
This endpoint returns devices for the organization. You can search by text, filter by specific serial number, or get all devices with pagination.
path Parameters
orgIdstring · requiredThe id of the organization.
query Parameters
limitinteger · int32The number of records to return. Max 30.
pageinteger · int32The page offset when fetching the records
searchstringSearch text to filter devices by name, serial number, or other searchable fields. Cannot be used together with Serial parameter.
serialstringSpecific serial number to search for a single device. Cannot be used together with Search parameter.
configurableOnlyboolean
Headers
Authorizationstring · requiredThe
Authorizationheader is used to authenticate with the API using your API key. Value is of the formatBearer YOUR_KEY_HERE.
Responses
Success
dataobjectsuccessbooleanerrorsarray | null
Register a device
This endpoint registers a new device with FORT Manager.
path Parameters
orgIdstring · requiredThe id of the organization.
query Parameters
namestringThe device name
serialNumberstringThe serial number identifying the device.
Headers
Authorizationstring · requiredThe
Authorizationheader is used to authenticate with the API using your API key. Value is of the formatBearer YOUR_KEY_HERE.
Responses
Success
dataobjectsuccessbooleanerrorsarray | null
Get the latest firmware by device serial number
This endpoint returns the latest firmware file based on your device’s serial number.
path Parameters
serialNumberstring · requiredThe serial number identifying the device.
orgIdstring · requiredThe id of the organization.
Headers
Authorizationstring · requiredThe
Authorizationheader is used to authenticate with the API using your API key. Value is of the formatBearer YOUR_KEY_HERE.
Responses
OK
Get the latest firmware version by device serial number
This endpoint returns the version string for the latest firmware based on your device's serial number.
path Parameters
serialNumberstring · requiredThe serial number identifying the device.
orgIdstring · requiredThe id of the organization.
Headers
Authorizationstring · requiredThe
Authorizationheader is used to authenticate with the API using your API key. Value is of the formatBearer YOUR_KEY_HERE.
Responses
Success
dataobjectsuccessbooleanerrorsarray | null
Get the latest firmware version by device type
This endpoint returns the version string for the latest firmware based on your device's type.
path Parameters
deviceTypestring · enum · requiredEnum values:SRCPWESPEPCNSCPorgIdstring · requiredThe id of the organization.
Headers
Authorizationstring · requiredThe
Authorizationheader is used to authenticate with the API using your API key. Value is of the formatBearer YOUR_KEY_HERE.
Responses
Success
dataobjectsuccessbooleanerrorsarray | null
Gets the latest firmware by a specific device type.
This endpoint returns the latest firmware file for download and update based on your devices type.
path Parameters
deviceTypestring · enum · requiredEnum values:SRCPWESPEPCNSCPorgIdstring · requiredThe id of the organization.
Headers
Authorizationstring · requiredThe
Authorizationheader is used to authenticate with the API using your API key. Value is of the formatBearer YOUR_KEY_HERE.
Responses
OK
Get a device's configuration
This endpoint returns the device configuration file for a specific device identified by its serial number.
path Parameters
serialNumberstring · requiredThe serial number identifying the device.
orgIdstring · requiredThe id of the organization.
Headers
Authorizationstring · requiredThe
Authorizationheader is used to authenticate with the API using your API key. Value is of the formatBearer YOUR_KEY_HERE.
Responses
OK
Get a blank configuration for a device
This endpoint returns a blank device configuration file for a specific device identified by its serial number.
path Parameters
serialNumberstring · requiredThe serial number identifying the device.
orgIdstring · requiredThe id of the organization.
Headers
Authorizationstring · requiredThe
Authorizationheader is used to authenticate with the API using your API key. Value is of the formatBearer YOUR_KEY_HERE.
Responses
OK
Update a device
This endpoint updates partial information of a device identified by its serial number. You can update the name, replace the image or delete the existing image.
path Parameters
serialNumberstring · requiredThe serial number identifying the device.
orgIdstring · requiredThe id of the organization.
query Parameters
namestringThe device name
deleteImagebooleanWhether to delete the device image
Headers
Authorizationstring · requiredThe
Authorizationheader is used to authenticate with the API using your API key. Value is of the formatBearer YOUR_KEY_HERE.
Responses
Success
dataobjectsuccessbooleanerrorsarray | null
Confirm firmware was applied to a device
This endpoint confirms a firmware apply action and updates the device firmware version.
path Parameters
serialNumberstring · requiredThe serial number identifying the device.
orgIdstring · requiredThe id of the organization.
Headers
Authorizationstring · requiredThe
Authorizationheader is used to authenticate with the API using your API key. Value is of the formatBearer YOUR_KEY_HERE.
Request Body
firmwareFileSuccessfullyDeployedboolean | nullIndicates whether the firmware file was successfully deployed to the device.
errorstring | nullError details if the file was not successfully deployed.
firmwareVersionstring | nullFirmware version that was applied to the device.
applyTimeStampstring · date-timeDate and time when the firmware was applied to the device.
Responses
Success
databooleansuccessbooleanerrorsarray | null
Confirm configuration was applied to a device
This endpoint confirms a configuration apply action and updates the configuration deploy status for this device. The syncId parameter can be retrieved from the syncId property in the body of the CBOR file used, or from the X-Config-File-Sync-Id header returned in the endpoints that download configuration files.
path Parameters
serialNumberstring · requiredThe serial number identifying the device.
orgIdstring · requiredThe id of the organization.
Headers
Authorizationstring · requiredThe
Authorizationheader is used to authenticate with the API using your API key. Value is of the formatBearer YOUR_KEY_HERE.
Request Body
configurationFileSuccessfullyDeployedbooleanerrorstring | nullError details if the file was not successfully deployed.
syncIdstring · uuidapplyTimeStampstring · date-timeDate and time when the firmware was applied to the device.
Responses
Success
databooleansuccessbooleanerrorsarray | null