SearchStax · Capability

SearchStax Provisioning API — Backup

SearchStax Provisioning API — Backup. 2 operations. Lead operation: List Backups. Self-contained Naftiko capability covering one Searchstax business surface.

Run with Naftiko SearchstaxBackup

What You Can Do

GET
Listbackups — List Backups
/v1/account/{account-name}/deployment/{uid}/backup
POST
Createbackup — Create Backup
/v1/account/{account-name}/deployment/{uid}/backup

MCP Tools

list-backups

List Backups

read-only idempotent
create-backup

Create Backup

Capability Spec

provisioning-backup.yaml Raw ↑
naftiko: 1.0.0-alpha2
info:
  label: SearchStax Provisioning API — Backup
  description: 'SearchStax Provisioning API — Backup. 2 operations. Lead operation: List Backups. Self-contained Naftiko capability
    covering one Searchstax business surface.'
  tags:
  - Searchstax
  - Backup
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    SEARCHSTAX_API_KEY: SEARCHSTAX_API_KEY
capability:
  consumes:
  - type: http
    namespace: provisioning-backup
    baseUri: https://app.searchstax.com/api/rest/v2
    description: SearchStax Provisioning API — Backup business capability. Self-contained, no shared references.
    resources:
    - name: account-account_name-deployment-uid-backup
      path: /account/{account_name}/deployment/{uid}/backup/
      operations:
      - name: listbackups
        method: GET
        description: List Backups
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: createbackup
        method: POST
        description: Create Backup
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    authentication:
      type: bearer
      token: '{{env.SEARCHSTAX_API_KEY}}'
  exposes:
  - type: rest
    namespace: provisioning-backup-rest
    port: 8080
    description: REST adapter for SearchStax Provisioning API — Backup. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/account/{account-name}/deployment/{uid}/backup
      name: account-account-name-deployment-uid-backup
      description: REST surface for account-account_name-deployment-uid-backup.
      operations:
      - method: GET
        name: listbackups
        description: List Backups
        call: provisioning-backup.listbackups
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createbackup
        description: Create Backup
        call: provisioning-backup.createbackup
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: provisioning-backup-mcp
    port: 9090
    transport: http
    description: MCP adapter for SearchStax Provisioning API — Backup. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: list-backups
      description: List Backups
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: provisioning-backup.listbackups
      outputParameters:
      - type: object
        mapping: $.
    - name: create-backup
      description: Create Backup
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: provisioning-backup.createbackup
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.