Author: pzampino
Date: Thu Dec 5 20:08:57 2019
New Revision: 1870890
URL: http://svn.apache.org/viewvc?rev=1870890&view=rev
Log:
Integrated Alias API descriptions into table with other API descriptions
Modified:
knox/site/books/knox-0-12-0/deployment-overview.png
knox/site/books/knox-0-12-0/deployment-provider.png
knox/site/books/knox-0-12-0/deployment-service.png
knox/site/books/knox-0-12-0/general_saml_flow.png
knox/site/books/knox-0-12-0/runtime-overview.png
knox/site/books/knox-0-12-0/runtime-request-processing.png
knox/site/books/knox-0-13-0/deployment-overview.png
knox/site/books/knox-0-13-0/deployment-provider.png
knox/site/books/knox-0-13-0/deployment-service.png
knox/site/books/knox-0-13-0/general_saml_flow.png
knox/site/books/knox-0-13-0/runtime-overview.png
knox/site/books/knox-0-13-0/runtime-request-processing.png
knox/site/books/knox-0-14-0/deployment-overview.png
knox/site/books/knox-0-14-0/deployment-provider.png
knox/site/books/knox-0-14-0/deployment-service.png
knox/site/books/knox-0-14-0/general_saml_flow.png
knox/site/books/knox-0-14-0/runtime-overview.png
knox/site/books/knox-0-14-0/runtime-request-processing.png
knox/site/books/knox-1-0-0/deployment-overview.png
knox/site/books/knox-1-0-0/deployment-provider.png
knox/site/books/knox-1-0-0/deployment-service.png
knox/site/books/knox-1-0-0/general_saml_flow.png
knox/site/books/knox-1-0-0/runtime-overview.png
knox/site/books/knox-1-0-0/runtime-request-processing.png
knox/site/books/knox-1-1-0/deployment-overview.png
knox/site/books/knox-1-1-0/deployment-provider.png
knox/site/books/knox-1-1-0/deployment-service.png
knox/site/books/knox-1-1-0/general_saml_flow.png
knox/site/books/knox-1-1-0/runtime-overview.png
knox/site/books/knox-1-1-0/runtime-request-processing.png
knox/site/books/knox-1-2-0/deployment-overview.png
knox/site/books/knox-1-2-0/deployment-provider.png
knox/site/books/knox-1-2-0/deployment-service.png
knox/site/books/knox-1-2-0/general_saml_flow.png
knox/site/books/knox-1-2-0/runtime-overview.png
knox/site/books/knox-1-2-0/runtime-request-processing.png
knox/site/books/knox-1-3-0/deployment-overview.png
knox/site/books/knox-1-3-0/deployment-provider.png
knox/site/books/knox-1-3-0/deployment-service.png
knox/site/books/knox-1-3-0/general_saml_flow.png
knox/site/books/knox-1-3-0/runtime-overview.png
knox/site/books/knox-1-3-0/runtime-request-processing.png
knox/site/books/knox-1-4-0/deployment-overview.png
knox/site/books/knox-1-4-0/deployment-provider.png
knox/site/books/knox-1-4-0/deployment-service.png
knox/site/books/knox-1-4-0/general_saml_flow.png
knox/site/books/knox-1-4-0/runtime-overview.png
knox/site/books/knox-1-4-0/runtime-request-processing.png
knox/site/books/knox-1-4-0/user-guide.html
knox/trunk/books/1.4.0/admin_api.md
Modified: knox/site/books/knox-0-12-0/deployment-overview.png
URL:
http://svn.apache.org/viewvc/knox/site/books/knox-0-12-0/deployment-overview.png?rev=1870890&r1=1870889&r2=1870890&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-0-12-0/deployment-provider.png
URL:
http://svn.apache.org/viewvc/knox/site/books/knox-0-12-0/deployment-provider.png?rev=1870890&r1=1870889&r2=1870890&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-0-12-0/deployment-service.png
URL:
http://svn.apache.org/viewvc/knox/site/books/knox-0-12-0/deployment-service.png?rev=1870890&r1=1870889&r2=1870890&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-0-12-0/general_saml_flow.png
URL:
http://svn.apache.org/viewvc/knox/site/books/knox-0-12-0/general_saml_flow.png?rev=1870890&r1=1870889&r2=1870890&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-0-12-0/runtime-overview.png
URL:
http://svn.apache.org/viewvc/knox/site/books/knox-0-12-0/runtime-overview.png?rev=1870890&r1=1870889&r2=1870890&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-0-12-0/runtime-request-processing.png
URL:
http://svn.apache.org/viewvc/knox/site/books/knox-0-12-0/runtime-request-processing.png?rev=1870890&r1=1870889&r2=1870890&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-0-13-0/deployment-overview.png
URL:
http://svn.apache.org/viewvc/knox/site/books/knox-0-13-0/deployment-overview.png?rev=1870890&r1=1870889&r2=1870890&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-0-13-0/deployment-provider.png
URL:
http://svn.apache.org/viewvc/knox/site/books/knox-0-13-0/deployment-provider.png?rev=1870890&r1=1870889&r2=1870890&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-0-13-0/deployment-service.png
URL:
http://svn.apache.org/viewvc/knox/site/books/knox-0-13-0/deployment-service.png?rev=1870890&r1=1870889&r2=1870890&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-0-13-0/general_saml_flow.png
URL:
http://svn.apache.org/viewvc/knox/site/books/knox-0-13-0/general_saml_flow.png?rev=1870890&r1=1870889&r2=1870890&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-0-13-0/runtime-overview.png
URL:
http://svn.apache.org/viewvc/knox/site/books/knox-0-13-0/runtime-overview.png?rev=1870890&r1=1870889&r2=1870890&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-0-13-0/runtime-request-processing.png
URL:
http://svn.apache.org/viewvc/knox/site/books/knox-0-13-0/runtime-request-processing.png?rev=1870890&r1=1870889&r2=1870890&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-0-14-0/deployment-overview.png
URL:
http://svn.apache.org/viewvc/knox/site/books/knox-0-14-0/deployment-overview.png?rev=1870890&r1=1870889&r2=1870890&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-0-14-0/deployment-provider.png
URL:
http://svn.apache.org/viewvc/knox/site/books/knox-0-14-0/deployment-provider.png?rev=1870890&r1=1870889&r2=1870890&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-0-14-0/deployment-service.png
URL:
http://svn.apache.org/viewvc/knox/site/books/knox-0-14-0/deployment-service.png?rev=1870890&r1=1870889&r2=1870890&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-0-14-0/general_saml_flow.png
URL:
http://svn.apache.org/viewvc/knox/site/books/knox-0-14-0/general_saml_flow.png?rev=1870890&r1=1870889&r2=1870890&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-0-14-0/runtime-overview.png
URL:
http://svn.apache.org/viewvc/knox/site/books/knox-0-14-0/runtime-overview.png?rev=1870890&r1=1870889&r2=1870890&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-0-14-0/runtime-request-processing.png
URL:
http://svn.apache.org/viewvc/knox/site/books/knox-0-14-0/runtime-request-processing.png?rev=1870890&r1=1870889&r2=1870890&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-1-0-0/deployment-overview.png
URL:
http://svn.apache.org/viewvc/knox/site/books/knox-1-0-0/deployment-overview.png?rev=1870890&r1=1870889&r2=1870890&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-1-0-0/deployment-provider.png
URL:
http://svn.apache.org/viewvc/knox/site/books/knox-1-0-0/deployment-provider.png?rev=1870890&r1=1870889&r2=1870890&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-1-0-0/deployment-service.png
URL:
http://svn.apache.org/viewvc/knox/site/books/knox-1-0-0/deployment-service.png?rev=1870890&r1=1870889&r2=1870890&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-1-0-0/general_saml_flow.png
URL:
http://svn.apache.org/viewvc/knox/site/books/knox-1-0-0/general_saml_flow.png?rev=1870890&r1=1870889&r2=1870890&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-1-0-0/runtime-overview.png
URL:
http://svn.apache.org/viewvc/knox/site/books/knox-1-0-0/runtime-overview.png?rev=1870890&r1=1870889&r2=1870890&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-1-0-0/runtime-request-processing.png
URL:
http://svn.apache.org/viewvc/knox/site/books/knox-1-0-0/runtime-request-processing.png?rev=1870890&r1=1870889&r2=1870890&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-1-1-0/deployment-overview.png
URL:
http://svn.apache.org/viewvc/knox/site/books/knox-1-1-0/deployment-overview.png?rev=1870890&r1=1870889&r2=1870890&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-1-1-0/deployment-provider.png
URL:
http://svn.apache.org/viewvc/knox/site/books/knox-1-1-0/deployment-provider.png?rev=1870890&r1=1870889&r2=1870890&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-1-1-0/deployment-service.png
URL:
http://svn.apache.org/viewvc/knox/site/books/knox-1-1-0/deployment-service.png?rev=1870890&r1=1870889&r2=1870890&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-1-1-0/general_saml_flow.png
URL:
http://svn.apache.org/viewvc/knox/site/books/knox-1-1-0/general_saml_flow.png?rev=1870890&r1=1870889&r2=1870890&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-1-1-0/runtime-overview.png
URL:
http://svn.apache.org/viewvc/knox/site/books/knox-1-1-0/runtime-overview.png?rev=1870890&r1=1870889&r2=1870890&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-1-1-0/runtime-request-processing.png
URL:
http://svn.apache.org/viewvc/knox/site/books/knox-1-1-0/runtime-request-processing.png?rev=1870890&r1=1870889&r2=1870890&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-1-2-0/deployment-overview.png
URL:
http://svn.apache.org/viewvc/knox/site/books/knox-1-2-0/deployment-overview.png?rev=1870890&r1=1870889&r2=1870890&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-1-2-0/deployment-provider.png
URL:
http://svn.apache.org/viewvc/knox/site/books/knox-1-2-0/deployment-provider.png?rev=1870890&r1=1870889&r2=1870890&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-1-2-0/deployment-service.png
URL:
http://svn.apache.org/viewvc/knox/site/books/knox-1-2-0/deployment-service.png?rev=1870890&r1=1870889&r2=1870890&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-1-2-0/general_saml_flow.png
URL:
http://svn.apache.org/viewvc/knox/site/books/knox-1-2-0/general_saml_flow.png?rev=1870890&r1=1870889&r2=1870890&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-1-2-0/runtime-overview.png
URL:
http://svn.apache.org/viewvc/knox/site/books/knox-1-2-0/runtime-overview.png?rev=1870890&r1=1870889&r2=1870890&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-1-2-0/runtime-request-processing.png
URL:
http://svn.apache.org/viewvc/knox/site/books/knox-1-2-0/runtime-request-processing.png?rev=1870890&r1=1870889&r2=1870890&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-1-3-0/deployment-overview.png
URL:
http://svn.apache.org/viewvc/knox/site/books/knox-1-3-0/deployment-overview.png?rev=1870890&r1=1870889&r2=1870890&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-1-3-0/deployment-provider.png
URL:
http://svn.apache.org/viewvc/knox/site/books/knox-1-3-0/deployment-provider.png?rev=1870890&r1=1870889&r2=1870890&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-1-3-0/deployment-service.png
URL:
http://svn.apache.org/viewvc/knox/site/books/knox-1-3-0/deployment-service.png?rev=1870890&r1=1870889&r2=1870890&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-1-3-0/general_saml_flow.png
URL:
http://svn.apache.org/viewvc/knox/site/books/knox-1-3-0/general_saml_flow.png?rev=1870890&r1=1870889&r2=1870890&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-1-3-0/runtime-overview.png
URL:
http://svn.apache.org/viewvc/knox/site/books/knox-1-3-0/runtime-overview.png?rev=1870890&r1=1870889&r2=1870890&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-1-3-0/runtime-request-processing.png
URL:
http://svn.apache.org/viewvc/knox/site/books/knox-1-3-0/runtime-request-processing.png?rev=1870890&r1=1870889&r2=1870890&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-1-4-0/deployment-overview.png
URL:
http://svn.apache.org/viewvc/knox/site/books/knox-1-4-0/deployment-overview.png?rev=1870890&r1=1870889&r2=1870890&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-1-4-0/deployment-provider.png
URL:
http://svn.apache.org/viewvc/knox/site/books/knox-1-4-0/deployment-provider.png?rev=1870890&r1=1870889&r2=1870890&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-1-4-0/deployment-service.png
URL:
http://svn.apache.org/viewvc/knox/site/books/knox-1-4-0/deployment-service.png?rev=1870890&r1=1870889&r2=1870890&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-1-4-0/general_saml_flow.png
URL:
http://svn.apache.org/viewvc/knox/site/books/knox-1-4-0/general_saml_flow.png?rev=1870890&r1=1870889&r2=1870890&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-1-4-0/runtime-overview.png
URL:
http://svn.apache.org/viewvc/knox/site/books/knox-1-4-0/runtime-overview.png?rev=1870890&r1=1870889&r2=1870890&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-1-4-0/runtime-request-processing.png
URL:
http://svn.apache.org/viewvc/knox/site/books/knox-1-4-0/runtime-request-processing.png?rev=1870890&r1=1870889&r2=1870890&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-1-4-0/user-guide.html
URL:
http://svn.apache.org/viewvc/knox/site/books/knox-1-4-0/user-guide.html?rev=1870890&r1=1870889&r2=1870890&view=diff
==============================================================================
--- knox/site/books/knox-1-4-0/user-guide.html (original)
+++ knox/site/books/knox-1-4-0/user-guide.html Thu Dec 5 20:08:57 2019
@@ -2617,77 +2617,104 @@ ls -alrt {GATEWAY_HOME}/data/deployment
</td>
</tr>
-</table>
-<table>
- <thead>
- <tr>
- <th>Resource </th>
- <th>Operation </th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>aliases/{topology}/{alias} </td>
- <td>PUT </td>
- <td>Add alias for a given topology</td>
- </tr>
- <tr>
- <td> </td>
- <td>Example Request </td>
- <td><code>curl -ik -u admin:admin-password -H "Content-Type:
application/json" -d "value=mysecret" -X PUT
'{GatewayAPI}/aliases/sandbox/myalias'</code></td>
- </tr>
- <tr>
- <td> </td>
- <td>Example Response </td>
- <td><code>{ "created" : { "topology":
"sandbox", "alias": "putalias" } }</code></td>
- </tr>
- <tr>
- <td>aliases/{topology}/{alias} </td>
- <td>POST </td>
- <td>Add alias for a given topology</td>
- </tr>
- <tr>
- <td> </td>
- <td>Example Request </td>
- <td><code>curl -ik -u admin:admin-password -d "value=mysecret"
-X POST '{GatewayAPI}/aliases/sandbox/myalias'</code></td>
- </tr>
- <tr>
- <td> </td>
- <td>Example Response </td>
- <td><code>{ "created" : { "topology":
"sandbox", "alias": "putalias" } }</code></td>
- </tr>
- <tr>
- <td>aliases/{topology} </td>
- <td>GET </td>
- <td>Get all aliases for a given topology</td>
- </tr>
- <tr>
- <td> </td>
- <td>Example Request </td>
- <td><code>curl -ik -u admin:admin-password -X GET
'{GatewayAPI}/aliases/sandbox'</code></td>
- </tr>
- <tr>
- <td> </td>
- <td>Example Response </td>
-
<td><code>{"topology":"sandbox","aliases":["myalias","encryptquerystring"]}</code></td>
- </tr>
- <tr>
- <td>aliases/{topology}/{alias} </td>
- <td>DELETE </td>
- <td>Delete alias for a given topology</td>
- </tr>
- <tr>
- <td> </td>
- <td>Example Request </td>
- <td><code>curl -ik -u admin:admin-password -X DELETE
'{GatewayAPI}/aliases/sandbox/myalias'</code></td>
- </tr>
- <tr>
- <td> </td>
- <td>Example Response </td>
- <td><code>{ "deleted" : { "topology":
"sandbox", "alias": "myalias" } }</code></td>
- </tr>
- </tbody>
+ <tr>
+ <td>aliases/{topology}</td>
+ <td>GET</td>
+ <td>Get the aliases associated with the specified topology.</td>
+ </tr>
+ <tr>
+ <td> </td>
+ <td>Example Request</td>
+ <td><pre>curl -iku admin:admin-password
{GatewayAPI}/aliases/sandbox</pre></td>
+ </tr>
+ <tr>
+ <td> </td>
+ <td>Example Response</td>
+ <td>
+ <pre>
+{
+ "topology":"sandbox",
+ "aliases":["myalias","encryptquerystring"]
+}
+ </pre>
+ </td>
+ </tr>
+
+ <tr>
+ <td>aliases/{topology}/{alias}</td>
+ <td>PUT</td>
+ <td>Add the specified alias for the specified topology.</td>
+ </tr>
+ <tr>
+ <td> </td>
+ <td>Example Request</td>
+ <td><pre>curl -iku admin:admin-password
{GatewayAPI}/aliases/sandbox/putalias -X PUT \
+ -H "Content-Type: application/json" \
+ -d "value=mysecret"</pre>
+ </td>
+ </tr>
+ <tr>
+ <td> </td>
+ <td>Example Response</td>
+ <td>
+ <pre>
+{
+ "created" : {
+ "topology": "sandbox",
+ "alias": "putalias"
+ }
+}</pre>
+ </td>
+ </tr>
+ <tr>
+ <td> </td>
+ <td>POST</td>
+ <td>Add the specified alias for the specified topology.</td>
+ </tr>
+ <tr>
+ <td> </td>
+ <td>Example Request</td>
+ <td><pre>curl -iku admin:admin-password
{GatewayAPI}/aliases/sandbox/postalias -X POST \
+ -H "Content-Type: application/json" \
+ -d "value=mysecret"</pre>
+ </td>
+ </tr>
+ <tr>
+ <td> </td>
+ <td>Example Response</td>
+ <td>
+ <pre>
+{
+ "created" : {
+ "topology": "sandbox",
+ "alias": "postalias"
+ }
+}</pre>
+ </td>
+ </tr>
+ <tr>
+ <td> </td>
+ <td>DELETE</td>
+ <td>Remove the specified alias for the specified topology.</td>
+ </tr>
+ <tr>
+ <td> </td>
+ <td>Example Request</td>
+ <td><pre>curl -iku admin:admin-password
{GatewayAPI}/aliases/sandbox/myalias -X DELETE</pre></td>
+ </tr>
+ <tr>
+ <td> </td>
+ <td>Example Response</td>
+ <td>
+ <pre>
+{
+ "deleted" : {
+ "topology": "sandbox",
+ "alias": "myalias"
+ }
+}</pre></td>
+ </tr>
+
</table>
<h3><a id="X-Forwarded-*+Headers+Support">X-Forwarded-* Headers Support</a> <a
href="#X-Forwarded-*+Headers+Support"><img
src="markbook-section-link.png"/></a></h3>
<p>Out-of-the-box Knox provides support for some <code>X-Forwarded-*</code>
headers through the use of a Servlet Filter. Specifically the headers
handled/populated by Knox are:</p>
Modified: knox/trunk/books/1.4.0/admin_api.md
URL:
http://svn.apache.org/viewvc/knox/trunk/books/1.4.0/admin_api.md?rev=1870890&r1=1870889&r2=1870890&view=diff
==============================================================================
--- knox/trunk/books/1.4.0/admin_api.md (original)
+++ knox/trunk/books/1.4.0/admin_api.md Thu Dec 5 20:08:57 2019
@@ -517,22 +517,105 @@ Please note that to access this API, the
</td>
</tr>
-</table>
+ <tr>
+ <td>aliases/{topology}</td>
+ <td>GET</td>
+ <td>Get the aliases associated with the specified topology.</td>
+ </tr>
+ <tr>
+ <td> </td>
+ <td>Example Request</td>
+ <td><pre>curl -iku admin:admin-password
{GatewayAPI}/aliases/sandbox</pre></td>
+ </tr>
+ <tr>
+ <td> </td>
+ <td>Example Response</td>
+ <td>
+ <pre>
+{
+ "topology":"sandbox",
+ "aliases":["myalias","encryptquerystring"]
+}
+ </pre>
+ </td>
+ </tr>
+
+ <tr>
+ <td>aliases/{topology}/{alias}</td>
+ <td>PUT</td>
+ <td>Add the specified alias for the specified topology.</td>
+ </tr>
+ <tr>
+ <td> </td>
+ <td>Example Request</td>
+ <td><pre>curl -iku admin:admin-password
{GatewayAPI}/aliases/sandbox/putalias -X PUT \
+ -H "Content-Type: application/json" \
+ -d "value=mysecret"</pre>
+ </td>
+ </tr>
+ <tr>
+ <td> </td>
+ <td>Example Response</td>
+ <td>
+ <pre>
+{
+ "created" : {
+ "topology": "sandbox",
+ "alias": "putalias"
+ }
+}</pre>
+ </td>
+ </tr>
+ <tr>
+ <td> </td>
+ <td>POST</td>
+ <td>Add the specified alias for the specified topology.</td>
+ </tr>
+ <tr>
+ <td> </td>
+ <td>Example Request</td>
+ <td><pre>curl -iku admin:admin-password
{GatewayAPI}/aliases/sandbox/postalias -X POST \
+ -H "Content-Type: application/json" \
+ -d "value=mysecret"</pre>
+ </td>
+ </tr>
+ <tr>
+ <td> </td>
+ <td>Example Response</td>
+ <td>
+ <pre>
+{
+ "created" : {
+ "topology": "sandbox",
+ "alias": "postalias"
+ }
+}</pre>
+ </td>
+ </tr>
+ <tr>
+ <td> </td>
+ <td>DELETE</td>
+ <td>Remove the specified alias for the specified topology.</td>
+ </tr>
+ <tr>
+ <td> </td>
+ <td>Example Request</td>
+ <td><pre>curl -iku admin:admin-password
{GatewayAPI}/aliases/sandbox/myalias -X DELETE</pre></td>
+ </tr>
+ <tr>
+ <td> </td>
+ <td>Example Response</td>
+ <td>
+ <pre>
+{
+ "deleted" : {
+ "topology": "sandbox",
+ "alias": "myalias"
+ }
+}</pre></td>
+ </tr>
-Resource | Operation | Description
----------|-----------|------------
-aliases/{topology}/{alias} | PUT | Add alias for a given topology
- | Example Request | `curl -ik -u admin:admin-password -H "Content-Type:
application/json" -d "value=mysecret" -X PUT
'{GatewayAPI}/aliases/sandbox/myalias'`
- | Example Response | `{ "created" : { "topology": "sandbox", "alias":
"putalias" } }`
-aliases/{topology}/{alias} | POST | Add alias for a given topology
- | Example Request | `curl -ik -u admin:admin-password -d "value=mysecret"
-X POST '{GatewayAPI}/aliases/sandbox/myalias'`
- | Example Response | `{ "created" : { "topology": "sandbox", "alias":
"putalias" } }`
-aliases/{topology} | GET | Get all aliases for a given topology
- | Example Request | `curl -ik -u admin:admin-password -X GET
'{GatewayAPI}/aliases/sandbox'`
- | Example Response |
`{"topology":"sandbox","aliases":["myalias","encryptquerystring"]}`
-aliases/{topology}/{alias} | DELETE | Delete alias for a given topology
- | Example Request | `curl -ik -u admin:admin-password -X DELETE
'{GatewayAPI}/aliases/sandbox/myalias'`
- | Example Response | `{ "deleted" : { "topology": "sandbox", "alias":
"myalias" } }`
+</table>