Coveo Migration API — Vault

naftiko: 1.0.0-alpha2
info:
  label: Coveo Migration API — Vault
  description: 'Coveo Migration API — Vault. 7 operations. Lead operation: Get All Vault Entries for an Organization. Self-contained
    Naftiko capability covering one Coveo business surface.'
  tags:
  - Coveo
  - Migration
  - Vault
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    COVEO_API_KEY: COVEO_API_KEY
capability:
  consumes:
  - type: http
    namespace: migration-vault
    baseUri: https://platform.cloud.coveo.com
    description: Coveo Migration API — Vault business capability. Self-contained, no shared references.
    authentication:
      type: bearer
      token: '{{env.COVEO_API_KEY}}'
    resources:
    - name: rest-organizations-organizationId-vaultentries
      path: /rest/organizations/{organizationId}/vaultentries
      operations:
      - name: getallvaultentries
        method: GET
        description: Get All Vault Entries for an Organization
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          required: true
        - name: page
          in: query
          type: integer
        - name: pageSize
          in: query
          type: integer
      - name: createvaultentry
        method: POST
        description: Create a Vault Entry
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: rest-organizations-organizationId-vaultentries-fetch
      path: /rest/organizations/{organizationId}/vaultentries/fetch
      operations:
      - name: fetchvaultentries
        method: PUT
        description: Fetches Vault Entries Referenced in a Specific Snapshot from a Given Organization
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          required: true
        - name: referenceSnapshotId
          in: query
          type: string
          required: true
        - name: sourceOrganizationId
          in: query
          type: string
          required: true
        - name: fetchStrategy
          in: query
          type: string
    - name: rest-organizations-organizationId-vaultentries-missing
      path: /rest/organizations/{organizationId}/vaultentries/missing
      operations:
      - name: getsnapshotvaultentrystate
        method: GET
        description: Retrieve State of Vault Entries for Specified Snapshot
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          required: true
        - name: snapshotId
          in: query
          type: string
          required: true
    - name: rest-organizations-organizationId-vaultentries-key
      path: /rest/organizations/{organizationId}/vaultentries/{key}
      operations:
      - name: getvaultentry
        method: GET
        description: Get a Single Vault Entry
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          required: true
        - name: key
          in: path
          type: string
          required: true
      - name: updatevaultentry
        method: PUT
        description: Update a Vault Entry
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          required: true
        - name: key
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deletevaultentry
        method: DELETE
        description: Delete a Vault Entry
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          required: true
        - name: key
          in: path
          type: string
          required: true
  exposes:
  - type: rest
    namespace: migration-vault-rest
    port: 8080
    description: REST adapter for Coveo Migration API — Vault. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/organizations/{organizationid}/vaultentries
      name: rest-organizations-organizationid-vaultentries
      description: REST surface for rest-organizations-organizationId-vaultentries.
      operations:
      - method: GET
        name: getallvaultentries
        description: Get All Vault Entries for an Organization
        call: migration-vault.getallvaultentries
        with:
          organizationId: rest.organizationId
          page: rest.page
          pageSize: rest.pageSize
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createvaultentry
        description: Create a Vault Entry
        call: migration-vault.createvaultentry
        with:
          organizationId: rest.organizationId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{organizationid}/vaultentries/fetch
      name: rest-organizations-organizationid-vaultentries-fetch
      description: REST surface for rest-organizations-organizationId-vaultentries-fetch.
      operations:
      - method: PUT
        name: fetchvaultentries
        description: Fetches Vault Entries Referenced in a Specific Snapshot from a Given Organization
        call: migration-vault.fetchvaultentries
        with:
          organizationId: rest.organizationId
          referenceSnapshotId: rest.referenceSnapshotId
          sourceOrganizationId: rest.sourceOrganizationId
          fetchStrategy: rest.fetchStrategy
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{organizationid}/vaultentries/missing
      name: rest-organizations-organizationid-vaultentries-missing
      description: REST surface for rest-organizations-organizationId-vaultentries-missing.
      operations:
      - method: GET
        name: getsnapshotvaultentrystate
        description: Retrieve State of Vault Entries for Specified Snapshot
        call: migration-vault.getsnapshotvaultentrystate
        with:
          organizationId: rest.organizationId
          snapshotId: rest.snapshotId
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{organizationid}/vaultentries/{key}
      name: rest-organizations-organizationid-vaultentries-key
      description: REST surface for rest-organizations-organizationId-vaultentries-key.
      operations:
      - method: GET
        name: getvaultentry
        description: Get a Single Vault Entry
        call: migration-vault.getvaultentry
        with:
          organizationId: rest.organizationId
          key: rest.key
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updatevaultentry
        description: Update a Vault Entry
        call: migration-vault.updatevaultentry
        with:
          organizationId: rest.organizationId
          key: rest.key
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletevaultentry
        description: Delete a Vault Entry
        call: migration-vault.deletevaultentry
        with:
          organizationId: rest.organizationId
          key: rest.key
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: migration-vault-mcp
    port: 9090
    transport: http
    description: MCP adapter for Coveo Migration API — Vault. One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: get-all-vault-entries-organization
      description: Get All Vault Entries for an Organization
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: migration-vault.getallvaultentries
      with:
        organizationId: tools.organizationId
        page: tools.page
        pageSize: tools.pageSize
      outputParameters:
      - type: object
        mapping: $.
    - name: create-vault-entry
      description: Create a Vault Entry
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: migration-vault.createvaultentry
      with:
        organizationId: tools.organizationId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: fetches-vault-entries-referenced-specific
      description: Fetches Vault Entries Referenced in a Specific Snapshot from a Given Organization
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: migration-vault.fetchvaultentries
      with:
        organizationId: tools.organizationId
        referenceSnapshotId: tools.referenceSnapshotId
        sourceOrganizationId: tools.sourceOrganizationId
        fetchStrategy: tools.fetchStrategy
      outputParameters:
      - type: object
        mapping: $.
    - name: retrieve-state-vault-entries-specified
      description: Retrieve State of Vault Entries for Specified Snapshot
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: migration-vault.getsnapshotvaultentrystate
      with:
        organizationId: tools.organizationId
        snapshotId: tools.snapshotId
      outputParameters:
      - type: object
        mapping: $.
    - name: get-single-vault-entry
      description: Get a Single Vault Entry
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: migration-vault.getvaultentry
      with:
        organizationId: tools.organizationId
        key: tools.key
      outputParameters:
      - type: object
        mapping: $.
    - name: update-vault-entry
      description: Update a Vault Entry
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: migration-vault.updatevaultentry
      with:
        organizationId: tools.organizationId
        key: tools.key
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-vault-entry
      description: Delete a Vault Entry
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: migration-vault.deletevaultentry
      with:
        organizationId: tools.organizationId
        key: tools.key
      outputParameters:
      - type: object
        mapping: $.