Feeds and Downloads
GET/v1/updates/{productCode}/feed/{channel}/{platform}/{file}GET /v1/updates/{productCode}/feed/{channel}/{platform}/{file}
Code samples
cURL
# 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
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| productCode | path | string | true | The application product’s code. |
| channel | path | string | true | The release channel. |
| platform | path | string | true | The platform the feed is served for. |
| file | path | string | true | latest.yml, latest-mac.yml or latest-linux.yml - it must be the |
| userKey | query | string | false | The 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
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | None |
| 204 | No Content | No Content | None |
| 403 | Forbidden | Forbidden | None |
| 404 | Not Found | Not Found | None |
Authentication: none, the endpoint is anonymous.
GET/v1/updates/{productCode}/latest.ymlGET /v1/updates/{productCode}/latest.yml
Code samples
cURL
# 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
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| productCode | path | string | true | The application product’s code. |
| channel | query | string | false | The release channel; stable by default. |
| platform | query | string | false | The platform; win-x64 by default. |
| userKey | query | string | false | The license user key, when the header is not used. |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | None |
| 204 | No Content | No Content | None |
| 403 | Forbidden | Forbidden | None |
| 404 | Not Found | Not Found | None |
Authentication: none, the endpoint is anonymous.
GET/v1/updates/{productCode}/latest-mac.ymlGET /v1/updates/{productCode}/latest-mac.yml
Code samples
cURL
# 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
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| productCode | path | string | true | The application product’s code. |
| channel | query | string | false | The release channel; stable by default. |
| platform | query | string | false | The platform; darwin-arm64 by default. |
| userKey | query | string | false | The license user key, when the header is not used. |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | None |
| 204 | No Content | No Content | None |
| 403 | Forbidden | Forbidden | None |
| 404 | Not Found | Not Found | None |
Authentication: none, the endpoint is anonymous.
GET/v1/updates/{productCode}/latest-linux.ymlGET /v1/updates/{productCode}/latest-linux.yml
Code samples
cURL
# 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
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| productCode | path | string | true | The application product’s code. |
| channel | query | string | false | The release channel; stable by default. |
| platform | query | string | false | The platform; linux-x64 by default. |
| userKey | query | string | false | The license user key, when the header is not used. |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | None |
| 204 | No Content | No Content | None |
| 403 | Forbidden | Forbidden | None |
| 404 | Not Found | Not Found | None |
Authentication: none, the endpoint is anonymous.
GET/v1/updates/{productCode}/download/{platform}/{version}/{fileName}GET /v1/updates/{productCode}/download/{platform}/{version}/{fileName}
Code samples
cURL
# 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
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| productCode | path | string | true | The application product’s code. |
| platform | path | string | true | The artifact’s platform. |
| version | path | string | true | The release version. |
| fileName | path | string | true | The artifact’s file name - the last path segment, because |
| token | query | string | false | The single-use download token, for a gated release. |
| kind | query | string | false | An optional artifact kind, when one file name is ambiguous. |
| userKey | query | string | false | The license user key, when the header is not used. |
| channel | query | string | false | The 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
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | None |
| 206 | Partial Content | Partial Content | None |
| 302 | Found | Found | None |
| 403 | Forbidden | Forbidden | None |
| 404 | Not Found | Not Found | None |
Authentication: none, the endpoint is anonymous.
HEAD/v1/updates/{productCode}/download/{platform}/{version}/{fileName}HEAD /v1/updates/{productCode}/download/{platform}/{version}/{fileName}
Code samples
cURL
# 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
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| productCode | path | string | true | The application product’s code. |
| platform | path | string | true | The artifact’s platform. |
| version | path | string | true | The release version. |
| fileName | path | string | true | The artifact’s file name - the last path segment, because |
| token | query | string | false | The single-use download token, for a gated release. |
| kind | query | string | false | An optional artifact kind, when one file name is ambiguous. |
| userKey | query | string | false | The license user key, when the header is not used. |
| channel | query | string | false | The 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
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | None |
| 206 | Partial Content | Partial Content | None |
| 302 | Found | Found | None |
| 403 | Forbidden | Forbidden | None |
| 404 | Not Found | Not Found | None |
Authentication: none, the endpoint is anonymous.