Chapter 11. Applications

This chapter provides information on API resources that allow a client to create and manage OpenShift applications. OpenShift supports a number of application frameworks such as PHP, JBoss, and Ruby.
The following table describes each parameter associated with an OpenShift application.
Name Description
name Name of the application.
framework Application framework. For example, JBoss, PHP, or Ruby.
domain_id The domain ID of the application.
embedded List of cartridges that have been added to this application.
creation_time Time the application was created.
scalable Whether application is scaled or not scaled. The values are either true or false.
gear_count Number of gears for this application.
gear_profile Gear size of an application. For example, small.
aliases Application server aliases, if applicable.
app_url The URL to access this application.
git_url The URL to access the Git repository for this application.
ssh_url The URL to access this application using an SSH terminal.
health_check_path The URL to check if the application is running.
uuid Unique identifier for this application.
initial_git_url The URL that was used to initialize the Git repository for this application.

11.1. Resolve DNS

Description

Check whether the DNS is created with an actual DNS nameserver lookup that is not subject to caching. When DNS availability is checked with the client tools, the value gets cached for approximately 30 seconds. This REST API call checks for DNS availability by directly querying the DNS servers.

Method and URL Structure

Method URL Structure
GET /broker/rest/application/:id/dns_resolvable

Request Parameters

Not applicable

cURL Command Example

$ curl GET https://openshift.redhat.com/broker/rest/applications/534253991015616165707776/dns_resolvable --user user@example.com

JSON Response

The following is an example of the API response if the DNS is resolvable. If the DNS is not resolved an error message is returned. 

{
    "api_version": 1.6,
    "data": true,
    "messages": [
        {
            "exit_code": 0,
            "field": null,
            "severity": "info",
            "text": "Resolved DNS myapp-mydomain.rhcloud.com"
        }
    ],
    "status": "ok",
    "supported_api_versions": [
	    1.0,
	    1.1,
	    1.2,
	    1.3,
	    1.4,
	    1.5,
	    1.6
	  ],
	  "type": "boolean",
	  "version": "1.6"
}