Getting Started
Welcome to Lumen NaaS Portal! This guide will walk you through creating your account, registering your first circuit, and setting up automated bandwidth management in just a few minutes.
Before You Begin
Make sure you have the following:
- A Lumen circuit ID (e.g.,
LUMEN-12345-ABC) - Your Lumen API token for circuit authentication
- An email address for account creation
Create Your Account
Set up your Lumen NaaS Portal credentials
Start by creating your Lumen NaaS Portal account. You have two options for authentication:
Email & Password
Create an account with your email address and a secure password. Password requirements:
- - At least 8 characters
- - At least 1 number
- - At least 1 special character
OAuth (Recommended)
Sign in quickly using your existing Google or Microsoft account. No password to remember!
Navigate to /register or click Sign Up in the header
Choose your authentication method (email/password or OAuth)
Complete the registration form with your name and email
If using email, verify your email address by clicking the link sent to your inbox
Register Your First Circuit
Connect your Lumen circuit to the portal
Once logged in, you'll land on the Circuits page. This is where you register and manage your Lumen circuits.
Click the Add Circuit button in the top-right corner
Enter your Lumen Circuit ID (the unique identifier from Lumen)
Enter your API Token (provided by Lumen for circuit authentication)
Optionally add a Friendly Name to easily identify the circuit
Optionally add Tags to group related circuits (e.g., "production", "backup")
Click Create Circuit to save
Your API token is encrypted at rest and never displayed after initial entry. Store it securely - you'll need to re-enter it if you edit the circuit.
After registering, your circuit card will display the current bandwidth status, automatically refreshing every 5 seconds.
Create Your First Automation
Set up automated bandwidth management
Now for the exciting part - setting up automated bandwidth management! Navigate to the Automations page from the sidebar.
Understanding Automation Components
Every automation has three tiers that work together:
Trigger
Determines when the automation runs. Returns true or false to route to different paths.
Action
Performs the bandwidth change. Each trigger state (true/false) can have its own action.
Notifier
Sends notifications about the execution result. Configure in Account → Notifiers first.
Creating a Scheduled Automation
Let's create a simple schedule-based automation that increases bandwidth during business hours:
Click Create Automation on the Automations page
Enter a descriptive name like "Business Hours Bandwidth"
Configure the Trigger:
Select Schedule as the trigger type
Choose the days of the week (e.g., Monday-Friday)
Set start time (e.g., 9:00 AM) and end time (e.g., 6:00 PM)
Select your timezone
Configure the Start Action (when schedule starts):
Select Bandwidth as the action type
Choose your registered circuit(s) or use tags
Set the target bandwidth (e.g., 1000 Mbps)
Configure the End Action (when schedule ends):
Select Bandwidth as the action type
Set a lower bandwidth for off-hours (e.g., 100 Mbps)
Optionally configure notifications for success/failure
Click Save to create the automation
Monitor Your Events
Track all activity with the audit trail
The Events page provides a complete audit trail of all activity in your account. Every automation execution, circuit change, and user action is logged with detailed information.
Event Features
Execution Groups
Related events grouped by execution ID for easy tracking
Tier Breakdown
See trigger, action, and notifier results separately
Filtering
Filter by event type, source, or search text
Export
Download events as CSV for external analysis
Real-time Updates
Page refreshes automatically to show new events
Next Steps
Now that you've set up your first automation, explore these advanced features: