Chapter 10. Quickstarts

This chapter provides information on API resources for OpenShift quickstart applications. Quickstarts provide quick access to new technology with code and libraries preconfigured, but you are responsible for updating the core libraries for security updates.
The following table describes each parameter associated with an OpenShift quickstart application.
Name Description
id Unique identifier of the quickstart.
search The search term to use for the quickstart.

10.1. List Quickstarts

Description

List all available quickstarts. The client will only see this resource if there are quickstarts available, and it will be absent if there are none. Unlike other REST API calls, the following guidelines apply when retrieving a list of quickstarts:

  • API versioning is not supported
  • Only JSON is supported
  • The body of the API response is different from other API responses
  • Parse errors or unexpected data values must be handled by omitting the entry

Method and URL Structure

Method URL Structure
GET /api/v1/quickstarts/promoted.json

Request Parameters

Not applicable

cURL Command Example

$ curl -X GET https://www.openshift.com/api/v1/quickstarts/promoted.json --user user@example.com

JSON Response

The API returns a list of all quickstarts that are available. See Chapter 10, Quickstarts for more information on all quickstart parameters. 

{
    "data": [
        {
            "quickstart": {
                "id": "13145",
                "href": "https://www.openshift.com/quickstarts/drupal-7",
                "name": "Drupal 7",
                "updated": "1365011911",
                "summary": "An open source content management platform written in PHP powering millions of websites and applications. It is built, used, and supported by an active and diverse community of people around the world. This quickstart will download and install the most recent stable version of Drupal and then generate a new site for you.  Your administrative username and password will default to admin/openshift_changeme, so don't forget to alter them once you log in!\n\nWithout sharing a filesystem, Drupal can't be web scaled, but the README.md describes a workaround that will allow you to scale if you don't need direct file upload into Drupal.\n\nCreating this quickstart may take several minutes.  You may need to restart the application once the database is configured. NOTE: If you want to run the Drupal cron tasks, please install the cron cartridge.",
                "body": "<p>An open source content management platform written in PHP powering millions of websites and applications. It is built, used, and supported by an active and diverse community of people around the world. This quickstart will download and install the most recent stable version of Drupal and then generate a new site for you.  Your administrative username and password will default to admin/openshift_changeme, so don't forget to alter them once you log in!</p>\n\n<p>Without sharing a filesystem, Drupal can't be web scaled, but the <a href=\"https://github.com/openshift/drupal-quickstart/blob/master/README.md\">README.md</a> describes a workaround that will allow you to scale if you don't need direct file upload into Drupal.</p>\n\n<p>Creating this quickstart may take several minutes.  You may need to restart the application once the database is configured. NOTE: If you want to run the Drupal cron tasks, please install the cron cartridge.</p>",
                "cartridges": "php-*, mysql-*",
                "website": "http://drupal.org/",
                "tags": "cms, drupal, instant_app, not_scalable, php",
                "language": "PHP",
                "initial_git_url": "https://github.com/openshift/drupal-quickstart.git",
                "provider": "openshift"
            }
        },
    ]
}