Firmware Channels

A firmware channel represents a distribution or deployment environment for a device class.

Endpoints

The Channel object

  • bundleIdstring

    ID of the bundle to be deployed to the channel.

  • creationTimestring| format is date-time

    Timestamp of channel creation.

  • descriptionstring

    Description of the channel.

  • deviceClassstring

    device class that this channel belongs to.

  • idstring

    Unique ID assigned at time of creation.

  • namestring

    Display name of channel and is unique per device class and project.

  • projectIdinteger

    Project that this channel belongs to.

Get firmware channels

Endpoint
get /channels
Description

Get a list of firmware channels for a project. Optionally, results can be filtered by device class or keywords.

Query Parameters

  • projectId

    integer

    required

    Return channels of the specified project.

  • deviceClass

    string

    Return only channels for the specified Device Class ID

  • search

    string

    Search for channels by keywords.

  • sortBy

    string

    A comma-delimited list of sort keys. (e.g. "name:asc,deviceClass:desc")

  • skip

    integer

    required

    Number of channels to skip over.

  • limit

    integer

    required

    Maximum number of channels to return. If value is 0, all channels are returned.

    Default value is 25

Request Headers What's this?

  • Authorization

    Must contain either a user, device, or project API key.

Response
  • 200Successful retrieval of firmware channels.
  • 401Authorization is required to access this resource.
  • 403Request failed because of denied permission.
  • 500An unexpected error has occurred.
  • 503The service is temporarily unavailable.