Nest Changelog
1.44.5 PRE
10/11/2023
1.44.6 PRE
10/12/2023
5 changed endpoints Collapse changed endpoints
GET /firmware 
Get a list of the available firmware updates
Response Body
{
data: List<{
appVersions?: {
android?: {
maxVersion?: string,
minVersion?: string,
},
ios?: {
maxVersion?: string,
minVersion?: string,
},
screen?: {
maxVersion?: string,
minVersion?: string,
},
},
capabilities?: List<{
data?: record,
name?: string,
}>,
dateReleased?: number,
dateRequired?: number,
id?: number,
name?: string,
releaseNotes?: string,
status?: 'draft' | 'published' | 'trash',
supportedModels?: List<string>,
type?: 'hardware' | 'tablet' | 'reflect',
updateFile?: {
url?: string,
},
version?: string,
}>,
pagination: {
page?: number,
skip?: number,
take?: number,
total?: {
pages?: number,
rows?: number,
},
},
}GET /firmware
Get a list of the available firmware updates
Response Body
{
data: List<{
appVersions?: {
android?: {
maxVersion?: string,
minVersion?: string,
},
ios?: {
maxVersion?: string,
minVersion?: string,
},
screen?: {
maxVersion?: string,
minVersion?: string,
},
},
capabilities?: List<{
data?: record,
name?: string,
}>,
dateReleased?: number,
dateRequired?: number,
id?: number,
name?: string,
releaseNotes?: string,
+ signatureFile?: {
+ url?: string,
+ },
status?: 'draft' | 'published' | 'trash',
supportedModels?: List<string>,
type?: 'hardware' | 'tablet' | 'reflect',
updateFile?: {
url?: string,
},
version?: string,
}>,
pagination: {
page?: number,
skip?: number,
take?: number,
total?: {
pages?: number,
rows?: number,
},
},
}POST /firmware
Create Firmware Update
Request Body
{
- appVersions?: {
- android?: {
- maxVersion?: string,
- minVersion?: string,
- },
- ios?: {
- maxVersion?: string,
- minVersion?: string,
- },
- screen?: {
- maxVersion?: string,
- minVersion?: string,
- },
- },
- capabilities?: List<{
- data?: record,
- name?: string,
- }>,
- dateReleased?: number,
- dateRequired?: number,
- name?: string,
- releaseNotes?: string,
- status?: 'draft' | 'published' | 'trash',
- supportedModels?: List<string>,
- type?: 'hardware' | 'tablet' | 'reflect',
- updateFile: {
- data?: string,
- filename: string,
- },
- version?: string,
}Response Body
{
data: {
appVersions?: {
android?: {
maxVersion?: string,
minVersion?: string,
},
ios?: {
maxVersion?: string,
minVersion?: string,
},
screen?: {
maxVersion?: string,
minVersion?: string,
},
},
capabilities?: List<{
data?: record,
name?: string,
}>,
dateReleased?: number,
dateRequired?: number,
id?: number,
name?: string,
releaseNotes?: string,
status?: 'draft' | 'published' | 'trash',
supportedModels?: List<string>,
type?: 'hardware' | 'tablet' | 'reflect',
updateFile?: {
url?: string,
},
version?: string,
},
}POST /firmware
Create Firmware Update
Request Body
{
+ firmware: string,
+ firmwareBin: string,
}Response Body
{
data: {
appVersions?: {
android?: {
maxVersion?: string,
minVersion?: string,
},
ios?: {
maxVersion?: string,
minVersion?: string,
},
screen?: {
maxVersion?: string,
minVersion?: string,
},
},
capabilities?: List<{
data?: record,
name?: string,
}>,
dateReleased?: number,
dateRequired?: number,
id?: number,
name?: string,
releaseNotes?: string,
+ signatureFile?: {
+ url?: string,
+ },
status?: 'draft' | 'published' | 'trash',
supportedModels?: List<string>,
type?: 'hardware' | 'tablet' | 'reflect',
updateFile?: {
url?: string,
},
version?: string,
},
}GET /firmware/{id}
Get Firmware Update by ID
Response Body
{
data: {
appVersions?: {
android?: {
maxVersion?: string,
minVersion?: string,
},
ios?: {
maxVersion?: string,
minVersion?: string,
},
screen?: {
maxVersion?: string,
minVersion?: string,
},
},
capabilities?: List<{
data?: record,
name?: string,
}>,
dateReleased?: number,
dateRequired?: number,
id?: number,
name?: string,
releaseNotes?: string,
status?: 'draft' | 'published' | 'trash',
supportedModels?: List<string>,
type?: 'hardware' | 'tablet' | 'reflect',
updateFile?: {
url?: string,
},
version?: string,
},
}GET /firmware/{id}
Get Firmware Update by ID
Response Body
{
data: {
appVersions?: {
android?: {
maxVersion?: string,
minVersion?: string,
},
ios?: {
maxVersion?: string,
minVersion?: string,
},
screen?: {
maxVersion?: string,
minVersion?: string,
},
},
capabilities?: List<{
data?: record,
name?: string,
}>,
dateReleased?: number,
dateRequired?: number,
id?: number,
name?: string,
releaseNotes?: string,
+ signatureFile?: {
+ url?: string,
+ },
status?: 'draft' | 'published' | 'trash',
supportedModels?: List<string>,
type?: 'hardware' | 'tablet' | 'reflect',
updateFile?: {
url?: string,
},
version?: string,
},
}PUT /firmware/{id}
Update Firmware Update
Request Body
{
- appVersions?: {
- android?: {
- maxVersion?: string,
- minVersion?: string,
- },
- ios?: {
- maxVersion?: string,
- minVersion?: string,
- },
- screen?: {
- maxVersion?: string,
- minVersion?: string,
- },
- },
- capabilities?: List<{
- data?: record,
- name?: string,
- }>,
- dateReleased?: number,
- dateRequired?: number,
- name?: string,
- releaseNotes?: string,
- status?: 'draft' | 'published' | 'trash',
- supportedModels?: List<string>,
- type?: 'hardware' | 'tablet' | 'reflect',
- updateFile: {
- data?: string,
- filename: string,
- },
- version?: string,
}Response Body
{
data: {
appVersions?: {
android?: {
maxVersion?: string,
minVersion?: string,
},
ios?: {
maxVersion?: string,
minVersion?: string,
},
screen?: {
maxVersion?: string,
minVersion?: string,
},
},
capabilities?: List<{
data?: record,
name?: string,
}>,
dateReleased?: number,
dateRequired?: number,
id?: number,
name?: string,
releaseNotes?: string,
status?: 'draft' | 'published' | 'trash',
supportedModels?: List<string>,
type?: 'hardware' | 'tablet' | 'reflect',
updateFile?: {
url?: string,
},
version?: string,
},
}PUT /firmware/{id}
Update Firmware Update
Request Body
{
+ firmware: string,
+ firmwareBin: string,
}Response Body
{
data: {
appVersions?: {
android?: {
maxVersion?: string,
minVersion?: string,
},
ios?: {
maxVersion?: string,
minVersion?: string,
},
screen?: {
maxVersion?: string,
minVersion?: string,
},
},
capabilities?: List<{
data?: record,
name?: string,
}>,
dateReleased?: number,
dateRequired?: number,
id?: number,
name?: string,
releaseNotes?: string,
+ signatureFile?: {
+ url?: string,
+ },
status?: 'draft' | 'published' | 'trash',
supportedModels?: List<string>,
type?: 'hardware' | 'tablet' | 'reflect',
updateFile?: {
url?: string,
},
version?: string,
},
}PATCH /firmware/{id}
Update Firmware Update
Request Body
{
- appVersions: {
- android?: {
- maxVersion?: string,
- minVersion?: string,
- },
- ios?: {
- maxVersion?: string,
- minVersion?: string,
- },
- screen?: {
- maxVersion?: string,
- minVersion?: string,
- },
- },
- capabilities: List<{
- data?: record,
- name?: string,
- }>,
- dateReleased: number,
- dateRequired: number,
- name: string,
- releaseNotes: string,
- status: 'draft' | 'published' | 'trash',
- supportedModels: List<string>,
- type: 'hardware' | 'tablet' | 'reflect',
- updateFile: {
- data?: string,
- filename: string,
- },
- version: string,
}Response Body
{
data: {
appVersions?: {
android?: {
maxVersion?: string,
minVersion?: string,
},
ios?: {
maxVersion?: string,
minVersion?: string,
},
screen?: {
maxVersion?: string,
minVersion?: string,
},
},
capabilities?: List<{
data?: record,
name?: string,
}>,
dateReleased?: number,
dateRequired?: number,
id?: number,
name?: string,
releaseNotes?: string,
status?: 'draft' | 'published' | 'trash',
supportedModels?: List<string>,
type?: 'hardware' | 'tablet' | 'reflect',
updateFile?: {
url?: string,
},
version?: string,
},
}PATCH /firmware/{id}
Update Firmware Update
Request Body
{
+ firmware: string,
+ firmwareBin: string,
}Response Body
{
data: {
appVersions?: {
android?: {
maxVersion?: string,
minVersion?: string,
},
ios?: {
maxVersion?: string,
minVersion?: string,
},
screen?: {
maxVersion?: string,
minVersion?: string,
},
},
capabilities?: List<{
data?: record,
name?: string,
}>,
dateReleased?: number,
dateRequired?: number,
id?: number,
name?: string,
releaseNotes?: string,
+ signatureFile?: {
+ url?: string,
+ },
status?: 'draft' | 'published' | 'trash',
supportedModels?: List<string>,
type?: 'hardware' | 'tablet' | 'reflect',
updateFile?: {
url?: string,
},
version?: string,
},
}