Please enable JavaScript to view this website.

Skip to main content

QuickLink API (1.0.0)

Download OpenAPI specification:Download

This API functions as a proxy to the Artifactory API. It provides endpoints to query and download artifacts from Artifactory.

Artifactory API

Endpoints to query and download artifacts from Artifactory

Get Artifacts

This endpoint uses the Artifactory API to query both the FW_Releases and cluster-releases repositories for all the released artifacts for a given Part Number and Product ID combination.

Authorizations:
auth0-authorizer
query Parameters
productId
required
string

The product ID to filter artifacts.

partNumber
string

The part number to filter artifacts.

production
boolean

Filter for production artifacts, useful if trying to search for non-released artifacts.

hardwareVersion
string

Filter artifacts by bootloader hardware version.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Download Artifact

This endpoint uses the Artifactory API to query for the details of an artifact and downloads it. If the artifact is a zip file, it extracts and returns the binary (*.bin) file from the bundle. Non-zip artifacts are returned as raw binary data without extraction.

Authorizations:
auth0-authorizer
query Parameters
artifact
required
string

The name of the artifact to download.

path
required
string

The path of the repository where the artifact is located.

isBle
boolean

When true, extracts BLE-specific firmware from the zip bundle instead of the standard .bin file.

imageType
integer
Enum: 0 1

Required when isBle is true. 0 for apploader-signed-encrypted, 1 for application-signed-encrypted.

repo
string

Overrides the default repository (FW_Releases) used for the download.

Responses

Get Most Recent Artifact

This endpoint uses the Artifactory API to query the repository for the most recently released artifact for a given Part Number and Product ID combination. It only returns artifacts with release type "production candidate" and filters by the @firmware_part Artifactory property specifically (not @raw_firmware_part or @part_number). This endpoint uses an environment-specific repository and connects via the Artifactory edge server.

query Parameters
productId
required
string

The product ID to filter artifacts.

partNumber
required
string

The part number to filter artifacts.

Responses

Response samples

Content type
application/json
{}