Skip to content

Commit

Permalink
PD-762: Update API Interface doc (port to master)
Browse files Browse the repository at this point in the history
  • Loading branch information
Mrt134 committed Dec 26, 2023
1 parent 9b8fdec commit ccb0632
Show file tree
Hide file tree
Showing 6 changed files with 43 additions and 14 deletions.
41 changes: 41 additions & 0 deletions content/AdminGuide/API.md
@@ -0,0 +1,41 @@
---
title: "API Interface"
description: "Guide to access the built-in TrueCommand API Interface and link to a static API documentation copy."
weight: "90"
geekdocCollapseSection: true
related: false
---

TrueCommand provides an Application Program Interface (API) screen with links to embedded API documentation, system logs, and a request form for sending and receiving API calls.

{{< trueimage src="/images/TrueCommand/APIInterface.png" alt="APIInterface" id="API Interface Screen" >}}

## API documentation

API documentation built with the TrueCommand version is available from the web interface by opening the admin menu and clicking **API**.
Alternately, copy the TrueCommand web interface URL to a new browser tab and append `/api/swagger`.

A static build of this version's API documentation is also provided [here](/api/tc_rest_api.html).

## System Logs

Click <span class="iconify" data-icon="mdi:file-document-outline"></span> **UI LOG** to open a sidebar that shows messages recorded by the TrueCommand user interface.
Click <span class="iconify" data-icon="mdi:download"></span> to download a local copy of the UI log.

Click <span class="iconify" data-icon="mdi:file-document-outline"></span> **MIDDLEWARE LOG** to open a sidebar that shows informational and alert messages recorded by the TrueCommand middleware.
Click <span class="iconify" data-icon="mdi:download"></span> to download a local copy of the middleware log.

## API Request Form

Interact with the TrueCommand API using this form.
To find the different calls and parameters, refer to the embedded API documentation.

Enter a **Name** in the form.
This must be path to the desired TrueCommand API call.
The form automatically adds a **/** character in front of the entered **Name**.
Example: {{< cli >}}alert-plugin/list {{< /cli >}}

Enter any additional parameters in a standardized JSON format.
This simple example shows deleting an TrueCommand user account:

{{< trueimage src="/images/TrueCommand/APICallUserRemove.png" alt="APICallUserRemove" id="Example API Request to Remove a TrueCommand User" >}}
2 changes: 1 addition & 1 deletion content/TCGettingStarted/InterfaceOverview.md
Expand Up @@ -54,7 +54,7 @@ These options appear when the logged in user account is a TrueCommand administra
| <span class="iconify" data-icon="mdi:account-supervisor-circle"></span> Teams | Opens the [**Teams**]({{< relref "/AdminGuide/Users.md" >}}) screen for grouping TrueCommand user accounts into teams with tunable permissions. |
| <span class="iconify" data-icon="mdi:text-short"></span> Logs | Opens the [**Logs**]({{< relref "SystemLog.md" >}}) screen for viewing all recorded user account activity within TrueCommand. |
| <span class="iconify" data-icon="mdi:key"></span> Administration | Opens the [**Administration**]({{< relref "/AdminGuide/Admin/_index.md" >}}) screen for configuring the deployed TrueCommand instance. |
| <span class="iconify" data-icon="mdi:swap-vertical-bold"></span> API | Opens the **[API Interface]({{< relref "/UserGuide/API.md" >}})** screen for testing API calls and viewing TrueCommand API documentation. |
| <span class="iconify" data-icon="mdi:swap-vertical-bold"></span> API | Opens the **[API Interface]({{< relref "API.md" >}})** screen for testing API calls and viewing TrueCommand API documentation. |
{{< /truetable >}}

### User Avatar Menu
Expand Down
2 changes: 1 addition & 1 deletion content/TCGettingStarted/TCReleaseNotes.md
Expand Up @@ -26,7 +26,7 @@ TrueCommand is primarily offered as a Software as a Service (SaaS) solution from
TrueCommand Cloud registrations are available from https://portal.ixsystems.com.
A valid email address and credit card is required ([signup instructions]({{< relref "InstallTCCloud.md" >}})).

A self-hosted TrueCommand container is available from https://hub.docker.com/r/ixsystems/truecommand/tags under the tag **3.0.0** ([deployment instructions]({{< relref "InstallTCDocker.md" >}})).
A self-hosted TrueCommand container is available from https://hub.docker.com/r/ixsystems/truecommand/tags under the tag **release-3.0.0** ([deployment instructions]({{< relref "InstallTCDocker.md" >}})).

## Upgrade Notes

Expand Down
12 changes: 0 additions & 12 deletions content/UserGuide/API.md

This file was deleted.

Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/images/TrueCommand/APIInterface.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit ccb0632

Please sign in to comment.