Difference between revisions of "Get WHMCS Download Information"

From WHMCS Documentation

(Input Parameters)
(Input Parameters)
Line 11: Line 11:
  
 
{| class="wikitable"
 
{| class="wikitable"
style="padding: 10px" bgcolor="#F1F1F1" | Parameter
+
!  Parameter
style="padding: 10px" bgcolor="#F1F1F1" | Type
+
!  Type
style="padding: 10px" bgcolor="#F1F1F1" | Description
+
!  Description
style="padding: 10px" bgcolor="#F1F1F1" | Required
+
!  Required
 
|-
 
|-
style="padding: 10px" bgcolor="#FFFFFF" | <tt>type</tt>
+
|  <tt>type</tt>
style="padding: 10px" bgcolor="#FFFFFF" | string
+
|  string
style="padding: 10px" bgcolor="#FFFFFF" | The type of release information to retrieve. You can specify <tt>stable</tt>, <tt>beta</tt>, <tt>rc</tt>, <tt>preprod</tt>, or <tt>any</tt>.  
+
|  The type of release information to retrieve. You can specify <tt>stable</tt>, <tt>beta</tt>, <tt>rc</tt>, <tt>preprod</tt>, or <tt>any</tt>.  
  
 
The default value is <tt>stable</tt>.
 
The default value is <tt>stable</tt>.
style="padding: 10px" bgcolor="#FFFFFF" | No
+
|  No
 
|}
 
|}
  

Revision as of 15:39, 27 April 2020

Getting download information

You can use the Service API to retrieve information about WHMCS releases, including download locations, with a curl command.

For example:

curl https://api1.whmcs.com/download/latest?type=stable

Input Parameters

Parameter Type Description Required
type string The type of release information to retrieve. You can specify stable, beta, rc, preprod, or any.

The default value is stable.

No

Response Parameters

Parameter Type Description
version string The most recent version that matches the specified release type.
url string The download location for the .zip file for that version release.
sha256Checksum string The .zip file's SHA-256 checksum value.
releaseNotesUrl string The URL for the version's release notes.
changelogUrl string The URL for the version's change log.

Example Request (CURL)

curl https://api1.whmcs.com/download/latest?type=stable

Example Response (JSON)

{
  "version": "7.9.2",
  "url": "https://releases.whmcs.com/v2/pkgs/whmcs-7.9.2-release.1.zip",
  "sha256Checksum": "f82c95a78251d4ece9065700f6a66bcc88984b59649e5713bfac07af7cac2707",
  "releaseNotesUrl": "https://docs.whmcs.com/Version_7.9.2_Release_Notes",
  "changelogUrl": "https://docs.whmcs.com/Changelog:WHMCS_V7.9.2"
}