Skip to Content
New release 12 available 🎉
API ReferenceUpdatesFeeds and Downloads

Feeds and Downloads

GET/v1/updates/{productCode}/feed/{channel}/{platform}/{file}GET /v1/updates/{productCode}/feed/{channel}/{platform}/{file}

Code samples

# You can also use wget curl -X GET /v1/updates/{productCode}/feed/{channel}/{platform}/{file}

GET /v1/updates/\{productCode\}/feed/\{channel\}/\{platform\}/\{file\}

Serves the electron-updater manifest for a product, channel and platform. This is the canonical route: the desktop points the generic provider at the directory and electron-updater appends the file name itself.

Parameters

NameInTypeRequiredDescription
productCodepathstringtrueThe application product’s code.
channelpathstringtrueThe release channel.
platformpathstringtrueThe platform the feed is served for.
filepathstringtruelatest.yml, latest-mac.yml or latest-linux.yml - it must be the
userKeyquerystringfalseThe license user key, when the header is not used.

Detailed descriptions

file: latest.yml, latest-mac.yml or latest-linux.yml - it must be the one this platform’s family is served from.

Responses

StatusMeaningDescriptionSchema
200OK OKNone
204No Content No ContentNone
403Forbidden ForbiddenNone
404Not Found Not FoundNone

Authentication: none, the endpoint is anonymous.

GET/v1/updates/{productCode}/latest.ymlGET /v1/updates/{productCode}/latest.yml

Code samples

# You can also use wget curl -X GET /v1/updates/{productCode}/latest.yml

GET /v1/updates/\{productCode\}/latest.yml

Convenience alias for the Windows manifest; defaults to win-x64.

Parameters

NameInTypeRequiredDescription
productCodepathstringtrueThe application product’s code.
channelquerystringfalseThe release channel; stable by default.
platformquerystringfalseThe platform; win-x64 by default.
userKeyquerystringfalseThe license user key, when the header is not used.

Responses

StatusMeaningDescriptionSchema
200OK OKNone
204No Content No ContentNone
403Forbidden ForbiddenNone
404Not Found Not FoundNone

Authentication: none, the endpoint is anonymous.

GET/v1/updates/{productCode}/latest-mac.ymlGET /v1/updates/{productCode}/latest-mac.yml

Code samples

# You can also use wget curl -X GET /v1/updates/{productCode}/latest-mac.yml

GET /v1/updates/\{productCode\}/latest-mac.yml

Convenience alias for the macOS manifest; defaults to darwin-arm64.

Parameters

NameInTypeRequiredDescription
productCodepathstringtrueThe application product’s code.
channelquerystringfalseThe release channel; stable by default.
platformquerystringfalseThe platform; darwin-arm64 by default.
userKeyquerystringfalseThe license user key, when the header is not used.

Responses

StatusMeaningDescriptionSchema
200OK OKNone
204No Content No ContentNone
403Forbidden ForbiddenNone
404Not Found Not FoundNone

Authentication: none, the endpoint is anonymous.

GET/v1/updates/{productCode}/latest-linux.ymlGET /v1/updates/{productCode}/latest-linux.yml

Code samples

# You can also use wget curl -X GET /v1/updates/{productCode}/latest-linux.yml

GET /v1/updates/\{productCode\}/latest-linux.yml

Convenience alias for the Linux manifest; defaults to linux-x64.

Parameters

NameInTypeRequiredDescription
productCodepathstringtrueThe application product’s code.
channelquerystringfalseThe release channel; stable by default.
platformquerystringfalseThe platform; linux-x64 by default.
userKeyquerystringfalseThe license user key, when the header is not used.

Responses

StatusMeaningDescriptionSchema
200OK OKNone
204No Content No ContentNone
403Forbidden ForbiddenNone
404Not Found Not FoundNone

Authentication: none, the endpoint is anonymous.

GET/v1/updates/{productCode}/download/{platform}/{version}/{fileName}GET /v1/updates/{productCode}/download/{platform}/{version}/{fileName}

Code samples

# You can also use wget curl -X GET /v1/updates/{productCode}/download/{platform}/{version}/{fileName}

GET /v1/updates/\{productCode\}/download/\{platform\}/\{version\}/\{fileName\}

Serves one artifact of one release. The platform rule is applied first and is never bypassed by an ungated release; a release that requires maintenance additionally requires a single-use download token (the same token may re-serve byte ranges of the same artifact until it expires, so a resumed download does not need a new one). Ungated releases are public and need no token.

Parameters

NameInTypeRequiredDescription
productCodepathstringtrueThe application product’s code.
platformpathstringtrueThe artifact’s platform.
versionpathstringtrueThe release version.
fileNamepathstringtrueThe artifact’s file name - the last path segment, because
tokenquerystringfalseThe single-use download token, for a gated release.
kindquerystringfalseAn optional artifact kind, when one file name is ambiguous.
userKeyquerystringfalseThe license user key, when the header is not used.
channelquerystringfalseThe release channel the version is expected in; when omitted,

Detailed descriptions

fileName: The artifact’s file name - the last path segment, because electron-updater picks artifacts by the extension of the URL path.

channel: The release channel the version is expected in; when omitted, a release of any channel of the product matches.

Responses

StatusMeaningDescriptionSchema
200OK OKNone
206Partial Content Partial ContentNone
302Found FoundNone
403Forbidden ForbiddenNone
404Not Found Not FoundNone

Authentication: none, the endpoint is anonymous.

HEAD/v1/updates/{productCode}/download/{platform}/{version}/{fileName}HEAD /v1/updates/{productCode}/download/{platform}/{version}/{fileName}

Code samples

# You can also use wget curl -X HEAD /v1/updates/{productCode}/download/{platform}/{version}/{fileName}

HEAD /v1/updates/\{productCode\}/download/\{platform\}/\{version\}/\{fileName\}

Serves one artifact of one release. The platform rule is applied first and is never bypassed by an ungated release; a release that requires maintenance additionally requires a single-use download token (the same token may re-serve byte ranges of the same artifact until it expires, so a resumed download does not need a new one). Ungated releases are public and need no token.

Parameters

NameInTypeRequiredDescription
productCodepathstringtrueThe application product’s code.
platformpathstringtrueThe artifact’s platform.
versionpathstringtrueThe release version.
fileNamepathstringtrueThe artifact’s file name - the last path segment, because
tokenquerystringfalseThe single-use download token, for a gated release.
kindquerystringfalseAn optional artifact kind, when one file name is ambiguous.
userKeyquerystringfalseThe license user key, when the header is not used.
channelquerystringfalseThe release channel the version is expected in; when omitted,

Detailed descriptions

fileName: The artifact’s file name - the last path segment, because electron-updater picks artifacts by the extension of the URL path.

channel: The release channel the version is expected in; when omitted, a release of any channel of the product matches.

Responses

StatusMeaningDescriptionSchema
200OK OKNone
206Partial Content Partial ContentNone
302Found FoundNone
403Forbidden ForbiddenNone
404Not Found Not FoundNone

Authentication: none, the endpoint is anonymous.

Last updated on