Creates an image for a device identified by serial number
POST /v1/image/{deviceSerial}
Summary
Creates an image for a device identified by serial number.
Authentication
No operation-level security requirement is documented here.
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
| deviceSerial | path | string | Yes | The device serial number from the route. | Example value |
Request Body
Required: Yes
application/json
key(integer (int64), optional)deviceID(integer (int64), optional)fileID(integer (int64), optional)imageStatus(integer (int64), optional)imageTypeID(integer (int64), optional)localFilePath(string, optional)height(integer (int64), optional)width(integer (int64), optional)filesize(integer (int64), optional)startTime(integer (int64), optional)startTimeMs(integer (int64), optional)tagListID(integer (int64), optional)creationDate(string (date-time), optional)
Example
{
"key": 1,
"deviceID": 201,
"fileID": 1,
"imageStatus": 1,
"imageTypeID": 1,
"localFilePath": "Example value",
"height": 1,
"width": 1,
"filesize": 1,
"startTime": 1,
"startTimeMs": 1,
"tagListID": 1,
"creationDate": "2026-03-30T12:00:00.0000000Z"
}
Responses
200
Success
application/json
key(integer (int64), optional)deviceID(integer (int64), optional)fileID(integer (int64), optional)imageStatus(integer (int64), optional)imageTypeID(integer (int64), optional)localFilePath(string, optional)height(integer (int64), optional)width(integer (int64), optional)filesize(integer (int64), optional)startTime(integer (int64), optional)startTimeMs(integer (int64), optional)tagListID(integer (int64), optional)creationDate(string (date-time), optional)
Example
{
"key": 1,
"deviceID": 201,
"fileID": 1,
"imageStatus": 1,
"imageTypeID": 1,
"localFilePath": "Example value",
"height": 1,
"width": 1,
"filesize": 1,
"startTime": 1,
"startTimeMs": 1,
"tagListID": 1,
"creationDate": "2026-03-30T12:00:00.0000000Z"
}