Documentation

Mistake on this page? Email us

Factory Configurator Utility (FCU) download API

This is the API documentation for the Factory Configurator Utility (FCU) download service, which authorized customers can use to download the FCU archive for factory provisioning.
Please contact us to enable FCU download for your account.
For more information about FCU, please see the Pelion factory provisioning documentation.
Version: 1.0.0
Host: https://api.us-east-1.mbedcloud.com

Endpoints

ManufacturingFactoryConfiguratorUtilityFCU

get /downloads/fcu/factory_configurator_utility.zip
Download the Factory Configurator Utility archive. Show more Show less

Downloads the Factory Configurator Utility (FCU) archive .zip file for the account ID associated with the access token.
Example:

curl -X GET https://api.us-east-1.mbedcloud.com/downloads/fcu/factory_configurator_utility.zip \
-H 'Authorization: Bearer <valid access token>'
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/zip
Responses
status description schema
200 The archive file was downloaded successfully.
400 Validation error or bad request. ErrorResponse
401 Authentication failure. ErrorResponse
403 Access denied. ErrorResponse
500 Internal server error. ErrorResponse
get /downloads/fcu/info
Download information about the Factory Configurator Utility archive. Show more Show less

Returns information about the Factory Configurator Utility (FCU) archive.
Example:

curl -X GET https://api.us-east-1.mbedcloud.com/downloads/fcu/inf \
-H 'Authorization: Bearer <valid access token>' o
Return type
Example data
Content-Type: application/json
{
  "download_size_bytes" : 2402668,
  "release_notes_url" : "https://api.us-east-1.mbedcloud.com/downloads/fcu/release_notes",
  "license_type" : "fcu",
  "download_url" : "https://api.us-east-1.mbedcloud.com/downloads/fcu/factory_configurator_utility.zip",
  "license_version" : "1.0",
  "version" : "1.2.9.500"
}
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 Successful response of the archive information. ArchiveInfoResponse
400 Validation error or bad request. ErrorResponse
401 Authentication failure. ErrorResponse
403 Access denied. ErrorResponse
500 Internal server error. ErrorResponse
get /downloads/fcu/release_notes
Download Factory Configurator Utility release notes. Show more Show less

Downloads the Factory Configurator Utility (FCU) release notes.
Example:

curl -X GET https://api.us-east-1.mbedcloud.com/downloads/fcu/release_notes \
-H 'Authorization: Bearer <valid access token>'
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.
  • text/markdown ; charset=UTF-8
  • application/json
Responses
status description schema
200 The release notes were downloaded successfully.
400 Validation error or bad request. ErrorResponse
401 Authentication failure. ErrorResponse
403 Access denied. ErrorResponse
500 Internal server error. ErrorResponse

Models

ArchiveInfoResponse

This object represents the response for the archive info request.
download_size_bytes
Integer

The size of the archive file in bytes.

download_url
String

URL to download the Factory Configurator Utility archive.

version
String

The Factory Configurator Utility version.

release_notes_url
String

URL to the Factory Configurator Utility release notes.

license_type (optional)
String

The license agreement type required for downloading Factory Configurator Utility.

license_version (optional)
String

The license agreement version required for downloading Factory Configurator Utility.

ErrorResponse

object
String

Entity name, always error.

Enum:
error
code
Integer ($int32)

HTTP response code

type
String

Error type used to categorise the error.

message
String

A human readable informative explanation

request_id
String

ID of the request.

fields (optional)
array[ErrorResponse_fields]

Request fields which failed validation.

ErrorResponse_fields

name
String

Name of the field which caused the error.

message
String

Message describing the error condition.