Pinrail Docs

Terminal Management

Public guidance for terminal inventory, connectors, routing, and provisioning workflows.

Overview

Pinrail Terminal Management gives operators a single place to manage terminal inventory, connector ownership, routing policy, and provisioning outputs.

Core Workflows

The current platform implementation supports these operator-facing workflows:

  • list terminals and inspect terminal detail
  • review connector inventory and connector run history
  • assign connectors to terminals
  • apply routing policy at the terminal or group level
  • generate provisioning exports for a terminal or fleet
  • review provisioning job history before rolling forward or back

Current API Areas

The current documented resource families are:

  • /v1/terminals
  • /v1/connectors
  • /v1/terminal-groups
  • terminal provisioning exports and provisioning-job actions

Exact request and response schemas will move into generated API reference once the external contract is frozen.

Provisioning Guidance

Provisioning outputs should be treated as operator-controlled artifacts.

  • keep exported configuration tied to a named terminal or group change
  • review connector and routing assignments before distribution
  • use rollback workflows when a provisioning push needs to be reverted
  • retain job history so field changes can be traced later

Public Boundary

This documentation covers customer-safe concepts and workflows only. Internal switch telemetry, raw CDE event payloads, and sensitive operational credentials remain out of scope for the public docs site.

On this page