SigNoz — gateway

naftiko: 1.0.0-alpha2
info:
  label: SigNoz — gateway
  description: 'SigNoz — gateway. 8 operations. Lead operation: Get ingestion keys for workspace. Self-contained Naftiko capability
    covering one Signoz business surface.'
  tags:
  - Signoz
  - gateway
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    SIGNOZ_API_KEY: SIGNOZ_API_KEY
capability:
  consumes:
  - type: http
    namespace: signoz-gateway
    baseUri: https://{host}:{port}{base_path}
    description: SigNoz — gateway business capability. Self-contained, no shared references.
    resources:
    - name: api-v2-gateway-ingestion_keys
      path: /api/v2/gateway/ingestion_keys
      operations:
      - name: getingestionkeys
        method: GET
        description: Get ingestion keys for workspace
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: page
          in: query
          type: integer
        - name: per_page
          in: query
          type: integer
      - name: createingestionkey
        method: POST
        description: Create ingestion key for workspace
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: api-v2-gateway-ingestion_keys-limits-limitId
      path: /api/v2/gateway/ingestion_keys/limits/{limitId}
      operations:
      - name: deleteingestionkeylimit
        method: DELETE
        description: Delete limit for the ingestion key
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: limitId
          in: path
          type: string
          required: true
      - name: updateingestionkeylimit
        method: PATCH
        description: Update limit for the ingestion key
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: limitId
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: api-v2-gateway-ingestion_keys-search
      path: /api/v2/gateway/ingestion_keys/search
      operations:
      - name: searchingestionkeys
        method: GET
        description: Search ingestion keys for workspace
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: name
          in: query
          type: string
          required: true
        - name: page
          in: query
          type: integer
        - name: per_page
          in: query
          type: integer
    - name: api-v2-gateway-ingestion_keys-keyId
      path: /api/v2/gateway/ingestion_keys/{keyId}
      operations:
      - name: deleteingestionkey
        method: DELETE
        description: Delete ingestion key for workspace
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: keyId
          in: path
          type: string
          required: true
      - name: updateingestionkey
        method: PATCH
        description: Update ingestion key for workspace
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: keyId
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: api-v2-gateway-ingestion_keys-keyId-limits
      path: /api/v2/gateway/ingestion_keys/{keyId}/limits
      operations:
      - name: createingestionkeylimit
        method: POST
        description: Create limit for the ingestion key
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: keyId
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    authentication:
      type: bearer
      token: '{{env.SIGNOZ_API_KEY}}'
  exposes:
  - type: rest
    namespace: signoz-gateway-rest
    port: 8080
    description: REST adapter for SigNoz — gateway. One Spectral-compliant resource per consumed operation, prefixed with
      /v1.
    resources:
    - path: /v1/api/v2/gateway/ingestion-keys
      name: api-v2-gateway-ingestion-keys
      description: REST surface for api-v2-gateway-ingestion_keys.
      operations:
      - method: GET
        name: getingestionkeys
        description: Get ingestion keys for workspace
        call: signoz-gateway.getingestionkeys
        with:
          page: rest.page
          per_page: rest.per_page
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createingestionkey
        description: Create ingestion key for workspace
        call: signoz-gateway.createingestionkey
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/v2/gateway/ingestion-keys/limits/{limitid}
      name: api-v2-gateway-ingestion-keys-limits-limitid
      description: REST surface for api-v2-gateway-ingestion_keys-limits-limitId.
      operations:
      - method: DELETE
        name: deleteingestionkeylimit
        description: Delete limit for the ingestion key
        call: signoz-gateway.deleteingestionkeylimit
        with:
          limitId: rest.limitId
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: updateingestionkeylimit
        description: Update limit for the ingestion key
        call: signoz-gateway.updateingestionkeylimit
        with:
          limitId: rest.limitId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/v2/gateway/ingestion-keys/search
      name: api-v2-gateway-ingestion-keys-search
      description: REST surface for api-v2-gateway-ingestion_keys-search.
      operations:
      - method: GET
        name: searchingestionkeys
        description: Search ingestion keys for workspace
        call: signoz-gateway.searchingestionkeys
        with:
          name: rest.name
          page: rest.page
          per_page: rest.per_page
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/v2/gateway/ingestion-keys/{keyid}
      name: api-v2-gateway-ingestion-keys-keyid
      description: REST surface for api-v2-gateway-ingestion_keys-keyId.
      operations:
      - method: DELETE
        name: deleteingestionkey
        description: Delete ingestion key for workspace
        call: signoz-gateway.deleteingestionkey
        with:
          keyId: rest.keyId
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: updateingestionkey
        description: Update ingestion key for workspace
        call: signoz-gateway.updateingestionkey
        with:
          keyId: rest.keyId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/v2/gateway/ingestion-keys/{keyid}/limits
      name: api-v2-gateway-ingestion-keys-keyid-limits
      description: REST surface for api-v2-gateway-ingestion_keys-keyId-limits.
      operations:
      - method: POST
        name: createingestionkeylimit
        description: Create limit for the ingestion key
        call: signoz-gateway.createingestionkeylimit
        with:
          keyId: rest.keyId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: signoz-gateway-mcp
    port: 9090
    transport: http
    description: MCP adapter for SigNoz — gateway. One tool per consumed operation, routed inline through this capability's
      consumes block.
    tools:
    - name: get-ingestion-keys-workspace
      description: Get ingestion keys for workspace
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: signoz-gateway.getingestionkeys
      with:
        page: tools.page
        per_page: tools.per_page
      outputParameters:
      - type: object
        mapping: $.
    - name: create-ingestion-key-workspace
      description: Create ingestion key for workspace
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: signoz-gateway.createingestionkey
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-limit-ingestion-key
      description: Delete limit for the ingestion key
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: signoz-gateway.deleteingestionkeylimit
      with:
        limitId: tools.limitId
      outputParameters:
      - type: object
        mapping: $.
    - name: update-limit-ingestion-key
      description: Update limit for the ingestion key
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: signoz-gateway.updateingestionkeylimit
      with:
        limitId: tools.limitId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: search-ingestion-keys-workspace
      description: Search ingestion keys for workspace
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: signoz-gateway.searchingestionkeys
      with:
        name: tools.name
        page: tools.page
        per_page: tools.per_page
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-ingestion-key-workspace
      description: Delete ingestion key for workspace
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: signoz-gateway.deleteingestionkey
      with:
        keyId: tools.keyId
      outputParameters:
      - type: object
        mapping: $.
    - name: update-ingestion-key-workspace
      description: Update ingestion key for workspace
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: signoz-gateway.updateingestionkey
      with:
        keyId: tools.keyId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: create-limit-ingestion-key
      description: Create limit for the ingestion key
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: signoz-gateway.createingestionkeylimit
      with:
        keyId: tools.keyId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.