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 Configuration Management API

Network element configuration read and write

Nokia NetAct Configuration Management 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 Configuration Management. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 1 JSON Schema.

This API exposes 2 operations across 1 path, 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.

2 operations 1 paths 3 schemas 1 GET1 PATCH

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 Configuration Management 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 2

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

Configuration Management 2

Network element configuration read and write

GET
/configuration/network-elements/{distinguishedName}/attributes
Get managed object attributes
getNetworkElementAttributes 2 params → 200
PATCH
/configuration/network-elements/{distinguishedName}/attributes
Modify managed object attributes
updateNetworkElementAttributes 1 param body → 200409

Schemas 3

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

MOAttributeUpdate
object
2 properties 1 required
MOAttributesResponse
object
2 properties
ErrorResponse
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nokia-netact-configuration-management-api-openapi.yml Raw ↑

Other APIs Nokia NetAct publishes across the network.

Nokia NetAct Fault Management API
Nokia NetAct Performance Management API
Nokia NetAct Topology API