NetBox · Capability

NetBox REST API — authentication-check

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

Run with Naftiko Netboxauthentication-check

What You Can Do

GET
Authenticationcheckretrieve — Return the user making the request, if authenticated successfully.
/v1/api/authentication-check

MCP Tools

return-user-making-request-if

Return the user making the request, if authenticated successfully.

read-only idempotent

Capability Spec

netbox-authentication-check.yaml Raw ↑
naftiko: 1.0.0-alpha2
info:
  label: NetBox REST API — authentication-check
  description: 'NetBox REST API — authentication-check. 1 operations. Lead operation: authentication-check. Self-contained
    Naftiko capability covering one Netbox business surface.'
  tags:
  - Netbox
  - authentication-check
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    NETBOX_API_KEY: NETBOX_API_KEY
capability:
  consumes:
  - type: http
    namespace: netbox-authentication-check
    baseUri: ''
    description: NetBox REST API — authentication-check business capability. Self-contained, no shared references.
    resources:
    - name: api-authentication-check
      path: /api/authentication-check/
      operations:
      - name: authenticationcheckretrieve
        method: GET
        description: Return the user making the request, if authenticated successfully.
        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-authentication-check-rest
    port: 8080
    description: REST adapter for NetBox REST API — authentication-check. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/api/authentication-check
      name: api-authentication-check
      description: REST surface for api-authentication-check.
      operations:
      - method: GET
        name: authenticationcheckretrieve
        description: Return the user making the request, if authenticated successfully.
        call: netbox-authentication-check.authenticationcheckretrieve
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: netbox-authentication-check-mcp
    port: 9090
    transport: http
    description: MCP adapter for NetBox REST API — authentication-check. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: return-user-making-request-if
      description: Return the user making the request, if authenticated successfully.
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: netbox-authentication-check.authenticationcheckretrieve
      outputParameters:
      - type: object
        mapping: $.