STEM Connect icon

STEM Connect

Manage telecommunications operations with STEM Connect API

Actions30

Circuit → Add

AI-generated

Overview

The "Add Circuit" operation in the STEM Connect node allows users to create a new end customer circuit record via the STEM Connect API. This operation is useful for telecommunications service providers or network administrators who need to programmatically add circuit details such as device serial numbers, VLAN descriptions, PPPoE credentials, and bandwidth speeds into their management system.

Typical use cases include:

  • Automating the provisioning of new circuits when onboarding customers.
  • Integrating circuit creation into larger workflows that manage network resources.
  • Synchronizing circuit data from external systems into STEM Connect.

For example, a user can add a new circuit with specific download/upload speeds and associated device information, enabling seamless tracking and management within the STEM Connect platform.

Properties

Name Meaning
Subsystem Selects the subsystem API endpoint to use: Main, Portal, or API.
Third Party Circuit Number External identifier for the circuit from a third party system.
Device Serial Number Serial number of the device associated with the circuit.
VLAN Description Description of the VLAN configuration related to the circuit.
Portal ID Identifier used in the portal subsystem for the circuit.
PPPoE Username Username for PPPoE authentication on the circuit.
PPPoE Password Password for PPPoE authentication (input masked).
Download Speed Download bandwidth speed allocated to the circuit (numeric value).
Upload Speed Upload bandwidth speed allocated to the circuit (numeric value).

Output

The output JSON contains the response from the STEM Connect API after adding the circuit. It typically includes details of the newly created circuit record, such as assigned IDs and the properties submitted.

If multiple items are returned by the API, each item is output as a separate JSON object in the array.

No binary data output is produced by this operation.

Dependencies

  • Requires an active connection to the STEM Connect API using an API key credential configured in n8n.
  • The node depends on the stemConnectApiRequest helper function to make authenticated HTTP requests to the STEM Connect endpoints.
  • Proper network access to the STEM Connect API server is necessary.

Troubleshooting

  • Common issues:

    • Missing or invalid API credentials will cause authentication failures.
    • Providing incomplete or invalid property values (e.g., non-numeric speeds) may result in API validation errors.
    • Network connectivity problems can prevent successful API calls.

  • Error messages:

    • Authentication errors typically indicate misconfigured or expired API keys; verify and update credentials.
    • Validation errors from the API will specify which fields are incorrect or missing; ensure all required fields are correctly filled.
    • Timeout or network errors suggest connectivity issues; check firewall and internet access.

Links and References

Discussion