NetBox · Capability

NetBox REST API — status

NetBox REST API — status. 1 operations. Lead operation: status. Self-contained Naftiko capability covering one Netbox business surface.

Run with Naftiko Netboxstatus

What You Can Do

GET
Statusretrieve — A lightweight read-only endpoint for conveying NetBox's current operational status.
/v1/api/status

MCP Tools

lightweight-read-only-endpoint-conveying

A lightweight read-only endpoint for conveying NetBox's current operational status.

read-only idempotent

Capability Spec

netbox-status.yaml Raw ↑
naftiko: 1.0.0-alpha2
info:
  label: NetBox REST API — status
  description: 'NetBox REST API — status. 1 operations. Lead operation: status. Self-contained Naftiko capability covering
    one Netbox business surface.'
  tags:
  - Netbox
  - status
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    NETBOX_API_KEY: NETBOX_API_KEY
capability:
  consumes:
  - type: http
    namespace: netbox-status
    baseUri: ''
    description: NetBox REST API — status business capability. Self-contained, no shared references.
    resources:
    - name: api-status
      path: /api/status/
      operations:
      - name: statusretrieve
        method: GET
        description: A lightweight read-only endpoint for conveying NetBox's current operational status.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    authentication:
      type: apikey
      key: sessionid
      value: '{{env.NETBOX_API_KEY}}'
      placement: cookie
  exposes:
  - type: rest
    namespace: netbox-status-rest
    port: 8080
    description: REST adapter for NetBox REST API — status. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/api/status
      name: api-status
      description: REST surface for api-status.
      operations:
      - method: GET
        name: statusretrieve
        description: A lightweight read-only endpoint for conveying NetBox's current operational status.
        call: netbox-status.statusretrieve
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: netbox-status-mcp
    port: 9090
    transport: http
    description: MCP adapter for NetBox REST API — status. One tool per consumed operation, routed inline through this capability's
      consumes block.
    tools:
    - name: lightweight-read-only-endpoint-conveying
      description: A lightweight read-only endpoint for conveying NetBox's current operational status.
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: netbox-status.statusretrieve
      outputParameters:
      - type: object
        mapping: $.