Mistake on this page? Email us

Update Service API

This is the API documentation for the Device Management deployment service, which is part of the Update service.
Version: 3
Host: https://api.us-east-1.mbedcloud.com

Endpoints

Default

post /v3/firmware-images/
Create an image Show more Show less
Create a firmware image.
Consumes
This API call consumes the following media types via the Content-Type request header:
  • multipart/form-data
Form parameters
datafile (required)
Form Parameter — The firmware image file to upload
description (optional)
Form Parameter — The description of the firmware image
name (required)
Form Parameter — The name of the firmware image
Return type
Example data
Content-Type: application/json
{
  "datafile_checksum" : "0000000000000000000000000000000000000000000000000000000000000000",
  "updated_at" : "2017-05-22T12:37:55.576563Z",
  "datafile_size" : 0,
  "name" : "",
  "created_at" : "2017-05-22T12:37:55.576563Z",
  "description" : "",
  "etag" : "2017-05-22T12:37:55.576563Z",
  "id" : "00000000000000000000000000000000",
  "datafile" : "http://example.com/00000000000000000000000000000000",
  "object" : "firmware-image"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json
Responses
status description schema
201 Firmware image created. The API gateway enforces the account-specific file size. FirmwareImage
400 Validation error: Cannot validate the data used to create the firmware image
401 Not authenticated
403 Forbidden
delete /v3/firmware-images/{image_id}/
Delete an image Show more Show less
Delete a firmware image.
Path parameters
image_id (required)
Path Parameter — The firmware image ID
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json
Responses
status description schema
204 Firmware image deleted
400 Bad Request
401 Not authenticated
404 Firmware image not found
get /v3/firmware-images/
List all images Show more Show less
List all firmware images.
Query parameters
limit (optional)
Query Parameter — How many firmware images to retrieve
order (optional)
Query Parameter — ASC or DESC
after (optional)
Query Parameter — The ID of the the item after which to retrieve the next page
include (optional)
Query Parameter — A comma-separated list of data fields to return. Currently supported: total_count
filter (optional)
Query Parameter

URL-encoded query string parameter to filter returned data

?filter={URL-encoded query string}

Filterable fields:

The table lists all the fields that can be filtered on with certain filters:

Field = / __eq / __neq __in / __nin __lte / __gte
created_at
datafile  
datafile_checksum  
datafile_size  
description  
etag
id  
name  
timestamp
updated_at
 

The query string is made up of key-value pairs separated by ampersands. For example, this query: key1=value1&key2=value2&key3=value3

would be URL-encoded as: ?filter=key1__eq%3Dvalue1%26key2__eq%3Dvalue2%26key3__eq%3Dvalue3

Filtering by properties name__eq=myimage

Filtering on date-time fields

Date-time fields should be specified in UTC RFC3339 format, YYYY-MM-DDThh:mm:ss.msZ. There are three permitted variations:

  • UTC RFC3339 with milliseconds. Example: 2016-11-30T16:25:12.1234Z
  • UTC RFC3339 without milliseconds. Example: 2016-11-30T16:25:12Z
  • UTC RFC3339 shortened without milliseconds and punctuation. Example: 20161130T162512Z

Date-time filtering supports three operators:

  • equality by appending __eq to the field name
  • greater than or equal to by appending __gte to the field name
  • less than or equal to by appending __lte to the field name

{field name}[|__eq|__lte|__gte]={UTC RFC3339 date-time}

Time ranges may be specified by including both the __gte and __lte forms in the filter. For example:

created_at__gte=2016-11-30T16:25:12.1234Z&created_at__lte=2016-12-30T00:00:00Z

Filtering on multiple fields

name__eq=myimage&created_at__gte=2016-11-30T16:25:12.1234Z&created_at__lte=2016-12-30T00:00:00Z

Filtering with filter operators

String field filtering supports the following operators:

  • equality: __eq
  • non-equality: __neq
  • in : __in
  • not in: __nin

For __in and __nin filters list of parameters must be comma-separated:

name__in=fw-image1,fw-image2

Return type
Example data
Content-Type: application/json
{
  "data" : "[]",
  "total_count" : 6,
  "limit" : 0,
  "after" : "null",
  "has_more" : true,
  "object" : "list",
  "order" : "ASC"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json
Responses
status description schema
200 Request successful FirmwareImagePage
400 Bad Request
401 Not authenticated
404 Unable to find content
get /v3/firmware-images/{image_id}/
Retrieve a firmware image.
Path parameters
image_id (required)
Path Parameter — The firmware image ID
Return type
Example data
Content-Type: application/json
{
  "datafile_checksum" : "0000000000000000000000000000000000000000000000000000000000000000",
  "updated_at" : "2017-05-22T12:37:55.576563Z",
  "datafile_size" : 0,
  "name" : "",
  "created_at" : "2017-05-22T12:37:55.576563Z",
  "description" : "",
  "etag" : "2017-05-22T12:37:55.576563Z",
  "id" : "00000000000000000000000000000000",
  "datafile" : "http://example.com/00000000000000000000000000000000",
  "object" : "firmware-image"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json
Responses
status description schema
200 Retrieved result successfully FirmwareImage
400 Bad Request
401 Not authenticated
404 Firmware image can't be found
post /v3/firmware-manifests/
Upload a manifest Show more Show less
Upload a firmware manifest. The API enforces a maximum size of manifests of 2 KB.
Consumes
This API call consumes the following media types via the Content-Type request header:
  • multipart/form-data
Form parameters
datafile (required)
Form Parameter — The manifest file to create. The API gateway enforces the account-specific file size.
description (optional)
Form Parameter — The description of the firmware manifest
key_table (optional)
Form Parameter — The key table of pre-shared keys for devices
name (required)
Form Parameter — The name of the firmware manifest
Return type
Example data
Content-Type: application/json
{
  "key_table" : "http://example.com",
  "updated_at" : "2017-05-22T12:37:55.576563Z",
  "datafile_size" : 0,
  "name" : "",
  "created_at" : "2017-05-22T12:37:55.576563Z",
  "description" : "",
  "device_class" : "00000000-0000-0000-0000-000000000000",
  "etag" : "2017-05-22T12:37:55.576563Z",
  "id" : "00000000000000000000000000000000",
  "datafile" : "http://example.com/00000000000000000000000000000000",
  "object" : "firmware-manifest",
  "timestamp" : "2017-05-22T12:37:55.576563Z"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json
Responses
status description schema
201 Created FirmwareManifest
400 Validation error. The data used to create the firmware manifest did not validate and/or the manifest uploaded exceeded 2 KB in size.
401 Not authenticated
403 Forbidden
delete /v3/firmware-manifests/{manifest_id}/
Delete a manifest Show more Show less
Delete a firmware manifest.
Path parameters
manifest_id (required)
Path Parameter — The firmware manifest ID
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json
Responses
status description schema
204 Firmware manifest deleted
400 Bad Request
401 Not authenticated
404 Firmware manifest not found
get /v3/firmware-manifests/
List firmware manifests.
Query parameters
limit (optional)
Query Parameter — How many firmware manifests to retrieve
order (optional)
Query Parameter — ASC or DESC
after (optional)
Query Parameter — The ID of the the item after which to retrieve the next page
include (optional)
Query Parameter — A comma-separated list of data fields to return. Currently supported: total_count
filter (optional)
Query Parameter

URL-encoded query string parameter to filter returned data

?filter={URL-encoded query string}

Filterable fields:

The table lists all the fields that can be filtered on with certain filters:

Field = / __eq / __neq __in / __nin __lte / __gte
created_at
datafile  
datafile_size  
description  
device_class  
etag
id  
name  
timestamp
updated_at
 

The query string is made up of key-value pairs separated by ampersands. For example, this query: key1__eq=value1&key2__eq=value2&key3__eq=value3

would be URL-encoded as: ?filter=key1__eq%3Dvalue1%26key2__eq%3Dvalue2%26key3__eq%3Dvalue3

Filtering by properties name__eq=mymanifest

Filtering on date-time fields

Date-time fields should be specified in UTC RFC3339 format, YYYY-MM-DDThh:mm:ss.msZ. There are three permitted variations:

  • UTC RFC3339 with milliseconds. Example: 2016-11-30T16:25:12.1234Z
  • UTC RFC3339 without milliseconds. Example: 2016-11-30T16:25:12Z
  • UTC RFC3339 shortened without milliseconds and punctuation. Example: 20161130T162512Z

Date-time filtering supports three operators:

  • equality by appending __eq to the field name
  • greater than or equal to by appending __gte to the field name
  • less than or equal to by appending __lte to the field name

{field name}[|__eq|__lte|__gte]={UTC RFC3339 date-time}

Time ranges may be specified by including both the __gte and __lte forms in the filter. For example:

created_at__gte=2016-11-30T16:25:12.1234Z&created_at__lte=2016-12-30T00:00:00Z

Filtering on multiple fields

name__eq=mymanifest&created_at__gte=2016-11-30T16:25:12.1234Z&created_at__lte=2016-12-30T00:00:00Z

Filtering with filter operators

String field filtering supports the following operators:

  • equality: __eq
  • non-equality: __neq
  • in : __in
  • not in: __nin

For __in and __nin filters list of parameters must be comma-separated:

name__in=fw-manifest1,fw-manifest2

Return type
Example data
Content-Type: application/json
{
  "data" : "[]",
  "total_count" : 6,
  "limit" : 0,
  "after" : "null",
  "has_more" : true,
  "object" : "list",
  "order" : "ASC"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json
Responses
status description schema
200 Request successful FirmwareManifestPage
400 Bad Request
401 Not authenticated
404 Unable to find content
get /v3/firmware-manifests/{manifest_id}/
Retrieve a firmware manifest.
Path parameters
manifest_id (required)
Path Parameter — The firmware manifest ID
Return type
Example data
Content-Type: application/json
{
  "key_table" : "http://example.com",
  "updated_at" : "2017-05-22T12:37:55.576563Z",
  "datafile_size" : 0,
  "name" : "",
  "created_at" : "2017-05-22T12:37:55.576563Z",
  "description" : "",
  "device_class" : "00000000-0000-0000-0000-000000000000",
  "etag" : "2017-05-22T12:37:55.576563Z",
  "id" : "00000000000000000000000000000000",
  "datafile" : "http://example.com/00000000000000000000000000000000",
  "object" : "firmware-manifest",
  "timestamp" : "2017-05-22T12:37:55.576563Z"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json
Responses
status description schema
200 Retrieved result successfully FirmwareManifest
400 Bad request
401 Not authenticated
404 Firmware manifest can't be found
post /v3/update-campaigns/{campaign_id}/archive
Archive a campaign. Show more Show less
This command will archive a campaign.
Path parameters
campaign_id (required)
Path Parameter — The campaign ID
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json
Responses
status description schema
202 The campaign has been archived.
400 Unable to change the phase of the campaign.
401 Not authenticated.
404 Cannot find the campaign.
409 Cannot archive the campaign while in the current phase.
post /v3/update-campaigns/
Create a campaign Show more Show less
Create an update campaign.
Request body
campaign UpdateCampaignPostRequest (required)
Body Parameter — Update campaign
Return type
Example data
Content-Type: application/json
{
  "phase" : "aeiou",
  "created_at" : "2017-05-22T12:37:55.576563Z",
  "description" : "",
  "finished" : "2017-05-22T12:37:55.576563Z",
  "root_manifest_id" : "00000000000000000000000000000000",
  "when" : "2017-05-22T12:37:55.576563Z",
  "updated_at" : "2017-05-22T12:37:55.576563Z",
  "device_filter" : "id__eq=00000000000000000000000000000000",
  "root_manifest_url" : "http://example.com/00000000000000000000000000000000",
  "name" : "campaign",
  "started_at" : "2017-05-22T12:37:55.576563Z",
  "etag" : "2017-05-22T12:37:58.753425Z",
  "id" : "00000000000000000000000000000000",
  "state" : "draft",
  "autostop_reason" : "Insufficient billing credit.",
  "object" : "update-campaign"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json
Responses
status description schema
201 Update campaign created UpdateCampaign
400 Validation error: The data used to create the campaign did not validate
401 Not authenticated
delete /v3/update-campaigns/{campaign_id}/
Delete a campaign Show more Show less
Delete an update campaign.
Path parameters
campaign_id (required)
Path Parameter — The ID of the update campaign
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json
Responses
status description schema
204 Update campaign deleted
400 Validation error: The data used to update the campaign did not validate
401 Not authenticated
404 Update campaign can't be found
get /v3/update-campaigns/
List all campaigns Show more Show less
Get update campaigns for devices specified by a filter.
Query parameters
limit (optional)
Query Parameter — How many update campaigns to retrieve
order (optional)
Query Parameter — The order of the records. Acceptable values: ASC, DESC. Default: ASC
after (optional)
Query Parameter — The ID of the the item after which to retrieve the next page
include (optional)
Query Parameter — A comma-separated list of data fields to return. Currently supported: total_count
filter (optional)
Query Parameter

URL-encoded query string parameter to filter returned data

?filter={URL-encoded query string}

Filterable fields:

The below table lists all the fields that can be filtered on with certain filters:

Field = / __eq / __neq __in / __nin __lte / __gte
created_at
description  
device_filter  
etag
finished
id  
name  
root_manifest_id  
started_at
state  
updated_at
when
 

The query string is made up of key-value pairs separated by ampersands. For example, this query: key1__eq=value1&key2__eq=value2&key3__eq=value3

would be URL-encoded as: ?filter=key1__eq%3Dvalue1%26key2__eq%3Dvalue2%26key3__eq%3Dvalue3

Filtering by campaign properties state__eq=[draft|scheduled|devicefectch|devicecopy|publishing|deploying|deployed|manifestremoved|expired]

root_manifest_id__eq=43217771234242e594ddb433816c498a

Filtering on date-time fields

Date-time fields should be specified in UTC RFC3339 format, YYYY-MM-DDThh:mm:ss.msZ. There are three permitted variations:

  • UTC RFC3339 with milliseconds. Example: 2016-11-30T16:25:12.1234Z
  • UTC RFC3339 without milliseconds. Example: 2016-11-30T16:25:12Z
  • UTC RFC3339 shortened without milliseconds and punctuation. Example: 20161130T162512Z

Date-time filtering supports three operators:

  • equality by appending __eq to the field name
  • greater than or equal to by appending __gte to the field name
  • less than or equal to by appending __lte to the field name

{field name}[|__eq|__lte|__gte]={UTC RFC3339 date-time}

Time ranges may be specified by including both the __gte and __lte forms in the filter. For example:

created_at__gte=2016-11-30T16:25:12.1234Z&created_at__lte=2016-12-30T00:00:00Z

Filtering on multiple fields

state__eq=deployed&created_at__gte=2016-11-30T16:25:12.1234Z&created_at__lte=2016-12-30T00:00:00Z

Filtering with filter operators

String field filtering supports the following operators:

  • equality: __eq
  • non-equality: __neq
  • in : __in
  • not in: __nin

For __in and __nin filters list of parameters must be comma-separated:

name__in=fw-image1,fw-image2

Return type
Example data
Content-Type: application/json
{
  "data" : "[]",
  "total_count" : 6,
  "limit" : 0,
  "after" : "null",
  "has_more" : true,
  "object" : "list",
  "order" : "ASC"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json
Responses
status description schema
200 Request successful UpdateCampaignPage
400 Validation error: The data used to update the campaign did not validate
401 Not authenticated
404 Unable to find content
get /v3/update-campaigns/{campaign_id}/campaign-device-metadata/
List all campaign device metadata Show more Show less
Get campaign device metadata.
Path parameters
campaign_id (required)
Path Parameter — The update campaign ID
Query parameters
limit (optional)
Query Parameter — How many objects to retrieve in the page
order (optional)
Query Parameter — ASC or DESC
after (optional)
Query Parameter — The ID of the the item after which to retrieve the next page
include (optional)
Query Parameter — A comma-separated list of data fields to return. Currently supported: total_count
Return type
Example data
Content-Type: application/json
{
  "data" : [ {
    "device_id" : "015c2fec9bba0000000000010010036f",
    "updated_at" : "2017-05-22T12:37:58.776736Z",
    "mechanism_url" : "",
    "name" : "default_object_name",
    "campaign" : "015bf72fccda00000000000100100280",
    "created_at" : "2017-05-22T12:37:55.576563Z",
    "description" : "",
    "etag" : "2017-05-22T12:37:58.753425Z",
    "id" : "015c3029f6f7000000000001001000c3",
    "mechanism" : "connector",
    "deployment_state" : "pending",
    "object" : "update-campaign-device-metadata"
  } ],
  "total_count" : 1,
  "limit" : 50,
  "after" : "null",
  "has_more" : false,
  "object" : "list",
  "order" : "ASC"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json
Responses
status description schema
200 Request successful CampaignDeviceMetadataPage
401 Unauthorized
get /v3/update-campaigns/{campaign_id}/campaign-device-metadata/{campaign_device_metadata_id}/
Get a campaign device metadata Show more Show less
Get update campaign metadata.
Path parameters
campaign_id (required)
Path Parameter — The update campaign ID
campaign_device_metadata_id (required)
Path Parameter — The campaign device metadata ID
Return type
Example data
Content-Type: application/json
{
  "device_id" : "015c2fec9bba0000000000010010036f",
  "updated_at" : "2017-05-22T12:37:58.776736Z",
  "mechanism_url" : "",
  "name" : "default_object_name",
  "campaign" : "015bf72fccda00000000000100100280",
  "created_at" : "2017-05-22T12:37:55.576563Z",
  "description" : "",
  "etag" : "2017-05-22T12:37:58.753425Z",
  "id" : "015c3029f6f7000000000001001000c3",
  "mechanism" : "connector",
  "deployment_state" : "pending",
  "object" : "update-campaign-device-metadata"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json
Responses
status description schema
200 Request successful CampaignDeviceMetadata
401 Unauthorized
404 Not Found
get /v3/update-campaigns/{campaign_id}/metrics
Get campaign metrics Show more Show less
Get detailed statistics of a campaign.
Path parameters
campaign_id (required)
Path Parameter — The campaign ID
Return type
Example data
Content-Type: application/json
{
  "pending_count" : 10,
  "total_count" : 100,
  "success_count" : 90,
  "created_at" : "2017-05-22T12:37:55.576563Z",
  "failed_count" : 0,
  "object" : "update-campaign-metrics"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json
Responses
status description schema
200 Request successful CampaignMetrics
401 Unauthorized
404 Unable to find campaign or the campaign hasn't started.
get /v3/update-campaigns/{campaign_id}/
Get a campaign. Show more Show less
Get an update campaign.
Path parameters
campaign_id (required)
Path Parameter — The campaign ID
Return type
Example data
Content-Type: application/json
{
  "phase" : "aeiou",
  "created_at" : "2017-05-22T12:37:55.576563Z",
  "description" : "",
  "finished" : "2017-05-22T12:37:55.576563Z",
  "root_manifest_id" : "00000000000000000000000000000000",
  "when" : "2017-05-22T12:37:55.576563Z",
  "updated_at" : "2017-05-22T12:37:55.576563Z",
  "device_filter" : "id__eq=00000000000000000000000000000000",
  "root_manifest_url" : "http://example.com/00000000000000000000000000000000",
  "name" : "campaign",
  "started_at" : "2017-05-22T12:37:55.576563Z",
  "etag" : "2017-05-22T12:37:58.753425Z",
  "id" : "00000000000000000000000000000000",
  "state" : "draft",
  "autostop_reason" : "Insufficient billing credit.",
  "object" : "update-campaign"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json
Responses
status description schema
200 Retrieved result successfully UpdateCampaign
400 Validation error: The data used to update the campaign did not validate
401 Not authenticated
404 Unable to find campaign
post /v3/update-campaigns/{campaign_id}/start
Start a campaign. Show more Show less
This command will begin the process of starting a campaign.
Path parameters
campaign_id (required)
Path Parameter — The campaign ID
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json
Responses
status description schema
202 The campaign is starting.
400 Unable to change the phase of the campaign.
401 Not authenticated.
404 Cannot find the campaign.
409 Cannot start the campaign while in the current phase.
post /v3/update-campaigns/{campaign_id}/stop
Stop a campaign. Show more Show less
This command will begin the process of stopping a campaign.
Path parameters
campaign_id (required)
Path Parameter — The campaign ID
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json
Responses
status description schema
202 The campaign is stopping.
400 Unable to change the phase of the campaign.
401 Not authenticated.
404 Cannot find the campaign.
409 Cannot stop the campaign while in the current phase.
put /v3/update-campaigns/{campaign_id}/
Modify a campaign Show more Show less
Modify an update campaign.
Path parameters
campaign_id (required)
Path Parameter
Request body
campaign UpdateCampaignPutRequest (required)
Body Parameter — Update campaign
Return type
Example data
Content-Type: application/json
{
  "phase" : "aeiou",
  "created_at" : "2017-05-22T12:37:55.576563Z",
  "description" : "",
  "finished" : "2017-05-22T12:37:55.576563Z",
  "root_manifest_id" : "00000000000000000000000000000000",
  "when" : "2017-05-22T12:37:55.576563Z",
  "updated_at" : "2017-05-22T12:37:55.576563Z",
  "device_filter" : "id__eq=00000000000000000000000000000000",
  "root_manifest_url" : "http://example.com/00000000000000000000000000000000",
  "name" : "campaign",
  "started_at" : "2017-05-22T12:37:55.576563Z",
  "etag" : "2017-05-22T12:37:58.753425Z",
  "id" : "00000000000000000000000000000000",
  "state" : "draft",
  "autostop_reason" : "Insufficient billing credit.",
  "object" : "update-campaign"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json
Responses
status description schema
200 Update campaign updated UpdateCampaign
400 Validation error: The data used to update the campaign did not validate
401 Not authenticated
403 Fields apart from 'name', 'description' and 'state' cannot be modified when the state is not 'draft'.
404 Update campaign can't be found

Models

CampaignDeviceMetadata

campaign (optional)
String The device's campaign ID
created_at (optional)
Date The time the campaign was created format: date-time
deployment_state (optional)
String The state of the update campaign on the device
Enum:
pending
updated_connector_channel
failed_connector_channel_update
deployed
manifestremoved
deregistered
description (optional)
String Description
device_id (optional)
String The device ID
etag (optional)
String API resource entity version
id (optional)
String The metadata record ID
mechanism (optional)
String How the firmware is delivered (connector or direct)
mechanism_url (optional)
String The Device Management Connect URL
name (optional)
String The record name
object (optional)
String The entity name: always 'update-campaign-device-metadata'
updated_at (optional)
Date The record was modified in the database format: date-time format: date-time

CampaignDeviceMetadataPage

object (optional)
String The entity name: always 'list'
order (optional)
String The order of the records to return. Acceptable values: ASC, DESC. Default: ASC
Enum:
ASC
DESC
limit (optional)
Integer The number of results to return, (range: 2-1000), or equals to total_count
after (optional)
String The entity ID to fetch after the given one
has_more (optional)
Boolean A flag indicating whether there are more results
data (optional)
array[CampaignDeviceMetadata] A list of entities
total_count (optional)
Integer The total number or records, if requested. It may be returned also for small lists.

CampaignMetrics

object (optional)
String Entity name: always 'update-campaign-metrics'
created_at (optional)
Date The time the metrics were created. format: date-time
success_count (optional)
Integer Running total of successfully updated devices. format: int32
failed_count (optional)
Integer Running total of devices that could not be updated. format: int32
pending_count (optional)
Integer Running total of devices that have yet to receive an update or are applying an update. format: int32
total_count (optional)
Integer Number of devices in the campaign. format: int32

FirmwareImage

created_at
Date The time the object was created format: date-time
datafile
String The firmware image file URL
datafile_checksum
String The checksum (sha256) generated for the datafile
datafile_size (optional)
Long The size of the datafile in bytes format: int64
description
String The description of the object
etag
Date The entity instance signature format: date-time
id
String The firmware image ID
name
String The firmware image name
object
String The API resource entity
updated_at
Date The time the object was updated format: date-time

FirmwareImageEqNeqFilter

created_at (optional)
Date format: date-time
datafile (optional)
datafile_checksum (optional)
datafile_size (optional)
description (optional)
etag (optional)
Date format: date-time
id (optional)
name (optional)
updated_at (optional)
Date format: date-time

FirmwareImageGteLteFilter

created_at (optional)
Date format: date-time
etag (optional)
Date format: date-time
updated_at (optional)
Date format: date-time

FirmwareImageInNinFilter

created_at (optional)
Date format: date-time
datafile (optional)
datafile_checksum (optional)
datafile_size (optional)
description (optional)
etag (optional)
Date format: date-time
id (optional)
name (optional)
updated_at (optional)
Date format: date-time

FirmwareImagePage

after (optional)
data (optional)
has_more (optional)
limit (optional)
Integer format: int32
object (optional)
order (optional)
String The order of the records based on creation time, ASC or DESC; by default ASC.
Enum:
ASC
DESC
total_count (optional)
Integer format: int32

FirmwareManifest

created_at
Date The time the object was created format: date-time
datafile
String The URL of the firmware manifest binary
datafile_size (optional)
Long The size of the datafile in bytes format: int64
description
String The description of the firmware manifest
device_class
String The class of the device
etag
Date The entity instance signature format: date-time
key_table (optional)
String The key table of pre-shared keys for devices format: uri
id
String The firmware manifest ID
name
String The name of the object
object
String The API resource entity
timestamp
Date The firmware manifest version as a timestamp format: date-time
updated_at
Date The time the object was updated format: date-time

FirmwareManifestEqNeqFilter

created_at (optional)
Date format: date-time
datafile (optional)
datafile_size (optional)
description (optional)
device_class (optional)
etag (optional)
Date format: date-time
id (optional)
name (optional)
timestamp (optional)
Date format: date-time
updated_at (optional)
Date format: date-time

FirmwareManifestGteLteFilter

created_at (optional)
Date format: date-time
etag (optional)
Date format: date-time
timestamp (optional)
Date format: date-time
updated_at (optional)
Date format: date-time

FirmwareManifestInNinFilter

created_at (optional)
Date format: date-time
datafile (optional)
datafile_size (optional)
description (optional)
device_class (optional)
etag (optional)
Date format: date-time
id (optional)
name (optional)
timestamp (optional)
Date format: date-time
updated_at (optional)
Date format: date-time

FirmwareManifestPage

after (optional)
data (optional)
has_more (optional)
limit (optional)
Integer format: int32
object (optional)
order (optional)
String The order of the records to return. Acceptable values: ASC, DESC. Default: ASC
Enum:
ASC
DESC
total_count (optional)
Integer format: int32

UpdateCampaign

autostop_reason (optional)
String Text description of why a campaign failed to start or why a campaign stopped.
phase (optional)
String The current phase of the campaign.
created_at (optional)
Date The time the update campaign was created format: date-time
description (optional)
String An optional description of the campaign
device_filter (optional)
String The filter for the devices the campaign is targeting at
etag (optional)
String The entity instance signature
finished (optional)
Date The campaign finish timestamp format: date-time
id (optional)
String The campaign ID
name (optional)
String The campaign name
object (optional)
String The API resource entity
root_manifest_id (optional)
root_manifest_url (optional)
started_at (optional)
Date format: date-time
state (optional)
String DEPRECATED: The state of the campaign (use phase instead).
Enum:
draft
scheduled
allocatingquota
allocatedquota
quotaallocationfailed
checkingmanifest
checkedmanifest
devicefetch
devicecopy
devicecheck
publishing
deploying
deployed
manifestremoved
expired
stopping
autostopped
userstopped
conflict
when (optional)
Date The scheduled start time for the campaign. The campaign will start within 1 minute when then start time has elapsed. format: date-time
updated_at (optional)
Date The time the object was updated format: date-time

UpdateCampaignEqNeqFilter

created_at (optional)
Date format: date-time
description (optional)
device_filter (optional)
etag (optional)
Date format: date-time
finished (optional)
Date format: date-time
id (optional)
name (optional)
root_manifest_id (optional)
started_at (optional)
Date format: date-time
state (optional)
when (optional)
Date format: date-time
updated_at (optional)
Date format: date-time

UpdateCampaignGteLteFilter

created_at (optional)
Date format: date-time
etag (optional)
Date format: date-time
finished (optional)
Date format: date-time
started_at (optional)
Date format: date-time
when (optional)
Date format: date-time
updated_at (optional)
Date format: date-time

UpdateCampaignInNinFilter

created_at (optional)
Date format: date-time
description (optional)
device_filter (optional)
etag (optional)
Date format: date-time
finished (optional)
Date format: date-time
id (optional)
name (optional)
root_manifest_id (optional)
started_at (optional)
Date format: date-time
state (optional)
when (optional)
Date format: date-time
updated_at (optional)
Date format: date-time

UpdateCampaignPage

after (optional)
data (optional)
has_more (optional)
limit (optional)
object (optional)
order (optional)
String The order of the records to return. Acceptable values: ASC, DESC. Default: ASC
Enum:
ASC
DESC
total_count (optional)

UpdateCampaignPostRequest

description (optional)
String An optional description of the campaign
device_filter
String The filter for the devices the campaign is targeting at
name (optional)
String The name for this campaign
object (optional)
String The API resource entity
root_manifest_id (optional)
state (optional)
String DEPRECATED: The state of the campaign (use phase instead)
Enum:
draft
scheduled
allocatingquota
allocatedquota
quotaallocationfailed
checkingmanifest
checkedmanifest
devicefetch
devicecopy
devicecheck
publishing
deploying
deployed
manifestremoved
expired
stopping
autostopped
userstopped
conflict
when (optional)
Date The scheduled start time for the update campaign. Not in use. format: date-time

UpdateCampaignPutRequest

description (optional)
String An optional description of the campaign
device_filter (optional)
String The filter for the devices the campaign is targeting at
name (optional)
String The campaign's name
object (optional)
String The API resource entity
root_manifest_id (optional)
state (optional)
String DEPRECATED: The state of the campaign (use phase instead).
Enum:
draft
scheduled
allocatingquota
allocatedquota
quotaallocationfailed
checkingmanifest
checkedmanifest
devicefetch
devicecopy
devicecheck
publishing
deploying
deployed
manifestremoved
expired
stopping
autostopped
userstopped
conflict
when (optional)
Date The scheduled start time for the update campaign. Not in use. format: date-time
Important Information for this Arm website

This site uses cookies to store information on your computer. By continuing to use our site, you consent to our cookies. If you are not happy with the use of these cookies, please review our Cookie Policy to learn how they can be disabled. By disabling cookies, some features of the site will not work.