NITS Automation API

Seven read-only endpoints that return the same circuit/node lookups the automation team used to run as raw SQL against the Oracle IMS_IRE schema directly — now versioned, key-authenticated, rate-limited, and audited. Everything on this page is public reference documentation; it contains no credentials or internal schema details.

Authentication

Every request needs an API key, sent as the X-API-Key header (or Authorization: Bearer <key>). This is a separate mechanism from human NITS sign-in — automation clients don't have or need a NITS login.

Getting a key: ask your NITS admin to create a service account for your script/job. Keys are shown once at creation and can't be recovered later — if one is lost, ask your admin to revoke it and issue a new one.

curl -H "X-API-Key: <your key>" "https://<host>/api/automation/loopback?etherway_ref=ENASETHW86887"

Rate Limits, Errors & Auditing

Rate limiting is enforced per key, per minute — your admin sets the limit when the key is created.
Missing/invalid/revoked key → 401 unauthorized.
Missing required parameter(s) → 400 missing_params.
Rate limit exceeded → 429.
Other failures return a short, safe message — never a raw database error, SQL fragment, or table name.
Every successful call is logged (which key, which endpoint, when) — visible to NITS admins.

Endpoints

GET/api/automation/loopback

Loopback IP + node/type for the ADVA/CIENA node carrying a given etherway circuit.

Param	Required	Example
`etherway_ref`	yes	`ENASETHW86887`

[{"nodename": "535351", "type": "CIENA 3903", "loopback": "10.133.142.47", "circuitname": "ENASETHW86887"}]

GET/api/automation/adva-flow

Loopback IP + card/port for one ADVA node on one etherflow circuit.

Param	Required	Example
`adva_node_id`	yes	`535308`
`etherflow_ref`	yes	`ENASETHG86108`

[{"nodename": "535308", "type": "FSP 150-GE114PRO", "loopback": "10.133.138.251", "cardport": "LAN3:118", "circuitname": "ENASETHG86108", "service": "ETHERFLOW"}]

GET/api/automation/mgmt-sap

Management SAP details for an etherway circuit — etherflow refs, CFN VLAN, EIR SVLAN, loopback.

Param	Required	Example
`etherway_ref`	yes	`ENASETHW86107`

GET/api/automation/agg-network

Aggregation-network carrier chain (VPLS/ETHA/VLAN/GBE hops) for an etherflow circuit. Can return more than one row per circuit when there's more than one path through the carrier chain — this is not deduplicated.

Param	Required	Example
`etherflow_ref`	yes	`CNCRETHICG67681`

GET/api/automation/etherway-detail

Full ADVA/etherway detail — service ID, bandwidth, VLANs, COS, A/B-end ADVA hostnames, etherflow ref, and card-slot fill (ADVA_SLOT_0..ADVA_SLOT_8).

Param	Required	Example
`etherway_ref`	yes	matched with `LIKE` — `%` wildcards honored, e.g. `ENASETHW87660`

GET/api/automation/vpls-settings

VPLS settings for every circuit matching a name reference — one flat object per circuit, every configured field (CFN VLAN, EIR SVLAN, Service ID, Bandwidth, A END ETHERWAY, COS TYPE, etc.) as its own key. Matched with LIKE, same as the reference params above. A matched circuit with no VPLS product configured still gets a full object with every field null, not a missing key. If a field is missing entirely (not just null), double-check circuit_ref matched the circuit that actually carries the VPLS values — a VPLS hierarchy's individual leg circuits and its parent service circuit are different rows.

Param	Required	Example
`circuit_ref`	yes	`NGAVPLSIPCI_TRR%`

[{"circuit_id": 677178, "circuit_name": "ABTRETHW113307", "a_end_etherway": "aETHW1", "a_end_cfn_vlan": "805", "cos_type": "50%", "b_end_etherway": "zETHW2", "b_end_cfn_vlan": "807"}]

GET/api/automation/etherway-node

Node status/type/loopback/card-port for the etherway node whose aggregation carrier chain terminates at a given etherflow circuit — the reverse direction of /etherway-detail//mgmt-sap above.

Param	Required	Example
`etherflow_ref`	yes	`CNCRETHICG67681`

[{"nodename": "535308", "status": "ACTIVE", "type": "FSP 150-GE114PRO", "loopback": "10.133.138.251", "cardport": "LAN3:118", "circuitname": "ENASETHW86107", "subcircuitname": "CNCRETHICG67681", "service": "ETHERWAY"}]

Try It Without Writing Code

NITS admins can try any of these endpoints from a browser at /admin/api-tester — pick an endpoint, paste a key, fill in the reference, and see the live response, status, and timing before wiring it into a script.