Show Table of Contents
16.2. Get Application Gear Endpoints
Description
Get API endpoints for individual application gears.
Method and URL Structure
| Method | URL Structure |
|---|---|
GET | /broker/rest/applications/:id/gear_groups |
Request Parameters
Not applicable
cURL Command Example
$ curl -X GET https://openshift.redhat.com/broker/rest/applications/5213190e2587c8817a000121/gear_groups --user user@myemail.com --data-urlencode include=endpoints
Request
{
"include": "endpoints"
}
JSON Response
The API returns a list of all gear groups for the specified application, including API endpoints for individual gears. Some information has been removed for brevity. See Chapter 13, Cartridges for more information on all cartridge parameters.
{
"api_version": 1.6,
"data": [
{
"gears": [
{
"id": "5244ccb703ef64dc410000cf",
"state": "started",
"ssh_url": "ssh://5244ccb703ef64dc410000cf@myapp-mydomain.rhcloud.com",
"endpoints": [
{
"cartridge_name": "jbosseap-6",
"external_address": "23.22.238.189",
"external_port": "65006",
"internal_address": "127.12.125.129",
"internal_port": "8080",
"protocols": [
"http",
"ws"
],
"types": [
"web_framework"
],
"mappings": [
{
"frontend": "",
"backend": ""
},
{
"frontend": "/health",
"backend": ""
}
]
},
{
"cartridge_name": "jbosseap-6",
"external_address": "23.22.238.189",
"external_port": "65007",
"internal_address": "127.12.125.129",
"internal_port": "7600",
"protocols": [
"tcp"
],
"types": [
"web_framework"
],
"mappings": []
},
{
"cartridge_name": "jbosseap-6",
"external_address": "23.22.238.189",
"external_port": "65008",
"internal_address": "127.12.125.129",
"internal_port": "5445",
"protocols": [
"tcp"
],
"types": [
"web_framework"
],
"mappings": []
},
{
"cartridge_name": "jbosseap-6",
"external_address": "23.22.238.189",
"external_port": "65009",
"internal_address": "127.12.125.129",
"internal_port": "5455",
"protocols": [
"tcp"
],
"types": [
"web_framework"
],
"mappings": []
},
{
"cartridge_name": "jbosseap-6",
"external_address": "23.22.238.189",
"external_port": "65010",
"internal_address": "127.12.125.129",
"internal_port": "4447",
"protocols": [
"tcp"
],
"types": [
"web_framework"
],
"mappings": []
}
]
}
],
}
],
"messages": [
{
"exit_code": 0,
"field": null,
"severity": "info",
"text": "Showing gear groups for application 'myapp' with domain 'mydomain'"
}
],
"status": "ok",
"type": "gear_groups",
"version": "1.6"
}
Where did the comment section go?
Red Hat's documentation publication system recently went through an upgrade to enable speedier, more mobile-friendly content. We decided to re-evaluate our commenting platform to ensure that it meets your expectations and serves as an optimal feedback mechanism. During this redesign, we invite your input on providing feedback on Red Hat documentation via the discussion platform.