Get firmware channels
GET/channels
Base URL: https://api.tinkermode.com
Get a list of firmware channels for a project. Optionally, results can be filtered by device class or keywords.
Authentication
Send an Authorization header of the form ModeCloud <AUTH_CODE>.
Must contain either a user, service account, device, or project API key.
Query parameters
| Name | Type | Required | Constraints | Description |
|---|---|---|---|---|
deviceClass | string | No | Return only channels for the specified Device Class ID | |
limit | integer | No | default: 25; min: 0 | Maximum number of channels to return. If value is 0, all channels are returned. |
projectId | integer | Yes | Return channels of the specified project. | |
search | string | No | Search for channels by keywords. | |
skip | integer | No | default: 0; min: 0 | Number of channels to skip over. |
sortBy | string | No | A comma-delimited list of sort keys. (e.g. "name:asc,deviceClass:desc") The default sort order is ascending. |
Responses
200 Successful retrieval of firmware channels.
Content type: application/json
Represents a channel.
An array of objects with the following shape:
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
bundleId | string | No | ID of the bundle to be deployed to the channel. | |
creationTime | string | No | read-only (server-generated); format: date-time | Timestamp of channel creation. |
description | string | No | Description of the channel. | |
deviceClass | string | Yes | read-only (server-generated) | device class that this channel belongs to. |
id | string | Yes | read-only (server-generated) | Unique ID assigned at time of creation. |
name | string | Yes | Display name of channel and is unique per device class and project. | |
projectId | integer | Yes | read-only (server-generated) | Project that this channel belongs to. |
401 Authorization is required to access this resource.
Content type: application/json
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
403 Request failed because of denied permission.
Content type: application/json
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
429 Request failed because of rate limit.
Content type: application/json
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
500 An unexpected error has occurred.
Content type: application/json
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
503 The service is temporarily unavailable.
Content type: application/json
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |