Getting Started

This section includes information to help you download, install, and start using the tool to manage API configurations efficiently.

On this page:

Prerequisites:

  • Ensure Java 17 is installed, the JAVA_HOME environment variable is set, and the required permissions are available.
  • Network access is available to the Akana Community Manager and Policy Manager portals.
  • Valid credentials for the Akana environment.
  • A local or remote repository is available to store exported assets.
  • (Optional) A JKS file containing PKI keys is available if you want to assign the keys to APIs or users.
  • Write access to the folder where the keystore file will be generated.

Download the installation ZIP file or files

  1. Log in to the Support Portal.
  2. Go to Product Downloads > API Ops tool > API Ops tool <version_number> Downloads.
  3. Select the desired version and download the files.

Unzip the installation files

In your target directory, extract the ZIP or TAR files for selected version. For example, api-ops-2026.1.0.zip or api-ops-2026.1.0.tar files.

Verify the installation

After extracting the installation files, confirm that the following directory structure exists in the installation directory (INSTALL_DIR).

Copy 
api-ops-2026.1.0/
├── bin/
├── config/
├── lib/

Installation includes the following directories:

api-ops
The root installation directory for the API Ops tool. It contains all required subfolders, including executables, configuration files, libraries, and logs used to run and manage API Ops operations.
bin
Includes executable scripts to run the API Ops tool. The api-ops.bat file is a Windows batch script and the api-ops.sh file is a shell script for UNIX‑based systems.
config
Includes the environment-config.yaml file, which defines environment‑specific settings; the export-config.yaml file, which includes settings used for export operations; and the import-config.yaml file, which includes settings used for import operations. The log4j2.properties file defines the logging configuration for the tool.
lib
Includes libraries and dependencies required by the API Ops tool.

Usage workflow

The following workflow shows how to move assets from a source environment to a target environment using export and import operations.

Source Environment → Export → Artifact → Transform (Interpolation) → Import → Target Environment

Step 1: Configure environments

Update the environment details in the environment-config.yaml file.

Step 2: Run Init

Run the Init command to initialize encryption for sensitive information in configuration files and exported assets.

Step 3: Export assets

  1. Update the export-config.yaml with source environment details, the list of assets to export, and the repository location.
  2. Run the export CLI command to export assets to the configured repository.

Step 4: Import assets

  1. Update the import-config.yaml with target environment details, the list of assets to import, asset interpolation rules, and the repository location.
  2. Run the import CLI command to import assets from the repository into the target environment.

Step 5: (Optional) Automate the workflow

You can configure a CI/CD pipeline to automatically trigger this workflow.

To get started, see the CLI Tool configuration and CLI commands.

Roles and permissions

To run the API Ops tool, you must use the Akana user credentials with appropriate Community Manager permissions.

Ensure that you have one of the following roles and permissions:

  • Community Manager (CM) user with the Business Admin role
  • Policy Manager (PM) administrator with access to the trust store