Prerequisite

Create API key if you haven't done so:

• Login to your Mammoth Cyber management portal
• Select "Setting --> Admins & API Keys --> API Keys" from the menu on the left side of the window
• Click the "+ Add" button (Please note the API secret string is only displayed once). You can either copy the secret or download it as a file, note the file is in dotenv format, you can pass it to the sample script directly, see more details below.

Review our API document here:

• Note our API is upgraded to v2
• Our sample script assume you use a recent Python3 version

Quickstart

Use the provided install.sh to prepare all necessary environment on Ubuntu

It installs git, python, pip, venv, checkout this repo, create an venv and install all required libraries.

You can download and run it with this command line on Linux. Note you need to execute from an account allows sudo:

curl -sSL https://raw.githubusercontent.com/appaegis/api-script-samples/refs/heads/main/install.sh | bash

After install is done, you can run API script.

Manual preparation

If you use an environment other than Ubuntu, or if you have existing python environment, you may want to follow below steps.

For Ubuntu 24.04 LTS and python 3.12.3 and venv module

# It is recommended to setup venv just for this repo
cd api-script-samples

sudo apt install python3-venv
python3 -m venv "apienv"
source apienv/bin/activate

Create python local environment at project root path

# Assume you've already in the api-script-samples directory
pip install -r requirements.txt

Run API script

Reminder: Make sure you've activated the venv for the shell you are using.

Method 1: Use downloaded API key file as env file for script, for example:

• ex-01: Upload block list

python3 block-list-v2.py --env credentails.txt --file input.txt

or

python3 block-list-v2.py --env credentails.txt --url https://url-to-list

Method 2: Use environment variable as input for script, for example:

• ex-01: Upload block list

export apiKey=abcd................................
export apiSecret=abcd.............................
python3 block-list-v2.py --file input.txt

Outdated v1 examples

• ex-01: Variable injecting with export

export API_HOST=https://api.appaegis.net  # optionally customize the API root
export API_KEY=abcd................................
export API_SECRET=abcd.............................

export USER_EMAIL=user@companydomain.com
export USER_SSH_IP=127.0.0.2:3333

./create-user.py
./purge-user.py --dryrun=True

• ex-02: Inline variable injection works as well

USER_EMAIL=bbb API_KEY=ddd API_SECRET=eee ./purge-user.py --dryrun True

ℹ️ After the create-user.py script is finished, go ask your user to check his/her email box to find the invitation.

⚠️ Please always dryrun before actrually deleting resource, because the deletion cannot be undone.
Data searching will start from userEntry, so circular references without user as foreignKey will not be removed. ex:Team <-> Role only without user reference.
If process is terminated before completion, the data relationship might be broken.

• ex-03: List all networks in json format

export API_KEY=abcd................................
export API_SECRET=abcd.............................

./list-se.py

• ex-04: List all service edge of one network in json format

export API_KEY=abcd................................
export API_SECRET=abcd.............................

./list-se.py --nwname "my network"