johnoliver/openjdk-api

The source code for the Express.js API :turtle:

AdoptOpenJDK API

The AdoptOpenJDK API provides a way to consume JSON information about the AdoptOpenJDK releases and nightly builds. Sign up to the mailing list where major API updates will be announced, and visit adoptopenjdk.net to find out more about the community.

Usage

Here is an example using curl (see the curl documentation):

curl https://api.adoptopenjdk.net/openjdk8/releases

This command returns information about all 'OpenJDK' releases, and defaults to the latest version of the API.

Optionally, you can include an 'accept header' to specify a version of the API:

curl -H 'accept-version: 1.0.0' https://api.adoptopenjdk.net/openjdk8/releases

The following Windows Powershell script uses Invoke-Webrequest to download the latest Windows 64-bit archive.

function Get-RedirectedUrl
{
    Param (
        [Parameter(Mandatory=$true)]
        [String]$URL
    )

    $request = [System.Net.WebRequest]::Create($url)
    $request.AllowAutoRedirect=$false
    $response=$request.GetResponse()

    If ($response.StatusCode -eq "Found")
    {
        $response.GetResponseHeader("Location")
    }
}

$url= "https://api.adoptopenjdk.net/openjdk8/releases/x64_win/latest/binary"

$fUrl = Get-RedirectedUrl $url
$filename = [System.IO.Path]::GetFileName($fUrl); 

Write-Host "Downloading $filename"

[Net.ServicePointManager]::SecurityProtocol = "tls12, tls11, tls"
Invoke-WebRequest -Uri $url -OutFile $filename

Note on the API rate limit: Add the -i option (e.g. curl -i https://api.adoptopenjdk.net/openjdk8/releases) to return the response header as well as the response body. There is a limit of 100 API calls per hour per IP, and the value of X-RateLimit-Remaining in the response header is useful to determine how many API calls are remaining from this limit.

API v1.0.0 Specification

You can append different paths to the https://api.adoptopenjdk.net URL, either in the above curl format, in a browser, or through an HTTP client, to return different JSON information:

/<variant>/<build type>/<platform>/<build>/<data type>

There are default values for all values in this path, with the exception of <variant>, which must be specified. These default values are as follows:

/<variant>/releases/allplatforms/allbuilds/info

To view the list of available variants simply use the following route:

/variants

This means that each of the following paths all return the same result (information about all builds, all platforms, of the 'release' build type):

• /openjdk8
• /openjdk8/releases
• /openjdk8/releases/allplatforms
• /openjdk8/releases/allplatforms/allbuilds
• /openjdk8/releases/allplatforms/allbuilds/info

However, if you need to specify <build> as latest, for instance, then you also need to specify <build type> and <platform> prior to that, even if you are using the default values:

/openjdk8/releases/allplatforms/latest

Path options

Variant	Example (click to view)
openjdk8	/openjdk8
openjdk8	/openjdk8-openj9
openjdk9	/openjdk9
openjdk9	/openjdk9-openj9
openjdk10	/openjdk10
amber	/openjdk-amber

Build Type	Example (click to view)
releases (DEFAULT)	/openjdk8/releases
nightly	/openjdk8/nightly

Platform	Example (click to view)
allplatforms (DEFAULT)	/openjdk8/releases/allplatforms
x64_linux	/openjdk8/releases/x64_linux
x64_mac	/openjdk8/releases/x64_mac
x64_win	/openjdk8/releases/x64_win
s390x_linux	/openjdk8/releases/s390x_linux
ppc64le_linux	/openjdk8/releases/ppc64le_linux
aarch64_linux	/openjdk8/releases/aarch64_linux
ppc64_aix	/openjdk8/releases/ppc64_aix

Build	Example (click to view)
allbuilds (DEFAULT)	/openjdk8/releases/x64_linux/allbuilds
latest	/openjdk8/releases/x64_linux/latest
<build number>	/openjdk8/releases/x64_linux/jdk8u152-b03

Note on build numbers: You can find more 'release' build numbers at adoptopenjdk.net/archive. To specify a 'nightly' build number, go to adoptopenjdk.net/nightly and click on the build number. This will take you to a GitHub page which contains the full, unique Nightly build number, e.g. jdk8u162-b00-20171207.

Data Type	Example (click to view)
info (DEFAULT)	/openjdk8/releases/x64_linux/latest/info
binary (Redirects to download)	/openjdk8/releases/x64_linux/latest/binary

Note on the /binary path: you must specify a single platform and a single build before you can use /binary.

Example usage of the /binary path, to download the latest binary for Linux X64 with curl:

curl -OLJ https://api.adoptopenjdk.net/openjdk8/releases/x64_linux/latest/binary

Additional path options

By default, the API returns a pretty-printed JSON. You can disable this pretty-printing by appending ?pretty=false to the end of any URL. For example:

curl https://api.adoptopenjdk.net/openjdk8/releases?pretty=false