aboutsummaryrefslogtreecommitdiffstats
path: root/ccsdk-app-os/src/main/webapp/api-specs.html
diff options
context:
space:
mode:
Diffstat (limited to 'ccsdk-app-os/src/main/webapp/api-specs.html')
-rw-r--r--ccsdk-app-os/src/main/webapp/api-specs.html789
1 files changed, 122 insertions, 667 deletions
diff --git a/ccsdk-app-os/src/main/webapp/api-specs.html b/ccsdk-app-os/src/main/webapp/api-specs.html
index e5c5dfc..9a7d498 100644
--- a/ccsdk-app-os/src/main/webapp/api-specs.html
+++ b/ccsdk-app-os/src/main/webapp/api-specs.html
@@ -1500,7 +1500,7 @@ var n=this.pipeline.run(e.tokenizer(t)),r=new e.Vector,i=[],o=this._fields.reduc
<ul class="toc-list-h1">
<li>
- <a href="#dcae-dashboard-api" class="toc-h1 toc-link" data-title="DCAE Dashboard API v1.0.0">DCAE Dashboard API v1.0.0</a>
+ <a href="#dcae-dashboard-api" class="toc-h1 toc-link" data-title="DCAE Dashboard API v1.4.0">DCAE Dashboard API v1.4.0</a>
</li>
@@ -1510,27 +1510,22 @@ var n=this.pipeline.run(e.tokenizer(t)),r=new e.Vector,i=[],o=this._fields.reduc
<ul class="toc-list-h2">
<li>
- <a href="#find-all-blueprint-templates" class="toc-h2 toc-link" data-title="">Find all blueprint templates</a>
+ <a href="#list-blueprints" class="toc-h2 toc-link" data-title="">List Blueprints</a>
</li>
<li>
- <a href="#create-upload-a-new-blueprint-template" class="toc-h2 toc-link" data-title="">Create/Upload a new blueprint template</a>
+ <a href="#create-blueprint" class="toc-h2 toc-link" data-title="">Create Blueprint</a>
</li>
<li>
- <a href="#delete-a-blueprint-template" class="toc-h2 toc-link" data-title="">Delete a blueprint template</a>
+ <a href="#delete-blueprint" class="toc-h2 toc-link" data-title="">Delete Blueprint</a>
</li>
<li>
- <a href="#get-services-mapped-to-a-blueprint-template" class="toc-h2 toc-link" data-title="">Get Services mapped to a blueprint template</a>
-
- </li>
-
- <li>
- <a href="#find-a-blueprint-by-a-name-pattern" class="toc-h2 toc-link" data-title="">Find a blueprint by a name pattern</a>
+ <a href="#get-deployments-for-a-blueprint" class="toc-h2 toc-link" data-title="">Get Deployments for a blueprint</a>
</li>
@@ -1544,47 +1539,42 @@ var n=this.pipeline.run(e.tokenizer(t)),r=new e.Vector,i=[],o=this._fields.reduc
<ul class="toc-list-h2">
<li>
- <a href="#lists-all-deployments" class="toc-h2 toc-link" data-title="">Lists all Deployments</a>
-
- </li>
-
- <li>
- <a href="#initiate-a-deployment--install--operation-for-an-application-or-service" class="toc-h2 toc-link" data-title="">Initiate a deployment (install) operation for an application or service</a>
+ <a href="#list-deployments" class="toc-h2 toc-link" data-title="">List Deployments</a>
</li>
<li>
- <a href="#initiate-an-uninstall-operation-for-an-application-or-service" class="toc-h2 toc-link" data-title="">Initiate an uninstall operation for an application or service</a>
+ <a href="#create-deployment" class="toc-h2 toc-link" data-title="">Create Deployment</a>
</li>
<li>
- <a href="#upgrade-or-rollback-an-existing-deployment-using-cloudify-helm-plugin" class="toc-h2 toc-link" data-title="">Upgrade or Rollback an existing deployment using Cloudify Helm plugin</a>
+ <a href="#delete-deployment" class="toc-h2 toc-link" data-title="">Delete Deployment</a>
</li>
<li>
- <a href="#gets-a-deployment" class="toc-h2 toc-link" data-title="">Gets a Deployment</a>
+ <a href="#upgrade_rollback-deployment" class="toc-h2 toc-link" data-title="">Upgrade_Rollback Deployment</a>
</li>
<li>
- <a href="#update-an-existing-deployment" class="toc-h2 toc-link" data-title="">Update an existing deployment</a>
+ <a href="#get-deployment" class="toc-h2 toc-link" data-title="">Get Deployment</a>
</li>
<li>
- <a href="#deployment-execution-status" class="toc-h2 toc-link" data-title="">Deployment execution status</a>
+ <a href="#deployment-status" class="toc-h2 toc-link" data-title="">Deployment Status</a>
</li>
<li>
- <a href="#deployment-health-status" class="toc-h2 toc-link" data-title="">Deployment health status</a>
+ <a href="#deployment-health" class="toc-h2 toc-link" data-title="">Deployment health</a>
</li>
<li>
- <a href="#deployment-inputs" class="toc-h2 toc-link" data-title="">Deployment inputs</a>
+ <a href="#deployment-inputs" class="toc-h2 toc-link" data-title="">Deployment Inputs</a>
</li>
@@ -1598,26 +1588,7 @@ var n=this.pipeline.run(e.tokenizer(t)),r=new e.Vector,i=[],o=this._fields.reduc
<ul class="toc-list-h2">
<li>
- <a href="#lists-all-cloudify-tenants" class="toc-h2 toc-link" data-title="">Lists all Cloudify Tenants</a>
-
- </li>
-
- </ul>
-
- </li>
-
- <li>
- <a href="#dcae-dashboard-api-components" class="toc-h1 toc-link" data-title="Components">Components</a>
-
- <ul class="toc-list-h2">
-
- <li>
- <a href="#lists-all-application-components" class="toc-h2 toc-link" data-title="">Lists all application components</a>
-
- </li>
-
- <li>
- <a href="#add-an-application-component" class="toc-h2 toc-link" data-title="">add an application component</a>
+ <a href="#list-tenants" class="toc-h2 toc-link" data-title="">List Tenants</a>
</li>
@@ -1636,11 +1607,6 @@ var n=this.pipeline.run(e.tokenizer(t)),r=new e.Vector,i=[],o=this._fields.reduc
</li>
<li>
- <a href="#tocscomponent" class="toc-h2 toc-link" data-title="">Component</a>
-
- </li>
-
- <li>
<a href="#tocscomponentinput" class="toc-h2 toc-link" data-title="">ComponentInput</a>
</li>
@@ -1747,7 +1713,7 @@ var n=this.pipeline.run(e.tokenizer(t)),r=new e.Vector,i=[],o=this._fields.reduc
<div class="page-wrapper">
<div class="dark-box"></div>
<div class="content">
- <h1 id="dcae-dashboard-api">DCAE Dashboard API v1.0.0</h1>
+ <h1 id="dcae-dashboard-api">DCAE Dashboard API v1.4.0</h1>
<blockquote>
<p>Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.</p>
</blockquote>
@@ -1755,16 +1721,16 @@ var n=this.pipeline.run(e.tokenizer(t)),r=new e.Vector,i=[],o=this._fields.reduc
<p>Base URLs:</p>
<ul>
<li>
-<p><a href="https://dcae-dashboard:8080/ccsdk-app/nb-api">https://dcae-dashboard:8080/ccsdk-app/nb-api</a></p>
+<p><a href="https://dcae-dashboard:8080/ccsdk-app/nb-api/v2">https://dcae-dashboard:8080/ccsdk-app/nb-api/v2</a></p>
</li>
<li>
-<p><a href="http://dcae-dashboard:8080/ccsdk-app/nb-api">http://dcae-dashboard:8080/ccsdk-app/nb-api</a></p>
+<p><a href="http://dcae-dashboard:8080/ccsdk-app/nb-api/v2">http://dcae-dashboard:8080/ccsdk-app/nb-api/v2</a></p>
</li>
</ul>
<p>Email: <a href="mailto:rp5662@att.com">Support</a></p>
<h1 id="dcae-dashboard-api-blueprints">Blueprints</h1>
<p>Query blueprint information</p>
-<h2 id="find-all-blueprint-templates">Find all blueprint templates</h2>
+<h2 id="list-blueprints">List Blueprints</h2>
<p><a id="opIdList Blueprints"></a></p>
<blockquote>
<p>Code samples</p>
@@ -1774,7 +1740,7 @@ headers = {
<span class="hljs-string">'Accept'</span>: <span class="hljs-string">'application/json'</span>
}
-r = requests.get(<span class="hljs-string">'https://dcae-dashboard:8080/ccsdk-app/nb-api/blueprints'</span>, params={
+r = requests.get(<span class="hljs-string">'https://dcae-dashboard:8080/ccsdk-app/nb-api/v2/blueprints'</span>, params={
<span class="hljs-string">'pageNum'</span>: <span class="hljs-string">'string'</span>, <span class="hljs-string">'viewPerPage'</span>: <span class="hljs-string">'string'</span>
}, headers = headers)
@@ -1782,13 +1748,14 @@ r = requests.get(<span class="hljs-string">'https://dcae-dashboard:8080/ccsdk-ap
</code></pre>
<pre class="highlight tab tab-shell"><code><span class="hljs-comment"># You can also use wget</span>
-curl -X GET https://dcae-dashboard:8080/ccsdk-app/nb-api/blueprints?pageNum=string&amp;viewPerPage=string \
+curl -X GET https://dcae-dashboard:8080/ccsdk-app/nb-api/v2/blueprints?pageNum=string&amp;viewPerPage=string \
-H <span class="hljs-string">'Accept: application/json'</span>
</code></pre>
<p><code>GET /blueprints</code></p>
+<p><em>Find all blueprint templates</em></p>
<p>Fetch the blueprints data from inventory</p>
-<h3 id="find-all-blueprint-templates-parameters">Parameters</h3>
+<h3 id="list-blueprints-parameters">Parameters</h3>
<table>
<thead>
<tr>
@@ -1917,13 +1884,13 @@ curl -X GET https://dcae-dashboard:8080/ccsdk-app/nb-api/blueprints?pageNum=stri
},
<span class="hljs-attr">"type"</span>: <span class="hljs-string">"string"</span>
},
- <span class="hljs-attr">"created"</span>: <span class="hljs-string">"2020-02-05T21:21:26Z"</span>,
- <span class="hljs-attr">"deactivated"</span>: <span class="hljs-string">"2020-02-05T21:21:26Z"</span>
+ <span class="hljs-attr">"created"</span>: <span class="hljs-string">"2020-08-12T15:08:29Z"</span>,
+ <span class="hljs-attr">"deactivated"</span>: <span class="hljs-string">"2020-08-12T15:08:29Z"</span>
}
]
}
</code></pre>
-<h3 id="find-all-blueprint-templates-responses">Responses</h3>
+<h3 id="list-blueprints-responses">Responses</h3>
<table>
<thead>
<tr>
@@ -1951,7 +1918,7 @@ curl -X GET https://dcae-dashboard:8080/ccsdk-app/nb-api/blueprints?pageNum=stri
<aside class="success">
This operation does not require authentication
</aside>
-<h2 id="create-upload-a-new-blueprint-template">Create/Upload a new blueprint template</h2>
+<h2 id="create-blueprint">Create Blueprint</h2>
<p><a id="opIdCreate Blueprint"></a></p>
<blockquote>
<p>Code samples</p>
@@ -1962,7 +1929,7 @@ headers = {
<span class="hljs-string">'Accept'</span>: <span class="hljs-string">'application/json'</span>
}
-r = requests.post(<span class="hljs-string">'https://dcae-dashboard:8080/ccsdk-app/nb-api/blueprints'</span>, params={
+r = requests.post(<span class="hljs-string">'https://dcae-dashboard:8080/ccsdk-app/nb-api/v2/blueprints'</span>, params={
}, headers = headers)
@@ -1970,12 +1937,13 @@ r = requests.post(<span class="hljs-string">'https://dcae-dashboard:8080/ccsdk-a
</code></pre>
<pre class="highlight tab tab-shell"><code><span class="hljs-comment"># You can also use wget</span>
-curl -X POST https://dcae-dashboard:8080/ccsdk-app/nb-api/blueprints \
+curl -X POST https://dcae-dashboard:8080/ccsdk-app/nb-api/v2/blueprints \
-H <span class="hljs-string">'Content-Type: application/json'</span> \
-H <span class="hljs-string">'Accept: application/json'</span>
</code></pre>
<p><code>POST /blueprints</code></p>
+<p><em>Create/Upload a new blueprint template</em></p>
<p>Upload a new blueprint template into inventory</p>
<blockquote>
<p>Body parameter</p>
@@ -1989,7 +1957,7 @@ curl -X POST https://dcae-dashboard:8080/ccsdk-app/nb-api/blueprints \
<span class="hljs-attr">"component"</span>: <span class="hljs-string">"string"</span>
}
</code></pre>
-<h3 id="create-upload-a-new-blueprint-template-parameters">Parameters</h3>
+<h3 id="create-blueprint-parameters">Parameters</h3>
<table>
<thead>
<tr>
@@ -2081,13 +2049,13 @@ curl -X POST https://dcae-dashboard:8080/ccsdk-app/nb-api/blueprints \
},
<span class="hljs-attr">"type"</span>: <span class="hljs-string">"string"</span>
},
- <span class="hljs-attr">"created"</span>: <span class="hljs-string">"2020-02-05T21:21:26Z"</span>,
- <span class="hljs-attr">"deactivated"</span>: <span class="hljs-string">"2020-02-05T21:21:26Z"</span>
+ <span class="hljs-attr">"created"</span>: <span class="hljs-string">"2020-08-12T15:08:29Z"</span>,
+ <span class="hljs-attr">"deactivated"</span>: <span class="hljs-string">"2020-08-12T15:08:29Z"</span>
}
]
}
</code></pre>
-<h3 id="create-upload-a-new-blueprint-template-responses">Responses</h3>
+<h3 id="create-blueprint-responses">Responses</h3>
<table>
<thead>
<tr>
@@ -2115,14 +2083,14 @@ curl -X POST https://dcae-dashboard:8080/ccsdk-app/nb-api/blueprints \
<aside class="success">
This operation does not require authentication
</aside>
-<h2 id="delete-a-blueprint-template">Delete a blueprint template</h2>
+<h2 id="delete-blueprint">Delete Blueprint</h2>
<p><a id="opIdDelete Blueprint"></a></p>
<blockquote>
<p>Code samples</p>
</blockquote>
<pre class="highlight tab tab-python"><code><span class="hljs-keyword">import</span> requests
-r = requests.delete(<span class="hljs-string">'https://dcae-dashboard:8080/ccsdk-app/nb-api/blueprints/{typeId}'</span>, params={
+r = requests.delete(<span class="hljs-string">'https://dcae-dashboard:8080/ccsdk-app/nb-api/v2/blueprints/{typeId}'</span>, params={
)
@@ -2130,12 +2098,13 @@ r = requests.delete(<span class="hljs-string">'https://dcae-dashboard:8080/ccsdk
</code></pre>
<pre class="highlight tab tab-shell"><code><span class="hljs-comment"># You can also use wget</span>
-curl -X DELETE https://dcae-dashboard:8080/ccsdk-app/nb-api/blueprints/{typeId}
+curl -X DELETE https://dcae-dashboard:8080/ccsdk-app/nb-api/v2/blueprints/{typeId}
</code></pre>
<p><code>DELETE /blueprints/{typeId}</code></p>
+<p><em>Delete a blueprint template</em></p>
<p>Delete a blueprint template from inventory</p>
-<h3 id="delete-a-blueprint-template-parameters">Parameters</h3>
+<h3 id="delete-blueprint-parameters">Parameters</h3>
<table>
<thead>
<tr>
@@ -2156,7 +2125,7 @@ curl -X DELETE https://dcae-dashboard:8080/ccsdk-app/nb-api/blueprints/{typeId}
</tr>
</tbody>
</table>
-<h3 id="delete-a-blueprint-template-responses">Responses</h3>
+<h3 id="delete-blueprint-responses">Responses</h3>
<table>
<thead>
<tr>
@@ -2178,14 +2147,14 @@ curl -X DELETE https://dcae-dashboard:8080/ccsdk-app/nb-api/blueprints/{typeId}
<aside class="success">
This operation does not require authentication
</aside>
-<h2 id="get-services-mapped-to-a-blueprint-template">Get Services mapped to a blueprint template</h2>
+<h2 id="get-deployments-for-a-blueprint">Get Deployments for a blueprint</h2>
<p><a id="opIdGet Deployments for a blueprint"></a></p>
<blockquote>
<p>Code samples</p>
</blockquote>
<pre class="highlight tab tab-python"><code><span class="hljs-keyword">import</span> requests
-r = requests.get(<span class="hljs-string">'https://dcae-dashboard:8080/ccsdk-app/nb-api/blueprints/{typeId}/services'</span>, params={
+r = requests.get(<span class="hljs-string">'https://dcae-dashboard:8080/ccsdk-app/nb-api/v2/blueprints/{typeId}/services'</span>, params={
)
@@ -2193,12 +2162,13 @@ r = requests.get(<span class="hljs-string">'https://dcae-dashboard:8080/ccsdk-ap
</code></pre>
<pre class="highlight tab tab-shell"><code><span class="hljs-comment"># You can also use wget</span>
-curl -X GET https://dcae-dashboard:8080/ccsdk-app/nb-api/blueprints/{typeId}/services
+curl -X GET https://dcae-dashboard:8080/ccsdk-app/nb-api/v2/blueprints/{typeId}/services
</code></pre>
<p><code>GET /blueprints/{typeId}/services</code></p>
+<p><em>Get Services mapped to a blueprint template</em></p>
<p>Get Deployment References existing for a blueprint</p>
-<h3 id="get-services-mapped-to-a-blueprint-template-parameters">Parameters</h3>
+<h3 id="get-deployments-for-a-blueprint-parameters">Parameters</h3>
<table>
<thead>
<tr>
@@ -2219,7 +2189,7 @@ curl -X GET https://dcae-dashboard:8080/ccsdk-app/nb-api/blueprints/{typeId}/ser
</tr>
</tbody>
</table>
-<h3 id="get-services-mapped-to-a-blueprint-template-responses">Responses</h3>
+<h3 id="get-deployments-for-a-blueprint-responses">Responses</h3>
<table>
<thead>
<tr>
@@ -2241,189 +2211,9 @@ curl -X GET https://dcae-dashboard:8080/ccsdk-app/nb-api/blueprints/{typeId}/ser
<aside class="success">
This operation does not require authentication
</aside>
-<h2 id="find-a-blueprint-by-a-name-pattern">Find a blueprint by a name pattern</h2>
-<p><a id="opIdGet Blueprint"></a></p>
-<blockquote>
-<p>Code samples</p>
-</blockquote>
-<pre class="highlight tab tab-python"><code><span class="hljs-keyword">import</span> requests
-headers = {
- <span class="hljs-string">'Accept'</span>: <span class="hljs-string">'application/json'</span>
-}
-
-r = requests.get(<span class="hljs-string">'https://dcae-dashboard:8080/ccsdk-app/nb-api/blueprints/findByName'</span>, params={
- <span class="hljs-string">'name'</span>: <span class="hljs-string">'string'</span>
-}, headers = headers)
-
-<span class="hljs-keyword">print</span> r.json()
-
-</code></pre>
-<pre class="highlight tab tab-shell"><code><span class="hljs-comment"># You can also use wget</span>
-curl -X GET https://dcae-dashboard:8080/ccsdk-app/nb-api/blueprints/findByName?name=string \
- -H <span class="hljs-string">'Accept: application/json'</span>
-
-</code></pre>
-<p><code>GET /blueprints/findByName</code></p>
-<p>Fetch the blueprint objects from inventory whose names match a string pattern</p>
-<h3 id="find-a-blueprint-by-a-name-pattern-parameters">Parameters</h3>
-<table>
-<thead>
-<tr>
-<th>Name</th>
-<th>In</th>
-<th>Type</th>
-<th>Required</th>
-<th>Description</th>
-</tr>
-</thead>
-<tbody>
-<tr>
-<td>name</td>
-<td>query</td>
-<td>string</td>
-<td>true</td>
-<td>name pattern to filter by</td>
-</tr>
-<tr>
-<td>_include</td>
-<td>query</td>
-<td>array[string]</td>
-<td>false</td>
-<td>blueprint object properties need to be considered for filter</td>
-</tr>
-</tbody>
-</table>
-<h4 id="enumerated-values">Enumerated Values</h4>
-<table>
-<thead>
-<tr>
-<th>Parameter</th>
-<th>Value</th>
-</tr>
-</thead>
-<tbody>
-<tr>
-<td>_include</td>
-<td>typeName</td>
-</tr>
-<tr>
-<td>_include</td>
-<td>typeId</td>
-</tr>
-<tr>
-<td>_include</td>
-<td>typeVersion</td>
-</tr>
-</tbody>
-</table>
-<blockquote>
-<p>Example responses</p>
-</blockquote>
-<blockquote>
-<p>200 Response</p>
-</blockquote>
-<pre class="highlight tab tab-json"><code>{
- <span class="hljs-attr">"links"</span>: {
- <span class="hljs-attr">"previousLink"</span>: {
- <span class="hljs-attr">"title"</span>: <span class="hljs-string">"string"</span>,
- <span class="hljs-attr">"rel"</span>: <span class="hljs-string">"string"</span>,
- <span class="hljs-attr">"uri"</span>: <span class="hljs-string">"http://example.com"</span>,
- <span class="hljs-attr">"uriBuilder"</span>: {},
- <span class="hljs-attr">"rels"</span>: [
- <span class="hljs-string">"string"</span>
- ],
- <span class="hljs-attr">"params"</span>: {
- <span class="hljs-attr">"property1"</span>: <span class="hljs-string">"string"</span>,
- <span class="hljs-attr">"property2"</span>: <span class="hljs-string">"string"</span>
- },
- <span class="hljs-attr">"type"</span>: <span class="hljs-string">"string"</span>
- },
- <span class="hljs-attr">"nextLink"</span>: {
- <span class="hljs-attr">"title"</span>: <span class="hljs-string">"string"</span>,
- <span class="hljs-attr">"rel"</span>: <span class="hljs-string">"string"</span>,
- <span class="hljs-attr">"uri"</span>: <span class="hljs-string">"http://example.com"</span>,
- <span class="hljs-attr">"uriBuilder"</span>: {},
- <span class="hljs-attr">"rels"</span>: [
- <span class="hljs-string">"string"</span>
- ],
- <span class="hljs-attr">"params"</span>: {
- <span class="hljs-attr">"property1"</span>: <span class="hljs-string">"string"</span>,
- <span class="hljs-attr">"property2"</span>: <span class="hljs-string">"string"</span>
- },
- <span class="hljs-attr">"type"</span>: <span class="hljs-string">"string"</span>
- }
- },
- <span class="hljs-attr">"totalCount"</span>: <span class="hljs-number">0</span>,
- <span class="hljs-attr">"items"</span>: [
- {
- <span class="hljs-attr">"owner"</span>: <span class="hljs-string">"string"</span>,
- <span class="hljs-attr">"typeName"</span>: <span class="hljs-string">"string"</span>,
- <span class="hljs-attr">"typeVersion"</span>: <span class="hljs-number">0</span>,
- <span class="hljs-attr">"blueprintTemplate"</span>: <span class="hljs-string">"string"</span>,
- <span class="hljs-attr">"serviceIds"</span>: [
- <span class="hljs-string">"string"</span>
- ],
- <span class="hljs-attr">"vnfTypes"</span>: [
- <span class="hljs-string">"string"</span>
- ],
- <span class="hljs-attr">"serviceLocations"</span>: [
- <span class="hljs-string">"string"</span>
- ],
- <span class="hljs-attr">"asdcServiceId"</span>: <span class="hljs-string">"string"</span>,
- <span class="hljs-attr">"asdcResourceId"</span>: <span class="hljs-string">"string"</span>,
- <span class="hljs-attr">"asdcServiceURL"</span>: <span class="hljs-string">"string"</span>,
- <span class="hljs-attr">"typeId"</span>: <span class="hljs-string">"string"</span>,
- <span class="hljs-attr">"selfLink"</span>: {
- <span class="hljs-attr">"title"</span>: <span class="hljs-string">"string"</span>,
- <span class="hljs-attr">"rel"</span>: <span class="hljs-string">"string"</span>,
- <span class="hljs-attr">"uri"</span>: <span class="hljs-string">"http://example.com"</span>,
- <span class="hljs-attr">"uriBuilder"</span>: {},
- <span class="hljs-attr">"rels"</span>: [
- <span class="hljs-string">"string"</span>
- ],
- <span class="hljs-attr">"params"</span>: {
- <span class="hljs-attr">"property1"</span>: <span class="hljs-string">"string"</span>,
- <span class="hljs-attr">"property2"</span>: <span class="hljs-string">"string"</span>
- },
- <span class="hljs-attr">"type"</span>: <span class="hljs-string">"string"</span>
- },
- <span class="hljs-attr">"created"</span>: <span class="hljs-string">"2020-02-05T21:21:26Z"</span>,
- <span class="hljs-attr">"deactivated"</span>: <span class="hljs-string">"2020-02-05T21:21:26Z"</span>
- }
- ]
-}
-</code></pre>
-<h3 id="find-a-blueprint-by-a-name-pattern-responses">Responses</h3>
-<table>
-<thead>
-<tr>
-<th>Status</th>
-<th>Meaning</th>
-<th>Description</th>
-<th>Schema</th>
-</tr>
-</thead>
-<tbody>
-<tr>
-<td>200</td>
-<td><a href="https://tools.ietf.org/html/rfc7231#section-6.3.1">OK</a></td>
-<td>List of <code>DCAEServiceType</code> objects</td>
-<td><a href="#schemainlineresponse200">InlineResponse200</a></td>
-</tr>
-<tr>
-<td>400</td>
-<td><a href="https://tools.ietf.org/html/rfc7231#section-6.5.1">Bad Request</a></td>
-<td>Invalid tag value</td>
-<td>None</td>
-</tr>
-</tbody>
-</table>
-<aside class="success">
-This operation does not require authentication
-</aside>
<h1 id="dcae-dashboard-api-deployments">Deployments</h1>
<p>Manage deployments</p>
-<h2 id="lists-all-deployments">Lists all Deployments</h2>
+<h2 id="list-deployments">List Deployments</h2>
<p><a id="opIdList Deployments"></a></p>
<blockquote>
<p>Code samples</p>
@@ -2433,7 +2223,7 @@ headers = {
<span class="hljs-string">'Accept'</span>: <span class="hljs-string">'application/json'</span>
}
-r = requests.get(<span class="hljs-string">'https://dcae-dashboard:8080/ccsdk-app/nb-api/deployments'</span>, params={
+r = requests.get(<span class="hljs-string">'https://dcae-dashboard:8080/ccsdk-app/nb-api/v2/deployments'</span>, params={
<span class="hljs-string">'pageNum'</span>: <span class="hljs-string">'string'</span>, <span class="hljs-string">'viewPerPage'</span>: <span class="hljs-string">'string'</span>
}, headers = headers)
@@ -2441,13 +2231,14 @@ r = requests.get(<span class="hljs-string">'https://dcae-dashboard:8080/ccsdk-ap
</code></pre>
<pre class="highlight tab tab-shell"><code><span class="hljs-comment"># You can also use wget</span>
-curl -X GET https://dcae-dashboard:8080/ccsdk-app/nb-api/deployments?pageNum=string&amp;viewPerPage=string \
+curl -X GET https://dcae-dashboard:8080/ccsdk-app/nb-api/v2/deployments?pageNum=string&amp;viewPerPage=string \
-H <span class="hljs-string">'Accept: application/json'</span>
</code></pre>
<p><code>GET /deployments</code></p>
+<p><em>List all Deployments</em></p>
<p>Query all deployments or Service objects from Inventory</p>
-<h3 id="lists-all-deployments-parameters">Parameters</h3>
+<h3 id="list-deployments-parameters">Parameters</h3>
<table>
<thead>
<tr>
@@ -2498,8 +2289,8 @@ curl -X GET https://dcae-dashboard:8080/ccsdk-app/nb-api/deployments?pageNum=str
},
<span class="hljs-attr">"type"</span>: <span class="hljs-string">"string"</span>
},
- <span class="hljs-attr">"created"</span>: <span class="hljs-string">"2020-02-05T21:21:26Z"</span>,
- <span class="hljs-attr">"modified"</span>: <span class="hljs-string">"2020-02-05T21:21:26Z"</span>,
+ <span class="hljs-attr">"created"</span>: <span class="hljs-string">"2020-08-12T15:08:29Z"</span>,
+ <span class="hljs-attr">"modified"</span>: <span class="hljs-string">"2020-08-12T15:08:29Z"</span>,
<span class="hljs-attr">"typeLink"</span>: {
<span class="hljs-attr">"title"</span>: <span class="hljs-string">"string"</span>,
<span class="hljs-attr">"rel"</span>: <span class="hljs-string">"string"</span>,
@@ -2549,8 +2340,8 @@ curl -X GET https://dcae-dashboard:8080/ccsdk-app/nb-api/deployments?pageNum=str
},
<span class="hljs-attr">"type"</span>: <span class="hljs-string">"string"</span>
},
- <span class="hljs-attr">"created"</span>: <span class="hljs-string">"2020-02-05T21:21:26Z"</span>,
- <span class="hljs-attr">"modified"</span>: <span class="hljs-string">"2020-02-05T21:21:26Z"</span>,
+ <span class="hljs-attr">"created"</span>: <span class="hljs-string">"2020-08-12T15:08:29Z"</span>,
+ <span class="hljs-attr">"modified"</span>: <span class="hljs-string">"2020-08-12T15:08:29Z"</span>,
<span class="hljs-attr">"componentType"</span>: <span class="hljs-string">"string"</span>,
<span class="hljs-attr">"componentSource"</span>: <span class="hljs-string">"DCAEController"</span>,
<span class="hljs-attr">"status"</span>: <span class="hljs-string">"string"</span>,
@@ -2562,7 +2353,7 @@ curl -X GET https://dcae-dashboard:8080/ccsdk-app/nb-api/deployments?pageNum=str
}
]
</code></pre>
-<h3 id="lists-all-deployments-responses">Responses</h3>
+<h3 id="list-deployments-responses">Responses</h3>
<table>
<thead>
<tr>
@@ -2587,7 +2378,7 @@ curl -X GET https://dcae-dashboard:8080/ccsdk-app/nb-api/deployments?pageNum=str
</tr>
</tbody>
</table>
-<h3 id="lists-all-deployments-responseschema">Response Schema</h3>
+<h3 id="list-deployments-responseschema">Response Schema</h3>
<p>Status Code <strong>200</strong></p>
<table>
<thead>
@@ -2834,7 +2625,7 @@ curl -X GET https://dcae-dashboard:8080/ccsdk-app/nb-api/deployments?pageNum=str
<aside class="success">
This operation does not require authentication
</aside>
-<h2 id="initiate-a-deployment--install--operation-for-an-application-or-service">Initiate a deployment (install) operation for an application or service</h2>
+<h2 id="create-deployment">Create Deployment</h2>
<p><a id="opIdCreate Deployment"></a></p>
<blockquote>
<p>Code samples</p>
@@ -2845,7 +2636,7 @@ headers = {
<span class="hljs-string">'Accept'</span>: <span class="hljs-string">'application/json'</span>
}
-r = requests.post(<span class="hljs-string">'https://dcae-dashboard:8080/ccsdk-app/nb-api/deployments'</span>, params={
+r = requests.post(<span class="hljs-string">'https://dcae-dashboard:8080/ccsdk-app/nb-api/v2/deployments'</span>, params={
}, headers = headers)
@@ -2853,12 +2644,13 @@ r = requests.post(<span class="hljs-string">'https://dcae-dashboard:8080/ccsdk-a
</code></pre>
<pre class="highlight tab tab-shell"><code><span class="hljs-comment"># You can also use wget</span>
-curl -X POST https://dcae-dashboard:8080/ccsdk-app/nb-api/deployments \
+curl -X POST https://dcae-dashboard:8080/ccsdk-app/nb-api/v2/deployments \
-H <span class="hljs-string">'Content-Type: application/json'</span> \
-H <span class="hljs-string">'Accept: application/json'</span>
</code></pre>
<p><code>POST /deployments</code></p>
+<p><em>Initiate a deployment (install) operation for an application or service</em></p>
<p>Controller sends the blueprint and required inputs to Deployment Handler microservice to initiate the deployment process</p>
<blockquote>
<p>Body parameter</p>
@@ -2873,7 +2665,7 @@ curl -X POST https://dcae-dashboard:8080/ccsdk-app/nb-api/deployments \
<span class="hljs-attr">"inputs"</span>: {}
}
</code></pre>
-<h3 id="initiate-a-deployment--install--operation-for-an-application-or-service-parameters">Parameters</h3>
+<h3 id="create-deployment-parameters">Parameters</h3>
<table>
<thead>
<tr>
@@ -2909,7 +2701,7 @@ curl -X POST https://dcae-dashboard:8080/ccsdk-app/nb-api/deployments \
}
}
</code></pre>
-<h3 id="initiate-a-deployment--install--operation-for-an-application-or-service-responses">Responses</h3>
+<h3 id="create-deployment-responses">Responses</h3>
<table>
<thead>
<tr>
@@ -2937,7 +2729,7 @@ curl -X POST https://dcae-dashboard:8080/ccsdk-app/nb-api/deployments \
<aside class="success">
This operation does not require authentication
</aside>
-<h2 id="initiate-an-uninstall-operation-for-an-application-or-service">Initiate an uninstall operation for an application or service</h2>
+<h2 id="delete-deployment">Delete Deployment</h2>
<p><a id="opIdDelete Deployment"></a></p>
<blockquote>
<p>Code samples</p>
@@ -2947,7 +2739,7 @@ headers = {
<span class="hljs-string">'Accept'</span>: <span class="hljs-string">'application/json'</span>
}
-r = requests.delete(<span class="hljs-string">'https://dcae-dashboard:8080/ccsdk-app/nb-api/deployments/{deploymentId}'</span>, params={
+r = requests.delete(<span class="hljs-string">'https://dcae-dashboard:8080/ccsdk-app/nb-api/v2/deployments/{deploymentId}'</span>, params={
<span class="hljs-string">'tenant'</span>: <span class="hljs-string">'string'</span>
}, headers = headers)
@@ -2955,13 +2747,14 @@ r = requests.delete(<span class="hljs-string">'https://dcae-dashboard:8080/ccsdk
</code></pre>
<pre class="highlight tab tab-shell"><code><span class="hljs-comment"># You can also use wget</span>
-curl -X DELETE https://dcae-dashboard:8080/ccsdk-app/nb-api/deployments/{deploymentId}?tenant=string \
+curl -X DELETE https://dcae-dashboard:8080/ccsdk-app/nb-api/v2/deployments/{deploymentId}?tenant=string \
-H <span class="hljs-string">'Accept: application/json'</span>
</code></pre>
<p><code>DELETE /deployments/{deploymentId}</code></p>
+<p><em>Initiate an uninstall operation for an application or service</em></p>
<p>Controller sends the deployment reference to Deployment Handler microservice to initiate the uninstall process</p>
-<h3 id="initiate-an-uninstall-operation-for-an-application-or-service-parameters">Parameters</h3>
+<h3 id="delete-deployment-parameters">Parameters</h3>
<table>
<thead>
<tr>
@@ -2997,7 +2790,7 @@ curl -X DELETE https://dcae-dashboard:8080/ccsdk-app/nb-api/deployments/{deploym
</blockquote>
<pre class="highlight tab tab-json"><code><span class="hljs-string">"string"</span>
</code></pre>
-<h3 id="initiate-an-uninstall-operation-for-an-application-or-service-responses">Responses</h3>
+<h3 id="delete-deployment-responses">Responses</h3>
<table>
<thead>
<tr>
@@ -3025,7 +2818,7 @@ curl -X DELETE https://dcae-dashboard:8080/ccsdk-app/nb-api/deployments/{deploym
<aside class="success">
This operation does not require authentication
</aside>
-<h2 id="upgrade-or-rollback-an-existing-deployment-using-cloudify-helm-plugin">Upgrade or Rollback an existing deployment using Cloudify Helm plugin</h2>
+<h2 id="upgrade_rollback-deployment">Upgrade_Rollback Deployment</h2>
<p><a id="opIdUpgrade/Rollback Deployment"></a></p>
<blockquote>
<p>Code samples</p>
@@ -3035,7 +2828,7 @@ headers = {
<span class="hljs-string">'Content-Type'</span>: <span class="hljs-string">'application/json'</span>
}
-r = requests.put(<span class="hljs-string">'https://dcae-dashboard:8080/ccsdk-app/nb-api/deployments/{deploymentId}'</span>, params={
+r = requests.put(<span class="hljs-string">'https://dcae-dashboard:8080/ccsdk-app/nb-api/v2/deployments/{deploymentId}'</span>, params={
}, headers = headers)
@@ -3043,11 +2836,12 @@ r = requests.put(<span class="hljs-string">'https://dcae-dashboard:8080/ccsdk-ap
</code></pre>
<pre class="highlight tab tab-shell"><code><span class="hljs-comment"># You can also use wget</span>
-curl -X PUT https://dcae-dashboard:8080/ccsdk-app/nb-api/deployments/{deploymentId} \
+curl -X PUT https://dcae-dashboard:8080/ccsdk-app/nb-api/v2/deployments/{deploymentId} \
-H <span class="hljs-string">'Content-Type: application/json'</span>
</code></pre>
<p><code>PUT /deployments/{deploymentId}</code></p>
+<p><em>Upgrade or Rollback an existing deployment using Cloudify Helm plugin</em></p>
<p>Upgrade or Rollback an existing deployment using Cloudify Helm plugin</p>
<blockquote>
<p>Body parameter</p>
@@ -3061,7 +2855,7 @@ curl -X PUT https://dcae-dashboard:8080/ccsdk-app/nb-api/deployments/{deployment
<span class="hljs-attr">"workflow"</span>: <span class="hljs-string">"string"</span>
}
</code></pre>
-<h3 id="upgrade-or-rollback-an-existing-deployment-using-cloudify-helm-plugin-parameters">Parameters</h3>
+<h3 id="upgrade_rollback-deployment-parameters">Parameters</h3>
<table>
<thead>
<tr>
@@ -3089,7 +2883,7 @@ curl -X PUT https://dcae-dashboard:8080/ccsdk-app/nb-api/deployments/{deployment
</tr>
</tbody>
</table>
-<h3 id="upgrade-or-rollback-an-existing-deployment-using-cloudify-helm-plugin-responses">Responses</h3>
+<h3 id="upgrade_rollback-deployment-responses">Responses</h3>
<table>
<thead>
<tr>
@@ -3123,7 +2917,7 @@ curl -X PUT https://dcae-dashboard:8080/ccsdk-app/nb-api/deployments/{deployment
<aside class="success">
This operation does not require authentication
</aside>
-<h2 id="gets-a-deployment">Gets a Deployment</h2>
+<h2 id="get-deployment">Get Deployment</h2>
<p><a id="opIdGet Deployment"></a></p>
<blockquote>
<p>Code samples</p>
@@ -3133,7 +2927,7 @@ headers = {
<span class="hljs-string">'Accept'</span>: <span class="hljs-string">'application/json'</span>
}
-r = requests.get(<span class="hljs-string">'https://dcae-dashboard:8080/ccsdk-app/nb-api/deployments/{deploymentId}'</span>, params={
+r = requests.get(<span class="hljs-string">'https://dcae-dashboard:8080/ccsdk-app/nb-api/v2/deployments/{deploymentId}'</span>, params={
}, headers = headers)
@@ -3141,13 +2935,14 @@ r = requests.get(<span class="hljs-string">'https://dcae-dashboard:8080/ccsdk-ap
</code></pre>
<pre class="highlight tab tab-shell"><code><span class="hljs-comment"># You can also use wget</span>
-curl -X GET https://dcae-dashboard:8080/ccsdk-app/nb-api/deployments/{deploymentId} \
+curl -X GET https://dcae-dashboard:8080/ccsdk-app/nb-api/v2/deployments/{deploymentId} \
-H <span class="hljs-string">'Accept: application/json'</span>
</code></pre>
<p><code>GET /deployments/{deploymentId}</code></p>
+<p><em>Get a Deployment</em></p>
<p>Query a deployment or Service object from Inventory</p>
-<h3 id="gets-a-deployment-parameters">Parameters</h3>
+<h3 id="get-deployment-parameters">Parameters</h3>
<table>
<thead>
<tr>
@@ -3191,8 +2986,8 @@ curl -X GET https://dcae-dashboard:8080/ccsdk-app/nb-api/deployments/{deployment
},
<span class="hljs-attr">"type"</span>: <span class="hljs-string">"string"</span>
},
- <span class="hljs-attr">"created"</span>: <span class="hljs-string">"2020-02-05T21:21:26Z"</span>,
- <span class="hljs-attr">"modified"</span>: <span class="hljs-string">"2020-02-05T21:21:26Z"</span>,
+ <span class="hljs-attr">"created"</span>: <span class="hljs-string">"2020-08-12T15:08:29Z"</span>,
+ <span class="hljs-attr">"modified"</span>: <span class="hljs-string">"2020-08-12T15:08:29Z"</span>,
<span class="hljs-attr">"typeLink"</span>: {
<span class="hljs-attr">"title"</span>: <span class="hljs-string">"string"</span>,
<span class="hljs-attr">"rel"</span>: <span class="hljs-string">"string"</span>,
@@ -3242,8 +3037,8 @@ curl -X GET https://dcae-dashboard:8080/ccsdk-app/nb-api/deployments/{deployment
},
<span class="hljs-attr">"type"</span>: <span class="hljs-string">"string"</span>
},
- <span class="hljs-attr">"created"</span>: <span class="hljs-string">"2020-02-05T21:21:26Z"</span>,
- <span class="hljs-attr">"modified"</span>: <span class="hljs-string">"2020-02-05T21:21:26Z"</span>,
+ <span class="hljs-attr">"created"</span>: <span class="hljs-string">"2020-08-12T15:08:29Z"</span>,
+ <span class="hljs-attr">"modified"</span>: <span class="hljs-string">"2020-08-12T15:08:29Z"</span>,
<span class="hljs-attr">"componentType"</span>: <span class="hljs-string">"string"</span>,
<span class="hljs-attr">"componentSource"</span>: <span class="hljs-string">"DCAEController"</span>,
<span class="hljs-attr">"status"</span>: <span class="hljs-string">"string"</span>,
@@ -3255,7 +3050,7 @@ curl -X GET https://dcae-dashboard:8080/ccsdk-app/nb-api/deployments/{deployment
}
]
</code></pre>
-<h3 id="gets-a-deployment-responses">Responses</h3>
+<h3 id="get-deployment-responses">Responses</h3>
<table>
<thead>
<tr>
@@ -3280,7 +3075,7 @@ curl -X GET https://dcae-dashboard:8080/ccsdk-app/nb-api/deployments/{deployment
</tr>
</tbody>
</table>
-<h3 id="gets-a-deployment-responseschema">Response Schema</h3>
+<h3 id="get-deployment-responseschema">Response Schema</h3>
<p>Status Code <strong>200</strong></p>
<table>
<thead>
@@ -3527,106 +3322,7 @@ curl -X GET https://dcae-dashboard:8080/ccsdk-app/nb-api/deployments/{deployment
<aside class="success">
This operation does not require authentication
</aside>
-<h2 id="update-an-existing-deployment">Update an existing deployment</h2>
-<p><a id="opIdUpdate Deployment"></a></p>
-<blockquote>
-<p>Code samples</p>
-</blockquote>
-<pre class="highlight tab tab-python"><code><span class="hljs-keyword">import</span> requests
-headers = {
- <span class="hljs-string">'Content-Type'</span>: <span class="hljs-string">'application/json'</span>
-}
-
-r = requests.put(<span class="hljs-string">'https://dcae-dashboard:8080/ccsdk-app/nb-api/deployments/{deploymentId}/update'</span>, params={
-
-}, headers = headers)
-
-<span class="hljs-keyword">print</span> r.json()
-
-</code></pre>
-<pre class="highlight tab tab-shell"><code><span class="hljs-comment"># You can also use wget</span>
-curl -X PUT https://dcae-dashboard:8080/ccsdk-app/nb-api/deployments/{deploymentId}/update \
- -H <span class="hljs-string">'Content-Type: application/json'</span>
-
-</code></pre>
-<p><code>PUT /deployments/{deploymentId}/update</code></p>
-<p>Dispatch a request to Deployment handler mS to use Cloudify deployment update operation</p>
-<blockquote>
-<p>Body parameter</p>
-</blockquote>
-<pre class="highlight tab tab-json"><code>{
- <span class="hljs-attr">"component"</span>: <span class="hljs-string">"string"</span>,
- <span class="hljs-attr">"tag"</span>: <span class="hljs-string">"string"</span>,
- <span class="hljs-attr">"blueprintId"</span>: <span class="hljs-string">"string"</span>,
- <span class="hljs-attr">"blueprintName"</span>: <span class="hljs-string">"string"</span>,
- <span class="hljs-attr">"blueprintVersion"</span>: <span class="hljs-number">0</span>,
- <span class="hljs-attr">"tenant"</span>: <span class="hljs-string">"string"</span>,
- <span class="hljs-attr">"inputs"</span>: {}
-}
-</code></pre>
-<h3 id="update-an-existing-deployment-parameters">Parameters</h3>
-<table>
-<thead>
-<tr>
-<th>Name</th>
-<th>In</th>
-<th>Type</th>
-<th>Required</th>
-<th>Description</th>
-</tr>
-</thead>
-<tbody>
-<tr>
-<td>deploymentId</td>
-<td>path</td>
-<td>string</td>
-<td>true</td>
-<td>ID of deployment to update</td>
-</tr>
-<tr>
-<td>body</td>
-<td>body</td>
-<td><a href="#schemadeploymentinput">DeploymentInput</a></td>
-<td>true</td>
-<td>Inputs to initiate a deployment: blueprint ID from inventory, Cloudify tenant name, blueprint inputs</td>
-</tr>
-</tbody>
-</table>
-<h3 id="update-an-existing-deployment-responses">Responses</h3>
-<table>
-<thead>
-<tr>
-<th>Status</th>
-<th>Meaning</th>
-<th>Description</th>
-<th>Schema</th>
-</tr>
-</thead>
-<tbody>
-<tr>
-<td>400</td>
-<td><a href="https://tools.ietf.org/html/rfc7231#section-6.5.1">Bad Request</a></td>
-<td>Invalid ID supplied</td>
-<td>None</td>
-</tr>
-<tr>
-<td>404</td>
-<td><a href="https://tools.ietf.org/html/rfc7231#section-6.5.4">Not Found</a></td>
-<td>Deployment not found</td>
-<td>None</td>
-</tr>
-<tr>
-<td>405</td>
-<td><a href="https://tools.ietf.org/html/rfc7231#section-6.5.5">Method Not Allowed</a></td>
-<td>Validation exception</td>
-<td>None</td>
-</tr>
-</tbody>
-</table>
-<aside class="success">
-This operation does not require authentication
-</aside>
-<h2 id="deployment-execution-status">Deployment execution status</h2>
+<h2 id="deployment-status">Deployment Status</h2>
<p><a id="opIdDeployment Status"></a></p>
<blockquote>
<p>Code samples</p>
@@ -3636,7 +3332,7 @@ headers = {
<span class="hljs-string">'Accept'</span>: <span class="hljs-string">'application/json'</span>
}
-r = requests.get(<span class="hljs-string">'https://dcae-dashboard:8080/ccsdk-app/nb-api/deployments/{deploymentId}/executions'</span>, params={
+r = requests.get(<span class="hljs-string">'https://dcae-dashboard:8080/ccsdk-app/nb-api/v2/deployments/{deploymentId}/executions'</span>, params={
<span class="hljs-string">'tenant'</span>: <span class="hljs-string">'string'</span>
}, headers = headers)
@@ -3644,13 +3340,14 @@ r = requests.get(<span class="hljs-string">'https://dcae-dashboard:8080/ccsdk-ap
</code></pre>
<pre class="highlight tab tab-shell"><code><span class="hljs-comment"># You can also use wget</span>
-curl -X GET https://dcae-dashboard:8080/ccsdk-app/nb-api/deployments/{deploymentId}/executions?tenant=string \
+curl -X GET https://dcae-dashboard:8080/ccsdk-app/nb-api/v2/deployments/{deploymentId}/executions?tenant=string \
-H <span class="hljs-string">'Accept: application/json'</span>
</code></pre>
<p><code>GET /deployments/{deploymentId}/executions</code></p>
+<p><em>Deployment execution status</em></p>
<p>Query deployment workflow execution status</p>
-<h3 id="deployment-execution-status-parameters">Parameters</h3>
+<h3 id="deployment-status-parameters">Parameters</h3>
<table>
<thead>
<tr>
@@ -3695,7 +3392,7 @@ curl -X GET https://dcae-dashboard:8080/ccsdk-app/nb-api/deployments/{deployment
}
]
</code></pre>
-<h3 id="deployment-execution-status-responses">Responses</h3>
+<h3 id="deployment-status-responses">Responses</h3>
<table>
<thead>
<tr>
@@ -3720,7 +3417,7 @@ curl -X GET https://dcae-dashboard:8080/ccsdk-app/nb-api/deployments/{deployment
</tr>
</tbody>
</table>
-<h3 id="deployment-execution-status-responseschema">Response Schema</h3>
+<h3 id="deployment-status-responseschema">Response Schema</h3>
<p>Status Code <strong>200</strong></p>
<table>
<thead>
@@ -3787,7 +3484,7 @@ curl -X GET https://dcae-dashboard:8080/ccsdk-app/nb-api/deployments/{deployment
<aside class="success">
This operation does not require authentication
</aside>
-<h2 id="deployment-health-status">Deployment health status</h2>
+<h2 id="deployment-health">Deployment health</h2>
<p><a id="opIdDeployment health"></a></p>
<blockquote>
<p>Code samples</p>
@@ -3797,7 +3494,7 @@ headers = {
<span class="hljs-string">'Accept'</span>: <span class="hljs-string">'application/json'</span>
}
-r = requests.get(<span class="hljs-string">'https://dcae-dashboard:8080/ccsdk-app/nb-api/deployments/{deploymentId}/health'</span>, params={
+r = requests.get(<span class="hljs-string">'https://dcae-dashboard:8080/ccsdk-app/nb-api/v2/deployments/{deploymentId}/health'</span>, params={
}, headers = headers)
@@ -3805,13 +3502,14 @@ r = requests.get(<span class="hljs-string">'https://dcae-dashboard:8080/ccsdk-ap
</code></pre>
<pre class="highlight tab tab-shell"><code><span class="hljs-comment"># You can also use wget</span>
-curl -X GET https://dcae-dashboard:8080/ccsdk-app/nb-api/deployments/{deploymentId}/health \
+curl -X GET https://dcae-dashboard:8080/ccsdk-app/nb-api/v2/deployments/{deploymentId}/health \
-H <span class="hljs-string">'Accept: application/json'</span>
</code></pre>
<p><code>GET /deployments/{deploymentId}/health</code></p>
+<p><em>Deployment health status</em></p>
<p>Query consul for service health using deployment ID filter</p>
-<h3 id="deployment-health-status-parameters">Parameters</h3>
+<h3 id="deployment-health-parameters">Parameters</h3>
<table>
<thead>
<tr>
@@ -3847,7 +3545,7 @@ curl -X GET https://dcae-dashboard:8080/ccsdk-app/nb-api/deployments/{deployment
<span class="hljs-attr">"serviceName"</span>: <span class="hljs-string">"string"</span>
}
</code></pre>
-<h3 id="deployment-health-status-responses">Responses</h3>
+<h3 id="deployment-health-responses">Responses</h3>
<table>
<thead>
<tr>
@@ -3869,7 +3567,7 @@ curl -X GET https://dcae-dashboard:8080/ccsdk-app/nb-api/deployments/{deployment
<aside class="success">
This operation does not require authentication
</aside>
-<h2 id="deployment-inputs">Deployment inputs</h2>
+<h2 id="deployment-inputs">Deployment Inputs</h2>
<p><a id="opIdDeployment Inputs"></a></p>
<blockquote>
<p>Code samples</p>
@@ -3879,7 +3577,7 @@ headers = {
<span class="hljs-string">'Accept'</span>: <span class="hljs-string">'application/json'</span>
}
-r = requests.get(<span class="hljs-string">'https://dcae-dashboard:8080/ccsdk-app/nb-api/deployments/{deploymentId}/inputs'</span>, params={
+r = requests.get(<span class="hljs-string">'https://dcae-dashboard:8080/ccsdk-app/nb-api/v2/deployments/{deploymentId}/inputs'</span>, params={
<span class="hljs-string">'tenant'</span>: <span class="hljs-string">'string'</span>
}, headers = headers)
@@ -3887,11 +3585,12 @@ r = requests.get(<span class="hljs-string">'https://dcae-dashboard:8080/ccsdk-ap
</code></pre>
<pre class="highlight tab tab-shell"><code><span class="hljs-comment"># You can also use wget</span>
-curl -X GET https://dcae-dashboard:8080/ccsdk-app/nb-api/deployments/{deploymentId}/inputs?tenant=string \
+curl -X GET https://dcae-dashboard:8080/ccsdk-app/nb-api/v2/deployments/{deploymentId}/inputs?tenant=string \
-H <span class="hljs-string">'Accept: application/json'</span>
</code></pre>
<p><code>GET /deployments/{deploymentId}/inputs</code></p>
+<p><em>Deployment inputs</em></p>
<p>Get blueprint inputs used to create deployment</p>
<h3 id="deployment-inputs-parameters">Parameters</h3>
<table>
@@ -3960,7 +3659,7 @@ This operation does not require authentication
</aside>
<h1 id="dcae-dashboard-api-tenants">Tenants</h1>
<p>Query Cloudify Tenants</p>
-<h2 id="lists-all-cloudify-tenants">Lists all Cloudify Tenants</h2>
+<h2 id="list-tenants">List Tenants</h2>
<p><a id="opIdList Tenants"></a></p>
<blockquote>
<p>Code samples</p>
@@ -3970,7 +3669,7 @@ headers = {
<span class="hljs-string">'Accept'</span>: <span class="hljs-string">'application/json'</span>
}
-r = requests.get(<span class="hljs-string">'https://dcae-dashboard:8080/ccsdk-app/nb-api/tenants'</span>, params={
+r = requests.get(<span class="hljs-string">'https://dcae-dashboard:8080/ccsdk-app/nb-api/v2/tenants'</span>, params={
}, headers = headers)
@@ -3978,11 +3677,12 @@ r = requests.get(<span class="hljs-string">'https://dcae-dashboard:8080/ccsdk-ap
</code></pre>
<pre class="highlight tab tab-shell"><code><span class="hljs-comment"># You can also use wget</span>
-curl -X GET https://dcae-dashboard:8080/ccsdk-app/nb-api/tenants \
+curl -X GET https://dcae-dashboard:8080/ccsdk-app/nb-api/v2/tenants \
-H <span class="hljs-string">'Accept: application/json'</span>
</code></pre>
<p><code>GET /tenants</code></p>
+<p><em>Lists all Cloudify Tenants</em></p>
<p>Query all Tenant names from Cloudify</p>
<blockquote>
<p>Example responses</p>
@@ -3996,7 +3696,7 @@ curl -X GET https://dcae-dashboard:8080/ccsdk-app/nb-api/tenants \
}
]
</code></pre>
-<h3 id="lists-all-cloudify-tenants-responses">Responses</h3>
+<h3 id="list-tenants-responses">Responses</h3>
<table>
<thead>
<tr>
@@ -4021,7 +3721,7 @@ curl -X GET https://dcae-dashboard:8080/ccsdk-app/nb-api/tenants \
</tr>
</tbody>
</table>
-<h3 id="lists-all-cloudify-tenants-responseschema">Response Schema</h3>
+<h3 id="list-tenants-responseschema">Response Schema</h3>
<p>Status Code <strong>200</strong></p>
<table>
<thead>
@@ -4053,207 +3753,6 @@ curl -X GET https://dcae-dashboard:8080/ccsdk-app/nb-api/tenants \
<aside class="success">
This operation does not require authentication
</aside>
-<h1 id="dcae-dashboard-api-components">Components</h1>
-<p>Query on-boarded components</p>
-<h2 id="lists-all-application-components">Lists all application components</h2>
-<p><a id="opIdList Components"></a></p>
-<blockquote>
-<p>Code samples</p>
-</blockquote>
-<pre class="highlight tab tab-python"><code><span class="hljs-keyword">import</span> requests
-headers = {
- <span class="hljs-string">'Accept'</span>: <span class="hljs-string">'application/json'</span>
-}
-
-r = requests.get(<span class="hljs-string">'https://dcae-dashboard:8080/ccsdk-app/nb-api/components'</span>, params={
-
-}, headers = headers)
-
-<span class="hljs-keyword">print</span> r.json()
-
-</code></pre>
-<pre class="highlight tab tab-shell"><code><span class="hljs-comment"># You can also use wget</span>
-curl -X GET https://dcae-dashboard:8080/ccsdk-app/nb-api/components \
- -H <span class="hljs-string">'Accept: application/json'</span>
-
-</code></pre>
-<p><code>GET /components</code></p>
-<p>Query all components from database</p>
-<blockquote>
-<p>Example responses</p>
-</blockquote>
-<blockquote>
-<p>200 Response</p>
-</blockquote>
-<pre class="highlight tab tab-json"><code>[
- {
- <span class="hljs-attr">"compId"</span>: <span class="hljs-number">0</span>,
- <span class="hljs-attr">"cname"</span>: <span class="hljs-string">"string"</span>,
- <span class="hljs-attr">"dname"</span>: <span class="hljs-string">"string"</span>
- }
-]
-</code></pre>
-<h3 id="lists-all-application-components-responses">Responses</h3>
-<table>
-<thead>
-<tr>
-<th>Status</th>
-<th>Meaning</th>
-<th>Description</th>
-<th>Schema</th>
-</tr>
-</thead>
-<tbody>
-<tr>
-<td>200</td>
-<td><a href="https://tools.ietf.org/html/rfc7231#section-6.3.1">OK</a></td>
-<td>successful operation</td>
-<td>Inline</td>
-</tr>
-<tr>
-<td>400</td>
-<td><a href="https://tools.ietf.org/html/rfc7231#section-6.5.1">Bad Request</a></td>
-<td>Invalid status value</td>
-<td>None</td>
-</tr>
-</tbody>
-</table>
-<h3 id="lists-all-application-components-responseschema">Response Schema</h3>
-<p>Status Code <strong>200</strong></p>
-<table>
-<thead>
-<tr>
-<th>Name</th>
-<th>Type</th>
-<th>Required</th>
-<th>Restrictions</th>
-<th>Description</th>
-</tr>
-</thead>
-<tbody>
-<tr>
-<td><em>anonymous</em></td>
-<td>[<a href="#schemacomponent">Component</a>]</td>
-<td>false</td>
-<td>none</td>
-<td>none</td>
-</tr>
-<tr>
-<td>» compId</td>
-<td>integer</td>
-<td>false</td>
-<td>none</td>
-<td>none</td>
-</tr>
-<tr>
-<td>» cname</td>
-<td>string</td>
-<td>false</td>
-<td>none</td>
-<td>component namespace name</td>
-</tr>
-<tr>
-<td>» dname</td>
-<td>string</td>
-<td>false</td>
-<td>none</td>
-<td>component display name</td>
-</tr>
-</tbody>
-</table>
-<aside class="success">
-This operation does not require authentication
-</aside>
-<h2 id="add-an-application-component">add an application component</h2>
-<p><a id="opIdAdd Component"></a></p>
-<blockquote>
-<p>Code samples</p>
-</blockquote>
-<pre class="highlight tab tab-python"><code><span class="hljs-keyword">import</span> requests
-headers = {
- <span class="hljs-string">'Content-Type'</span>: <span class="hljs-string">'application/json'</span>,
- <span class="hljs-string">'Accept'</span>: <span class="hljs-string">'*/*'</span>
-}
-
-r = requests.post(<span class="hljs-string">'https://dcae-dashboard:8080/ccsdk-app/nb-api/components'</span>, params={
-
-}, headers = headers)
-
-<span class="hljs-keyword">print</span> r.json()
-
-</code></pre>
-<pre class="highlight tab tab-shell"><code><span class="hljs-comment"># You can also use wget</span>
-curl -X POST https://dcae-dashboard:8080/ccsdk-app/nb-api/components \
- -H <span class="hljs-string">'Content-Type: application/json'</span> \
- -H <span class="hljs-string">'Accept: */*'</span>
-
-</code></pre>
-<p><code>POST /components</code></p>
-<p>Insert a component into database</p>
-<blockquote>
-<p>Body parameter</p>
-</blockquote>
-<pre class="highlight tab tab-json"><code>{
- <span class="hljs-attr">"cname"</span>: <span class="hljs-string">"string"</span>,
- <span class="hljs-attr">"dname"</span>: <span class="hljs-string">"string"</span>
-}
-</code></pre>
-<h3 id="add-an-application-component-parameters">Parameters</h3>
-<table>
-<thead>
-<tr>
-<th>Name</th>
-<th>In</th>
-<th>Type</th>
-<th>Required</th>
-<th>Description</th>
-</tr>
-</thead>
-<tbody>
-<tr>
-<td>body</td>
-<td>body</td>
-<td><a href="#schemacomponentinput">ComponentInput</a></td>
-<td>true</td>
-<td>New component input</td>
-</tr>
-</tbody>
-</table>
-<blockquote>
-<p>Example responses</p>
-</blockquote>
-<blockquote>
-<p>200 Response</p>
-</blockquote>
-<h3 id="add-an-application-component-responses">Responses</h3>
-<table>
-<thead>
-<tr>
-<th>Status</th>
-<th>Meaning</th>
-<th>Description</th>
-<th>Schema</th>
-</tr>
-</thead>
-<tbody>
-<tr>
-<td>200</td>
-<td><a href="https://tools.ietf.org/html/rfc7231#section-6.3.1">OK</a></td>
-<td>successful operation</td>
-<td>Inline</td>
-</tr>
-<tr>
-<td>400</td>
-<td><a href="https://tools.ietf.org/html/rfc7231#section-6.5.1">Bad Request</a></td>
-<td>Invalid status value</td>
-<td>None</td>
-</tr>
-</tbody>
-</table>
-<h3 id="add-an-application-component-responseschema">Response Schema</h3>
-<aside class="success">
-This operation does not require authentication
-</aside>
<h1 id="schemas">Schemas</h1>
<h2 id="tocstenant">Tenant</h2>
<p><a id="schematenant"></a></p>
@@ -4283,50 +3782,6 @@ This operation does not require authentication
</tr>
</tbody>
</table>
-<h2 id="tocscomponent">Component</h2>
-<p><a id="schemacomponent"></a></p>
-<pre class="highlight tab tab-json"><code>{
- <span class="hljs-attr">"compId"</span>: <span class="hljs-number">0</span>,
- <span class="hljs-attr">"cname"</span>: <span class="hljs-string">"string"</span>,
- <span class="hljs-attr">"dname"</span>: <span class="hljs-string">"string"</span>
-}
-
-</code></pre>
-<h3 id="properties">Properties</h3>
-<table>
-<thead>
-<tr>
-<th>Name</th>
-<th>Type</th>
-<th>Required</th>
-<th>Restrictions</th>
-<th>Description</th>
-</tr>
-</thead>
-<tbody>
-<tr>
-<td>compId</td>
-<td>integer</td>
-<td>false</td>
-<td>none</td>
-<td>none</td>
-</tr>
-<tr>
-<td>cname</td>
-<td>string</td>
-<td>false</td>
-<td>none</td>
-<td>component namespace name</td>
-</tr>
-<tr>
-<td>dname</td>
-<td>string</td>
-<td>false</td>
-<td>none</td>
-<td>component display name</td>
-</tr>
-</tbody>
-</table>
<h2 id="tocscomponentinput">ComponentInput</h2>
<p><a id="schemacomponentinput"></a></p>
<pre class="highlight tab tab-json"><code>{
@@ -4430,8 +3885,8 @@ This operation does not require authentication
},
<span class="hljs-attr">"type"</span>: <span class="hljs-string">"string"</span>
},
- <span class="hljs-attr">"created"</span>: <span class="hljs-string">"2020-02-05T21:21:26Z"</span>,
- <span class="hljs-attr">"deactivated"</span>: <span class="hljs-string">"2020-02-05T21:21:26Z"</span>
+ <span class="hljs-attr">"created"</span>: <span class="hljs-string">"2020-08-12T15:08:29Z"</span>,
+ <span class="hljs-attr">"deactivated"</span>: <span class="hljs-string">"2020-08-12T15:08:29Z"</span>
}
]
}
@@ -4597,8 +4052,8 @@ This operation does not require authentication
},
<span class="hljs-attr">"type"</span>: <span class="hljs-string">"string"</span>
},
- <span class="hljs-attr">"created"</span>: <span class="hljs-string">"2020-02-05T21:21:26Z"</span>,
- <span class="hljs-attr">"modified"</span>: <span class="hljs-string">"2020-02-05T21:21:26Z"</span>,
+ <span class="hljs-attr">"created"</span>: <span class="hljs-string">"2020-08-12T15:08:29Z"</span>,
+ <span class="hljs-attr">"modified"</span>: <span class="hljs-string">"2020-08-12T15:08:29Z"</span>,
<span class="hljs-attr">"typeLink"</span>: {
<span class="hljs-attr">"title"</span>: <span class="hljs-string">"string"</span>,
<span class="hljs-attr">"rel"</span>: <span class="hljs-string">"string"</span>,
@@ -4648,8 +4103,8 @@ This operation does not require authentication
},
<span class="hljs-attr">"type"</span>: <span class="hljs-string">"string"</span>
},
- <span class="hljs-attr">"created"</span>: <span class="hljs-string">"2020-02-05T21:21:26Z"</span>,
- <span class="hljs-attr">"modified"</span>: <span class="hljs-string">"2020-02-05T21:21:26Z"</span>,
+ <span class="hljs-attr">"created"</span>: <span class="hljs-string">"2020-08-12T15:08:29Z"</span>,
+ <span class="hljs-attr">"modified"</span>: <span class="hljs-string">"2020-08-12T15:08:29Z"</span>,
<span class="hljs-attr">"componentType"</span>: <span class="hljs-string">"string"</span>,
<span class="hljs-attr">"componentSource"</span>: <span class="hljs-string">"DCAEController"</span>,
<span class="hljs-attr">"status"</span>: <span class="hljs-string">"string"</span>,
@@ -4810,8 +4265,8 @@ This operation does not require authentication
},
<span class="hljs-attr">"type"</span>: <span class="hljs-string">"string"</span>
},
- <span class="hljs-attr">"created"</span>: <span class="hljs-string">"2020-02-05T21:21:26Z"</span>,
- <span class="hljs-attr">"modified"</span>: <span class="hljs-string">"2020-02-05T21:21:26Z"</span>,
+ <span class="hljs-attr">"created"</span>: <span class="hljs-string">"2020-08-12T15:08:29Z"</span>,
+ <span class="hljs-attr">"modified"</span>: <span class="hljs-string">"2020-08-12T15:08:29Z"</span>,
<span class="hljs-attr">"typeLink"</span>: {
<span class="hljs-attr">"title"</span>: <span class="hljs-string">"string"</span>,
<span class="hljs-attr">"rel"</span>: <span class="hljs-string">"string"</span>,
@@ -4861,8 +4316,8 @@ This operation does not require authentication
},
<span class="hljs-attr">"type"</span>: <span class="hljs-string">"string"</span>
},
- <span class="hljs-attr">"created"</span>: <span class="hljs-string">"2020-02-05T21:21:26Z"</span>,
- <span class="hljs-attr">"modified"</span>: <span class="hljs-string">"2020-02-05T21:21:26Z"</span>,
+ <span class="hljs-attr">"created"</span>: <span class="hljs-string">"2020-08-12T15:08:29Z"</span>,
+ <span class="hljs-attr">"modified"</span>: <span class="hljs-string">"2020-08-12T15:08:29Z"</span>,
<span class="hljs-attr">"componentType"</span>: <span class="hljs-string">"string"</span>,
<span class="hljs-attr">"componentSource"</span>: <span class="hljs-string">"DCAEController"</span>,
<span class="hljs-attr">"status"</span>: <span class="hljs-string">"string"</span>,
@@ -5024,8 +4479,8 @@ This operation does not require authentication
},
<span class="hljs-attr">"type"</span>: <span class="hljs-string">"string"</span>
},
- <span class="hljs-attr">"created"</span>: <span class="hljs-string">"2020-02-05T21:21:26Z"</span>,
- <span class="hljs-attr">"modified"</span>: <span class="hljs-string">"2020-02-05T21:21:26Z"</span>,
+ <span class="hljs-attr">"created"</span>: <span class="hljs-string">"2020-08-12T15:08:29Z"</span>,
+ <span class="hljs-attr">"modified"</span>: <span class="hljs-string">"2020-08-12T15:08:29Z"</span>,
<span class="hljs-attr">"componentType"</span>: <span class="hljs-string">"string"</span>,
<span class="hljs-attr">"componentSource"</span>: <span class="hljs-string">"DCAEController"</span>,
<span class="hljs-attr">"status"</span>: <span class="hljs-string">"string"</span>,
@@ -5232,8 +4687,8 @@ This operation does not require authentication
},
<span class="hljs-attr">"type"</span>: <span class="hljs-string">"string"</span>
},
- <span class="hljs-attr">"created"</span>: <span class="hljs-string">"2020-02-05T21:21:26Z"</span>,
- <span class="hljs-attr">"deactivated"</span>: <span class="hljs-string">"2020-02-05T21:21:26Z"</span>
+ <span class="hljs-attr">"created"</span>: <span class="hljs-string">"2020-08-12T15:08:29Z"</span>,
+ <span class="hljs-attr">"deactivated"</span>: <span class="hljs-string">"2020-08-12T15:08:29Z"</span>
}
</code></pre>