Kube includes public APIs that allow websites or apps to communicate, generate, and manage records within Kube. To use a Kube API, you must generate a key.
Once the key is generated, Kube APIs include multiple services. Each service may include the following methods:
DELETE: Deletes record(s).
GET: Retrieves information for a record.
POST: Creates a record.
PUT: Updates a record.
NOTE: Kube APIs are documented in Swagger. Anyone who wants to access Kube's Swagger documentation must be an internal user of Kube. The link to Swagger can be found under System Settings > Operator Profile > API.
This article describes generating a key, managing an active API key, and reactivating an archived key.
NOTE: Depending on your assigned role and permissions, and the version of Kube your organization uses, some or all of these menus or services may not be available or displayed.
To generate an API authorization key
Select your Personal Profile in the top menu and select System Settings from the drop-down menu. The Operator Details screen appears.
Select the API tab.
Click Add to add a new API Key.
NOTE: By default, Kube comes with a global API key labeled Kube Global. You cannot change the name or API permissions for this key.
Complete the fields. See the end of this article for a screen reference.
Click Save.
Managing an active API authorization key
Select your Personal Profile in the top menu and select System Settings from the drop-down menu. The Operator Details screen appears.
Select the API tab.
Locate the API key in the API Keys section and click the three dot additional options button. Various options appear.
Select History to view a log of the revocation history of the key.
Select Archive to both revoke the API key and remove it from the Active list.
For revoked keys, to regenerate the key, select Generate API Key.
To revoke an API key, select Revoke API Key.
CAUTION: Revoking the API key will remove access from the application using the key and a new key will need to be generated and configured within that application to regain access.
Select Edit Permissions to update the Application name or change which APIs the application using the key has access to.
Reactivating an archived API key
Select your Personal Profile in the top menu and select System Settings from the drop-down menu. The Operator Details screen appears.
Select the API tab.
In the API keys section, locate the Active/Archived toggle. Click the toggle to highlight Archived.
Locate the API key in the list and click the three dot additional options
button.
Click Activate. Kube reactivates and generates a new API key.
Click the Active/Archived toggle to highlight Active to return to the list of active API keys.
Add New API Key Screen Reference
Username | Enter a username the API will challenge with the key to authenticate. The username can be up to seven alphanumeric characters. |
Application | For internal reference, enter an easy to recognize application name the API key will be utilized by. |
API Permissions | Select which APIs and methods the application using the key should have access to. |