NGINX · Capability

NGINX Plus REST API — General Info

NGINX Plus REST API — General Info. 2 operations. Lead operation: NGINX Return List of Root Endpoints. Self-contained Naftiko capability covering one Nginx business surface.

Run with Naftiko NginxGeneral Info

What You Can Do

GET

Getapiendpoints — NGINX Return List of Root Endpoints

/v1

GET

Getnginx — NGINX Return Status of NGINX Running Instance

/v1/nginx

MCP Tools

nginx-return-list-root-endpoints

NGINX Return List of Root Endpoints

read-only idempotent

nginx-return-status-nginx-running

NGINX Return Status of NGINX Running Instance

read-only idempotent

Capability Spec

naftiko: 1.0.0-alpha2
info:
  label: NGINX Plus REST API — General Info
  description: 'NGINX Plus REST API — General Info. 2 operations. Lead operation: NGINX Return List of Root Endpoints. Self-contained
    Naftiko capability covering one Nginx business surface.'
  tags:
  - Nginx
  - General Info
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    NGINX_API_KEY: NGINX_API_KEY
capability:
  consumes:
  - type: http
    namespace: plus-http-general-info
    baseUri: ''
    description: NGINX Plus REST API — General Info business capability. Self-contained, no shared references.
    resources:
    - name: root
      path: /
      operations:
      - name: getapiendpoints
        method: GET
        description: NGINX Return List of Root Endpoints
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: nginx
      path: /nginx
      operations:
      - name: getnginx
        method: GET
        description: NGINX Return Status of NGINX Running Instance
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: fields
          in: query
          type: string
          description: Limits which fields of nginx running instance will be output.
  exposes:
  - type: rest
    namespace: plus-http-general-info-rest
    port: 8080
    description: REST adapter for NGINX Plus REST API — General Info. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1
      name: root
      description: REST surface for root.
      operations:
      - method: GET
        name: getapiendpoints
        description: NGINX Return List of Root Endpoints
        call: plus-http-general-info.getapiendpoints
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/nginx
      name: nginx
      description: REST surface for nginx.
      operations:
      - method: GET
        name: getnginx
        description: NGINX Return Status of NGINX Running Instance
        call: plus-http-general-info.getnginx
        with:
          fields: rest.fields
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: plus-http-general-info-mcp
    port: 9090
    transport: http
    description: MCP adapter for NGINX Plus REST API — General Info. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: nginx-return-list-root-endpoints
      description: NGINX Return List of Root Endpoints
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: plus-http-general-info.getapiendpoints
      outputParameters:
      - type: object
        mapping: $.
    - name: nginx-return-status-nginx-running
      description: NGINX Return Status of NGINX Running Instance
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: plus-http-general-info.getnginx
      with:
        fields: tools.fields
      outputParameters:
      - type: object
        mapping: $.