API Reference — AlertService

naftiko: 1.0.0-alpha2
info:
  label: API Reference — AlertService
  description: 'API Reference — AlertService. 10 operations. Lead operation: List returns the slim list version of the alerts..
    Self-contained Naftiko capability covering one Stackrox business surface.'
  tags:
  - Stackrox
  - AlertService
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    STACKROX_API_KEY: STACKROX_API_KEY
capability:
  consumes:
  - type: http
    namespace: stackrox-alertservice
    baseUri: https://{central-host}
    description: API Reference — AlertService business capability. Self-contained, no shared references.
    resources:
    - name: v1-alerts
      path: /v1/alerts
      operations:
      - name: listalerts
        method: GET
        description: List returns the slim list version of the alerts.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: query
          in: query
          type: string
        - name: pagination.limit
          in: query
          type: integer
        - name: pagination.offset
          in: query
          type: integer
        - name: pagination.sort_option.field
          in: query
          type: string
        - name: pagination.sort_option.reversed
          in: query
          type: boolean
      - name: deletealerts
        method: DELETE
        description: ''
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: query.query
          in: query
          type: string
        - name: query.pagination.limit
          in: query
          type: integer
        - name: query.pagination.offset
          in: query
          type: integer
        - name: query.pagination.sort_option.field
          in: query
          type: string
        - name: query.pagination.sort_option.reversed
          in: query
          type: boolean
        - name: confirm
          in: query
          type: boolean
    - name: v1-alerts-resolve
      path: /v1/alerts/resolve
      operations:
      - name: resolvealerts
        method: PATCH
        description: ResolveAlertsByQuery marks alerts matching search query as resolved.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: v1-alerts-summary-counts
      path: /v1/alerts/summary/counts
      operations:
      - name: getalertscounts
        method: GET
        description: GetAlertsCounts returns the number of alerts in the requested cluster or category.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: request.query
          in: query
          type: string
        - name: request.pagination.limit
          in: query
          type: integer
        - name: request.pagination.offset
          in: query
          type: integer
        - name: request.pagination.sort_option.field
          in: query
          type: string
        - name: request.pagination.sort_option.reversed
          in: query
          type: boolean
        - name: groupBy
          in: query
          type: string
    - name: v1-alerts-summary-groups
      path: /v1/alerts/summary/groups
      operations:
      - name: getalertsgroup
        method: GET
        description: GetAlertsGroup returns alerts grouped by policy.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: query
          in: query
          type: string
        - name: pagination.limit
          in: query
          type: integer
        - name: pagination.offset
          in: query
          type: integer
        - name: pagination.sort_option.field
          in: query
          type: string
        - name: pagination.sort_option.reversed
          in: query
          type: boolean
    - name: v1-alerts-summary-timeseries
      path: /v1/alerts/summary/timeseries
      operations:
      - name: getalerttimeseries
        method: GET
        description: GetAlertTimeseries returns the alerts sorted by time.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: query
          in: query
          type: string
        - name: pagination.limit
          in: query
          type: integer
        - name: pagination.offset
          in: query
          type: integer
        - name: pagination.sort_option.field
          in: query
          type: string
        - name: pagination.sort_option.reversed
          in: query
          type: boolean
    - name: v1-alerts-id
      path: /v1/alerts/{id}
      operations:
      - name: getalert
        method: GET
        description: GetAlert returns the alert given its id.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          required: true
    - name: v1-alerts-id-resolve
      path: /v1/alerts/{id}/resolve
      operations:
      - name: resolvealert
        method: PATCH
        description: ResolveAlert marks the given alert (by ID) as resolved.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: v1-alerts-id-snooze
      path: /v1/alerts/{id}/snooze
      operations:
      - name: snoozealert
        method: PATCH
        description: SnoozeAlert is deprecated.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: v1-alertscount
      path: /v1/alertscount
      operations:
      - name: countalerts
        method: GET
        description: CountAlerts counts how many alerts match the get request.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: query
          in: query
          type: string
        - name: pagination.limit
          in: query
          type: integer
        - name: pagination.offset
          in: query
          type: integer
        - name: pagination.sort_option.field
          in: query
          type: string
        - name: pagination.sort_option.reversed
          in: query
          type: boolean
    authentication:
      type: apikey
      key: Authorization
      value: '{{env.STACKROX_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: stackrox-alertservice-rest
    port: 8080
    description: REST adapter for API Reference — AlertService. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/v1/alerts
      name: v1-alerts
      description: REST surface for v1-alerts.
      operations:
      - method: GET
        name: listalerts
        description: List returns the slim list version of the alerts.
        call: stackrox-alertservice.listalerts
        with:
          query: rest.query
          pagination.limit: rest.pagination.limit
          pagination.offset: rest.pagination.offset
          pagination.sort_option.field: rest.pagination.sort_option.field
          pagination.sort_option.reversed: rest.pagination.sort_option.reversed
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletealerts
        description: deletealerts
        call: stackrox-alertservice.deletealerts
        with:
          query.query: rest.query.query
          query.pagination.limit: rest.query.pagination.limit
          query.pagination.offset: rest.query.pagination.offset
          query.pagination.sort_option.field: rest.query.pagination.sort_option.field
          query.pagination.sort_option.reversed: rest.query.pagination.sort_option.reversed
          confirm: rest.confirm
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/alerts/resolve
      name: v1-alerts-resolve
      description: REST surface for v1-alerts-resolve.
      operations:
      - method: PATCH
        name: resolvealerts
        description: ResolveAlertsByQuery marks alerts matching search query as resolved.
        call: stackrox-alertservice.resolvealerts
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/alerts/summary/counts
      name: v1-alerts-summary-counts
      description: REST surface for v1-alerts-summary-counts.
      operations:
      - method: GET
        name: getalertscounts
        description: GetAlertsCounts returns the number of alerts in the requested cluster or category.
        call: stackrox-alertservice.getalertscounts
        with:
          request.query: rest.request.query
          request.pagination.limit: rest.request.pagination.limit
          request.pagination.offset: rest.request.pagination.offset
          request.pagination.sort_option.field: rest.request.pagination.sort_option.field
          request.pagination.sort_option.reversed: rest.request.pagination.sort_option.reversed
          groupBy: rest.groupBy
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/alerts/summary/groups
      name: v1-alerts-summary-groups
      description: REST surface for v1-alerts-summary-groups.
      operations:
      - method: GET
        name: getalertsgroup
        description: GetAlertsGroup returns alerts grouped by policy.
        call: stackrox-alertservice.getalertsgroup
        with:
          query: rest.query
          pagination.limit: rest.pagination.limit
          pagination.offset: rest.pagination.offset
          pagination.sort_option.field: rest.pagination.sort_option.field
          pagination.sort_option.reversed: rest.pagination.sort_option.reversed
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/alerts/summary/timeseries
      name: v1-alerts-summary-timeseries
      description: REST surface for v1-alerts-summary-timeseries.
      operations:
      - method: GET
        name: getalerttimeseries
        description: GetAlertTimeseries returns the alerts sorted by time.
        call: stackrox-alertservice.getalerttimeseries
        with:
          query: rest.query
          pagination.limit: rest.pagination.limit
          pagination.offset: rest.pagination.offset
          pagination.sort_option.field: rest.pagination.sort_option.field
          pagination.sort_option.reversed: rest.pagination.sort_option.reversed
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/alerts/{id}
      name: v1-alerts-id
      description: REST surface for v1-alerts-id.
      operations:
      - method: GET
        name: getalert
        description: GetAlert returns the alert given its id.
        call: stackrox-alertservice.getalert
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/alerts/{id}/resolve
      name: v1-alerts-id-resolve
      description: REST surface for v1-alerts-id-resolve.
      operations:
      - method: PATCH
        name: resolvealert
        description: ResolveAlert marks the given alert (by ID) as resolved.
        call: stackrox-alertservice.resolvealert
        with:
          id: rest.id
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/alerts/{id}/snooze
      name: v1-alerts-id-snooze
      description: REST surface for v1-alerts-id-snooze.
      operations:
      - method: PATCH
        name: snoozealert
        description: SnoozeAlert is deprecated.
        call: stackrox-alertservice.snoozealert
        with:
          id: rest.id
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/alertscount
      name: v1-alertscount
      description: REST surface for v1-alertscount.
      operations:
      - method: GET
        name: countalerts
        description: CountAlerts counts how many alerts match the get request.
        call: stackrox-alertservice.countalerts
        with:
          query: rest.query
          pagination.limit: rest.pagination.limit
          pagination.offset: rest.pagination.offset
          pagination.sort_option.field: rest.pagination.sort_option.field
          pagination.sort_option.reversed: rest.pagination.sort_option.reversed
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: stackrox-alertservice-mcp
    port: 9090
    transport: http
    description: MCP adapter for API Reference — AlertService. One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: list-returns-slim-list-version
      description: List returns the slim list version of the alerts.
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: stackrox-alertservice.listalerts
      with:
        query: tools.query
        pagination.limit: tools.pagination.limit
        pagination.offset: tools.pagination.offset
        pagination.sort_option.field: tools.pagination.sort_option.field
        pagination.sort_option.reversed: tools.pagination.sort_option.reversed
      outputParameters:
      - type: object
        mapping: $.
    - name: deletealerts
      description: deletealerts
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: stackrox-alertservice.deletealerts
      with:
        query.query: tools.query.query
        query.pagination.limit: tools.query.pagination.limit
        query.pagination.offset: tools.query.pagination.offset
        query.pagination.sort_option.field: tools.query.pagination.sort_option.field
        query.pagination.sort_option.reversed: tools.query.pagination.sort_option.reversed
        confirm: tools.confirm
      outputParameters:
      - type: object
        mapping: $.
    - name: resolvealertsbyquery-marks-alerts-matching-search
      description: ResolveAlertsByQuery marks alerts matching search query as resolved.
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: stackrox-alertservice.resolvealerts
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: getalertscounts-returns-number-alerts-requested
      description: GetAlertsCounts returns the number of alerts in the requested cluster or category.
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: stackrox-alertservice.getalertscounts
      with:
        request.query: tools.request.query
        request.pagination.limit: tools.request.pagination.limit
        request.pagination.offset: tools.request.pagination.offset
        request.pagination.sort_option.field: tools.request.pagination.sort_option.field
        request.pagination.sort_option.reversed: tools.request.pagination.sort_option.reversed
        groupBy: tools.groupBy
      outputParameters:
      - type: object
        mapping: $.
    - name: getalertsgroup-returns-alerts-grouped-policy
      description: GetAlertsGroup returns alerts grouped by policy.
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: stackrox-alertservice.getalertsgroup
      with:
        query: tools.query
        pagination.limit: tools.pagination.limit
        pagination.offset: tools.pagination.offset
        pagination.sort_option.field: tools.pagination.sort_option.field
        pagination.sort_option.reversed: tools.pagination.sort_option.reversed
      outputParameters:
      - type: object
        mapping: $.
    - name: getalerttimeseries-returns-alerts-sorted-time
      description: GetAlertTimeseries returns the alerts sorted by time.
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: stackrox-alertservice.getalerttimeseries
      with:
        query: tools.query
        pagination.limit: tools.pagination.limit
        pagination.offset: tools.pagination.offset
        pagination.sort_option.field: tools.pagination.sort_option.field
        pagination.sort_option.reversed: tools.pagination.sort_option.reversed
      outputParameters:
      - type: object
        mapping: $.
    - name: getalert-returns-alert-given-its
      description: GetAlert returns the alert given its id.
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: stackrox-alertservice.getalert
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.
    - name: resolvealert-marks-given-alert-id
      description: ResolveAlert marks the given alert (by ID) as resolved.
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: stackrox-alertservice.resolvealert
      with:
        id: tools.id
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: snoozealert-is-deprecated
      description: SnoozeAlert is deprecated.
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: stackrox-alertservice.snoozealert
      with:
        id: tools.id
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: countalerts-counts-how-many-alerts
      description: CountAlerts counts how many alerts match the get request.
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: stackrox-alertservice.countalerts
      with:
        query: tools.query
        pagination.limit: tools.pagination.limit
        pagination.offset: tools.pagination.offset
        pagination.sort_option.field: tools.pagination.sort_option.field
        pagination.sort_option.reversed: tools.pagination.sort_option.reversed
      outputParameters:
      - type: object
        mapping: $.