13.2.3. Get Cartridge Information
Description
Get information for the specified cartridge using the cartridge name or unique ID.
Method and URL Structure
Method Resource URL GET /broker/rest/application/:id/cartridge/:name
Request Parameters
Not applicable
cURL Command Example
Using the name of the cartridge:
$ curl -X GET https://openshift.redhat.com/broker/rest/application/534253991015616165707776/cartridge/mysql-5.5 --user user@example.com
JSON Response
The API returns the embedded cartridge resource. Unnecessary information and related resource links returned by the API have been removed for brevity. See Chapter 13, Cartridges for more information on all cartridge parameters.
{
"api_version": 1.6,
"data": {
"additional_gear_storage": 0,
"base_gear_storage": 1,
"collocated_with": [
"ruby-2.0",
"haproxy-1.4"
],
"current_scale": 1,
"description": "MySQL is a multi-user, multi-threaded SQL database server.",
"display_name": "MySQL Database 5.5",
"gear_profile": "small",
"help_topics": {
},
"license": "GPL",
"license_url": "",
"name": "mysql-5.5",
"properties": [
{
"name": "username",
"type": "cart_data",
"description": "Root user on mysql database",
"value": "adminthGnHLU"
},
{
"name": "password",
"type": "cart_data",
"description": "Password for root user on mysql database",
"value": "dPFjWLrUjfxC"
},
{
"name": "database_name",
"type": "cart_data",
"description": "MySQL DB name",
"value": "myapp"
},
{
"name": "connection_url",
"type": "cart_data",
"description": "MySQL DB connection URL",
"value": "mysql://$OPENSHIFT_MYSQL_DB_HOST:$OPENSHIFT_MYSQL_DB_PORT/"
}
],
"scales_from": 1,
"scales_to": 1,
"scales_with": "haproxy-1.4",
"status_messages": null,
"supported_scales_from": 1,
"supported_scales_to": 1,
"tags": [
"service",
"database",
"embedded"
],
"type": "embedded",
"url": null,
"usage_rates": [
],
"version": "5.5",
"website": "http://www.mysql.com"
},
"messages": [
{
"exit_code": 0,
"field": null,
"severity": "info",
"text": "Showing cartridge mysql-5.5 for application myapp under domain mydomain"
}
],
"status": "ok",
"supported_api_versions": [
1.0,
1.1,
1.2,
1.3,
1.4,
1.5,
1.6
],
"type": "cartridge",
"version": "1.6"
}
