API Reference — ExternalBackupService

naftiko: 1.0.0-alpha2
info:
  label: API Reference — ExternalBackupService
  description: 'API Reference — ExternalBackupService. 7 operations. Lead operation: ExternalBackupService. Self-contained
    Naftiko capability covering one Stackrox business surface.'
  tags:
  - Stackrox
  - ExternalBackupService
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    STACKROX_API_KEY: STACKROX_API_KEY
capability:
  consumes:
  - type: http
    namespace: stackrox-externalbackupservice
    baseUri: https://{central-host}
    description: API Reference — ExternalBackupService business capability. Self-contained, no shared references.
    resources:
    - name: v1-externalbackups
      path: /v1/externalbackups
      operations:
      - name: getexternalbackups
        method: GET
        description: ''
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: postexternalbackup
        method: POST
        description: ''
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: v1-externalbackups-test
      path: /v1/externalbackups/test
      operations:
      - name: testexternalbackup
        method: POST
        description: ''
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: v1-externalbackups-id
      path: /v1/externalbackups/{id}
      operations:
      - name: getexternalbackup
        method: GET
        description: ''
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          required: true
      - name: deleteexternalbackup
        method: DELETE
        description: ''
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          required: true
      - name: triggerexternalbackup
        method: POST
        description: ''
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          required: true
      - name: putexternalbackup
        method: PUT
        description: ''
        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: false
    authentication:
      type: apikey
      key: Authorization
      value: '{{env.STACKROX_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: stackrox-externalbackupservice-rest
    port: 8080
    description: REST adapter for API Reference — ExternalBackupService. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/v1/externalbackups
      name: v1-externalbackups
      description: REST surface for v1-externalbackups.
      operations:
      - method: GET
        name: getexternalbackups
        description: getexternalbackups
        call: stackrox-externalbackupservice.getexternalbackups
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: postexternalbackup
        description: postexternalbackup
        call: stackrox-externalbackupservice.postexternalbackup
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/externalbackups/test
      name: v1-externalbackups-test
      description: REST surface for v1-externalbackups-test.
      operations:
      - method: POST
        name: testexternalbackup
        description: testexternalbackup
        call: stackrox-externalbackupservice.testexternalbackup
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/externalbackups/{id}
      name: v1-externalbackups-id
      description: REST surface for v1-externalbackups-id.
      operations:
      - method: GET
        name: getexternalbackup
        description: getexternalbackup
        call: stackrox-externalbackupservice.getexternalbackup
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deleteexternalbackup
        description: deleteexternalbackup
        call: stackrox-externalbackupservice.deleteexternalbackup
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: triggerexternalbackup
        description: triggerexternalbackup
        call: stackrox-externalbackupservice.triggerexternalbackup
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: putexternalbackup
        description: putexternalbackup
        call: stackrox-externalbackupservice.putexternalbackup
        with:
          id: rest.id
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: stackrox-externalbackupservice-mcp
    port: 9090
    transport: http
    description: MCP adapter for API Reference — ExternalBackupService. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: getexternalbackups
      description: getexternalbackups
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: stackrox-externalbackupservice.getexternalbackups
      outputParameters:
      - type: object
        mapping: $.
    - name: postexternalbackup
      description: postexternalbackup
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: stackrox-externalbackupservice.postexternalbackup
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: testexternalbackup
      description: testexternalbackup
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: stackrox-externalbackupservice.testexternalbackup
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: getexternalbackup
      description: getexternalbackup
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: stackrox-externalbackupservice.getexternalbackup
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.
    - name: deleteexternalbackup
      description: deleteexternalbackup
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: stackrox-externalbackupservice.deleteexternalbackup
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.
    - name: triggerexternalbackup
      description: triggerexternalbackup
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: stackrox-externalbackupservice.triggerexternalbackup
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.
    - name: putexternalbackup
      description: putexternalbackup
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: stackrox-externalbackupservice.putexternalbackup
      with:
        id: tools.id
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.