API

Authentication

All requests to Lumeo's REST API require you to authenticate. You authenticate requests to Lumeo using API Keys which can be created and revoked in the Lumeo Console, .

To authenticate using an API Key, use HTTP Bearer (token) authentication and provide the API key as the token in the Authorization header when making requests to protected resources:

Authorization: Bearer <token>

Application ID

Application ID (aka Workspace ID) is a path parameter in most API Calls, and can be found in the left navigation bar under the Settings Tab.

API Keys

API Keys (aka Access Tokens) for your application can be created on Settings -> Access tokens page.

Script Helpers

Lumeo provides a python package lumeo containing scripts to make it easy to manage common operations.

Install

Install it as such from the terminal:

brew install pipx
pipx ensurepath
sudo pipx --global ensurepath # optional to allow pipx actions with --global argument

pipx install 'lumeo[all]' --force

sudo apt update
sudo apt install pipx
pipx ensurepath

pipx install lumeo[all] --force

Update the installed package with:

pipx upgrade lumeo

Usage

lumeo-scripts : Lists all the scripts available from the lumeo package