<!DOCTYPE HTML><html><head><title>OpenShift 3 API documentation</title><meta http-equiv=X-UA-Compatible content="IE=edge"><meta http-equiv=Content-Type content="text/html; charset=utf-8"><meta name=generator content="https://github.com/kevinrenskers/raml2html 1.0.4"><link rel=stylesheet href=http://netdna.bootstrapcdn.com/bootstrap/3.1.1/css/bootstrap.min.css><link rel=stylesheet href=http://cdnjs.cloudflare.com/ajax/libs/highlight.js/8.1/styles/default.min.css><script type=text/javascript src=http://code.jquery.com/jquery-1.11.0.min.js></script><script type=text/javascript src=http://netdna.bootstrapcdn.com/bootstrap/3.1.1/js/bootstrap.min.js></script><script type=text/javascript src=http://cdnjs.cloudflare.com/ajax/libs/highlight.js/8.1/highlight.min.js></script><script type=text/javascript>
$(document).ready(function() {
$('.page-header pre code, .top-resource-description pre code').each(function(i, block) {
hljs.highlightBlock(block);
});
$('[data-toggle]').click(function() {
var selector = $(this).data('target') + ' pre code';
$(selector).each(function(i, block) {
hljs.highlightBlock(block);
});
});
});
</script><style>
.hljs {
background: transparent;
}
.parent {
color: #999;
}
.list-group-item > .badge {
float: none;
margin-right: 6px;
}
.panel-title > .methods {
float: right;
}
.badge {
border-radius: 0;
text-transform: uppercase;
width: 70px;
font-weight: normal;
color: #f3f3f6;
line-height: normal;
}
.badge_get {
background-color: #63a8e2;
}
.badge_post {
background-color: #6cbd7d;
}
.badge_put {
background-color: #22bac4;
}
.badge_delete {
background-color: #d26460;
}
.list-group, .panel-group {
margin-bottom: 0;
}
.panel-group .panel+.panel-white {
margin-top: 0;
}
.panel-group .panel-white {
border-bottom: 1px solid #F5F5F5;
border-radius: 0;
}
.panel-white:last-child {
border-bottom-color: white;
-webkit-box-shadow: none;
box-shadow: none;
}
.panel-white .panel-heading {
background: white;
}
.tab-pane ul {
padding-left: 2em;
}
.tab-pane h2 {
font-size: 1.2em;
padding-bottom: 4px;
border-bottom: 1px solid #ddd;
}
.tab-pane h3 {
font-size: 1.1em;
}
.tab-content {
border-left: 1px solid #ddd;
border-right: 1px solid #ddd;
border-bottom: 1px solid #ddd;
padding: 10px;
}
#sidebar {
margin-top: 30px;
}
.top-resource-description {
border-bottom: 1px solid #ddd;
background: #fcfcfc;
padding: 15px 15px 0 15px;
margin: -15px -15px 10px -15px;
}
.resource-description {
border-bottom: 1px solid #fcfcfc;
background: #fcfcfc;
padding: 15px 15px 0 15px;
margin: -15px -15px 10px -15px;
}
.list-group .badge {
float: left;
}
.method_description {
margin-left: 85px;
}
.method_description p:last-child {
margin: 0;
}
.list-group-item {
cursor: pointer;
}
.list-group-item:hover {
background-color: #f5f5f5;
}
</style></head><body data-spy=scroll data-target=#sidebar><div class=container><div class=row><div class=col-md-9 role=main><div class=page-header><h1>OpenShift 3 API documentation <small>version v1beta1</small></h1><p>http://localhost:8080/osapi/v1beta1</p><h3 id=Overview><a href=#Overview>Overview</a></h3><p>The OpenShift 3.x model attempts to expose underlying Docker and Kubernetes models as accurately as possible, with a focus on easy composition of applications by a developer (install Ruby, push code, add MySQL).</p><p>Unlike 2.x, more flexibility of configuration is exposed after creation in all aspects of the model. Terminology is still being weighed, but the concept of an application as a separate object is being removed in favor of more flexible composition of "services" - allowing two web containers to reuse a DB, or expose a DB directly to the edge of the network. The existing API will continue to be supported through 3.x, with concepts mapped as closely as possible to the new model.</p><h3 id=Kubernetes-API><a href=#Kubernetes-API>Kubernetes API</a></h3><p>OpenShift exposes <a href=http://htmlpreview.github.io/?https://github.com/GoogleCloudPlatform/kubernetes/blob/master/api/kubernetes.html>Kubernetes API</a> at <a href="http://localhost:8080/api/v1beta1/">http://localhost:8080/api/v1beta1/</a>.</p></div><div class="panel panel-default"><div class=panel-heading><h3 id=_aliases class=panel-title>/aliases (NOT IMPLEMENTED)</h3></div><div class=panel-body><div class=panel-group><div class="panel panel-white"><div class=panel-heading><h4 class=panel-title><a class=collapsed data-toggle=collapse href=#panel__aliases><span class=parent></span>/aliases</a> <span class=methods><a href=# data-toggle=modal data-target=#_aliases_get><span class="badge badge_get">get</span></a> <a href=# data-toggle=modal data-target=#_aliases_post><span class="badge badge_post">post</span></a></span></h4></div><div id=panel__aliases class="panel-collapse collapse"><div class=panel-body><div class=list-group><div data-toggle=modal data-target=#_aliases_get class=list-group-item><span class="badge badge_get">get</span><div class=method_description><p>List all aliases visible to you.</p><p>Aliases in v3 perform the same function as aliases in v2. The main difference is that in v3 an alias is associated with a service, not an application.</p></div><div class=clearfix></div></div><div data-toggle=modal data-target=#_aliases_post class=list-group-item><span class="badge badge_post">post</span><div class=method_description><p>Create an alias for this service.</p></div><div class=clearfix></div></div></div></div></div><div class="modal fade" tabindex=0 id=_aliases_get><div class=modal-dialog><div class=modal-content><div class=modal-header><button type=button class=close data-dismiss=modal aria-hidden=true>×</button><h4 class=modal-title id=myModalLabel><span class="badge badge_get">get</span> <span class=parent></span>/aliases</h4></div><div class=modal-body><div class="alert alert-info"><p>List all aliases visible to you.</p><p>Aliases in v3 perform the same function as aliases in v2. The main difference is that in v3 an alias is associated with a service, not an application.</p></div><ul class="nav nav-tabs"><li class=active><a href=#_aliases_get_request data-toggle=tab>Request</a></li><li><a href=#_aliases_get_response data-toggle=tab>Response</a></li></ul><div class=tab-content><div class="tab-pane active" id=_aliases_get_request><h3>Query Parameters</h3><ul><li><strong>serviceID</strong>: <em>(string)</em><p>filter aliases by associated service.</p></li></ul></div><div class=tab-pane id=_aliases_get_response><h2>HTTP status code <a href=http://httpstatus.es/200 target=_blank>200</a></h2><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Example</strong>:</p><pre><code>{
"list":
[
{
"id": "myalias",
"ssl_certificate": "-----BEGIN CERTIFICATE-----\nMIIDoDCCAogCCQDzF8AJCHnrbjANBgkqhkiG9w0BAQUFADCBkTELMAkGA1UEBhMC\nVVMxCzAJBgNVBAgMAkNBMRIwEAYDVQQHDAlTdW5ueXZhbGUxDzANBgNVBAoMBnJl\nZGhhdDESMBAGA1UECwwJb3BlbnNoaWZ0MRIwEAYDVQQDDAlvcGVuc2hpZnQxKDAm\nBgkqhkiG9w0BCQEWGWluZm9Ab3BlbnNoaWZ0LnJlZGhhdC5jb20wHhcNMTMwMjE5\nMjExMTQ4WhcNMTQwMjE5MjExMTQ4WjCBkTELMAkGA1UEBhMCVVMxCzAJBgNVBAgM\nAkNBMRIwEAYDVQQHDAlTdW5ueXZhbGUxDzANBgNVBAoMBnJlZGhhdDESMBAGA1UE\nCwwJb3BlbnNoaWZ0MRIwEAYDVQQDDAlvcGVuc2hpZnQxKDAmBgkqhkiG9w0BCQEW\nGWluZm9Ab3BlbnNoaWZ0LnJlZGhhdC5jb20wggEiMA0GCSqGSIb3DQEBAQUAA4IB\nDwAwggEKAoIBAQDAEbH4MCi3iIDP1HS+/Xwu8SjdSc5WJX6htV7hJpmFZ8HohV/8\nba0v6aM9IJIIt+sIe2J62t/9G3leOdIHBxeACN4fV2l/iA/fvxvlnFKeD7sHm9Oc\nYj1H6YYJ57sIOf/oLDpJl6l3Rw8VC3+3W0/lzlVpA8qt7fpkiW7XQJCPplUSrdVC\n3okQ2T5NAod5+wVIOqELgE5bLX1LRs5VPsjytHkJ7rKXs55FHR3kpsoImn5xD0Ky\n6lRn8cIMolQoyN5HIGr8f5P+07hrHibve8jje/DKTssb5yEUAEmh6iGHQsRAnsUW\nQoIEUOLqQCu9re2No4G52Kl2xQIjyJF7rCfxAgMBAAEwDQYJKoZIhvcNAQEFBQAD\nggEBAGHrya/ZkiAje2kHsOajXMlO2+y1iLfUDcRLuEWpUa8sI5EM4YtemQrsupFp\n8lVYG5C4Vh8476oF9t8Wex5eH3ocwbSvPIUqE07hdmrubiMq4wxFVRYq7g9lHAnx\nl+bABuN/orbAcPcGAGg7AkXVoAc3Fza/ZcgMcw7NOtDTEss70V9OdgCfQUJL0KdO\nhCO8bQ1EaEiq6zEh8RpZe8mu+f/GYATX1I+eJUc6F6cn83oJjE9bqAVzk7TzTHeK\nEBKN50C14wWtXeG7n2+ugaVO+0xnvHeUrQBLHSRyOHqxXrQQ5XmzcaBiyI0f2IQM\nHst1BVXyX0n/L/ZoYYsv5juJmDo=\n-----END CERTIFICATE-----",
"private_key": "-----BEGIN RSA PRIVATE KEY-----\nMIIEogIBAAKCAQEAwBGx+DAot4iAz9R0vv18LvEo3UnOViV+obVe4SaZhWfB6IVf\n/G2tL+mjPSCSCLfrCHtietrf/Rt5XjnSBwcXgAjeH1dpf4gP378b5ZxSng+7B5vT\nnGI9R+mGCee7CDn/6Cw6SZepd0cPFQt/t1tP5c5VaQPKre36ZIlu10CQj6ZVEq3V\nQt6JENk+TQKHefsFSDqhC4BOWy19S0bOVT7I8rR5Ce6yl7OeRR0d5KbKCJp+cQ9C\nsupUZ/HCDKJUKMjeRyBq/H+T/tO4ax4m73vI43vwyk7LG+chFABJoeohh0LEQJ7F\nFkKCBFDi6kArva3tjaOBudipdsUCI8iRe6wn8QIDAQABAoIBAG/on4JVRRQSw8LU\nLiWt+jI7ryyoOUH2XL8JtzuGSwLwvomlVJT2rmbxQXx3Qr8zsgziHzIn30RRQrkF\nBXu0xRuDjzBBtSVqeJ1Mc4uoNncEAVxgjb5bewswZDnXPCGB8bosMtX4OPRXgdEo\nPwTtfjMOsrMaU3hd5Xu4m81tQA2BvwOlx8aYDyH0jeTnervc5uRGbeTBQG4Bu40E\nrWNmXvgNq2EzTAwbbN6Ma97gw9KgXnM4Nlh29Fxb5TBeUU9lkzuTZAZIDXKIm7AG\nUwMbj/A038yAumYQtThTE/3e4W3rn7F2Vko900bC4aAC1KQOAzjIeQqzqkVxWTWq\n4SUFQAECgYEA/ODwifOTuI6hdZK6JRgc4wp6Rc0fkqHuxLzABXoIGuSVlWyimqIN\nZySAkpo5EW6DNraRJxNCOBmWeGPEhHGrea+JPiPEwCK0F7SxvSmg3jzNzw3Es31T\necET7eDwuSOY9v4XDzLyiXXkEUUReD7Ng2hEYL+HaQrl5jWj4lxgq/ECgYEAwnCb\nKrz7FwX8AqtFAEi6uUrc12k1xYKQfrwSxbfdK2vBBUpgB71Iq/fqP+1BittEljDG\n8f4jEtMBFfEPhLzGIHaI3UiHUHXS4GetA77TRgR8lnKKpj1FcMIY2iKU479707O5\nQ08pgWRUDQ8BVg2ePgbo5QjLMc/rv7UF3AHvPAECgYB/auAIwqDGN6gHU/1TP4ke\npWLi1O55tfpXSzv+BnUbB96PQgPUop7aP7xBIlBrBiI7aVZOOBf/qHT3CF421geu\n8tHWa7NxlIrl/vgn9lfGYyDYmXlpb1amXLEsBVGGF/e1TGZWFDe9J5fZU9HvosVu\n1xTNIvSZ6xHYI2MGZcGYIQKBgEYeebaV5C7PV6xWu1F46O19U9rS9DM//H/XryVi\nQv4vo7IWuj7QQe7SPsXC98ntfPR0rqoCLf/R3ChfgGsr8H8wf/bc+v9HHj8S5E/f\ndy1e3Nccg2ej3PDm7jNsGSlwmmUkAQGHAL7KwYzcBm1UB+bycvZ1j2FtS+UckPpg\nMDgBAoGALD8PkxHb4U4DtbNFSYRrUdvS9heav/yph3lTMfifNkOir36io6v8RPgb\nD2bHKKZgmYlTgJrxD45Er9agC5jclJO35QRU/OfGf3GcnABkBI7vlvUKADAo65Sq\nweZkdJnbrIadcvLOHOzkKC9m+rxFTC9VoN1dwK2zwYvUXfa1VJA=\n-----END RSA PRIVATE KEY-----",
"pass_phrase": "abcd"
}
]
}
</code></pre></div></div></div></div></div></div><div class="modal fade" tabindex=0 id=_aliases_post><div class=modal-dialog><div class=modal-content><div class=modal-header><button type=button class=close data-dismiss=modal aria-hidden=true>×</button><h4 class=modal-title id=myModalLabel><span class="badge badge_post">post</span> <span class=parent></span>/aliases</h4></div><div class=modal-body><div class="alert alert-info"><p>Create an alias for this service.</p></div><ul class="nav nav-tabs"><li class=active><a href=#_aliases_post_request data-toggle=tab>Request</a></li></ul><div class=tab-content><div class="tab-pane active" id=_aliases_post_request><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Example</strong>:</p><pre><code>{
"data":
{
"id": "53c4249f076573c0f4000001",
"suffix": "dev.rhcloud.com",
"name": "mydomain",
"members": [
{
"login": "adminuser",
"role": "admin",
"type": "user",
"owner": true
}
]
}
}
</code></pre></div></div></div></div></div></div></div><div class="panel panel-white"><div class=panel-heading><h4 class=panel-title><a class=collapsed data-toggle=collapse href=#panel__aliases__aliasID_><span class=parent>/aliases</span>/{aliasID}</a> <span class=methods><a href=# data-toggle=modal data-target=#_aliases__aliasID__get><span class="badge badge_get">get</span></a> <a href=# data-toggle=modal data-target=#_aliases__aliasID__put><span class="badge badge_put">put</span></a> <a href=# data-toggle=modal data-target=#_aliases__aliasID__delete><span class="badge badge_delete">delete</span></a></span></h4></div><div id=panel__aliases__aliasID_ class="panel-collapse collapse"><div class=panel-body><div class=list-group><div data-toggle=modal data-target=#_aliases__aliasID__get class=list-group-item><span class="badge badge_get">get</span><div class=method_description><p>Get a specific alias.</p></div><div class=clearfix></div></div><div data-toggle=modal data-target=#_aliases__aliasID__put class=list-group-item><span class="badge badge_put">put</span><div class=method_description><p>Update a specific alias.</p></div><div class=clearfix></div></div><div data-toggle=modal data-target=#_aliases__aliasID__delete class=list-group-item><span class="badge badge_delete">delete</span><div class=method_description><p>Delete a specific alias.</p></div><div class=clearfix></div></div></div></div></div><div class="modal fade" tabindex=0 id=_aliases__aliasID__get><div class=modal-dialog><div class=modal-content><div class=modal-header><button type=button class=close data-dismiss=modal aria-hidden=true>×</button><h4 class=modal-title id=myModalLabel><span class="badge badge_get">get</span> <span class=parent>/aliases</span>/{aliasID}</h4></div><div class=modal-body><div class="alert alert-info"><p>Get a specific alias.</p></div><ul class="nav nav-tabs"><li class=active><a href=#_aliases__aliasID__get_request data-toggle=tab>Request</a></li></ul><div class=tab-content><div class="tab-pane active" id=_aliases__aliasID__get_request><h3>URI Parameters</h3><ul><li><strong>aliasID</strong>: <em>required (string)</em></li></ul><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Example</strong>:</p><pre><code>{
"data":
{
"id": "53c4249f076573c0f4000001",
"suffix": "dev.rhcloud.com",
"name": "mydomain",
"members": [
{
"login": "adminuser",
"role": "admin",
"type": "user",
"owner": true
}
]
}
}
</code></pre></div></div></div></div></div></div><div class="modal fade" tabindex=0 id=_aliases__aliasID__put><div class=modal-dialog><div class=modal-content><div class=modal-header><button type=button class=close data-dismiss=modal aria-hidden=true>×</button><h4 class=modal-title id=myModalLabel><span class="badge badge_put">put</span> <span class=parent>/aliases</span>/{aliasID}</h4></div><div class=modal-body><div class="alert alert-info"><p>Update a specific alias.</p></div><ul class="nav nav-tabs"><li class=active><a href=#_aliases__aliasID__put_request data-toggle=tab>Request</a></li></ul><div class=tab-content><div class="tab-pane active" id=_aliases__aliasID__put_request><h3>URI Parameters</h3><ul><li><strong>aliasID</strong>: <em>required (string)</em></li></ul><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Example</strong>:</p><pre><code>{
"data":
{
"id": "53c4249f076573c0f4000001",
"suffix": "dev.rhcloud.com",
"name": "mydomain",
"members": [
{
"login": "adminuser",
"role": "admin",
"type": "user",
"owner": true
}
]
}
}
</code></pre></div></div></div></div></div></div><div class="modal fade" tabindex=0 id=_aliases__aliasID__delete><div class=modal-dialog><div class=modal-content><div class=modal-header><button type=button class=close data-dismiss=modal aria-hidden=true>×</button><h4 class=modal-title id=myModalLabel><span class="badge badge_delete">delete</span> <span class=parent>/aliases</span>/{aliasID}</h4></div><div class=modal-body><div class="alert alert-info"><p>Delete a specific alias.</p></div><ul class="nav nav-tabs"><li class=active><a href=#_aliases__aliasID__delete_request data-toggle=tab>Request</a></li><li><a href=#_aliases__aliasID__delete_response data-toggle=tab>Response</a></li></ul><div class=tab-content><div class="tab-pane active" id=_aliases__aliasID__delete_request><h3>URI Parameters</h3><ul><li><strong>aliasID</strong>: <em>required (string)</em></li></ul></div><div class=tab-pane id=_aliases__aliasID__delete_response><h2>HTTP status code <a href=http://httpstatus.es/200 target=_blank>200</a></h2><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Example</strong>:</p><pre><code>{
"apiVersion": "v1beta1",
"creationTimestamp": null,
"kind": "Status",
"status": "success"
}
</code></pre></div></div></div></div></div></div></div></div></div></div><div class="panel panel-default"><div class=panel-heading><h3 id=_buildConfigHooks__buildID___secret___plugin_ class=panel-title>/buildConfigHooks/{buildID}/{secret}/{plugin}</h3></div><div class=panel-body><div class=panel-group><div class="panel panel-white"><div class=panel-heading><h4 class=panel-title><a class=collapsed data-toggle=collapse href=#panel__buildConfigHooks__buildID___secret___plugin_><span class=parent></span>/buildConfigHooks/{buildID}/{secret}/{plugin}</a> <span class=methods><a href=# data-toggle=modal data-target=#_buildConfigHooks__buildID___secret___plugin__post><span class="badge badge_post">post</span></a></span></h4></div><div id=panel__buildConfigHooks__buildID___secret___plugin_ class="panel-collapse collapse"><div class=panel-body><div class=list-group><div data-toggle=modal data-target=#_buildConfigHooks__buildID___secret___plugin__post class=list-group-item><span class="badge badge_post">post</span><div class=method_description><p>Webhook on push event from external repository.</p><p>buildID specifies which build to trigger, whereas plugin defines source of the request, this might be github, bitbucket or others.</p></div><div class=clearfix></div></div></div></div></div><div class="modal fade" tabindex=0 id=_buildConfigHooks__buildID___secret___plugin__post><div class=modal-dialog><div class=modal-content><div class=modal-header><button type=button class=close data-dismiss=modal aria-hidden=true>×</button><h4 class=modal-title id=myModalLabel><span class="badge badge_post">post</span> <span class=parent></span>/buildConfigHooks/{buildID}/{secret}/{plugin}</h4></div><div class=modal-body><div class="alert alert-info"><p>Webhook on push event from external repository.</p><p>buildID specifies which build to trigger, whereas plugin defines source of the request, this might be github, bitbucket or others.</p></div><ul class="nav nav-tabs"><li class=active><a href=#_buildConfigHooks__buildID___secret___plugin__post_request data-toggle=tab>Request</a></li><li><a href=#_buildConfigHooks__buildID___secret___plugin__post_response data-toggle=tab>Response</a></li></ul><div class=tab-content><div class="tab-pane active" id=_buildConfigHooks__buildID___secret___plugin__post_request><h3>URI Parameters</h3><ul><li><strong>buildID</strong>: <em>required (string)</em></li><li><strong>secret</strong>: <em>required (string)</em></li><li><strong>plugin</strong>: <em>required (string)</em></li></ul></div><div class=tab-pane id=_buildConfigHooks__buildID___secret___plugin__post_response><h2>HTTP status code <a href=http://httpstatus.es/204 target=_blank>204</a></h2><p>No content</p></div></div></div></div></div></div></div></div></div></div><div class="panel panel-default"><div class=panel-heading><h3 id=_buildConfigs class=panel-title>/buildConfigs</h3></div><div class=panel-body><div class=panel-group><div class="panel panel-white"><div class=panel-heading><h4 class=panel-title><a class=collapsed data-toggle=collapse href=#panel__buildConfigs><span class=parent></span>/buildConfigs</a> <span class=methods><a href=# data-toggle=modal data-target=#_buildConfigs_get><span class="badge badge_get">get</span></a> <a href=# data-toggle=modal data-target=#_buildConfigs_post><span class="badge badge_post">post</span></a></span></h4></div><div id=panel__buildConfigs class="panel-collapse collapse"><div class=panel-body><div class=list-group><div data-toggle=modal data-target=#_buildConfigs_get class=list-group-item><span class="badge badge_get">get</span><div class=method_description><p>List all BuildConfigs.</p><p>BuildConfig contains the inputs needed to produce a new deployable image.</p></div><div class=clearfix></div></div><div data-toggle=modal data-target=#_buildConfigs_post class=list-group-item><span class="badge badge_post">post</span><div class=method_description><p>Create a new build.</p></div><div class=clearfix></div></div></div></div></div><div class="modal fade" tabindex=0 id=_buildConfigs_get><div class=modal-dialog><div class=modal-content><div class=modal-header><button type=button class=close data-dismiss=modal aria-hidden=true>×</button><h4 class=modal-title id=myModalLabel><span class="badge badge_get">get</span> <span class=parent></span>/buildConfigs</h4></div><div class=modal-body><div class="alert alert-info"><p>List all BuildConfigs.</p><p>BuildConfig contains the inputs needed to produce a new deployable image.</p></div><ul class="nav nav-tabs"><li class=active><a href=#_buildConfigs_get_request data-toggle=tab>Request</a></li><li><a href=#_buildConfigs_get_response data-toggle=tab>Response</a></li></ul><div class=tab-content><div class="tab-pane active" id=_buildConfigs_get_request></div><div class=tab-pane id=_buildConfigs_get_response><h2>HTTP status code <a href=http://httpstatus.es/200 target=_blank>200</a></h2><h3>Body</h3><p><strong>Type: application/json</strong></p></div></div></div></div></div></div><div class="modal fade" tabindex=0 id=_buildConfigs_post><div class=modal-dialog><div class=modal-content><div class=modal-header><button type=button class=close data-dismiss=modal aria-hidden=true>×</button><h4 class=modal-title id=myModalLabel><span class="badge badge_post">post</span> <span class=parent></span>/buildConfigs</h4></div><div class=modal-body><div class="alert alert-info"><p>Create a new build.</p></div><ul class="nav nav-tabs"><li class=active><a href=#_buildConfigs_post_request data-toggle=tab>Request</a></li></ul><div class=tab-content><div class="tab-pane active" id=_buildConfigs_post_request><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Example</strong>:</p><pre><code>{
"kind": "BuildConfig",
"apiVersion": "v1beta1",
"desiredInput": {
"type": "sti",
"sourceURI": "git://github.com/pmorie/simple-ruby",
"builderImage": "openshift/ruby-19-centos",
"imageTag": "test-ruby-app"
}
}
</code></pre></div></div></div></div></div></div></div><div class="panel panel-white"><div class=panel-heading><h4 class=panel-title><a class=collapsed data-toggle=collapse href=#panel__buildConfigs__configID_><span class=parent>/buildConfigs</span>/{configID}</a> <span class=methods><a href=# data-toggle=modal data-target=#_buildConfigs__configID__get><span class="badge badge_get">get</span></a> <a href=# data-toggle=modal data-target=#_buildConfigs__configID__put><span class="badge badge_put">put</span></a> <a href=# data-toggle=modal data-target=#_buildConfigs__configID__delete><span class="badge badge_delete">delete</span></a></span></h4></div><div id=panel__buildConfigs__configID_ class="panel-collapse collapse"><div class=panel-body><div class=list-group><div data-toggle=modal data-target=#_buildConfigs__configID__get class=list-group-item><span class="badge badge_get">get</span><div class=method_description><p>Get a specific build configuration.</p></div><div class=clearfix></div></div><div data-toggle=modal data-target=#_buildConfigs__configID__put class=list-group-item><span class="badge badge_put">put</span><div class=method_description><p>Update a specific build configuration.</p></div><div class=clearfix></div></div><div data-toggle=modal data-target=#_buildConfigs__configID__delete class=list-group-item><span class="badge badge_delete">delete</span><div class=method_description><p>Delete a specific build configuration.</p></div><div class=clearfix></div></div></div></div></div><div class="modal fade" tabindex=0 id=_buildConfigs__configID__get><div class=modal-dialog><div class=modal-content><div class=modal-header><button type=button class=close data-dismiss=modal aria-hidden=true>×</button><h4 class=modal-title id=myModalLabel><span class="badge badge_get">get</span> <span class=parent>/buildConfigs</span>/{configID}</h4></div><div class=modal-body><div class="alert alert-info"><p>Get a specific build configuration.</p></div><ul class="nav nav-tabs"><li class=active><a href=#_buildConfigs__configID__get_request data-toggle=tab>Request</a></li><li><a href=#_buildConfigs__configID__get_response data-toggle=tab>Response</a></li></ul><div class=tab-content><div class="tab-pane active" id=_buildConfigs__configID__get_request><h3>URI Parameters</h3><ul><li><strong>configID</strong>: <em>required (string)</em></li></ul></div><div class=tab-pane id=_buildConfigs__configID__get_response><h2>HTTP status code <a href=http://httpstatus.es/200 target=_blank>200</a></h2><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Example</strong>:</p><pre><code>{
"apiVersion": "v1beta1",
"creationTimestamp": "2014-09-16T19:33:36Z",
"desiredInput": {
"builderImage": "openshift/ruby-19-centos",
"imageTag": "test-ruby-app",
"registry": "localhost:5000",
"sourceURI": "git://github.com/pmorie/simple-ruby",
"type": "sti"
},
"id": "5a6a5b9c-3dd8-11e4-9d75-0800279696e1",
"kind": "BuildConfig",
"resourceVersion": 117
}
</code></pre></div></div></div></div></div></div><div class="modal fade" tabindex=0 id=_buildConfigs__configID__put><div class=modal-dialog><div class=modal-content><div class=modal-header><button type=button class=close data-dismiss=modal aria-hidden=true>×</button><h4 class=modal-title id=myModalLabel><span class="badge badge_put">put</span> <span class=parent>/buildConfigs</span>/{configID}</h4></div><div class=modal-body><div class="alert alert-info"><p>Update a specific build configuration.</p></div><ul class="nav nav-tabs"><li class=active><a href=#_buildConfigs__configID__put_request data-toggle=tab>Request</a></li></ul><div class=tab-content><div class="tab-pane active" id=_buildConfigs__configID__put_request><h3>URI Parameters</h3><ul><li><strong>configID</strong>: <em>required (string)</em></li></ul><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Example</strong>:</p><pre><code>{
"apiVersion": "v1beta1",
"creationTimestamp": "2014-09-16T19:33:36Z",
"desiredInput": {
"builderImage": "openshift/ruby-19-centos",
"imageTag": "test-ruby-app",
"registry": "localhost:5000",
"sourceURI": "git://github.com/pmorie/simple-ruby",
"type": "sti"
},
"id": "5a6a5b9c-3dd8-11e4-9d75-0800279696e1",
"kind": "BuildConfig",
"resourceVersion": 117
}
</code></pre></div></div></div></div></div></div><div class="modal fade" tabindex=0 id=_buildConfigs__configID__delete><div class=modal-dialog><div class=modal-content><div class=modal-header><button type=button class=close data-dismiss=modal aria-hidden=true>×</button><h4 class=modal-title id=myModalLabel><span class="badge badge_delete">delete</span> <span class=parent>/buildConfigs</span>/{configID}</h4></div><div class=modal-body><div class="alert alert-info"><p>Delete a specific build configuration.</p></div><ul class="nav nav-tabs"><li class=active><a href=#_buildConfigs__configID__delete_request data-toggle=tab>Request</a></li><li><a href=#_buildConfigs__configID__delete_response data-toggle=tab>Response</a></li></ul><div class=tab-content><div class="tab-pane active" id=_buildConfigs__configID__delete_request><h3>URI Parameters</h3><ul><li><strong>configID</strong>: <em>required (string)</em></li></ul></div><div class=tab-pane id=_buildConfigs__configID__delete_response><h2>HTTP status code <a href=http://httpstatus.es/200 target=_blank>200</a></h2><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Example</strong>:</p><pre><code>{
"apiVersion": "v1beta1",
"creationTimestamp": null,
"kind": "Status",
"status": "success"
}
</code></pre></div></div></div></div></div></div></div></div></div></div><div class="panel panel-default"><div class=panel-heading><h3 id=_builds class=panel-title>/builds</h3></div><div class=panel-body><div class=panel-group><div class="panel panel-white"><div class=panel-heading><h4 class=panel-title><a class=collapsed data-toggle=collapse href=#panel__builds><span class=parent></span>/builds</a> <span class=methods><a href=# data-toggle=modal data-target=#_builds_get><span class="badge badge_get">get</span></a> <a href=# data-toggle=modal data-target=#_builds_post><span class="badge badge_post">post</span></a></span></h4></div><div id=panel__builds class="panel-collapse collapse"><div class=panel-body><div class=list-group><div data-toggle=modal data-target=#_builds_get class=list-group-item><span class="badge badge_get">get</span><div class=method_description><p>List all builds.</p><p>Build encapsulates the inputs needed to produce a new deployable image, as well as the status of the operation and a reference to the Pod which runs the build.</p></div><div class=clearfix></div></div><div data-toggle=modal data-target=#_builds_post class=list-group-item><span class="badge badge_post">post</span><div class=method_description><p>Create a new build.</p></div><div class=clearfix></div></div></div></div></div><div class="modal fade" tabindex=0 id=_builds_get><div class=modal-dialog><div class=modal-content><div class=modal-header><button type=button class=close data-dismiss=modal aria-hidden=true>×</button><h4 class=modal-title id=myModalLabel><span class="badge badge_get">get</span> <span class=parent></span>/builds</h4></div><div class=modal-body><div class="alert alert-info"><p>List all builds.</p><p>Build encapsulates the inputs needed to produce a new deployable image, as well as the status of the operation and a reference to the Pod which runs the build.</p></div><ul class="nav nav-tabs"><li class=active><a href=#_builds_get_request data-toggle=tab>Request</a></li><li><a href=#_builds_get_response data-toggle=tab>Response</a></li></ul><div class=tab-content><div class="tab-pane active" id=_builds_get_request></div><div class=tab-pane id=_builds_get_response><h2>HTTP status code <a href=http://httpstatus.es/200 target=_blank>200</a></h2><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Example</strong>:</p><pre><code>{
"apiVersion": "v1beta1",
"creationTimestamp": null,
"items": [
{
"creationTimestamp": "2014-09-16T02:58:19Z",
"id": "5065bcf2-3d4d-11e4-a95b-0800279696e1",
"input": {
"imageTag": "test/dockerbuild",
"sourceURI": "git://github.com/test/dockerbuild",
"type": "docker"
},
"podID": "build-sti-5065bcf2-3d4d-11e4-a95b-0800279696e1",
"resourceVersion": 114,
"status": "new"
}
],
"kind": "BuildList",
"resourceVersion": 116
}
</code></pre></div></div></div></div></div></div><div class="modal fade" tabindex=0 id=_builds_post><div class=modal-dialog><div class=modal-content><div class=modal-header><button type=button class=close data-dismiss=modal aria-hidden=true>×</button><h4 class=modal-title id=myModalLabel><span class="badge badge_post">post</span> <span class=parent></span>/builds</h4></div><div class=modal-body><div class="alert alert-info"><p>Create a new build.</p></div><ul class="nav nav-tabs"><li class=active><a href=#_builds_post_request data-toggle=tab>Request</a></li></ul><div class=tab-content><div class="tab-pane active" id=_builds_post_request><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Example</strong>:</p><pre><code>{
"kind": "Build",
"apiVersion": "v1beta1",
"input": {
"type": "docker",
"sourceURI": "github.com/test/dockerBuild",
"imageTag": "test/dockerBuild"
}
}
</code></pre></div></div></div></div></div></div></div><div class="panel panel-white"><div class=panel-heading><h4 class=panel-title><a class=collapsed data-toggle=collapse href=#panel__builds__buildID_><span class=parent>/builds</span>/{buildID}</a> <span class=methods><a href=# data-toggle=modal data-target=#_builds__buildID__get><span class="badge badge_get">get</span></a> <a href=# data-toggle=modal data-target=#_builds__buildID__put><span class="badge badge_put">put</span></a> <a href=# data-toggle=modal data-target=#_builds__buildID__delete><span class="badge badge_delete">delete</span></a></span></h4></div><div id=panel__builds__buildID_ class="panel-collapse collapse"><div class=panel-body><div class=list-group><div data-toggle=modal data-target=#_builds__buildID__get class=list-group-item><span class="badge badge_get">get</span><div class=method_description><p>Get details about a specific build.</p></div><div class=clearfix></div></div><div data-toggle=modal data-target=#_builds__buildID__put class=list-group-item><span class="badge badge_put">put</span><div class=method_description><p>Update a specific build.</p></div><div class=clearfix></div></div><div data-toggle=modal data-target=#_builds__buildID__delete class=list-group-item><span class="badge badge_delete">delete</span><div class=method_description><p>Delete a specific build.</p></div><div class=clearfix></div></div></div></div></div><div class="modal fade" tabindex=0 id=_builds__buildID__get><div class=modal-dialog><div class=modal-content><div class=modal-header><button type=button class=close data-dismiss=modal aria-hidden=true>×</button><h4 class=modal-title id=myModalLabel><span class="badge badge_get">get</span> <span class=parent>/builds</span>/{buildID}</h4></div><div class=modal-body><div class="alert alert-info"><p>Get details about a specific build.</p></div><ul class="nav nav-tabs"><li class=active><a href=#_builds__buildID__get_request data-toggle=tab>Request</a></li><li><a href=#_builds__buildID__get_response data-toggle=tab>Response</a></li></ul><div class=tab-content><div class="tab-pane active" id=_builds__buildID__get_request><h3>URI Parameters</h3><ul><li><strong>buildID</strong>: <em>required (string)</em></li></ul></div><div class=tab-pane id=_builds__buildID__get_response><h2>HTTP status code <a href=http://httpstatus.es/200 target=_blank>200</a></h2><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Example</strong>:</p><pre><code>{
"apiVersion": "v1beta1",
"creationTimestamp": "2014-09-16T02:58:19Z",
"id": "5065bcf2-3d4d-11e4-a95b-0800279696e1",
"input": {
"imageTag": "test/dockerBuild",
"sourceURI": "github.com/test/dockerBuild",
"type": "docker"
},
"kind": "Build",
"podID": "build-sti-5065bcf2-3d4d-11e4-a95b-0800279696e1",
"resourceVersion": 114,
"status": "pending"
}
</code></pre></div></div></div></div></div></div><div class="modal fade" tabindex=0 id=_builds__buildID__put><div class=modal-dialog><div class=modal-content><div class=modal-header><button type=button class=close data-dismiss=modal aria-hidden=true>×</button><h4 class=modal-title id=myModalLabel><span class="badge badge_put">put</span> <span class=parent>/builds</span>/{buildID}</h4></div><div class=modal-body><div class="alert alert-info"><p>Update a specific build.</p></div><ul class="nav nav-tabs"><li class=active><a href=#_builds__buildID__put_request data-toggle=tab>Request</a></li></ul><div class=tab-content><div class="tab-pane active" id=_builds__buildID__put_request><h3>URI Parameters</h3><ul><li><strong>buildID</strong>: <em>required (string)</em></li></ul><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Example</strong>:</p><pre><code>{
"apiVersion": "v1beta1",
"creationTimestamp": "2014-09-16T02:58:19Z",
"id": "5065bcf2-3d4d-11e4-a95b-0800279696e1",
"input": {
"imageTag": "test/dockerBuild",
"sourceURI": "github.com/test/dockerBuild",
"type": "docker"
},
"kind": "Build",
"podID": "build-sti-5065bcf2-3d4d-11e4-a95b-0800279696e1",
"resourceVersion": 114,
"status": "pending"
}
</code></pre></div></div></div></div></div></div><div class="modal fade" tabindex=0 id=_builds__buildID__delete><div class=modal-dialog><div class=modal-content><div class=modal-header><button type=button class=close data-dismiss=modal aria-hidden=true>×</button><h4 class=modal-title id=myModalLabel><span class="badge badge_delete">delete</span> <span class=parent>/builds</span>/{buildID}</h4></div><div class=modal-body><div class="alert alert-info"><p>Delete a specific build.</p></div><ul class="nav nav-tabs"><li class=active><a href=#_builds__buildID__delete_request data-toggle=tab>Request</a></li><li><a href=#_builds__buildID__delete_response data-toggle=tab>Response</a></li></ul><div class=tab-content><div class="tab-pane active" id=_builds__buildID__delete_request><h3>URI Parameters</h3><ul><li><strong>buildID</strong>: <em>required (string)</em></li></ul></div><div class=tab-pane id=_builds__buildID__delete_response><h2>HTTP status code <a href=http://httpstatus.es/200 target=_blank>200</a></h2><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Example</strong>:</p><pre><code>{
"apiVersion": "v1beta1",
"creationTimestamp": null,
"kind": "Status",
"status": "success"
}
</code></pre></div></div></div></div></div></div></div></div></div></div><div class="panel panel-default"><div class=panel-heading><h3 id=_configs class=panel-title>/configs (NOT IMPLEMENTED)</h3></div><div class=panel-body><div class=panel-group><div class="panel panel-white"><div class=panel-heading><h4 class=panel-title><a class=collapsed data-toggle=collapse href=#panel__configs><span class=parent></span>/configs</a> <span class=methods><a href=# data-toggle=modal data-target=#_configs_get><span class="badge badge_get">get</span></a> <a href=# data-toggle=modal data-target=#_configs_post><span class="badge badge_post">post</span></a></span></h4></div><div id=panel__configs class="panel-collapse collapse"><div class=panel-body><div class=list-group><div data-toggle=modal data-target=#_configs_get class=list-group-item><span class="badge badge_get">get</span><div class=method_description><p>List all configs that your account has access to.</p><p>A config defines 0..n Kubernetes resources.</p></div><div class=clearfix></div></div><div data-toggle=modal data-target=#_configs_post class=list-group-item><span class="badge badge_post">post</span><div class=method_description><p>Create a new config.</p></div><div class=clearfix></div></div></div></div></div><div class="modal fade" tabindex=0 id=_configs_get><div class=modal-dialog><div class=modal-content><div class=modal-header><button type=button class=close data-dismiss=modal aria-hidden=true>×</button><h4 class=modal-title id=myModalLabel><span class="badge badge_get">get</span> <span class=parent></span>/configs</h4></div><div class=modal-body><div class="alert alert-info"><p>List all configs that your account has access to.</p><p>A config defines 0..n Kubernetes resources.</p></div><ul class="nav nav-tabs"><li class=active><a href=#_configs_get_request data-toggle=tab>Request</a></li><li><a href=#_configs_get_response data-toggle=tab>Response</a></li></ul><div class=tab-content><div class="tab-pane active" id=_configs_get_request></div><div class=tab-pane id=_configs_get_response><h2>HTTP status code <a href=http://httpstatus.es/200 target=_blank>200</a></h2></div></div></div></div></div></div><div class="modal fade" tabindex=0 id=_configs_post><div class=modal-dialog><div class=modal-content><div class=modal-header><button type=button class=close data-dismiss=modal aria-hidden=true>×</button><h4 class=modal-title id=myModalLabel><span class="badge badge_post">post</span> <span class=parent></span>/configs</h4></div><div class=modal-body><div class="alert alert-info"><p>Create a new config.</p></div><ul class="nav nav-tabs"><li class=active><a href=#_configs_post_request data-toggle=tab>Request</a></li><li><a href=#_configs_post_response data-toggle=tab>Response</a></li></ul><div class=tab-content><div class="tab-pane active" id=_configs_post_request><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Schema</strong>:</p><pre><code>{
"$schema": "http://json-schema.org/draft-03/schema",
"type": "object",
"required": true,
"description": "Config resource.",
"properties": {
"id": {
"type": "string",
"required": true
},
"name": {
"type": "string",
"required": true
},
"description": {
"type": "string",
"required": false
},
"items": {
"type": "array",
"required": false,
"items": {
"type": "object",
"required": true,
"properties": {
"kind": {
"type": "string",
"required": true
},
"id": {
"type": "string",
"required": true
}
}
}
}
}
}</code></pre><p><strong>Example</strong>:</p><pre><code>{
"kind": "Config",
"id": "example1",
"name": "My awesome PHP app",
"description": "Example PHP application with PostgreSQL database",
"apiVersion": "v1beta1",
"creationTimestamp": "2014-09-22T09:48:27Z",
"items": [
{
"kind": "Service",
"id": "frontend",
"creationTimestamp": null,
"apiVersion": "v1beta1",
"port": 8080,
"containerPort": 9292,
"selector": {
"name": "frontend"
}
},
{
"kind": "Service",
"id": "database",
"creationTimestamp": null,
"apiVersion": "v1beta1",
"port": 5432,
"containerPort": 5432,
"selector": {
"name": "database"
}
},
{
"kind": "ReplicationController",
"id": "frontendController",
"creationTimestamp": null,
"apiVersion": "v1beta1",
"desiredState": {
"replicas": 2,
"replicaSelector": {
"name": "frontend"
},
"podTemplate": {
"desiredState": {
"manifest": {
"version": "v1beta1",
"id": "frontendController",
"volumes": null,
"containers": [
{
"name": "nginx-php-app",
"image": "mfojtik/nginx-php-app",
"ports": [
{
"hostPort": 8080,
"containerPort": 9292,
"protocol": "TCP"
}
],
"env": [
{
"name": "PGPASSWORD",
"key": "PGPASSWORD",
"value": "MPbGM5T0"
},
{
"name": "PGUSER",
"key": "PGUSER",
"value": "adminO8bR"
},
{
"name": "PGDATABASE",
"key": "PGDATABASE",
"value": "mydb"
}
]
}
]
},
"restartpolicy": {}
},
"labels": {
"name": "frontend"
}
}
},
"labels": {
"name": "frontend"
}
},
{
"kind": "Pod",
"id": "postgresql",
"creationTimestamp": null,
"apiVersion": "v1beta1",
"labels": {
"name": "database"
},
"desiredState": {
"manifest": {
"version": "v1beta1",
"id": "database",
"volumes": null,
"containers": [
{
"name": "postgresql",
"image": "postgres",
"ports": [
{
"hostPort": 5432,
"containerPort": 5432,
"protocol": "TCP"
}
],
"env": [
{
"name": "PGPASSWORD",
"key": "PGPASSWORD",
"value": "MPbGM5T0"
},
{
"name": "PGUSER",
"key": "PGUSER",
"value": "adminO8bR"
},
{
"name": "PGDATABASE",
"key": "PGDATABASE",
"value": "mydb"
}
]
}
]
},
"restartpolicy": {
"type": "RestartAlways"
}
},
"currentState": {
"manifest": {
"version": "",
"id": "",
"volumes": null,
"containers": null
},
"restartpolicy": {}
}
}
]
}</code></pre></div><div class=tab-pane id=_configs_post_response><h2>HTTP status code <a href=http://httpstatus.es/200 target=_blank>200</a></h2><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Example</strong>:</p><pre><code>{
"apiVersion": "v1beta1",
"creationTimestamp": null,
"kind": "Status",
"status": "success"
}
</code></pre></div></div></div></div></div></div></div><div class="panel panel-white"><div class=panel-heading><h4 class=panel-title><a class=collapsed data-toggle=collapse href=#panel__configs__configID_><span class=parent>/configs</span>/{configID}</a> <span class=methods><a href=# data-toggle=modal data-target=#_configs__configID__get><span class="badge badge_get">get</span></a> <a href=# data-toggle=modal data-target=#_configs__configID__put><span class="badge badge_put">put</span></a> <a href=# data-toggle=modal data-target=#_configs__configID__delete><span class="badge badge_delete">delete</span></a></span></h4></div><div id=panel__configs__configID_ class="panel-collapse collapse"><div class=panel-body><div class=list-group><div data-toggle=modal data-target=#_configs__configID__get class=list-group-item><span class="badge badge_get">get</span><div class=method_description><p>Get a specific config.</p></div><div class=clearfix></div></div><div data-toggle=modal data-target=#_configs__configID__put class=list-group-item><span class="badge badge_put">put</span><div class=method_description><p>Update a specific config.</p></div><div class=clearfix></div></div><div data-toggle=modal data-target=#_configs__configID__delete class=list-group-item><span class="badge badge_delete">delete</span><div class=method_description><p>Delete a specific config.</p></div><div class=clearfix></div></div></div></div></div><div class="modal fade" tabindex=0 id=_configs__configID__get><div class=modal-dialog><div class=modal-content><div class=modal-header><button type=button class=close data-dismiss=modal aria-hidden=true>×</button><h4 class=modal-title id=myModalLabel><span class="badge badge_get">get</span> <span class=parent>/configs</span>/{configID}</h4></div><div class=modal-body><div class="alert alert-info"><p>Get a specific config.</p></div><ul class="nav nav-tabs"><li class=active><a href=#_configs__configID__get_request data-toggle=tab>Request</a></li><li><a href=#_configs__configID__get_response data-toggle=tab>Response</a></li></ul><div class=tab-content><div class="tab-pane active" id=_configs__configID__get_request><h3>URI Parameters</h3><ul><li><strong>configID</strong>: <em>required (string)</em></li></ul></div><div class=tab-pane id=_configs__configID__get_response><h2>HTTP status code <a href=http://httpstatus.es/200 target=_blank>200</a></h2><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Example</strong>:</p><pre><code>{
"kind": "Config",
"id": "example1",
"name": "My awesome PHP app",
"description": "Example PHP application with PostgreSQL database",
"apiVersion": "v1beta1",
"creationTimestamp": "2014-09-22T09:48:27Z",
"items": [
{
"kind": "Service",
"id": "frontend",
"creationTimestamp": null,
"apiVersion": "v1beta1",
"port": 8080,
"containerPort": 9292,
"selector": {
"name": "frontend"
}
},
{
"kind": "Service",
"id": "database",
"creationTimestamp": null,
"apiVersion": "v1beta1",
"port": 5432,
"containerPort": 5432,
"selector": {
"name": "database"
}
},
{
"kind": "ReplicationController",
"id": "frontendController",
"creationTimestamp": null,
"apiVersion": "v1beta1",
"desiredState": {
"replicas": 2,
"replicaSelector": {
"name": "frontend"
},
"podTemplate": {
"desiredState": {
"manifest": {
"version": "v1beta1",
"id": "frontendController",
"volumes": null,
"containers": [
{
"name": "nginx-php-app",
"image": "mfojtik/nginx-php-app",
"ports": [
{
"hostPort": 8080,
"containerPort": 9292,
"protocol": "TCP"
}
],
"env": [
{
"name": "PGPASSWORD",
"key": "PGPASSWORD",
"value": "MPbGM5T0"
},
{
"name": "PGUSER",
"key": "PGUSER",
"value": "adminO8bR"
},
{
"name": "PGDATABASE",
"key": "PGDATABASE",
"value": "mydb"
}
]
}
]
},
"restartpolicy": {}
},
"labels": {
"name": "frontend"
}
}
},
"labels": {
"name": "frontend"
}
},
{
"kind": "Pod",
"id": "postgresql",
"creationTimestamp": null,
"apiVersion": "v1beta1",
"labels": {
"name": "database"
},
"desiredState": {
"manifest": {
"version": "v1beta1",
"id": "database",
"volumes": null,
"containers": [
{
"name": "postgresql",
"image": "postgres",
"ports": [
{
"hostPort": 5432,
"containerPort": 5432,
"protocol": "TCP"
}
],
"env": [
{
"name": "PGPASSWORD",
"key": "PGPASSWORD",
"value": "MPbGM5T0"
},
{
"name": "PGUSER",
"key": "PGUSER",
"value": "adminO8bR"
},
{
"name": "PGDATABASE",
"key": "PGDATABASE",
"value": "mydb"
}
]
}
]
},
"restartpolicy": {
"type": "RestartAlways"
}
},
"currentState": {
"manifest": {
"version": "",
"id": "",
"volumes": null,
"containers": null
},
"restartpolicy": {}
}
}
]
}</code></pre></div></div></div></div></div></div><div class="modal fade" tabindex=0 id=_configs__configID__put><div class=modal-dialog><div class=modal-content><div class=modal-header><button type=button class=close data-dismiss=modal aria-hidden=true>×</button><h4 class=modal-title id=myModalLabel><span class="badge badge_put">put</span> <span class=parent>/configs</span>/{configID}</h4></div><div class=modal-body><div class="alert alert-info"><p>Update a specific config.</p></div><ul class="nav nav-tabs"><li class=active><a href=#_configs__configID__put_request data-toggle=tab>Request</a></li><li><a href=#_configs__configID__put_response data-toggle=tab>Response</a></li></ul><div class=tab-content><div class="tab-pane active" id=_configs__configID__put_request><h3>URI Parameters</h3><ul><li><strong>configID</strong>: <em>required (string)</em></li></ul></div><div class=tab-pane id=_configs__configID__put_response><h2>HTTP status code <a href=http://httpstatus.es/200 target=_blank>200</a></h2><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Example</strong>:</p><pre><code>{
"apiVersion": "v1beta1",
"creationTimestamp": null,
"kind": "Status",
"status": "success"
}
</code></pre></div></div></div></div></div></div><div class="modal fade" tabindex=0 id=_configs__configID__delete><div class=modal-dialog><div class=modal-content><div class=modal-header><button type=button class=close data-dismiss=modal aria-hidden=true>×</button><h4 class=modal-title id=myModalLabel><span class="badge badge_delete">delete</span> <span class=parent>/configs</span>/{configID}</h4></div><div class=modal-body><div class="alert alert-info"><p>Delete a specific config.</p></div><ul class="nav nav-tabs"><li class=active><a href=#_configs__configID__delete_request data-toggle=tab>Request</a></li><li><a href=#_configs__configID__delete_response data-toggle=tab>Response</a></li></ul><div class=tab-content><div class="tab-pane active" id=_configs__configID__delete_request><h3>URI Parameters</h3><ul><li><strong>configID</strong>: <em>required (string)</em></li></ul></div><div class=tab-pane id=_configs__configID__delete_response><h2>HTTP status code <a href=http://httpstatus.es/200 target=_blank>200</a></h2><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Example</strong>:</p><pre><code>{
"apiVersion": "v1beta1",
"creationTimestamp": null,
"kind": "Status",
"status": "success"
}
</code></pre></div></div></div></div></div></div></div></div></div></div><div class="panel panel-default"><div class=panel-heading><h3 id=_deploymentConfigs class=panel-title>/deploymentConfigs</h3></div><div class=panel-body><div class=panel-group><div class="panel panel-white"><div class=panel-heading><h4 class=panel-title><a class=collapsed data-toggle=collapse href=#panel__deploymentConfigs><span class=parent></span>/deploymentConfigs</a> <span class=methods><a href=# data-toggle=modal data-target=#_deploymentConfigs_get><span class="badge badge_get">get</span></a> <a href=# data-toggle=modal data-target=#_deploymentConfigs_post><span class="badge badge_post">post</span></a></span></h4></div><div id=panel__deploymentConfigs class="panel-collapse collapse"><div class=panel-body><div class=list-group><div data-toggle=modal data-target=#_deploymentConfigs_get class=list-group-item><span class="badge badge_get">get</span><div class=method_description><p>List all DeploymentConfigs.</p><p>A DeploymentConfig represents a configuration for a single deployment of a replication controller: a template for the deployment, how new deployments are triggered, what the current deployed state is.</p></div><div class=clearfix></div></div><div data-toggle=modal data-target=#_deploymentConfigs_post class=list-group-item><span class="badge badge_post">post</span><div class=method_description><p>Create a new build.</p></div><div class=clearfix></div></div></div></div></div><div class="modal fade" tabindex=0 id=_deploymentConfigs_get><div class=modal-dialog><div class=modal-content><div class=modal-header><button type=button class=close data-dismiss=modal aria-hidden=true>×</button><h4 class=modal-title id=myModalLabel><span class="badge badge_get">get</span> <span class=parent></span>/deploymentConfigs</h4></div><div class=modal-body><div class="alert alert-info"><p>List all DeploymentConfigs.</p><p>A DeploymentConfig represents a configuration for a single deployment of a replication controller: a template for the deployment, how new deployments are triggered, what the current deployed state is.</p></div><ul class="nav nav-tabs"><li class=active><a href=#_deploymentConfigs_get_request data-toggle=tab>Request</a></li><li><a href=#_deploymentConfigs_get_response data-toggle=tab>Response</a></li></ul><div class=tab-content><div class="tab-pane active" id=_deploymentConfigs_get_request></div><div class=tab-pane id=_deploymentConfigs_get_response><h2>HTTP status code <a href=http://httpstatus.es/200 target=_blank>200</a></h2><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Example</strong>:</p><pre><code>{
"apiVersion": "v1beta1",
"creationTimestamp": null,
"kind": "DeploymentConfigList",
"items": [
{
"id": "redisslave-config",
"kind": "DeploymentConfig",
"apiVersion": "v1beta1",
"triggerPolicy": "manual",
"template": {
"strategy": {
"type": "customPod",
"customPod": {
"image": "127.0.0.1:5000/openshift/kube-deploy"
}
},
"controllerTemplate": {
"replicas": 2,
"replicaSelector": {
"name": "redisslave"
},
"podTemplate": {
"desiredState": {
"manifest": {
"version": "v1beta1",
"id": "redisSlaveController",
"containers": [
{
"name": "slave",
"image": "brendanburns/redis-slave",
"env": [
{
"name": "REDIS_PASSWORD",
"value": "secret"
}
],
"ports": [
{
"containerPort": 6379
}
]
}
]
}
},
"labels": {
"name": "redisslave"
}
}
}
}
}
]
}
</code></pre></div></div></div></div></div></div><div class="modal fade" tabindex=0 id=_deploymentConfigs_post><div class=modal-dialog><div class=modal-content><div class=modal-header><button type=button class=close data-dismiss=modal aria-hidden=true>×</button><h4 class=modal-title id=myModalLabel><span class="badge badge_post">post</span> <span class=parent></span>/deploymentConfigs</h4></div><div class=modal-body><div class="alert alert-info"><p>Create a new build.</p></div><ul class="nav nav-tabs"><li class=active><a href=#_deploymentConfigs_post_request data-toggle=tab>Request</a></li></ul><div class=tab-content><div class="tab-pane active" id=_deploymentConfigs_post_request><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Example</strong>:</p><pre><code>{
"apiVersion": "v1beta1",
"creationTimestamp": null,
"kind": "Status",
"status": "success"
}
</code></pre></div></div></div></div></div></div></div><div class="panel panel-white"><div class=panel-heading><h4 class=panel-title><a class=collapsed data-toggle=collapse href=#panel__deploymentConfigs__configID_><span class=parent>/deploymentConfigs</span>/{configID}</a> <span class=methods><a href=# data-toggle=modal data-target=#_deploymentConfigs__configID__get><span class="badge badge_get">get</span></a> <a href=# data-toggle=modal data-target=#_deploymentConfigs__configID__put><span class="badge badge_put">put</span></a> <a href=# data-toggle=modal data-target=#_deploymentConfigs__configID__delete><span class="badge badge_delete">delete</span></a></span></h4></div><div id=panel__deploymentConfigs__configID_ class="panel-collapse collapse"><div class=panel-body><div class=list-group><div data-toggle=modal data-target=#_deploymentConfigs__configID__get class=list-group-item><span class="badge badge_get">get</span><div class=method_description><p>Get a specific build configuration.</p></div><div class=clearfix></div></div><div data-toggle=modal data-target=#_deploymentConfigs__configID__put class=list-group-item><span class="badge badge_put">put</span><div class=method_description><p>Update a specific build configuration.</p></div><div class=clearfix></div></div><div data-toggle=modal data-target=#_deploymentConfigs__configID__delete class=list-group-item><span class="badge badge_delete">delete</span><div class=method_description><p>Delete a specific build configuration.</p></div><div class=clearfix></div></div></div></div></div><div class="modal fade" tabindex=0 id=_deploymentConfigs__configID__get><div class=modal-dialog><div class=modal-content><div class=modal-header><button type=button class=close data-dismiss=modal aria-hidden=true>×</button><h4 class=modal-title id=myModalLabel><span class="badge badge_get">get</span> <span class=parent>/deploymentConfigs</span>/{configID}</h4></div><div class=modal-body><div class="alert alert-info"><p>Get a specific build configuration.</p></div><ul class="nav nav-tabs"><li class=active><a href=#_deploymentConfigs__configID__get_request data-toggle=tab>Request</a></li><li><a href=#_deploymentConfigs__configID__get_response data-toggle=tab>Response</a></li></ul><div class=tab-content><div class="tab-pane active" id=_deploymentConfigs__configID__get_request><h3>URI Parameters</h3><ul><li><strong>configID</strong>: <em>required (string)</em></li></ul></div><div class=tab-pane id=_deploymentConfigs__configID__get_response><h2>HTTP status code <a href=http://httpstatus.es/200 target=_blank>200</a></h2><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Example</strong>:</p><pre><code>{
"id": "redisslave-config",
"kind": "DeploymentConfig",
"apiVersion": "v1beta1",
"triggerPolicy": "manual",
"template": {
"strategy": {
"type": "customPod",
"customPod": {
"image": "127.0.0.1:5000/openshift/kube-deploy"
}
},
"controllerTemplate": {
"replicas": 2,
"replicaSelector": {
"name": "redisslave"
},
"podTemplate": {
"desiredState": {
"manifest": {
"version": "v1beta1",
"id": "redisSlaveController",
"containers": [
{
"name": "slave",
"image": "brendanburns/redis-slave",
"env": [
{
"name": "REDIS_PASSWORD",
"value": "secret"
}
],
"ports": [
{
"containerPort": 6379
}
]
}
]
}
},
"labels": {
"name": "redisslave"
}
}
}
}
}
</code></pre></div></div></div></div></div></div><div class="modal fade" tabindex=0 id=_deploymentConfigs__configID__put><div class=modal-dialog><div class=modal-content><div class=modal-header><button type=button class=close data-dismiss=modal aria-hidden=true>×</button><h4 class=modal-title id=myModalLabel><span class="badge badge_put">put</span> <span class=parent>/deploymentConfigs</span>/{configID}</h4></div><div class=modal-body><div class="alert alert-info"><p>Update a specific build configuration.</p></div><ul class="nav nav-tabs"><li class=active><a href=#_deploymentConfigs__configID__put_request data-toggle=tab>Request</a></li></ul><div class=tab-content><div class="tab-pane active" id=_deploymentConfigs__configID__put_request><h3>URI Parameters</h3><ul><li><strong>configID</strong>: <em>required (string)</em></li></ul><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Example</strong>:</p><pre><code>{
"id": "redisslave-config",
"kind": "DeploymentConfig",
"apiVersion": "v1beta1",
"triggerPolicy": "manual",
"template": {
"strategy": {
"type": "customPod",
"customPod": {
"image": "127.0.0.1:5000/openshift/kube-deploy"
}
},
"controllerTemplate": {
"replicas": 2,
"replicaSelector": {
"name": "redisslave"
},
"podTemplate": {
"desiredState": {
"manifest": {
"version": "v1beta1",
"id": "redisSlaveController",
"containers": [
{
"name": "slave",
"image": "brendanburns/redis-slave",
"env": [
{
"name": "REDIS_PASSWORD",
"value": "secret"
}
],
"ports": [
{
"containerPort": 6379
}
]
}
]
}
},
"labels": {
"name": "redisslave"
}
}
}
}
}
</code></pre></div></div></div></div></div></div><div class="modal fade" tabindex=0 id=_deploymentConfigs__configID__delete><div class=modal-dialog><div class=modal-content><div class=modal-header><button type=button class=close data-dismiss=modal aria-hidden=true>×</button><h4 class=modal-title id=myModalLabel><span class="badge badge_delete">delete</span> <span class=parent>/deploymentConfigs</span>/{configID}</h4></div><div class=modal-body><div class="alert alert-info"><p>Delete a specific build configuration.</p></div><ul class="nav nav-tabs"><li class=active><a href=#_deploymentConfigs__configID__delete_request data-toggle=tab>Request</a></li><li><a href=#_deploymentConfigs__configID__delete_response data-toggle=tab>Response</a></li></ul><div class=tab-content><div class="tab-pane active" id=_deploymentConfigs__configID__delete_request><h3>URI Parameters</h3><ul><li><strong>configID</strong>: <em>required (string)</em></li></ul></div><div class=tab-pane id=_deploymentConfigs__configID__delete_response><h2>HTTP status code <a href=http://httpstatus.es/200 target=_blank>200</a></h2><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Example</strong>:</p><pre><code>{
"apiVersion": "v1beta1",
"creationTimestamp": null,
"kind": "Status",
"status": "success"
}
</code></pre></div></div></div></div></div></div></div></div></div></div><div class="panel panel-default"><div class=panel-heading><h3 id=_deployments class=panel-title>/deployments</h3></div><div class=panel-body><div class=panel-group><div class="panel panel-white"><div class=panel-heading><h4 class=panel-title><a class=collapsed data-toggle=collapse href=#panel__deployments><span class=parent></span>/deployments</a> <span class=methods><a href=# data-toggle=modal data-target=#_deployments_get><span class="badge badge_get">get</span></a> <a href=# data-toggle=modal data-target=#_deployments_post><span class="badge badge_post">post</span></a></span></h4></div><div id=panel__deployments class="panel-collapse collapse"><div class=panel-body><div class=list-group><div data-toggle=modal data-target=#_deployments_get class=list-group-item><span class="badge badge_get">get</span><div class=method_description><p>List all deployments.</p><p>A deployment represents a single unique realization of a deployment config.</p></div><div class=clearfix></div></div><div data-toggle=modal data-target=#_deployments_post class=list-group-item><span class="badge badge_post">post</span><div class=method_description><p>Create a new deployment.</p></div><div class=clearfix></div></div></div></div></div><div class="modal fade" tabindex=0 id=_deployments_get><div class=modal-dialog><div class=modal-content><div class=modal-header><button type=button class=close data-dismiss=modal aria-hidden=true>×</button><h4 class=modal-title id=myModalLabel><span class="badge badge_get">get</span> <span class=parent></span>/deployments</h4></div><div class=modal-body><div class="alert alert-info"><p>List all deployments.</p><p>A deployment represents a single unique realization of a deployment config.</p></div><ul class="nav nav-tabs"><li class=active><a href=#_deployments_get_request data-toggle=tab>Request</a></li><li><a href=#_deployments_get_response data-toggle=tab>Response</a></li></ul><div class=tab-content><div class="tab-pane active" id=_deployments_get_request></div><div class=tab-pane id=_deployments_get_response><h2>HTTP status code <a href=http://httpstatus.es/200 target=_blank>200</a></h2><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Example</strong>:</p><pre><code>{
"apiVersion": "v1beta1",
"creationTimestamp": null,
"kind": "DeploymentList",
"items": [
{
"id": "redisslave-deploy",
"kind": "Deployment",
"apiVersion": "v1beta1",
"triggerPolicy": "manual",
"configId": "redisslave-config",
"strategy": {
"type": "customPod",
"customPod": {
"image": "127.0.0.1:5000/openshift/kube-deploy"
}
},
"controllerTemplate": {
"replicas": 2,
"replicaSelector": {
"name": "redisslave"
},
"podTemplate": {
"desiredState": {
"manifest": {
"version": "v1beta1",
"id": "redisSlaveController",
"containers": [
{
"name": "slave",
"image": "brendanburns/redis-slave",
"env": [
{
"name": "REDIS_PASSWORD",
"value": "secret"
}
],
"ports": [
{
"containerPort": 6379
}
]
}
]
}
},
"labels": {
"name": "redisslave"
}
}
}
}
]
}
</code></pre></div></div></div></div></div></div><div class="modal fade" tabindex=0 id=_deployments_post><div class=modal-dialog><div class=modal-content><div class=modal-header><button type=button class=close data-dismiss=modal aria-hidden=true>×</button><h4 class=modal-title id=myModalLabel><span class="badge badge_post">post</span> <span class=parent></span>/deployments</h4></div><div class=modal-body><div class="alert alert-info"><p>Create a new deployment.</p></div><ul class="nav nav-tabs"><li class=active><a href=#_deployments_post_request data-toggle=tab>Request</a></li></ul><div class=tab-content><div class="tab-pane active" id=_deployments_post_request><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Example</strong>:</p><pre><code>{
"id": "redisslave-deploy",
"kind": "Deployment",
"apiVersion": "v1beta1",
"triggerPolicy": "manual",
"configId": "redisslave-config",
"strategy": {
"type": "customPod",
"customPod": {
"image": "127.0.0.1:5000/openshift/kube-deploy"
}
},
"controllerTemplate": {
"replicas": 2,
"replicaSelector": {
"name": "redisslave"
},
"podTemplate": {
"desiredState": {
"manifest": {
"version": "v1beta1",
"id": "redisSlaveController",
"containers": [
{
"name": "slave",
"image": "brendanburns/redis-slave",
"env": [
{
"name": "REDIS_PASSWORD",
"value": "secret"
}
],
"ports": [
{
"containerPort": 6379
}
]
}
]
}
},
"labels": {
"name": "redisslave"
}
}
}
}
</code></pre></div></div></div></div></div></div></div><div class="panel panel-white"><div class=panel-heading><h4 class=panel-title><a class=collapsed data-toggle=collapse href=#panel__deployments__deploymentID_><span class=parent>/deployments</span>/{deploymentID}</a> <span class=methods><a href=# data-toggle=modal data-target=#_deployments__deploymentID__get><span class="badge badge_get">get</span></a> <a href=# data-toggle=modal data-target=#_deployments__deploymentID__put><span class="badge badge_put">put</span></a> <a href=# data-toggle=modal data-target=#_deployments__deploymentID__delete><span class="badge badge_delete">delete</span></a></span></h4></div><div id=panel__deployments__deploymentID_ class="panel-collapse collapse"><div class=panel-body><div class=list-group><div data-toggle=modal data-target=#_deployments__deploymentID__get class=list-group-item><span class="badge badge_get">get</span><div class=method_description><p>Get details about a specific deployment.</p></div><div class=clearfix></div></div><div data-toggle=modal data-target=#_deployments__deploymentID__put class=list-group-item><span class="badge badge_put">put</span><div class=method_description><p>Update a specific deployment.</p></div><div class=clearfix></div></div><div data-toggle=modal data-target=#_deployments__deploymentID__delete class=list-group-item><span class="badge badge_delete">delete</span><div class=method_description><p>Delete a specific deployment.</p></div><div class=clearfix></div></div></div></div></div><div class="modal fade" tabindex=0 id=_deployments__deploymentID__get><div class=modal-dialog><div class=modal-content><div class=modal-header><button type=button class=close data-dismiss=modal aria-hidden=true>×</button><h4 class=modal-title id=myModalLabel><span class="badge badge_get">get</span> <span class=parent>/deployments</span>/{deploymentID}</h4></div><div class=modal-body><div class="alert alert-info"><p>Get details about a specific deployment.</p></div><ul class="nav nav-tabs"><li class=active><a href=#_deployments__deploymentID__get_request data-toggle=tab>Request</a></li><li><a href=#_deployments__deploymentID__get_response data-toggle=tab>Response</a></li></ul><div class=tab-content><div class="tab-pane active" id=_deployments__deploymentID__get_request><h3>URI Parameters</h3><ul><li><strong>deploymentID</strong>: <em>required (string)</em></li></ul></div><div class=tab-pane id=_deployments__deploymentID__get_response><h2>HTTP status code <a href=http://httpstatus.es/200 target=_blank>200</a></h2><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Example</strong>:</p><pre><code>{
"id": "redisslave-deploy",
"kind": "Deployment",
"apiVersion": "v1beta1",
"triggerPolicy": "manual",
"configId": "redisslave-config",
"strategy": {
"type": "customPod",
"customPod": {
"image": "127.0.0.1:5000/openshift/kube-deploy"
}
},
"controllerTemplate": {
"replicas": 2,
"replicaSelector": {
"name": "redisslave"
},
"podTemplate": {
"desiredState": {
"manifest": {
"version": "v1beta1",
"id": "redisSlaveController",
"containers": [
{
"name": "slave",
"image": "brendanburns/redis-slave",
"env": [
{
"name": "REDIS_PASSWORD",
"value": "secret"
}
],
"ports": [
{
"containerPort": 6379
}
]
}
]
}
},
"labels": {
"name": "redisslave"
}
}
}
}
</code></pre></div></div></div></div></div></div><div class="modal fade" tabindex=0 id=_deployments__deploymentID__put><div class=modal-dialog><div class=modal-content><div class=modal-header><button type=button class=close data-dismiss=modal aria-hidden=true>×</button><h4 class=modal-title id=myModalLabel><span class="badge badge_put">put</span> <span class=parent>/deployments</span>/{deploymentID}</h4></div><div class=modal-body><div class="alert alert-info"><p>Update a specific deployment.</p></div><ul class="nav nav-tabs"><li class=active><a href=#_deployments__deploymentID__put_request data-toggle=tab>Request</a></li></ul><div class=tab-content><div class="tab-pane active" id=_deployments__deploymentID__put_request><h3>URI Parameters</h3><ul><li><strong>deploymentID</strong>: <em>required (string)</em></li></ul><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Example</strong>:</p><pre><code>{
"id": "redisslave-deploy",
"kind": "Deployment",
"apiVersion": "v1beta1",
"triggerPolicy": "manual",
"configId": "redisslave-config",
"strategy": {
"type": "customPod",
"customPod": {
"image": "127.0.0.1:5000/openshift/kube-deploy"
}
},
"controllerTemplate": {
"replicas": 2,
"replicaSelector": {
"name": "redisslave"
},
"podTemplate": {
"desiredState": {
"manifest": {
"version": "v1beta1",
"id": "redisSlaveController",
"containers": [
{
"name": "slave",
"image": "brendanburns/redis-slave",
"env": [
{
"name": "REDIS_PASSWORD",
"value": "secret"
}
],
"ports": [
{
"containerPort": 6379
}
]
}
]
}
},
"labels": {
"name": "redisslave"
}
}
}
}
</code></pre></div></div></div></div></div></div><div class="modal fade" tabindex=0 id=_deployments__deploymentID__delete><div class=modal-dialog><div class=modal-content><div class=modal-header><button type=button class=close data-dismiss=modal aria-hidden=true>×</button><h4 class=modal-title id=myModalLabel><span class="badge badge_delete">delete</span> <span class=parent>/deployments</span>/{deploymentID}</h4></div><div class=modal-body><div class="alert alert-info"><p>Delete a specific deployment.</p></div><ul class="nav nav-tabs"><li class=active><a href=#_deployments__deploymentID__delete_request data-toggle=tab>Request</a></li><li><a href=#_deployments__deploymentID__delete_response data-toggle=tab>Response</a></li></ul><div class=tab-content><div class="tab-pane active" id=_deployments__deploymentID__delete_request><h3>URI Parameters</h3><ul><li><strong>deploymentID</strong>: <em>required (string)</em></li></ul></div><div class=tab-pane id=_deployments__deploymentID__delete_response><h2>HTTP status code <a href=http://httpstatus.es/200 target=_blank>200</a></h2><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Example</strong>:</p><pre><code>{
"apiVersion": "v1beta1",
"creationTimestamp": null,
"kind": "Status",
"status": "success"
}
</code></pre></div></div></div></div></div></div></div></div></div></div><div class="panel panel-default"><div class=panel-heading><h3 id=_imageRepositories class=panel-title>/imageRepositories</h3></div><div class=panel-body><div class=panel-group><div class="panel panel-white"><div class=panel-heading><h4 class=panel-title><a class=collapsed data-toggle=collapse href=#panel__imageRepositories><span class=parent></span>/imageRepositories</a> <span class=methods><a href=# data-toggle=modal data-target=#_imageRepositories_get><span class="badge badge_get">get</span></a> <a href=# data-toggle=modal data-target=#_imageRepositories_post><span class="badge badge_post">post</span></a></span></h4></div><div id=panel__imageRepositories class="panel-collapse collapse"><div class=panel-body><div class=list-group><div data-toggle=modal data-target=#_imageRepositories_get class=list-group-item><span class="badge badge_get">get</span><div class=method_description><p>List all image repositories.</p><p>An image repository is a collection of images that share the same metadata. It may reference a Docker image repository on a Docker registry, but this is optional. An image repository also contains a mapping of tags to images.</p></div><div class=clearfix></div></div><div data-toggle=modal data-target=#_imageRepositories_post class=list-group-item><span class="badge badge_post">post</span><div class=method_description><p>Create a new image repository.</p></div><div class=clearfix></div></div></div></div></div><div class="modal fade" tabindex=0 id=_imageRepositories_get><div class=modal-dialog><div class=modal-content><div class=modal-header><button type=button class=close data-dismiss=modal aria-hidden=true>×</button><h4 class=modal-title id=myModalLabel><span class="badge badge_get">get</span> <span class=parent></span>/imageRepositories</h4></div><div class=modal-body><div class="alert alert-info"><p>List all image repositories.</p><p>An image repository is a collection of images that share the same metadata. It may reference a Docker image repository on a Docker registry, but this is optional. An image repository also contains a mapping of tags to images.</p></div><ul class="nav nav-tabs"><li class=active><a href=#_imageRepositories_get_request data-toggle=tab>Request</a></li><li><a href=#_imageRepositories_get_response data-toggle=tab>Response</a></li></ul><div class=tab-content><div class="tab-pane active" id=_imageRepositories_get_request></div><div class=tab-pane id=_imageRepositories_get_response><h2>HTTP status code <a href=http://httpstatus.es/200 target=_blank>200</a></h2><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Example</strong>:</p><pre><code>{
"apiVersion": "v1beta1",
"creationTimestamp": null,
"items": [
{
"creationTimestamp": "2014-09-10T12:23:01-04:00",
"dockerImageRepository": "localhost:5000/someproject/somerepo",
"id": "somerepo",
"resourceVersion": 17,
"tags": {
"c115fca463efa744a5492ca580ef24b20ed5ef2155c624cc5b1262aefc14797b": "c115fca463efa744a5492ca580ef24b20ed5ef2155c624cc5b1262aefc14797b",
"latest": "c115fca463efa744a5492ca580ef24b20ed5ef2155c624cc5b1262aefc14797b"
}
},
{
"creationTimestamp": "2014-09-10T09:33:42-04:00",
"dockerImageRepository": "openshift/ruby-19-centos",
"id": "test",
"labels": {
"color": "blue"
},
"resourceVersion": 14,
"tags": {
"latest": "120e218dd395ec314e7b6249f39d2853911b3d6def6ea164ae05722649f34b16"
}
}
],
"kind": "ImageRepositoryList",
"resourceVersion": 22
}
</code></pre></div></div></div></div></div></div><div class="modal fade" tabindex=0 id=_imageRepositories_post><div class=modal-dialog><div class=modal-content><div class=modal-header><button type=button class=close data-dismiss=modal aria-hidden=true>×</button><h4 class=modal-title id=myModalLabel><span class="badge badge_post">post</span> <span class=parent></span>/imageRepositories</h4></div><div class=modal-body><div class="alert alert-info"><p>Create a new image repository.</p></div><ul class="nav nav-tabs"><li class=active><a href=#_imageRepositories_post_request data-toggle=tab>Request</a></li></ul><div class=tab-content><div class="tab-pane active" id=_imageRepositories_post_request><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Example</strong>:</p><pre><code>{
"apiVersion": "v1beta1",
"dockerImageRepository": "openshift/ruby-19-centos",
"id": "test",
"kind": "ImageRepository",
"labels": {
"color": "blue"
},
"tags": {
"latest": "120e218dd395ec314e7b6249f39d2853911b3d6def6ea164ae05722649f34b16"
}
}
</code></pre></div></div></div></div></div></div></div><div class="panel panel-white"><div class=panel-heading><h4 class=panel-title><a class=collapsed data-toggle=collapse href=#panel__imageRepositories__repositoryID_><span class=parent>/imageRepositories</span>/{repositoryID}</a> <span class=methods><a href=# data-toggle=modal data-target=#_imageRepositories__repositoryID__get><span class="badge badge_get">get</span></a> <a href=# data-toggle=modal data-target=#_imageRepositories__repositoryID__put><span class="badge badge_put">put</span></a> <a href=# data-toggle=modal data-target=#_imageRepositories__repositoryID__delete><span class="badge badge_delete">delete</span></a></span></h4></div><div id=panel__imageRepositories__repositoryID_ class="panel-collapse collapse"><div class=panel-body><div class=list-group><div data-toggle=modal data-target=#_imageRepositories__repositoryID__get class=list-group-item><span class="badge badge_get">get</span><div class=method_description><p>Get information about a specific image repository.</p></div><div class=clearfix></div></div><div data-toggle=modal data-target=#_imageRepositories__repositoryID__put class=list-group-item><span class="badge badge_put">put</span><div class=method_description><p>Update an image repository.</p></div><div class=clearfix></div></div><div data-toggle=modal data-target=#_imageRepositories__repositoryID__delete class=list-group-item><span class="badge badge_delete">delete</span><div class=method_description><p>Delete an image repository.</p></div><div class=clearfix></div></div></div></div></div><div class="modal fade" tabindex=0 id=_imageRepositories__repositoryID__get><div class=modal-dialog><div class=modal-content><div class=modal-header><button type=button class=close data-dismiss=modal aria-hidden=true>×</button><h4 class=modal-title id=myModalLabel><span class="badge badge_get">get</span> <span class=parent>/imageRepositories</span>/{repositoryID}</h4></div><div class=modal-body><div class="alert alert-info"><p>Get information about a specific image repository.</p></div><ul class="nav nav-tabs"><li class=active><a href=#_imageRepositories__repositoryID__get_request data-toggle=tab>Request</a></li></ul><div class=tab-content><div class="tab-pane active" id=_imageRepositories__repositoryID__get_request><h3>URI Parameters</h3><ul><li><strong>repositoryID</strong>: <em>required (string)</em></li></ul><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Example</strong>:</p><pre><code>{
"apiVersion": "v1beta1",
"creationTimestamp": "2014-09-10T09:33:42-04:00",
"dockerImageRepository": "openshift/ruby-19-centos",
"id": "test",
"kind": "ImageRepository",
"labels": {
"color": "blue"
},
"resourceVersion": 14,
"tags": {
"latest": "120e218dd395ec314e7b6249f39d2853911b3d6def6ea164ae05722649f34b16"
}
}
</code></pre></div></div></div></div></div></div><div class="modal fade" tabindex=0 id=_imageRepositories__repositoryID__put><div class=modal-dialog><div class=modal-content><div class=modal-header><button type=button class=close data-dismiss=modal aria-hidden=true>×</button><h4 class=modal-title id=myModalLabel><span class="badge badge_put">put</span> <span class=parent>/imageRepositories</span>/{repositoryID}</h4></div><div class=modal-body><div class="alert alert-info"><p>Update an image repository.</p></div><ul class="nav nav-tabs"><li class=active><a href=#_imageRepositories__repositoryID__put_request data-toggle=tab>Request</a></li></ul><div class=tab-content><div class="tab-pane active" id=_imageRepositories__repositoryID__put_request><h3>URI Parameters</h3><ul><li><strong>repositoryID</strong>: <em>required (string)</em></li></ul><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Example</strong>:</p><pre><code>{
"apiVersion": "v1beta1",
"creationTimestamp": "2014-09-10T09:33:42-04:00",
"dockerImageRepository": "openshift/ruby-19-centos",
"id": "test",
"kind": "ImageRepository",
"labels": {
"color": "blue"
},
"resourceVersion": 14,
"tags": {
"latest": "120e218dd395ec314e7b6249f39d2853911b3d6def6ea164ae05722649f34b16"
}
}
</code></pre></div></div></div></div></div></div><div class="modal fade" tabindex=0 id=_imageRepositories__repositoryID__delete><div class=modal-dialog><div class=modal-content><div class=modal-header><button type=button class=close data-dismiss=modal aria-hidden=true>×</button><h4 class=modal-title id=myModalLabel><span class="badge badge_delete">delete</span> <span class=parent>/imageRepositories</span>/{repositoryID}</h4></div><div class=modal-body><div class="alert alert-info"><p>Delete an image repository.</p></div><ul class="nav nav-tabs"><li class=active><a href=#_imageRepositories__repositoryID__delete_request data-toggle=tab>Request</a></li><li><a href=#_imageRepositories__repositoryID__delete_response data-toggle=tab>Response</a></li></ul><div class=tab-content><div class="tab-pane active" id=_imageRepositories__repositoryID__delete_request><h3>URI Parameters</h3><ul><li><strong>repositoryID</strong>: <em>required (string)</em></li></ul></div><div class=tab-pane id=_imageRepositories__repositoryID__delete_response><h2>HTTP status code <a href=http://httpstatus.es/200 target=_blank>200</a></h2><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Example</strong>:</p><pre><code>{
"apiVersion": "v1beta1",
"creationTimestamp": null,
"kind": "Status",
"status": "success"
}
</code></pre></div></div></div></div></div></div></div></div></div></div><div class="panel panel-default"><div class=panel-heading><h3 id=_imageRepositoryMappings class=panel-title>/imageRepositoryMappings</h3></div><div class=panel-body><div class=panel-group><div class="panel panel-white"><div class=panel-heading><h4 class=panel-title><a class=collapsed data-toggle=collapse href=#panel__imageRepositoryMappings><span class=parent></span>/imageRepositoryMappings</a> <span class=methods><a href=# data-toggle=modal data-target=#_imageRepositoryMappings_post><span class="badge badge_post">post</span></a></span></h4></div><div id=panel__imageRepositoryMappings class="panel-collapse collapse"><div class=panel-body><div class=list-group><div data-toggle=modal data-target=#_imageRepositoryMappings_post class=list-group-item><span class="badge badge_post">post</span><div class=method_description><p>Create an image and update an image repository.</p><p>This is designed as a webhook that a Docker registry can invoke when a new tag is created. The image repository mapping contains a reference to the repository, the image's metadata, and the name of the new tag. Upon execution, a new image is created if it doesn't already exist, and the image repository is updated with the new tag.</p></div><div class=clearfix></div></div></div></div></div><div class="modal fade" tabindex=0 id=_imageRepositoryMappings_post><div class=modal-dialog><div class=modal-content><div class=modal-header><button type=button class=close data-dismiss=modal aria-hidden=true>×</button><h4 class=modal-title id=myModalLabel><span class="badge badge_post">post</span> <span class=parent></span>/imageRepositoryMappings</h4></div><div class=modal-body><div class="alert alert-info"><p>Create an image and update an image repository.</p><p>This is designed as a webhook that a Docker registry can invoke when a new tag is created. The image repository mapping contains a reference to the repository, the image's metadata, and the name of the new tag. Upon execution, a new image is created if it doesn't already exist, and the image repository is updated with the new tag.</p></div><ul class="nav nav-tabs"><li class=active><a href=#_imageRepositoryMappings_post_request data-toggle=tab>Request</a></li></ul><div class=tab-content><div class="tab-pane active" id=_imageRepositoryMappings_post_request><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Example</strong>:</p><pre><code>{
"dockerImageRepository": "localhost:5000/someproject/somerepo",
"image": {
"dockerImageReference": "localhost:5000/someproject/somerepo:c115fca463efa744a5492ca580ef24b20ed5ef2155c624cc5b1262aefc14797b",
"id": "c115fca463efa744a5492ca580ef24b20ed5ef2155c624cc5b1262aefc14797b",
"metadata": {
"Size": 0,
"architecture": "amd64",
"config": {
"AttachStderr": false,
"AttachStdin": false,
"AttachStdout": false,
"Cmd": [
"/bin/sh"
],
"CpuShares": 0,
"Cpuset": "",
"Domainname": "",
"Entrypoint": null,
"Env": [
"c=e",
"b=2",
"a=1",
"HOME=/",
"PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin"
],
"ExposedPorts": null,
"Hostname": "",
"Image": "",
"Memory": 0,
"MemorySwap": 0,
"NetworkDisabled": false,
"OnBuild": null,
"OpenStdin": false,
"PortSpecs": null,
"StdinOnce": false,
"Tty": false,
"User": "",
"Volumes": null,
"WorkingDir": ""
},
"container": "6b03c2dda0f8cbfa6186d96557e35e35c61915a70e4217a465f92f26c2d9290b",
"container_config": {
"AttachStderr": true,
"AttachStdin": false,
"AttachStdout": true,
"Cmd": [
"/bin/sh"
],
"CpuShares": 0,
"Cpuset": "",
"Domainname": "",
"Entrypoint": null,
"Env": [
"c=e",
"b=2",
"a=1",
"HOME=/",
"PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin"
],
"ExposedPorts": null,
"Hostname": "6b03c2dda0f8",
"Image": "localhost:5000/someproject/somerepo",
"Memory": 0,
"MemorySwap": 0,
"NetworkDisabled": false,
"OnBuild": null,
"OpenStdin": false,
"PortSpecs": null,
"StdinOnce": false,
"Tty": false,
"User": "",
"Volumes": null,
"WorkingDir": ""
},
"created": "2014-09-04T17:43:39.863545902Z",
"docker_version": "1.1.2",
"id": "c115fca463efa744a5492ca580ef24b20ed5ef2155c624cc5b1262aefc14797b",
"os": "linux",
"parent": "32730be9f383719ce6308329c8ee5aac189ece9e41928dc10b8bc0fc35e9d1d5"
}
},
"kind": "ImageRepositoryMapping",
"tag": "latest",
"version": "v1beta1"
}
</code></pre></div></div></div></div></div></div></div></div></div></div><div class="panel panel-default"><div class=panel-heading><h3 id=_images class=panel-title>/images</h3></div><div class=panel-body><div class=panel-group><div class="panel panel-white"><div class=panel-heading><h4 class=panel-title><a class=collapsed data-toggle=collapse href=#panel__images><span class=parent></span>/images</a> <span class=methods><a href=# data-toggle=modal data-target=#_images_get><span class="badge badge_get">get</span></a> <a href=# data-toggle=modal data-target=#_images_post><span class="badge badge_post">post</span></a></span></h4></div><div id=panel__images class="panel-collapse collapse"><div class=panel-body><div class=list-group><div data-toggle=modal data-target=#_images_get class=list-group-item><span class="badge badge_get">get</span><div class=method_description><p>List all images.</p><p>An image is a reference to an image in a Docker image repository on a Docker registry, plus a set of metadata. The metadata that Openshift stores for an image will augment the metadata that has already been specified in the image through its Dockerfile.</p></div><div class=clearfix></div></div><div data-toggle=modal data-target=#_images_post class=list-group-item><span class="badge badge_post">post</span><div class=method_description><p>Create a new image definition.</p></div><div class=clearfix></div></div></div></div></div><div class="modal fade" tabindex=0 id=_images_get><div class=modal-dialog><div class=modal-content><div class=modal-header><button type=button class=close data-dismiss=modal aria-hidden=true>×</button><h4 class=modal-title id=myModalLabel><span class="badge badge_get">get</span> <span class=parent></span>/images</h4></div><div class=modal-body><div class="alert alert-info"><p>List all images.</p><p>An image is a reference to an image in a Docker image repository on a Docker registry, plus a set of metadata. The metadata that Openshift stores for an image will augment the metadata that has already been specified in the image through its Dockerfile.</p></div><ul class="nav nav-tabs"><li class=active><a href=#_images_get_request data-toggle=tab>Request</a></li><li><a href=#_images_get_response data-toggle=tab>Response</a></li></ul><div class=tab-content><div class="tab-pane active" id=_images_get_request></div><div class=tab-pane id=_images_get_response><h2>HTTP status code <a href=http://httpstatus.es/200 target=_blank>200</a></h2><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Example</strong>:</p><pre><code>{
"apiVersion": "v1beta1",
"creationTimestamp": null,
"items": [
{
"creationTimestamp": "2014-09-10T09:33:43-04:00",
"dockerImageReference": "openshift/ruby-19-centos:latest",
"id": "abcd1234",
"metadata": {
"Size": 0,
"containerconfig": {
"AttachStderr": false,
"AttachStdin": false,
"AttachStdout": false,
"Cmd": null,
"CpuShares": 0,
"Dns": null,
"Domainname": "",
"Entrypoint": null,
"Env": null,
"ExposedPorts": null,
"Hostname": "",
"Image": "",
"Memory": 0,
"MemorySwap": 0,
"NetworkDisabled": false,
"OpenStdin": false,
"PortSpecs": null,
"StdinOnce": false,
"Tty": false,
"User": "",
"Volumes": null,
"VolumesFrom": "",
"WorkingDir": ""
},
"created": "0001-01-01T00:00:00Z",
"id": ""
},
"resourceVersion": 15
},
{
"creationTimestamp": "2014-09-10T12:23:24-04:00",
"dockerImageReference": "localhost:5000/someproject/somerepo:c115fca463efa744a5492ca580ef24b20ed5ef2155c624cc5b1262aefc14797b",
"id": "c115fca463efa744a5492ca580ef24b20ed5ef2155c624cc5b1262aefc14797b",
"metadata": {
"Size": 0,
"architecture": "amd64",
"config": {
"AttachStderr": false,
"AttachStdin": false,
"AttachStdout": false,
"Cmd": null,
"CpuShares": 0,
"Dns": null,
"Domainname": "",
"Entrypoint": null,
"Env": null,
"ExposedPorts": null,
"Hostname": "",
"Image": "",
"Memory": 0,
"MemorySwap": 0,
"NetworkDisabled": false,
"OpenStdin": false,
"PortSpecs": null,
"StdinOnce": false,
"Tty": false,
"User": "",
"Volumes": null,
"VolumesFrom": "",
"WorkingDir": ""
},
"container": "6b03c2dda0f8cbfa6186d96557e35e35c61915a70e4217a465f92f26c2d9290b",
"containerconfig": {
"AttachStderr": false,
"AttachStdin": false,
"AttachStdout": false,
"Cmd": null,
"CpuShares": 0,
"Dns": null,
"Domainname": "",
"Entrypoint": null,
"Env": null,
"ExposedPorts": null,
"Hostname": "",
"Image": "",
"Memory": 0,
"MemorySwap": 0,
"NetworkDisabled": false,
"OpenStdin": false,
"PortSpecs": null,
"StdinOnce": false,
"Tty": false,
"User": "",
"Volumes": null,
"VolumesFrom": "",
"WorkingDir": ""
},
"created": "0001-01-01T00:00:00Z",
"id": "c115fca463efa744a5492ca580ef24b20ed5ef2155c624cc5b1262aefc14797b",
"parent": "32730be9f383719ce6308329c8ee5aac189ece9e41928dc10b8bc0fc35e9d1d5"
},
"resourceVersion": 18
}
],
"kind": "ImageList",
"resourceVersion": 22
}
</code></pre></div></div></div></div></div></div><div class="modal fade" tabindex=0 id=_images_post><div class=modal-dialog><div class=modal-content><div class=modal-header><button type=button class=close data-dismiss=modal aria-hidden=true>×</button><h4 class=modal-title id=myModalLabel><span class="badge badge_post">post</span> <span class=parent></span>/images</h4></div><div class=modal-body><div class="alert alert-info"><p>Create a new image definition.</p></div><ul class="nav nav-tabs"><li class=active><a href=#_images_post_request data-toggle=tab>Request</a></li></ul><div class=tab-content><div class="tab-pane active" id=_images_post_request><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Example</strong>:</p><pre><code>{
"apiVersion": "v1beta1",
"dockerImageReference": "localhost:5000/someproject/somerepo:c115fca463efa744a5492ca580ef24b20ed5ef2155c624cc5b1262aefc14797b",
"id": "c115fca463efa744a5492ca580ef24b20ed5ef2155c624cc5b1262aefc14797b",
"kind": "Image",
"metadata": {
"Size": 0,
"architecture": "amd64",
"config": {
"AttachStderr": false,
"AttachStdin": false,
"AttachStdout": false,
"Cmd": null,
"CpuShares": 0,
"Dns": null,
"Domainname": "",
"Entrypoint": null,
"Env": null,
"ExposedPorts": null,
"Hostname": "",
"Image": "",
"Memory": 0,
"MemorySwap": 0,
"NetworkDisabled": false,
"OpenStdin": false,
"PortSpecs": null,
"StdinOnce": false,
"Tty": false,
"User": "",
"Volumes": null,
"VolumesFrom": "",
"WorkingDir": ""
},
"container": "6b03c2dda0f8cbfa6186d96557e35e35c61915a70e4217a465f92f26c2d9290b",
"containerconfig": {
"AttachStderr": false,
"AttachStdin": false,
"AttachStdout": false,
"Cmd": null,
"CpuShares": 0,
"Dns": null,
"Domainname": "",
"Entrypoint": null,
"Env": null,
"ExposedPorts": null,
"Hostname": "",
"Image": "",
"Memory": 0,
"MemorySwap": 0,
"NetworkDisabled": false,
"OpenStdin": false,
"PortSpecs": null,
"StdinOnce": false,
"Tty": false,
"User": "",
"Volumes": null,
"VolumesFrom": "",
"WorkingDir": ""
},
"created": "0001-01-01T00:00:00Z",
"id": "c115fca463efa744a5492ca580ef24b20ed5ef2155c624cc5b1262aefc14797b",
"parent": "32730be9f383719ce6308329c8ee5aac189ece9e41928dc10b8bc0fc35e9d1d5"
},
}
</code></pre></div></div></div></div></div></div></div><div class="panel panel-white"><div class=panel-heading><h4 class=panel-title><a class=collapsed data-toggle=collapse href=#panel__images__imageID_><span class=parent>/images</span>/{imageID}</a> <span class=methods><a href=# data-toggle=modal data-target=#_images__imageID__get><span class="badge badge_get">get</span></a> <a href=# data-toggle=modal data-target=#_images__imageID__delete><span class="badge badge_delete">delete</span></a></span></h4></div><div id=panel__images__imageID_ class="panel-collapse collapse"><div class=panel-body><div class=list-group><div data-toggle=modal data-target=#_images__imageID__get class=list-group-item><span class="badge badge_get">get</span><div class=method_description><p>Get a specific image definition.</p></div><div class=clearfix></div></div><div data-toggle=modal data-target=#_images__imageID__delete class=list-group-item><span class="badge badge_delete">delete</span><div class=method_description><p>Delete a specific image.</p></div><div class=clearfix></div></div></div></div></div><div class="modal fade" tabindex=0 id=_images__imageID__get><div class=modal-dialog><div class=modal-content><div class=modal-header><button type=button class=close data-dismiss=modal aria-hidden=true>×</button><h4 class=modal-title id=myModalLabel><span class="badge badge_get">get</span> <span class=parent>/images</span>/{imageID}</h4></div><div class=modal-body><div class="alert alert-info"><p>Get a specific image definition.</p></div><ul class="nav nav-tabs"><li class=active><a href=#_images__imageID__get_request data-toggle=tab>Request</a></li></ul><div class=tab-content><div class="tab-pane active" id=_images__imageID__get_request><h3>URI Parameters</h3><ul><li><strong>imageID</strong>: <em>required (string)</em></li></ul><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Example</strong>:</p><pre><code>{
"apiVersion": "v1beta1",
"creationTimestamp": "2014-09-10T12:23:24-04:00",
"dockerImageReference": "localhost:5000/someproject/somerepo:c115fca463efa744a5492ca580ef24b20ed5ef2155c624cc5b1262aefc14797b",
"id": "c115fca463efa744a5492ca580ef24b20ed5ef2155c624cc5b1262aefc14797b",
"kind": "Image",
"metadata": {
"Size": 0,
"architecture": "amd64",
"config": {
"AttachStderr": false,
"AttachStdin": false,
"AttachStdout": false,
"Cmd": null,
"CpuShares": 0,
"Dns": null,
"Domainname": "",
"Entrypoint": null,
"Env": null,
"ExposedPorts": null,
"Hostname": "",
"Image": "",
"Memory": 0,
"MemorySwap": 0,
"NetworkDisabled": false,
"OpenStdin": false,
"PortSpecs": null,
"StdinOnce": false,
"Tty": false,
"User": "",
"Volumes": null,
"VolumesFrom": "",
"WorkingDir": ""
},
"container": "6b03c2dda0f8cbfa6186d96557e35e35c61915a70e4217a465f92f26c2d9290b",
"containerconfig": {
"AttachStderr": false,
"AttachStdin": false,
"AttachStdout": false,
"Cmd": null,
"CpuShares": 0,
"Dns": null,
"Domainname": "",
"Entrypoint": null,
"Env": null,
"ExposedPorts": null,
"Hostname": "",
"Image": "",
"Memory": 0,
"MemorySwap": 0,
"NetworkDisabled": false,
"OpenStdin": false,
"PortSpecs": null,
"StdinOnce": false,
"Tty": false,
"User": "",
"Volumes": null,
"VolumesFrom": "",
"WorkingDir": ""
},
"created": "0001-01-01T00:00:00Z",
"id": "c115fca463efa744a5492ca580ef24b20ed5ef2155c624cc5b1262aefc14797b",
"parent": "32730be9f383719ce6308329c8ee5aac189ece9e41928dc10b8bc0fc35e9d1d5"
},
"resourceVersion": 18
}
</code></pre></div></div></div></div></div></div><div class="modal fade" tabindex=0 id=_images__imageID__delete><div class=modal-dialog><div class=modal-content><div class=modal-header><button type=button class=close data-dismiss=modal aria-hidden=true>×</button><h4 class=modal-title id=myModalLabel><span class="badge badge_delete">delete</span> <span class=parent>/images</span>/{imageID}</h4></div><div class=modal-body><div class="alert alert-info"><p>Delete a specific image.</p></div><ul class="nav nav-tabs"><li class=active><a href=#_images__imageID__delete_request data-toggle=tab>Request</a></li><li><a href=#_images__imageID__delete_response data-toggle=tab>Response</a></li></ul><div class=tab-content><div class="tab-pane active" id=_images__imageID__delete_request><h3>URI Parameters</h3><ul><li><strong>imageID</strong>: <em>required (string)</em></li></ul></div><div class=tab-pane id=_images__imageID__delete_response><h2>HTTP status code <a href=http://httpstatus.es/200 target=_blank>200</a></h2><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Example</strong>:</p><pre><code>{
"apiVersion": "v1beta1",
"creationTimestamp": null,
"kind": "Status",
"status": "success"
}
</code></pre></div></div></div></div></div></div></div></div></div></div><div class="panel panel-default"><div class=panel-heading><h3 id=_links class=panel-title>/links (NOT IMPLEMENTED)</h3></div><div class=panel-body><div class=panel-group><div class="panel panel-white"><div class=panel-heading><h4 class=panel-title><a class=collapsed data-toggle=collapse href=#panel__links><span class=parent></span>/links</a> <span class=methods><a href=# data-toggle=modal data-target=#_links_get><span class="badge badge_get">get</span></a> <a href=# data-toggle=modal data-target=#_links_post><span class="badge badge_post">post</span></a></span></h4></div><div id=panel__links class="panel-collapse collapse"><div class=panel-body><div class=list-group><div data-toggle=modal data-target=#_links_get class=list-group-item><span class="badge badge_get">get</span><div class=method_description><p>List of links between services in your account.</p><p>Unlike a Docker link, a Link in OpenShift defines a relationship between services which may be composed by multiple Docker images. A link may include additional metadata about the relationship such as the algorithm to use to distribute requests.</p></div><div class=clearfix></div></div><div data-toggle=modal data-target=#_links_post class=list-group-item><span class="badge badge_post">post</span><div class=method_description><p>Create a new link between two services.</p></div><div class=clearfix></div></div></div></div></div><div class="modal fade" tabindex=0 id=_links_get><div class=modal-dialog><div class=modal-content><div class=modal-header><button type=button class=close data-dismiss=modal aria-hidden=true>×</button><h4 class=modal-title id=myModalLabel><span class="badge badge_get">get</span> <span class=parent></span>/links</h4></div><div class=modal-body><div class="alert alert-info"><p>List of links between services in your account.</p><p>Unlike a Docker link, a Link in OpenShift defines a relationship between services which may be composed by multiple Docker images. A link may include additional metadata about the relationship such as the algorithm to use to distribute requests.</p></div><ul class="nav nav-tabs"><li class=active><a href=#_links_get_request data-toggle=tab>Request</a></li><li><a href=#_links_get_response data-toggle=tab>Response</a></li></ul><div class=tab-content><div class="tab-pane active" id=_links_get_request><h3>Query Parameters</h3><ul><li><strong>projectID</strong>: <em>(string)</em><p>filter the links owned by a particular project.</p></li><li><strong>serviceID</strong>: <em>(string)</em><p>filter the links attached to a particular service.</p></li></ul></div><div class=tab-pane id=_links_get_response><h2>HTTP status code <a href=http://httpstatus.es/200 target=_blank>200</a></h2><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Example</strong>:</p><pre><code>{
"list":
[
{
"id": "53c4249f076573c0f4000001",
"projectId": "myproject-1234123132",
"source": {
"serviceId": "nginx-1893747912737"
},
"destination": {
"serviceId": "ruby1.9-1237471273",
"port": 8080
}
"policy": "round-robin"
}
]
}
</code></pre></div></div></div></div></div></div><div class="modal fade" tabindex=0 id=_links_post><div class=modal-dialog><div class=modal-content><div class=modal-header><button type=button class=close data-dismiss=modal aria-hidden=true>×</button><h4 class=modal-title id=myModalLabel><span class="badge badge_post">post</span> <span class=parent></span>/links</h4></div><div class=modal-body><div class="alert alert-info"><p>Create a new link between two services.</p></div><ul class="nav nav-tabs"><li class=active><a href=#_links_post_request data-toggle=tab>Request</a></li></ul><div class=tab-content><div class="tab-pane active" id=_links_post_request><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Example</strong>:</p><pre><code>{
"data":
{
"id": "53c4249f076573c0f4000001",
"projectId": "myproject-1234123132",
"source": {
"serviceId": "nginx-1893747912737"
},
"destination": {
"serviceId": "ruby1.9-1237471273",
"port": 8080
}
"policy": "round-robin"
}
}
</code></pre></div></div></div></div></div></div></div><div class="panel panel-white"><div class=panel-heading><h4 class=panel-title><a class=collapsed data-toggle=collapse href=#panel__links__linkID_><span class=parent>/links</span>/{linkID}</a> <span class=methods><a href=# data-toggle=modal data-target=#_links__linkID__get><span class="badge badge_get">get</span></a> <a href=# data-toggle=modal data-target=#_links__linkID__put><span class="badge badge_put">put</span></a> <a href=# data-toggle=modal data-target=#_links__linkID__delete><span class="badge badge_delete">delete</span></a></span></h4></div><div id=panel__links__linkID_ class="panel-collapse collapse"><div class=panel-body><div class=list-group><div data-toggle=modal data-target=#_links__linkID__get class=list-group-item><span class="badge badge_get">get</span><div class=method_description><p>Get details about a specific link.</p></div><div class=clearfix></div></div><div data-toggle=modal data-target=#_links__linkID__put class=list-group-item><span class="badge badge_put">put</span><div class=method_description><p>Update a specific link.</p></div><div class=clearfix></div></div><div data-toggle=modal data-target=#_links__linkID__delete class=list-group-item><span class="badge badge_delete">delete</span><div class=method_description><p>Delete a specific link.</p></div><div class=clearfix></div></div></div></div></div><div class="modal fade" tabindex=0 id=_links__linkID__get><div class=modal-dialog><div class=modal-content><div class=modal-header><button type=button class=close data-dismiss=modal aria-hidden=true>×</button><h4 class=modal-title id=myModalLabel><span class="badge badge_get">get</span> <span class=parent>/links</span>/{linkID}</h4></div><div class=modal-body><div class="alert alert-info"><p>Get details about a specific link.</p></div><ul class="nav nav-tabs"><li class=active><a href=#_links__linkID__get_request data-toggle=tab>Request</a></li></ul><div class=tab-content><div class="tab-pane active" id=_links__linkID__get_request><h3>URI Parameters</h3><ul><li><strong>linkID</strong>: <em>required (string)</em></li></ul><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Example</strong>:</p><pre><code>{
"data":
{
"id": "53c4249f076573c0f4000001",
"projectId": "myproject-1234123132",
"source": {
"serviceId": "nginx-1893747912737"
},
"destination": {
"serviceId": "ruby1.9-1237471273",
"port": 8080
}
"policy": "round-robin"
}
}
</code></pre></div></div></div></div></div></div><div class="modal fade" tabindex=0 id=_links__linkID__put><div class=modal-dialog><div class=modal-content><div class=modal-header><button type=button class=close data-dismiss=modal aria-hidden=true>×</button><h4 class=modal-title id=myModalLabel><span class="badge badge_put">put</span> <span class=parent>/links</span>/{linkID}</h4></div><div class=modal-body><div class="alert alert-info"><p>Update a specific link.</p></div><ul class="nav nav-tabs"><li class=active><a href=#_links__linkID__put_request data-toggle=tab>Request</a></li></ul><div class=tab-content><div class="tab-pane active" id=_links__linkID__put_request><h3>URI Parameters</h3><ul><li><strong>linkID</strong>: <em>required (string)</em></li></ul><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Example</strong>:</p><pre><code>{
"data":
{
"id": "53c4249f076573c0f4000001",
"projectId": "myproject-1234123132",
"source": {
"serviceId": "nginx-1893747912737"
},
"destination": {
"serviceId": "ruby1.9-1237471273",
"port": 8080
}
"policy": "round-robin"
}
}
</code></pre></div></div></div></div></div></div><div class="modal fade" tabindex=0 id=_links__linkID__delete><div class=modal-dialog><div class=modal-content><div class=modal-header><button type=button class=close data-dismiss=modal aria-hidden=true>×</button><h4 class=modal-title id=myModalLabel><span class="badge badge_delete">delete</span> <span class=parent>/links</span>/{linkID}</h4></div><div class=modal-body><div class="alert alert-info"><p>Delete a specific link.</p></div><ul class="nav nav-tabs"><li class=active><a href=#_links__linkID__delete_request data-toggle=tab>Request</a></li><li><a href=#_links__linkID__delete_response data-toggle=tab>Response</a></li></ul><div class=tab-content><div class="tab-pane active" id=_links__linkID__delete_request><h3>URI Parameters</h3><ul><li><strong>linkID</strong>: <em>required (string)</em></li></ul></div><div class=tab-pane id=_links__linkID__delete_response><h2>HTTP status code <a href=http://httpstatus.es/200 target=_blank>200</a></h2><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Example</strong>:</p><pre><code>{
"apiVersion": "v1beta1",
"creationTimestamp": null,
"kind": "Status",
"status": "success"
}
</code></pre></div></div></div></div></div></div></div></div></div></div><div class="panel panel-default"><div class=panel-heading><h3 id=_projects class=panel-title>/projects (NOT IMPLEMENTED)</h3></div><div class=panel-body><div class=panel-group><div class="panel panel-white"><div class=panel-heading><h4 class=panel-title><a class=collapsed data-toggle=collapse href=#panel__projects><span class=parent></span>/projects</a> <span class=methods><a href=# data-toggle=modal data-target=#_projects_get><span class="badge badge_get">get</span></a> <a href=# data-toggle=modal data-target=#_projects_post><span class="badge badge_post">post</span></a></span></h4></div><div id=panel__projects class="panel-collapse collapse"><div class=panel-body><div class=list-group><div data-toggle=modal data-target=#_projects_get class=list-group-item><span class="badge badge_get">get</span><div class=method_description><p>List all projects for your account.</p><p>Projects are a similar concept to v2 domains. A project is a grouping of services with shared access control and resource limits. Applications can be assembled from services in a project by linking them together via service endpoints.</p></div><div class=clearfix></div></div><div data-toggle=modal data-target=#_projects_post class=list-group-item><span class="badge badge_post">post</span><div class=method_description><p>Create a new project.</p></div><div class=clearfix></div></div></div></div></div><div class="modal fade" tabindex=0 id=_projects_get><div class=modal-dialog><div class=modal-content><div class=modal-header><button type=button class=close data-dismiss=modal aria-hidden=true>×</button><h4 class=modal-title id=myModalLabel><span class="badge badge_get">get</span> <span class=parent></span>/projects</h4></div><div class=modal-body><div class="alert alert-info"><p>List all projects for your account.</p><p>Projects are a similar concept to v2 domains. A project is a grouping of services with shared access control and resource limits. Applications can be assembled from services in a project by linking them together via service endpoints.</p></div><ul class="nav nav-tabs"><li class=active><a href=#_projects_get_request data-toggle=tab>Request</a></li><li><a href=#_projects_get_response data-toggle=tab>Response</a></li></ul><div class=tab-content><div class="tab-pane active" id=_projects_get_request></div><div class=tab-pane id=_projects_get_response><h2>HTTP status code <a href=http://httpstatus.es/200 target=_blank>200</a></h2><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Example</strong>:</p><pre><code>{
"data":
[
{
"id": "53c4249f076573c0f4000001",
"suffix": "dev.rhcloud.com",
"name": "mydomain",
"members": [
{
"login": "adminuser",
"role": "admin",
"type": "user",
"owner": true
}
]
},
{
"id": "54c4259f076573c0f4000023",
"suffix": "dev.rhcloud.com",
"name": "appdomain",
"members": [
{
"login": "adminuser",
"role": "admin",
"type": "user",
"owner": true
}
]
}
]
}
</code></pre></div></div></div></div></div></div><div class="modal fade" tabindex=0 id=_projects_post><div class=modal-dialog><div class=modal-content><div class=modal-header><button type=button class=close data-dismiss=modal aria-hidden=true>×</button><h4 class=modal-title id=myModalLabel><span class="badge badge_post">post</span> <span class=parent></span>/projects</h4></div><div class=modal-body><div class="alert alert-info"><p>Create a new project.</p></div><ul class="nav nav-tabs"><li class=active><a href=#_projects_post_request data-toggle=tab>Request</a></li></ul><div class=tab-content><div class="tab-pane active" id=_projects_post_request><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Example</strong>:</p><pre><code>{
"data":
{
"id": "53c4249f076573c0f4000001",
"suffix": "dev.rhcloud.com",
"name": "myproject",
"members": [
{
"login": "adminuser",
"role": "admin",
"type": "user",
"owner": true
}
]
}
}
</code></pre></div></div></div></div></div></div></div><div class="panel panel-white"><div class=panel-heading><h4 class=panel-title><a class=collapsed data-toggle=collapse href=#panel__projects__projectID_><span class=parent>/projects</span>/{projectID}</a> <span class=methods><a href=# data-toggle=modal data-target=#_projects__projectID__get><span class="badge badge_get">get</span></a> <a href=# data-toggle=modal data-target=#_projects__projectID__put><span class="badge badge_put">put</span></a> <a href=# data-toggle=modal data-target=#_projects__projectID__delete><span class="badge badge_delete">delete</span></a> <a href=# data-toggle=modal data-target=#_projects__projectID__post><span class="badge badge_post">post</span></a></span></h4></div><div id=panel__projects__projectID_ class="panel-collapse collapse"><div class=panel-body><div class=list-group><div data-toggle=modal data-target=#_projects__projectID__get class=list-group-item><span class="badge badge_get">get</span><div class=method_description><p>Get a specific project.</p></div><div class=clearfix></div></div><div data-toggle=modal data-target=#_projects__projectID__put class=list-group-item><span class="badge badge_put">put</span><div class=method_description><p>Update a project.</p></div><div class=clearfix></div></div><div data-toggle=modal data-target=#_projects__projectID__delete class=list-group-item><span class="badge badge_delete">delete</span><div class=method_description><p>Delete a project.</p></div><div class=clearfix></div></div><div data-toggle=modal data-target=#_projects__projectID__post class=list-group-item><span class="badge badge_post">post</span><div class=method_description><p>Instantiate a template in the given project.</p></div><div class=clearfix></div></div></div></div></div><div class="modal fade" tabindex=0 id=_projects__projectID__get><div class=modal-dialog><div class=modal-content><div class=modal-header><button type=button class=close data-dismiss=modal aria-hidden=true>×</button><h4 class=modal-title id=myModalLabel><span class="badge badge_get">get</span> <span class=parent>/projects</span>/{projectID}</h4></div><div class=modal-body><div class="alert alert-info"><p>Get a specific project.</p></div><ul class="nav nav-tabs"><li class=active><a href=#_projects__projectID__get_request data-toggle=tab>Request</a></li><li><a href=#_projects__projectID__get_response data-toggle=tab>Response</a></li></ul><div class=tab-content><div class="tab-pane active" id=_projects__projectID__get_request><h3>URI Parameters</h3><ul><li><strong>projectID</strong>: <em>required (string)</em></li></ul></div><div class=tab-pane id=_projects__projectID__get_response><h2>HTTP status code <a href=http://httpstatus.es/200 target=_blank>200</a></h2><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Example</strong>:</p><pre><code>{
"data":
{
"id": "53c4249f076573c0f4000001",
"suffix": "dev.rhcloud.com",
"name": "myproject",
"members": [
{
"login": "adminuser",
"role": "admin",
"type": "user",
"owner": true
}
]
}
}
</code></pre></div></div></div></div></div></div><div class="modal fade" tabindex=0 id=_projects__projectID__put><div class=modal-dialog><div class=modal-content><div class=modal-header><button type=button class=close data-dismiss=modal aria-hidden=true>×</button><h4 class=modal-title id=myModalLabel><span class="badge badge_put">put</span> <span class=parent>/projects</span>/{projectID}</h4></div><div class=modal-body><div class="alert alert-info"><p>Update a project.</p></div><ul class="nav nav-tabs"><li class=active><a href=#_projects__projectID__put_request data-toggle=tab>Request</a></li></ul><div class=tab-content><div class="tab-pane active" id=_projects__projectID__put_request><h3>URI Parameters</h3><ul><li><strong>projectID</strong>: <em>required (string)</em></li></ul><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Example</strong>:</p><pre><code>{
"data":
{
"id": "53c4249f076573c0f4000001",
"name": "newproject-name"
}
}
</code></pre></div></div></div></div></div></div><div class="modal fade" tabindex=0 id=_projects__projectID__delete><div class=modal-dialog><div class=modal-content><div class=modal-header><button type=button class=close data-dismiss=modal aria-hidden=true>×</button><h4 class=modal-title id=myModalLabel><span class="badge badge_delete">delete</span> <span class=parent>/projects</span>/{projectID}</h4></div><div class=modal-body><div class="alert alert-info"><p>Delete a project.</p></div><ul class="nav nav-tabs"><li class=active><a href=#_projects__projectID__delete_request data-toggle=tab>Request</a></li><li><a href=#_projects__projectID__delete_response data-toggle=tab>Response</a></li></ul><div class=tab-content><div class="tab-pane active" id=_projects__projectID__delete_request><h3>URI Parameters</h3><ul><li><strong>projectID</strong>: <em>required (string)</em></li></ul></div><div class=tab-pane id=_projects__projectID__delete_response><h2>HTTP status code <a href=http://httpstatus.es/200 target=_blank>200</a></h2><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Example</strong>:</p><pre><code>{
"apiVersion": "v1beta1",
"creationTimestamp": null,
"kind": "Status",
"status": "success"
}
</code></pre></div></div></div></div></div></div><div class="modal fade" tabindex=0 id=_projects__projectID__post><div class=modal-dialog><div class=modal-content><div class=modal-header><button type=button class=close data-dismiss=modal aria-hidden=true>×</button><h4 class=modal-title id=myModalLabel><span class="badge badge_post">post</span> <span class=parent>/projects</span>/{projectID}</h4></div><div class=modal-body><div class="alert alert-info"><p>Instantiate a template in the given project.</p></div><ul class="nav nav-tabs"><li class=active><a href=#_projects__projectID__post_request data-toggle=tab>Request</a></li></ul><div class=tab-content><div class="tab-pane active" id=_projects__projectID__post_request><h3>URI Parameters</h3><ul><li><strong>projectID</strong>: <em>required (string)</em></li></ul><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Example</strong>:</p><pre><code>{
"templateId": "the-template-id"
}
</code></pre></div></div></div></div></div></div></div></div></div></div><div class="panel panel-default"><div class=panel-heading><h3 id=_templateConfigs class=panel-title>/templateConfigs</h3></div><div class=panel-body><div class=panel-group><div class="panel panel-white"><div class=panel-heading><h4 class=panel-title><a class=collapsed data-toggle=collapse href=#panel__templateConfigs><span class=parent></span>/templateConfigs</a> <span class=methods><a href=# data-toggle=modal data-target=#_templateConfigs_post><span class="badge badge_post">post</span></a></span></h4></div><div id=panel__templateConfigs class="panel-collapse collapse"><div class=panel-body><div class=list-group><div data-toggle=modal data-target=#_templateConfigs_post class=list-group-item><span class="badge badge_post">post</span><div class=method_description><p>Process a template into a config. See /templates endpoint for details on template transformation, parameters and generators.</p></div><div class=clearfix></div></div></div></div></div><div class="modal fade" tabindex=0 id=_templateConfigs_post><div class=modal-dialog><div class=modal-content><div class=modal-header><button type=button class=close data-dismiss=modal aria-hidden=true>×</button><h4 class=modal-title id=myModalLabel><span class="badge badge_post">post</span> <span class=parent></span>/templateConfigs</h4></div><div class=modal-body><div class="alert alert-info"><p>Process a template into a config. See /templates endpoint for details on template transformation, parameters and generators.</p></div><ul class="nav nav-tabs"><li class=active><a href=#_templateConfigs_post_request data-toggle=tab>Request</a></li><li><a href=#_templateConfigs_post_response data-toggle=tab>Response</a></li></ul><div class=tab-content><div class="tab-pane active" id=_templateConfigs_post_request><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Schema</strong>:</p><pre><code>{
"$schema": "http://json-schema.org/draft-03/schema",
"type": "object",
"required": true,
"description": "Template resource.",
"properties": {
"id": {
"type": "string",
"required": true
},
"name": {
"type": "string",
"required": true
},
"description": {
"type": "string",
"required": false
},
"parameters": {
"type": "array",
"required": false,
"items": {
"type": "object",
"required": false,
"properties": {
"name": {
"type": "string",
"required": true
},
"type": {
"type": "string",
"required": true,
"enum": ["string"]
},
"value": {
"type": "string",
"required": false
},
"expression": {
"type": "string",
"required": false
},
"description": {
"type": "string",
"required": false
}
}
}
},
"items": {
"type": "array",
"required": false,
"items": {
"type": "object",
"required": true,
"properties": {
"kind": {
"type": "string",
"required": true
},
"id": {
"type": "string",
"required": true
}
}
}
}
}
}</code></pre><p><strong>Example</strong>:</p><pre><code>{
"kind": "Template",
"id": "example1",
"name": "My awesome PHP app",
"description": "Example PHP application with PostgreSQL database",
"parameters": [
{
"name": "DB_PASSWORD",
"description": "PostgreSQL admin user password",
"type": "string",
"expression": "[a-zA-Z0-9]{8}"
},
{
"name": "DB_USER",
"description": "PostgreSQL username",
"type": "string",
"expression": "admin[a-zA-Z0-9]{4}"
},
{
"name": "DB_NAME",
"description": "PostgreSQL database name",
"type": "string",
"value": "mydb"
}
],
"items": [
{
"kind": "Service",
"id": "frontend",
"apiVersion": "v1beta1",
"port": 8080,
"containerPort": 9292,
"selector": {
"name": "frontend"
}
},
{
"kind": "Service",
"id": "database",
"apiVersion": "v1beta1",
"port": 5432,
"containerPort": 5432,
"selector": {
"name": "database"
}
},
{
"kind": "ReplicationController",
"id": "frontendController",
"apiVersion": "v1beta1",
"desiredState": {
"replicas": 2,
"replicaSelector": {
"name": "frontend"
},
"podTemplate": {
"desiredState": {
"manifest": {
"id": "frontendController",
"version": "v1beta1",
"containers": [
{
"name": "nginx-php-app",
"image": "mfojtik/nginx-php-app",
"env": [
{
"name": "PGPASSWORD",
"value": "${DB_PASSWORD}"
},
{
"name": "PGUSER",
"value": "${DB_USER}"
},
{
"name": "PGDATABASE",
"value": "${DB_NAME}"
}
],
"ports": [
{
"containerPort": 9292,
"hostPort": 8080
}
]
}
]
}
},
"labels": {
"name": "frontend"
}
}
},
"labels": {
"name": "frontend"
}
},
{
"kind": "Pod",
"id": "postgresql",
"apiVersion": "v1beta1",
"desiredState": {
"manifest": {
"version": "v1beta1",
"id": "database",
"containers": [
{
"name": "postgresql",
"image": "postgres",
"env": [
{
"name": "PGPASSWORD",
"value": "${DB_PASSWORD}"
},
{
"name": "PGUSER",
"value": "${DB_USER}"
},
{
"name": "PGDATABASE",
"value": "${DB_NAME}"
}
],
"ports": [
{
"containerPort": 5432,
"hostPort": 5432
}
]
}
]
}
},
"labels": {
"name": "database"
}
}
]
}</code></pre></div><div class=tab-pane id=_templateConfigs_post_response><h2>HTTP status code <a href=http://httpstatus.es/200 target=_blank>200</a></h2><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Example</strong>:</p><pre><code>{
"kind": "Config",
"id": "example1",
"name": "My awesome PHP app",
"description": "Example PHP application with PostgreSQL database",
"apiVersion": "v1beta1",
"creationTimestamp": "2014-09-22T09:48:27Z",
"items": [
{
"kind": "Service",
"id": "frontend",
"creationTimestamp": null,
"apiVersion": "v1beta1",
"port": 8080,
"containerPort": 9292,
"selector": {
"name": "frontend"
}
},
{
"kind": "Service",
"id": "database",
"creationTimestamp": null,
"apiVersion": "v1beta1",
"port": 5432,
"containerPort": 5432,
"selector": {
"name": "database"
}
},
{
"kind": "ReplicationController",
"id": "frontendController",
"creationTimestamp": null,
"apiVersion": "v1beta1",
"desiredState": {
"replicas": 2,
"replicaSelector": {
"name": "frontend"
},
"podTemplate": {
"desiredState": {
"manifest": {
"version": "v1beta1",
"id": "frontendController",
"volumes": null,
"containers": [
{
"name": "nginx-php-app",
"image": "mfojtik/nginx-php-app",
"ports": [
{
"hostPort": 8080,
"containerPort": 9292,
"protocol": "TCP"
}
],
"env": [
{
"name": "PGPASSWORD",
"key": "PGPASSWORD",
"value": "MPbGM5T0"
},
{
"name": "PGUSER",
"key": "PGUSER",
"value": "adminO8bR"
},
{
"name": "PGDATABASE",
"key": "PGDATABASE",
"value": "mydb"
}
]
}
]
},
"restartpolicy": {}
},
"labels": {
"name": "frontend"
}
}
},
"labels": {
"name": "frontend"
}
},
{
"kind": "Pod",
"id": "postgresql",
"creationTimestamp": null,
"apiVersion": "v1beta1",
"labels": {
"name": "database"
},
"desiredState": {
"manifest": {
"version": "v1beta1",
"id": "database",
"volumes": null,
"containers": [
{
"name": "postgresql",
"image": "postgres",
"ports": [
{
"hostPort": 5432,
"containerPort": 5432,
"protocol": "TCP"
}
],
"env": [
{
"name": "PGPASSWORD",
"key": "PGPASSWORD",
"value": "MPbGM5T0"
},
{
"name": "PGUSER",
"key": "PGUSER",
"value": "adminO8bR"
},
{
"name": "PGDATABASE",
"key": "PGDATABASE",
"value": "mydb"
}
]
}
]
},
"restartpolicy": {
"type": "RestartAlways"
}
},
"currentState": {
"manifest": {
"version": "",
"id": "",
"volumes": null,
"containers": null
},
"restartpolicy": {}
}
}
]
}</code></pre></div></div></div></div></div></div></div></div></div></div><div class="panel panel-default"><div class=panel-heading><h3 id=_templates class=panel-title>/templates (NOT IMPLEMENTED)</h3></div><div class=panel-body><div class=panel-group><div class="panel panel-white"><div class=panel-heading><h4 class=panel-title><a class=collapsed data-toggle=collapse href=#panel__templates><span class=parent></span>/templates</a> <span class=methods><a href=# data-toggle=modal data-target=#_templates_get><span class="badge badge_get">get</span></a> <a href=# data-toggle=modal data-target=#_templates_post><span class="badge badge_post">post</span></a></span></h4></div><div id=panel__templates class="panel-collapse collapse"><div class=panel-body><div class=list-group><div data-toggle=modal data-target=#_templates_get class=list-group-item><span class="badge badge_get">get</span><div class=method_description><p>List all templates that your account has access to.</p><p>A template represents generic config with parameters.</p><p>Parameters:</p><p>Example #1 - static paramater:</p><pre><code>{
"name": "DB_NAME",
"description": "PostgreSQL database name",
"type": "string",
"value": "mydb"
}
</code></pre><p>The above parameter can be referenced in the rest of the template as ${DB_NAME} expression, which is to be substituted by its value (the "mydb" string) during the transformation.</p><p>Example #2 - parameter with generator:</p><pre><code>{
"name": "DB_PASSWORD",
"description": "PostgreSQL admin user password",
"type": "string",
"expression": "[a-zA-Z0-9]{8}"
}
</code></pre><p>The above parameter can be referenced in the rest of the template as ${DB_PASSWORD} expression, which is to be substituted by its newly generated value during the transformation.</p><p>Generators:</p><p>Generators generate random values based on the input. OpenShift 3 currently support expression value generator only.</p><p>Expression value generator generates random string based on the input expression. The input expression is a string, which may contain "[a-zA-Z0-9]{length}" expression constructs, defining range and length of the result random characters.</p><p>Examples ("expression" => "value"):</p><pre><code>"test[0-9]{1}x" => "test7x"
"[0-1]{8}" => "01001100"
"0x[A-F0-9]{4}" => "0xB3AF"
"[a-zA-Z0-9]{8}" => "hW4yQU5i"
</code></pre></div><div class=clearfix></div></div><div data-toggle=modal data-target=#_templates_post class=list-group-item><span class="badge badge_post">post</span><div class=method_description><p>Create a new template.</p></div><div class=clearfix></div></div></div></div></div><div class="modal fade" tabindex=0 id=_templates_get><div class=modal-dialog><div class=modal-content><div class=modal-header><button type=button class=close data-dismiss=modal aria-hidden=true>×</button><h4 class=modal-title id=myModalLabel><span class="badge badge_get">get</span> <span class=parent></span>/templates</h4></div><div class=modal-body><div class="alert alert-info"><p>List all templates that your account has access to.</p><p>A template represents generic config with parameters.</p><p>Parameters:</p><p>Example #1 - static paramater:</p><pre><code>{
"name": "DB_NAME",
"description": "PostgreSQL database name",
"type": "string",
"value": "mydb"
}
</code></pre><p>The above parameter can be referenced in the rest of the template as ${DB_NAME} expression, which is to be substituted by its value (the "mydb" string) during the transformation.</p><p>Example #2 - parameter with generator:</p><pre><code>{
"name": "DB_PASSWORD",
"description": "PostgreSQL admin user password",
"type": "string",
"expression": "[a-zA-Z0-9]{8}"
}
</code></pre><p>The above parameter can be referenced in the rest of the template as ${DB_PASSWORD} expression, which is to be substituted by its newly generated value during the transformation.</p><p>Generators:</p><p>Generators generate random values based on the input. OpenShift 3 currently support expression value generator only.</p><p>Expression value generator generates random string based on the input expression. The input expression is a string, which may contain "[a-zA-Z0-9]{length}" expression constructs, defining range and length of the result random characters.</p><p>Examples ("expression" => "value"):</p><pre><code>"test[0-9]{1}x" => "test7x"
"[0-1]{8}" => "01001100"
"0x[A-F0-9]{4}" => "0xB3AF"
"[a-zA-Z0-9]{8}" => "hW4yQU5i"
</code></pre></div><ul class="nav nav-tabs"><li class=active><a href=#_templates_get_request data-toggle=tab>Request</a></li></ul><div class=tab-content><div class="tab-pane active" id=_templates_get_request></div></div></div></div></div></div><div class="modal fade" tabindex=0 id=_templates_post><div class=modal-dialog><div class=modal-content><div class=modal-header><button type=button class=close data-dismiss=modal aria-hidden=true>×</button><h4 class=modal-title id=myModalLabel><span class="badge badge_post">post</span> <span class=parent></span>/templates</h4></div><div class=modal-body><div class="alert alert-info"><p>Create a new template.</p></div><ul class="nav nav-tabs"><li class=active><a href=#_templates_post_request data-toggle=tab>Request</a></li><li><a href=#_templates_post_response data-toggle=tab>Response</a></li></ul><div class=tab-content><div class="tab-pane active" id=_templates_post_request><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Schema</strong>:</p><pre><code>{
"$schema": "http://json-schema.org/draft-03/schema",
"type": "object",
"required": true,
"description": "Template resource.",
"properties": {
"id": {
"type": "string",
"required": true
},
"name": {
"type": "string",
"required": true
},
"description": {
"type": "string",
"required": false
},
"parameters": {
"type": "array",
"required": false,
"items": {
"type": "object",
"required": false,
"properties": {
"name": {
"type": "string",
"required": true
},
"type": {
"type": "string",
"required": true,
"enum": ["string"]
},
"value": {
"type": "string",
"required": false
},
"expression": {
"type": "string",
"required": false
},
"description": {
"type": "string",
"required": false
}
}
}
},
"items": {
"type": "array",
"required": false,
"items": {
"type": "object",
"required": true,
"properties": {
"kind": {
"type": "string",
"required": true
},
"id": {
"type": "string",
"required": true
}
}
}
}
}
}</code></pre><p><strong>Example</strong>:</p><pre><code>{
"kind": "Template",
"id": "example1",
"name": "My awesome PHP app",
"description": "Example PHP application with PostgreSQL database",
"parameters": [
{
"name": "DB_PASSWORD",
"description": "PostgreSQL admin user password",
"type": "string",
"expression": "[a-zA-Z0-9]{8}"
},
{
"name": "DB_USER",
"description": "PostgreSQL username",
"type": "string",
"expression": "admin[a-zA-Z0-9]{4}"
},
{
"name": "DB_NAME",
"description": "PostgreSQL database name",
"type": "string",
"value": "mydb"
}
],
"items": [
{
"kind": "Service",
"id": "frontend",
"apiVersion": "v1beta1",
"port": 8080,
"containerPort": 9292,
"selector": {
"name": "frontend"
}
},
{
"kind": "Service",
"id": "database",
"apiVersion": "v1beta1",
"port": 5432,
"containerPort": 5432,
"selector": {
"name": "database"
}
},
{
"kind": "ReplicationController",
"id": "frontendController",
"apiVersion": "v1beta1",
"desiredState": {
"replicas": 2,
"replicaSelector": {
"name": "frontend"
},
"podTemplate": {
"desiredState": {
"manifest": {
"id": "frontendController",
"version": "v1beta1",
"containers": [
{
"name": "nginx-php-app",
"image": "mfojtik/nginx-php-app",
"env": [
{
"name": "PGPASSWORD",
"value": "${DB_PASSWORD}"
},
{
"name": "PGUSER",
"value": "${DB_USER}"
},
{
"name": "PGDATABASE",
"value": "${DB_NAME}"
}
],
"ports": [
{
"containerPort": 9292,
"hostPort": 8080
}
]
}
]
}
},
"labels": {
"name": "frontend"
}
}
},
"labels": {
"name": "frontend"
}
},
{
"kind": "Pod",
"id": "postgresql",
"apiVersion": "v1beta1",
"desiredState": {
"manifest": {
"version": "v1beta1",
"id": "database",
"containers": [
{
"name": "postgresql",
"image": "postgres",
"env": [
{
"name": "PGPASSWORD",
"value": "${DB_PASSWORD}"
},
{
"name": "PGUSER",
"value": "${DB_USER}"
},
{
"name": "PGDATABASE",
"value": "${DB_NAME}"
}
],
"ports": [
{
"containerPort": 5432,
"hostPort": 5432
}
]
}
]
}
},
"labels": {
"name": "database"
}
}
]
}</code></pre></div><div class=tab-pane id=_templates_post_response><h2>HTTP status code <a href=http://httpstatus.es/200 target=_blank>200</a></h2><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Example</strong>:</p><pre><code>{
"apiVersion": "v1beta1",
"creationTimestamp": null,
"kind": "Status",
"status": "success"
}
</code></pre></div></div></div></div></div></div></div><div class="panel panel-white"><div class=panel-heading><h4 class=panel-title><a class=collapsed data-toggle=collapse href=#panel__templates__templateID_><span class=parent>/templates</span>/{templateID}</a> <span class=methods><a href=# data-toggle=modal data-target=#_templates__templateID__get><span class="badge badge_get">get</span></a> <a href=# data-toggle=modal data-target=#_templates__templateID__put><span class="badge badge_put">put</span></a> <a href=# data-toggle=modal data-target=#_templates__templateID__delete><span class="badge badge_delete">delete</span></a></span></h4></div><div id=panel__templates__templateID_ class="panel-collapse collapse"><div class=panel-body><div class=list-group><div data-toggle=modal data-target=#_templates__templateID__get class=list-group-item><span class="badge badge_get">get</span><div class=method_description><p>Get a specific template.</p></div><div class=clearfix></div></div><div data-toggle=modal data-target=#_templates__templateID__put class=list-group-item><span class="badge badge_put">put</span><div class=method_description><p>Update a specific template.</p></div><div class=clearfix></div></div><div data-toggle=modal data-target=#_templates__templateID__delete class=list-group-item><span class="badge badge_delete">delete</span><div class=method_description><p>Delete a specific template.</p></div><div class=clearfix></div></div></div></div></div><div class="modal fade" tabindex=0 id=_templates__templateID__get><div class=modal-dialog><div class=modal-content><div class=modal-header><button type=button class=close data-dismiss=modal aria-hidden=true>×</button><h4 class=modal-title id=myModalLabel><span class="badge badge_get">get</span> <span class=parent>/templates</span>/{templateID}</h4></div><div class=modal-body><div class="alert alert-info"><p>Get a specific template.</p></div><ul class="nav nav-tabs"><li class=active><a href=#_templates__templateID__get_request data-toggle=tab>Request</a></li><li><a href=#_templates__templateID__get_response data-toggle=tab>Response</a></li></ul><div class=tab-content><div class="tab-pane active" id=_templates__templateID__get_request><h3>URI Parameters</h3><ul><li><strong>templateID</strong>: <em>required (string)</em></li></ul></div><div class=tab-pane id=_templates__templateID__get_response><h2>HTTP status code <a href=http://httpstatus.es/200 target=_blank>200</a></h2><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Example</strong>:</p><pre><code>{
"kind": "Template",
"id": "example1",
"name": "My awesome PHP app",
"description": "Example PHP application with PostgreSQL database",
"parameters": [
{
"name": "DB_PASSWORD",
"description": "PostgreSQL admin user password",
"type": "string",
"expression": "[a-zA-Z0-9]{8}"
},
{
"name": "DB_USER",
"description": "PostgreSQL username",
"type": "string",
"expression": "admin[a-zA-Z0-9]{4}"
},
{
"name": "DB_NAME",
"description": "PostgreSQL database name",
"type": "string",
"value": "mydb"
}
],
"items": [
{
"kind": "Service",
"id": "frontend",
"apiVersion": "v1beta1",
"port": 8080,
"containerPort": 9292,
"selector": {
"name": "frontend"
}
},
{
"kind": "Service",
"id": "database",
"apiVersion": "v1beta1",
"port": 5432,
"containerPort": 5432,
"selector": {
"name": "database"
}
},
{
"kind": "ReplicationController",
"id": "frontendController",
"apiVersion": "v1beta1",
"desiredState": {
"replicas": 2,
"replicaSelector": {
"name": "frontend"
},
"podTemplate": {
"desiredState": {
"manifest": {
"id": "frontendController",
"version": "v1beta1",
"containers": [
{
"name": "nginx-php-app",
"image": "mfojtik/nginx-php-app",
"env": [
{
"name": "PGPASSWORD",
"value": "${DB_PASSWORD}"
},
{
"name": "PGUSER",
"value": "${DB_USER}"
},
{
"name": "PGDATABASE",
"value": "${DB_NAME}"
}
],
"ports": [
{
"containerPort": 9292,
"hostPort": 8080
}
]
}
]
}
},
"labels": {
"name": "frontend"
}
}
},
"labels": {
"name": "frontend"
}
},
{
"kind": "Pod",
"id": "postgresql",
"apiVersion": "v1beta1",
"desiredState": {
"manifest": {
"version": "v1beta1",
"id": "database",
"containers": [
{
"name": "postgresql",
"image": "postgres",
"env": [
{
"name": "PGPASSWORD",
"value": "${DB_PASSWORD}"
},
{
"name": "PGUSER",
"value": "${DB_USER}"
},
{
"name": "PGDATABASE",
"value": "${DB_NAME}"
}
],
"ports": [
{
"containerPort": 5432,
"hostPort": 5432
}
]
}
]
}
},
"labels": {
"name": "database"
}
}
]
}</code></pre></div></div></div></div></div></div><div class="modal fade" tabindex=0 id=_templates__templateID__put><div class=modal-dialog><div class=modal-content><div class=modal-header><button type=button class=close data-dismiss=modal aria-hidden=true>×</button><h4 class=modal-title id=myModalLabel><span class="badge badge_put">put</span> <span class=parent>/templates</span>/{templateID}</h4></div><div class=modal-body><div class="alert alert-info"><p>Update a specific template.</p></div><ul class="nav nav-tabs"><li class=active><a href=#_templates__templateID__put_request data-toggle=tab>Request</a></li><li><a href=#_templates__templateID__put_response data-toggle=tab>Response</a></li></ul><div class=tab-content><div class="tab-pane active" id=_templates__templateID__put_request><h3>URI Parameters</h3><ul><li><strong>templateID</strong>: <em>required (string)</em></li></ul></div><div class=tab-pane id=_templates__templateID__put_response><h2>HTTP status code <a href=http://httpstatus.es/200 target=_blank>200</a></h2><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Example</strong>:</p><pre><code>{
"apiVersion": "v1beta1",
"creationTimestamp": null,
"kind": "Status",
"status": "success"
}
</code></pre></div></div></div></div></div></div><div class="modal fade" tabindex=0 id=_templates__templateID__delete><div class=modal-dialog><div class=modal-content><div class=modal-header><button type=button class=close data-dismiss=modal aria-hidden=true>×</button><h4 class=modal-title id=myModalLabel><span class="badge badge_delete">delete</span> <span class=parent>/templates</span>/{templateID}</h4></div><div class=modal-body><div class="alert alert-info"><p>Delete a specific template.</p></div><ul class="nav nav-tabs"><li class=active><a href=#_templates__templateID__delete_request data-toggle=tab>Request</a></li><li><a href=#_templates__templateID__delete_response data-toggle=tab>Response</a></li></ul><div class=tab-content><div class="tab-pane active" id=_templates__templateID__delete_request><h3>URI Parameters</h3><ul><li><strong>templateID</strong>: <em>required (string)</em></li></ul></div><div class=tab-pane id=_templates__templateID__delete_response><h2>HTTP status code <a href=http://httpstatus.es/200 target=_blank>200</a></h2><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Example</strong>:</p><pre><code>{
"apiVersion": "v1beta1",
"creationTimestamp": null,
"kind": "Status",
"status": "success"
}
</code></pre></div></div></div></div></div></div></div></div></div></div></div><div class=col-md-3><div id=sidebar class="hidden-print affix" role=complementary><ul class="nav nav-pills nav-stacked"><li><a href=#_aliases>/aliases (NOT IMPLEMENTED)</a></li><li><a href=#_buildConfigHooks__buildID___secret___plugin_>/buildConfigHooks/{buildID}/{secret}/{plugin}</a></li><li><a href=#_buildConfigs>/buildConfigs</a></li><li><a href=#_builds>/builds</a></li><li><a href=#_configs>/configs (NOT IMPLEMENTED)</a></li><li><a href=#_deploymentConfigs>/deploymentConfigs</a></li><li><a href=#_deployments>/deployments</a></li><li><a href=#_imageRepositories>/imageRepositories</a></li><li><a href=#_imageRepositoryMappings>/imageRepositoryMappings</a></li><li><a href=#_images>/images</a></li><li><a href=#_links>/links (NOT IMPLEMENTED)</a></li><li><a href=#_projects>/projects (NOT IMPLEMENTED)</a></li><li><a href=#_templateConfigs>/templateConfigs</a></li><li><a href=#_templates>/templates (NOT IMPLEMENTED)</a></li></ul></div></div></div></div></body></html>