API Reference — DBService

naftiko: 1.0.0-alpha2
info:
  label: API Reference — DBService
  description: 'API Reference — DBService. 4 operations. Lead operation: DBService. Self-contained Naftiko capability covering
    one Stackrox business surface.'
  tags:
  - Stackrox
  - DBService
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    STACKROX_API_KEY: STACKROX_API_KEY
capability:
  consumes:
  - type: http
    namespace: stackrox-dbservice
    baseUri: https://{central-host}
    description: API Reference — DBService business capability. Self-contained, no shared references.
    resources:
    - name: v1-db-exportcaps
      path: /v1/db/exportcaps
      operations:
      - name: getexportcapabilities
        method: GET
        description: ''
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: v1-db-interruptrestore-processId-attemptId
      path: /v1/db/interruptrestore/{processId}/{attemptId}
      operations:
      - name: interruptrestoreprocess
        method: POST
        description: ''
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: processId
          in: path
          type: string
          required: true
        - name: attemptId
          in: path
          type: string
          required: true
    - name: v1-db-restore
      path: /v1/db/restore
      operations:
      - name: getactiverestoreprocess
        method: GET
        description: ''
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: v1-db-restore-id
      path: /v1/db/restore/{id}
      operations:
      - name: cancelrestoreprocess
        method: DELETE
        description: ''
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          required: true
    authentication:
      type: apikey
      key: Authorization
      value: '{{env.STACKROX_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: stackrox-dbservice-rest
    port: 8080
    description: REST adapter for API Reference — DBService. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/v1/db/exportcaps
      name: v1-db-exportcaps
      description: REST surface for v1-db-exportcaps.
      operations:
      - method: GET
        name: getexportcapabilities
        description: getexportcapabilities
        call: stackrox-dbservice.getexportcapabilities
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/db/interruptrestore/{processid}/{attemptid}
      name: v1-db-interruptrestore-processid-attemptid
      description: REST surface for v1-db-interruptrestore-processId-attemptId.
      operations:
      - method: POST
        name: interruptrestoreprocess
        description: interruptrestoreprocess
        call: stackrox-dbservice.interruptrestoreprocess
        with:
          processId: rest.processId
          attemptId: rest.attemptId
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/db/restore
      name: v1-db-restore
      description: REST surface for v1-db-restore.
      operations:
      - method: GET
        name: getactiverestoreprocess
        description: getactiverestoreprocess
        call: stackrox-dbservice.getactiverestoreprocess
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/db/restore/{id}
      name: v1-db-restore-id
      description: REST surface for v1-db-restore-id.
      operations:
      - method: DELETE
        name: cancelrestoreprocess
        description: cancelrestoreprocess
        call: stackrox-dbservice.cancelrestoreprocess
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: stackrox-dbservice-mcp
    port: 9090
    transport: http
    description: MCP adapter for API Reference — DBService. One tool per consumed operation, routed inline through this capability's
      consumes block.
    tools:
    - name: getexportcapabilities
      description: getexportcapabilities
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: stackrox-dbservice.getexportcapabilities
      outputParameters:
      - type: object
        mapping: $.
    - name: interruptrestoreprocess
      description: interruptrestoreprocess
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: stackrox-dbservice.interruptrestoreprocess
      with:
        processId: tools.processId
        attemptId: tools.attemptId
      outputParameters:
      - type: object
        mapping: $.
    - name: getactiverestoreprocess
      description: getactiverestoreprocess
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: stackrox-dbservice.getactiverestoreprocess
      outputParameters:
      - type: object
        mapping: $.
    - name: cancelrestoreprocess
      description: cancelrestoreprocess
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: stackrox-dbservice.cancelrestoreprocess
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.