Service API Configuration

This module is not available in the current version. It will be available in a future version. Use this page 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.

Where to find parameter descriptions: Each tab shows a description under its title. Some fields have a hint or an (i) tooltip. Click the arrow of a parameter row to see its TR-098 and TR-181 paths, its type, and its default value.

When to use it

Use Service API Configuration when you need to:

  • configure the API connection settings and parameters,

  • manage the mail service configuration,

  • configure the speed test parameters,

  • define the subscription service settings,

  • configure service groups,

  • manage the wireless network parameters,

  • export the configuration before you make changes,

  • import an updated configuration with a dry-run preview.

Before you start

  • Sign in to the correct environment.

  • Check your role:

    • VIEWER can browse the configuration and use Export YAML.

    • EDITOR and ADMIN can also edit the settings and use Import YAML.

A VIEWER account works in read-only mode. You cannot edit or save.

Sections

Service API Configuration has these tabs:

API Configuration

Core API connection settings, endpoints, and authentication parameters.

Mail Server

Mail service configuration with SMTP settings, templates, and delivery options.

Speed Test

Parameters for the network speed test.

Subscription

Subscription service settings.

Service Groups

Service group definitions and mappings.

Wireless Security

Wireless network configuration parameters.

Change values

  1. Open a tab.

  2. Review the current settings.

  3. Change the values in the inline fields.

Expected result: The page tracks your changes automatically. The Unsaved changes badge shows pending changes.

Autosave

  • The page saves your draft in the browser local storage while you edit.

  • If you leave the page or close the browser, the page keeps the draft.

  • When you return, a message shows the restored draft.

Autosave uses the local storage of your browser and works only on your device.

Save changes

  1. Change the values in one or more tabs.

  2. Click Save changes in the toolbar.

Expected result:

  • If the save works, the configuration updates and the Unsaved changes badge disappears.

  • The portal saves the changes on the server and clears the autosaved draft.

  • If validation fails, the page shows errors and blocks the save.

Discard changes

  1. Click Refresh in the toolbar.

  2. If you have unsaved changes, a confirmation dialog opens.

  3. Click Confirm.

Expected result: The page discards your changes, clears the autosaved draft, and loads the configuration from the server.

Export the configuration

  1. Click Export YAML.

Expected result: The portal downloads a YAML file with the current configuration.

The file contains:

  • All configuration sections: API, Mail, Speed Test, Subscription, Service Groups, and Wireless.

  • The current values from the server, not your draft changes.

Import with dry-run

  1. Click Import YAML.

  2. Upload a YAML file.

  3. Review the dry-run preview of the proposed changes.

  4. If the dry-run shows warnings, select Allow import with warnings.

  5. Click Apply import.

Expected result:

  • The dry-run starts automatically after you select the file.

  • A warning needs your explicit confirmation before you can apply.

  • An error blocks the apply action until you fix it.

  • The import replaces the entire configuration.

  • The page refreshes and clears the autosaved draft after a successful import.

Refresh the configuration

  1. Click Refresh in the toolbar.

  2. If you have unsaved changes, confirm the dialog.

Expected result: The page loads the current configuration from the server.

Use Refresh after an import or after changes by other operators.

Troubleshooting

The edit actions are disabled

Your role is not EDITOR or ADMIN. Ask an administrator to change your role.

Save changes is disabled

You made no changes, or the form has validation errors. Make a change and fix the errors in the form fields.

You cannot see your changes after the save

The page can show old values. Click Refresh to load the configuration and check the changes.

Errors stop the import

The YAML file has errors. Fix the reported issues in the YAML file and import it again.

The page does not restore the draft

The browser can block local storage. Enable local storage in the browser.

Autosave does not work

The local storage quota can be full. Clear old autosaved drafts.

Related pages