Service API Configuration

This module is currently unavailable and will be available in future versions. The documentation below is provided for reference only.

Service API Configuration manages the configuration for the Service API module, including API settings, mail, speed test, subscription, service groups, and wireless parameters.

When to use it

Use Service API Configuration when you need to:

configure API connection settings and parameters,
manage mail service configuration,
set up speed test parameters,
define subscription service settings,
configure service groups,
manage wireless network parameters,
export configuration before making changes,
import updated configuration with a dry-run preview.

Prerequisites

Before working with Service API Configuration:

Confirm you are logged into the correct environment.
Confirm your permissions:
- VIEWER — browse configuration and Export.
- EDITOR / ADMIN — edit settings and Import.

VIEWER accounts run in read-only mode. Write actions (Edit/Save) are blocked.

Configuration sections

Service API Configuration is organized into tabs:

API: Core API connection settings, endpoints, and authentication parameters.
Mail: Mail service configuration including SMTP settings, templates, and delivery options.
Speed Test: Parameters for network speed testing functionality.
Subscription: Subscription service settings and configurations.
Service Group: Service group definitions and mappings.
Wireless: Wireless network configuration parameters.

Browse and edit

Use the tab navigation to switch between configuration sections.
Review current settings in each section.
Edit inline fields to modify values.
Changes are tracked automatically.
The Unsaved Changes badge appears when modifications are pending.

Autosave

Draft changes are automatically saved to local storage as you edit.
If you navigate away or close the browser, your draft is preserved.
When you return, you’ll see a notification that your draft was restored.

Autosave uses browser local storage and is specific to your device.

Save changes

Make edits in one or more sections.
Click Save in the toolbar.
Changes are persisted to the server.
The autosaved draft is cleared.

Expected outcomes:

On success, the configuration updates and the Unsaved Changes badge disappears.
If validation fails, errors are shown and save is blocked.

Discard changes

Click Refresh in the toolbar.
If you have unsaved changes, a confirmation dialog appears.
Confirm to discard changes and reload the configuration from the server.

This action clears the autosaved draft.

Export configuration

Click Export to download a YAML file with the current configuration.

What is exported:

All configuration sections (API, Mail, Speed Test, Subscription, Service Group, Wireless).
Current values from the server (not draft changes).
Format: YAML.

Import with dry-run

Click Import and upload a YAML file.
Review the dry-run preview showing proposed changes.
If warnings exist, enable Allow warnings before applying.
Apply the import and the configuration refreshes.