Firmware Bundles

ListFirmware

get/firmwares

Request

Base URL
https://api.nrfcloud.com/v1
Auth
HTTP bearer
TypeScript
https://skmtc.dev/nrfcloud/apis/nrf-cloud-rest-api/docs/firmwares/get.ts
A function with typed inputs. Its response is checked against the schema.

Query parameters

pageNextTokenstring

If available in the initial response, use this token to retrieve the next page of items in the list. When supplying as a request parameter, use URL-encoding.

Example:4bb1f9ab35bd

pageLimitinteger

Maximum number of items you want returned in the response (<=100).

modemOnlyboolean

Whether or not to return a list of modem firmware instead of the current tenant's firmware

Response

totalinteger

Reflects the total results returned by the query, which may be less than the total number of items available. If the response contains a pageNextToken value, you can supply the pageNextToken in the next request to get more results. The maximum value of total is the page limit of the request, or ten pages if no page limit is provided.

pageNextTokenstring

Token used to retrieve the next page of items in the list. Present in a response only if the total available results exceeds the specified limit on a page. This token does not change between requests. When supplying as a request parameter, use URL-encoding.

Example response

{
  "total": 10,
  "pageNextToken": "4bb1f9ab35bd"
}

Changes

No recorded changes to this operation across all 7 revisions of this API.