Create API Keys

API Keys are required to publish your KAB files to KOS Studio and guarantee that the person publishing to your Artifact inventory has the appropriate permissions to do so.

Learn more about publishing a KAB here.

Access create API keys

  1. Log in to KOS Studio.
  2. Select Settings from top navigation (in the upper right corner of the screen) > Create API Keys.

View existing API keys

  1. Log in to KOS Studio.
  2. Select Settings from top navigation (in the upper right corner of the screen) > Create API Keys.
  3. Create API Keys opens in a new window where all active API Keys for your organization are available. Consider following :
    • If no active API keys are present, the system will display no keys and ask the user to create a new one.
    • Each key displays and provides the name, last connected date, and created date.

Create an API key

  1. Log in to KOS Studio.
  2. Select Settings from top navigation (in the upper right corner of the screen) > Create API Keys.
  3. Create New API Key pop-up opens, provides a unique name for the key, and click Create.
  4. An API key is now created and displayed in the pop-up. Click on the copy to copy the API key. Consider following:
    • API key value is only displayed to copy at the creation time and can not be accessed once the pop-up is closed.
  5. Click OK to close the pop-up.
  6. The system creates a provided API key and gets listed as an available API key.

Suspend an API key

  1. Log in to KOS Studio.
  2. Select Settings from top navigation (in the upper right corner of the screen) > Create API Keys.
  3. Create API Keys opens in a new window displaying all active API Keys for your organization.
  4. Select the more icon for the API key you wish to suspend and select Suspend.
  5. Consider following:
    • Publishing artifacts with the suspended API key is blocked.

Restore an API key.

  1. Log in to KOS Studio.
  2. Select Settings  from top navigation (in the upper right corner of the screen) > Create API Keys
  3. Create API Keys opens a new window displaying all active API Keys for your organization.
  4. Select the more icon for the already suspended API key you wish to restore and select Restore.
  5. Consider following:
    • Publishing artifacts with the restored API key will be allowed after restoring the API key

Delete an API key

  1. Log in to KOS Studio.
  2. Select Settings  from top navigation (in the upper right corner of the screen) > Create API Keys
  3. Create API Keys opens a new window displaying all active API Keys for your organization.
  4. Select the more icon for the API key you wish to delete and select Delete. Confirm on the confirmation pop-up.
  5. Consider following:
    • Publishing with the deleted API key is not allowed.
    • The deletion of the API keys can not be reversed.