Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Nokia NetAct Topology API

Network topology discovery and navigation

Nokia NetAct Topology API is one of 4 APIs that Nokia NetAct publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 1 JSON Schema definition.

Tagged areas include Topology. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 1 JSON Schema.

This API exposes 3 operations across 3 paths, and defines 3 schemas. It is described by OpenAPI 3.1.0, at version 22.0.0.

Requests are made against a single base URL, https://{netact-host}/api/v1.

3 operations 3 paths 3 schemas 3 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
22.0.0
Base URL
https://api.nokia-netact.example.com
Authentication
HTTP Bearer, HTTP Basic
Resource Areas
1

Authentication & Security 2

Nokia NetAct Topology API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (BearerAuth). It accepts HTTP basic authentication (BasicAuth). By default, every request must be authenticated.

Paths & Operations 3

Across 3 paths, the API surfaces 3 operations — 3 GET. Each is listed below with its method, path, parameters, and response codes.

Topology 3

Network topology discovery and navigation

GET
/topology/network-elements
List network elements
listNetworkElements 9 params → 200401
GET
/topology/network-elements/{distinguishedName}
Get network element details
getNetworkElement 1 param → 200404
GET
/topology/network-elements/{distinguishedName}/children
Get child network elements
getNetworkElementChildren 2 params → 200

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are NetworkElement (11 properties), NetworkElementListResponse (4 properties), ErrorResponse (3 properties). Each schema is shown below with its type and property counts.

NetworkElement
object
A managed network element in the Nokia NetAct topology
11 properties
NetworkElementListResponse
object
4 properties
ErrorResponse
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nokia-netact-topology-api-openapi.yml Raw ↑

Other APIs Nokia NetAct publishes across the network.

Nokia NetAct Configuration Management API
Nokia NetAct Fault Management API
Nokia NetAct Performance Management API