Nokia NetAct Network Management Northbound Interface API

naftiko: 1.0.0-alpha2
info:
  label: Nokia NetAct Network Management Northbound Interface API
  description: Nokia NetAct provides network element management APIs for telecom operators. APIs enable network topology discovery,
    performance monitoring, fault management, and configuration management across RAN, transport, and core network infrastructure.
    The NBI (Northbound Interface) exposes REST APIs for OSS/BSS integration.
  tags:
  - Nokia
  - Netact
  - API
  created: '2026-05-06'
  modified: '2026-05-06'
capability:
  consumes:
  - type: http
    namespace: nokia-netact
    baseUri: https://netact.example.com/api/v1
    description: Nokia NetAct Network Management Northbound Interface API HTTP API.
    authentication:
      type: bearer
      token: '{{NOKIA_NETACT_TOKEN}}'
    resources:
    - name: topology-network-elements
      path: /topology/network-elements
      operations:
      - name: listnetworkelements
        method: GET
        description: List network elements
        inputParameters:
        - name: neType
          in: query
          type: string
          description: Network element type (e.g., BTS, NodeB, eNodeB, gNodeB, BSC, RNC, MSC)
        - name: technology
          in: query
          type: string
        - name: vendor
          in: query
          type: string
          description: Network equipment vendor name
        - name: operationalState
          in: query
          type: string
        - name: administrativeState
          in: query
          type: string
        - name: alarmState
          in: query
          type: string
        - name: dnFilter
          in: query
          type: string
          description: Distinguished Name prefix filter for topology subtree queries
        - name: limit
          in: query
          type: integer
        - name: offset
          in: query
          type: integer
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: topology-network-elements-distinguishedname
      path: /topology/network-elements/{distinguishedName}
      operations:
      - name: getnetworkelement
        method: GET
        description: Get network element details
        inputParameters:
        - name: distinguishedName
          in: path
          type: string
          required: true
          description: DN of the network element (URL-encoded)
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: topology-network-elements-distinguishedname-chil
      path: /topology/network-elements/{distinguishedName}/children
      operations:
      - name: getnetworkelementchildren
        method: GET
        description: Get child network elements
        inputParameters:
        - name: distinguishedName
          in: path
          type: string
          required: true
        - name: childClass
          in: query
          type: string
          description: Filter by specific MO class name (e.g., LNCEL, WCEL, GCELL)
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: faults-alarms
      path: /faults/alarms
      operations:
      - name: listactivealarms
        method: GET
        description: List active alarms
        inputParameters:
        - name: severity
          in: query
          type: string
        - name: neDn
          in: query
          type: string
          description: Distinguished Name of the source NE
        - name: alarmType
          in: query
          type: string
        - name: fromTime
          in: query
          type: string
        - name: limit
          in: query
          type: integer
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: faults-alarms-alarmid
      path: /faults/alarms/{alarmId}
      operations:
      - name: getalarm
        method: GET
        description: Get alarm details
        inputParameters:
        - name: alarmId
          in: path
          type: string
          required: true
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: faults-alarms-alarmid-acknowledge
      path: /faults/alarms/{alarmId}/acknowledge
      operations:
      - name: acknowledgealarm
        method: POST
        description: Acknowledge an alarm
        inputParameters:
        - name: alarmId
          in: path
          type: string
          required: true
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: performance-kpis
      path: /performance/kpis
      operations:
      - name: getperformancekpis
        method: GET
        description: Get KPI performance counters
        inputParameters:
        - name: neDn
          in: query
          type: string
          required: true
          description: DN of the network element or subtree root
        - name: kpiGroup
          in: query
          type: string
          description: KPI group name (e.g., ACCESSIBILITY, RETAINABILITY, TRAFFIC)
        - name: granularity
          in: query
          type: string
          description: Measurement granularity (ISO 8601 duration)
        - name: startTime
          in: query
          type: string
          required: true
        - name: endTime
          in: query
          type: string
          required: true
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: configuration-network-elements-distinguishedname
      path: /configuration/network-elements/{distinguishedName}/attributes
      operations:
      - name: getnetworkelementattributes
        method: GET
        description: Get managed object attributes
        inputParameters:
        - name: distinguishedName
          in: path
          type: string
          required: true
        - name: attributes
          in: query
          type: string
          description: Comma-separated list of attribute names to retrieve (all if omitted)
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: updatenetworkelementattributes
        method: PATCH
        description: Modify managed object attributes
        inputParameters:
        - name: distinguishedName
          in: path
          type: string
          required: true
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
  exposes:
  - type: rest
    port: 8080
    namespace: nokia-netact-rest
    description: REST adapter for Nokia NetAct Network Management Northbound Interface API.
    resources:
    - path: /topology/network-elements
      name: listnetworkelements
      operations:
      - method: GET
        name: listnetworkelements
        description: List network elements
        call: nokia-netact.listnetworkelements
        outputParameters:
        - type: object
          mapping: $.
    - path: /topology/network-elements/{distinguishedName}
      name: getnetworkelement
      operations:
      - method: GET
        name: getnetworkelement
        description: Get network element details
        call: nokia-netact.getnetworkelement
        with:
          distinguishedName: rest.distinguishedName
        outputParameters:
        - type: object
          mapping: $.
    - path: /topology/network-elements/{distinguishedName}/children
      name: getnetworkelementchildren
      operations:
      - method: GET
        name: getnetworkelementchildren
        description: Get child network elements
        call: nokia-netact.getnetworkelementchildren
        with:
          distinguishedName: rest.distinguishedName
        outputParameters:
        - type: object
          mapping: $.
    - path: /faults/alarms
      name: listactivealarms
      operations:
      - method: GET
        name: listactivealarms
        description: List active alarms
        call: nokia-netact.listactivealarms
        outputParameters:
        - type: object
          mapping: $.
    - path: /faults/alarms/{alarmId}
      name: getalarm
      operations:
      - method: GET
        name: getalarm
        description: Get alarm details
        call: nokia-netact.getalarm
        with:
          alarmId: rest.alarmId
        outputParameters:
        - type: object
          mapping: $.
    - path: /faults/alarms/{alarmId}/acknowledge
      name: acknowledgealarm
      operations:
      - method: POST
        name: acknowledgealarm
        description: Acknowledge an alarm
        call: nokia-netact.acknowledgealarm
        with:
          alarmId: rest.alarmId
        outputParameters:
        - type: object
          mapping: $.
    - path: /performance/kpis
      name: getperformancekpis
      operations:
      - method: GET
        name: getperformancekpis
        description: Get KPI performance counters
        call: nokia-netact.getperformancekpis
        outputParameters:
        - type: object
          mapping: $.
    - path: /configuration/network-elements/{distinguishedName}/attributes
      name: getnetworkelementattributes
      operations:
      - method: GET
        name: getnetworkelementattributes
        description: Get managed object attributes
        call: nokia-netact.getnetworkelementattributes
        with:
          distinguishedName: rest.distinguishedName
        outputParameters:
        - type: object
          mapping: $.
    - path: /configuration/network-elements/{distinguishedName}/attributes
      name: updatenetworkelementattributes
      operations:
      - method: PATCH
        name: updatenetworkelementattributes
        description: Modify managed object attributes
        call: nokia-netact.updatenetworkelementattributes
        with:
          distinguishedName: rest.distinguishedName
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    port: 9090
    namespace: nokia-netact-mcp
    transport: http
    description: MCP adapter for Nokia NetAct Network Management Northbound Interface API for AI agent use.
    tools:
    - name: listnetworkelements
      description: List network elements
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: nokia-netact.listnetworkelements
      with:
        neType: tools.neType
        technology: tools.technology
        vendor: tools.vendor
        operationalState: tools.operationalState
        administrativeState: tools.administrativeState
        alarmState: tools.alarmState
        dnFilter: tools.dnFilter
        limit: tools.limit
        offset: tools.offset
      inputParameters:
      - name: neType
        type: string
        description: Network element type (e.g., BTS, NodeB, eNodeB, gNodeB, BSC, RNC, MSC)
      - name: technology
        type: string
        description: technology
      - name: vendor
        type: string
        description: Network equipment vendor name
      - name: operationalState
        type: string
        description: operationalState
      - name: administrativeState
        type: string
        description: administrativeState
      - name: alarmState
        type: string
        description: alarmState
      - name: dnFilter
        type: string
        description: Distinguished Name prefix filter for topology subtree queries
      - name: limit
        type: integer
        description: limit
      - name: offset
        type: integer
        description: offset
      outputParameters:
      - type: object
        mapping: $.
    - name: getnetworkelement
      description: Get network element details
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: nokia-netact.getnetworkelement
      with:
        distinguishedName: tools.distinguishedName
      inputParameters:
      - name: distinguishedName
        type: string
        description: DN of the network element (URL-encoded)
        required: true
      outputParameters:
      - type: object
        mapping: $.
    - name: getnetworkelementchildren
      description: Get child network elements
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: nokia-netact.getnetworkelementchildren
      with:
        distinguishedName: tools.distinguishedName
        childClass: tools.childClass
      inputParameters:
      - name: distinguishedName
        type: string
        description: distinguishedName
        required: true
      - name: childClass
        type: string
        description: Filter by specific MO class name (e.g., LNCEL, WCEL, GCELL)
      outputParameters:
      - type: object
        mapping: $.
    - name: listactivealarms
      description: List active alarms
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: nokia-netact.listactivealarms
      with:
        severity: tools.severity
        neDn: tools.neDn
        alarmType: tools.alarmType
        fromTime: tools.fromTime
        limit: tools.limit
      inputParameters:
      - name: severity
        type: string
        description: severity
      - name: neDn
        type: string
        description: Distinguished Name of the source NE
      - name: alarmType
        type: string
        description: alarmType
      - name: fromTime
        type: string
        description: fromTime
      - name: limit
        type: integer
        description: limit
      outputParameters:
      - type: object
        mapping: $.
    - name: getalarm
      description: Get alarm details
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: nokia-netact.getalarm
      with:
        alarmId: tools.alarmId
      inputParameters:
      - name: alarmId
        type: string
        description: alarmId
        required: true
      outputParameters:
      - type: object
        mapping: $.
    - name: acknowledgealarm
      description: Acknowledge an alarm
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: nokia-netact.acknowledgealarm
      with:
        alarmId: tools.alarmId
      inputParameters:
      - name: alarmId
        type: string
        description: alarmId
        required: true
      outputParameters:
      - type: object
        mapping: $.
    - name: getperformancekpis
      description: Get KPI performance counters
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: nokia-netact.getperformancekpis
      with:
        neDn: tools.neDn
        kpiGroup: tools.kpiGroup
        granularity: tools.granularity
        startTime: tools.startTime
        endTime: tools.endTime
      inputParameters:
      - name: neDn
        type: string
        description: DN of the network element or subtree root
        required: true
      - name: kpiGroup
        type: string
        description: KPI group name (e.g., ACCESSIBILITY, RETAINABILITY, TRAFFIC)
      - name: granularity
        type: string
        description: Measurement granularity (ISO 8601 duration)
      - name: startTime
        type: string
        description: startTime
        required: true
      - name: endTime
        type: string
        description: endTime
        required: true
      outputParameters:
      - type: object
        mapping: $.
    - name: getnetworkelementattributes
      description: Get managed object attributes
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: nokia-netact.getnetworkelementattributes
      with:
        distinguishedName: tools.distinguishedName
        attributes: tools.attributes
      inputParameters:
      - name: distinguishedName
        type: string
        description: distinguishedName
        required: true
      - name: attributes
        type: string
        description: Comma-separated list of attribute names to retrieve (all if omitted)
      outputParameters:
      - type: object
        mapping: $.
    - name: updatenetworkelementattributes
      description: Modify managed object attributes
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: nokia-netact.updatenetworkelementattributes
      with:
        distinguishedName: tools.distinguishedName
      inputParameters:
      - name: distinguishedName
        type: string
        description: distinguishedName
        required: true
      outputParameters:
      - type: object
        mapping: $.
binds:
- namespace: env
  keys:
    NOKIA_NETACT_TOKEN: NOKIA_NETACT_TOKEN