Coveo Search Interface Service API — IPX Configuration

naftiko: 1.0.0-alpha2
info:
  label: Coveo Search Interface Service API — IPX Configuration
  description: 'Coveo Search Interface Service API — IPX Configuration. 15 operations. Lead operation: List All IPX Interface
    Configurations. Self-contained Naftiko capability covering one Coveo business surface.'
  tags:
  - Coveo
  - Search Interface Service
  - IPX Configuration
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    COVEO_SEARCH_TOKEN: COVEO_SEARCH_TOKEN
capability:
  consumes:
  - type: http
    namespace: search-interface-ipx-configuration
    baseUri: https://platform.cloud.coveo.com
    description: Coveo Search Interface Service API — IPX Configuration business capability. Self-contained, no shared references.
    authentication:
      type: bearer
      token: '{{env.COVEO_SEARCH_TOKEN}}'
    resources:
    - name: rest-organizations-organizationId-ipxinterface-v1-interfaces
      path: /rest/organizations/{organizationId}/ipxinterface/v1/interfaces
      operations:
      - name: getallipxinterfaceconfigs
        method: GET
        description: List All IPX Interface Configurations
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: createipxinterfaceconfig
        method: POST
        description: Create IPX Interface Configuration
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: createPipelines
          in: query
          type: boolean
          description: If true, pipelines, conditions and models will be created for the IPX interface.
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: rest-organizations-organizationId-ipxinterface-v1-interfaces-interfaceId
      path: /rest/organizations/{organizationId}/ipxinterface/v1/interfaces/{interfaceId}
      operations:
      - name: getipxinterfaceconfig
        method: GET
        description: Show IPX Interface Configuration
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: updateipxinterfaceconfig
        method: PUT
        description: Update IPX Interface Configuration
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deleteipxinterfaceconfig
        method: DELETE
        description: Delete IPX Interface Configuration
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: rest-organizations-organizationId-ipxinterface-v1-interfaces-interfaceId-edit
      path: /rest/organizations/{organizationId}/ipxinterface/v1/interfaces/{interfaceId}/edit
      operations:
      - name: getipxinterfaceedit
        method: GET
        description: Get IPX Interface Builder
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: rest-organizations-organizationId-ipxinterface-v1-interfaces-interfaceId-login
      path: /rest/organizations/{organizationId}/ipxinterface/v1/interfaces/{interfaceId}/login
      operations:
      - name: getipxinterfacelogin
        method: GET
        description: Get IPX Interface Login
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: rest-organizations-organizationId-ipxinterface-v1-interfaces-interfaceId-pipelin
      path: /rest/organizations/{organizationId}/ipxinterface/v1/interfaces/{interfaceId}/pipelines
      operations:
      - name: getipxinterfacepipelines
        method: GET
        description: Get IPX Interface Pipelines
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: rest-organizations-organizationId-ipxinterface-v1-interfaces-interfaceId-preview
      path: /rest/organizations/{organizationId}/ipxinterface/v1/interfaces/{interfaceId}/preview
      operations:
      - name: previewipxinterface
        method: POST
        description: Preview IPX Interface
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: rest-organizations-organizationId-ipxinterface-v1-interfaces-interfaceId-token
      path: /rest/organizations/{organizationId}/ipxinterface/v1/interfaces/{interfaceId}/token
      operations:
      - name: getipxinterfacetoken
        method: GET
        description: Get IPX Interface Search Token
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: rest-organizations-organizationId-ipxinterface-v1-interfaces-interfaceId-version
      path: /rest/organizations/{organizationId}/ipxinterface/v1/interfaces/{interfaceId}/versions
      operations:
      - name: getipxinterfaceversions
        method: GET
        description: Get Versions for an IPX Interface
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: rest-organizations-organizationId-ipxinterface-v1-interfaces-interfaceId-version
      path: /rest/organizations/{organizationId}/ipxinterface/v1/interfaces/{interfaceId}/versions/{versionNumber}
      operations:
      - name: getipxinterfaceversion
        method: GET
        description: Get an IPX Interface Version
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: rest-organizations-organizationId-ipxinterface-v1-interfaces-interfaceId-version
      path: /rest/organizations/{organizationId}/ipxinterface/v1/interfaces/{interfaceId}/versions/{versionNumber}/label
      operations:
      - name: updateipxinterfaceversionlabel
        method: PUT
        description: Update an IPX Interface Version Label
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: rest-organizations-organizationId-ipxinterface-v1-interfaces-interfaceId-version
      path: /rest/organizations/{organizationId}/ipxinterface/v1/interfaces/{interfaceId}/versions/{versionNumber}/restore
      operations:
      - name: restoreipxinterfaceversion
        method: POST
        description: Restore an IPX Interface Version
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: rest-organizations-organizationId-ipxinterface-v1-projects-interfaces
      path: /rest/organizations/{organizationId}/ipxinterface/v1/projects/interfaces
      operations:
      - name: getprojectipxinterfaceconfigs
        method: GET
        description: List IPX Interface Configurations in Project
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
  exposes:
  - type: rest
    namespace: search-interface-ipx-configuration-rest
    port: 8080
    description: REST adapter for Coveo Search Interface Service API — IPX Configuration. One Spectral-compliant resource
      per consumed operation, prefixed with /v1.
    resources:
    - path: /v1/organizations/{organizationid}/ipxinterface/v1/interfaces
      name: rest-organizations-organizationid-ipxinterface-v1-interfaces
      description: REST surface for rest-organizations-organizationId-ipxinterface-v1-interfaces.
      operations:
      - method: GET
        name: getallipxinterfaceconfigs
        description: List All IPX Interface Configurations
        call: search-interface-ipx-configuration.getallipxinterfaceconfigs
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createipxinterfaceconfig
        description: Create IPX Interface Configuration
        call: search-interface-ipx-configuration.createipxinterfaceconfig
        with:
          createPipelines: rest.createPipelines
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{organizationid}/ipxinterface/v1/interfaces/{interfaceid}
      name: rest-organizations-organizationid-ipxinterface-v1-interfaces-interfaceid
      description: REST surface for rest-organizations-organizationId-ipxinterface-v1-interfaces-interfaceId.
      operations:
      - method: GET
        name: getipxinterfaceconfig
        description: Show IPX Interface Configuration
        call: search-interface-ipx-configuration.getipxinterfaceconfig
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updateipxinterfaceconfig
        description: Update IPX Interface Configuration
        call: search-interface-ipx-configuration.updateipxinterfaceconfig
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deleteipxinterfaceconfig
        description: Delete IPX Interface Configuration
        call: search-interface-ipx-configuration.deleteipxinterfaceconfig
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{organizationid}/ipxinterface/v1/interfaces/{interfaceid}/edit
      name: rest-organizations-organizationid-ipxinterface-v1-interfaces-interfaceid-edit
      description: REST surface for rest-organizations-organizationId-ipxinterface-v1-interfaces-interfaceId-edit.
      operations:
      - method: GET
        name: getipxinterfaceedit
        description: Get IPX Interface Builder
        call: search-interface-ipx-configuration.getipxinterfaceedit
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{organizationid}/ipxinterface/v1/interfaces/{interfaceid}/login
      name: rest-organizations-organizationid-ipxinterface-v1-interfaces-interfaceid-login
      description: REST surface for rest-organizations-organizationId-ipxinterface-v1-interfaces-interfaceId-login.
      operations:
      - method: GET
        name: getipxinterfacelogin
        description: Get IPX Interface Login
        call: search-interface-ipx-configuration.getipxinterfacelogin
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{organizationid}/ipxinterface/v1/interfaces/{interfaceid}/pipelines
      name: rest-organizations-organizationid-ipxinterface-v1-interfaces-interfaceid-pipelin
      description: REST surface for rest-organizations-organizationId-ipxinterface-v1-interfaces-interfaceId-pipelin.
      operations:
      - method: GET
        name: getipxinterfacepipelines
        description: Get IPX Interface Pipelines
        call: search-interface-ipx-configuration.getipxinterfacepipelines
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{organizationid}/ipxinterface/v1/interfaces/{interfaceid}/preview
      name: rest-organizations-organizationid-ipxinterface-v1-interfaces-interfaceid-preview
      description: REST surface for rest-organizations-organizationId-ipxinterface-v1-interfaces-interfaceId-preview.
      operations:
      - method: POST
        name: previewipxinterface
        description: Preview IPX Interface
        call: search-interface-ipx-configuration.previewipxinterface
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{organizationid}/ipxinterface/v1/interfaces/{interfaceid}/token
      name: rest-organizations-organizationid-ipxinterface-v1-interfaces-interfaceid-token
      description: REST surface for rest-organizations-organizationId-ipxinterface-v1-interfaces-interfaceId-token.
      operations:
      - method: GET
        name: getipxinterfacetoken
        description: Get IPX Interface Search Token
        call: search-interface-ipx-configuration.getipxinterfacetoken
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{organizationid}/ipxinterface/v1/interfaces/{interfaceid}/versions
      name: rest-organizations-organizationid-ipxinterface-v1-interfaces-interfaceid-version
      description: REST surface for rest-organizations-organizationId-ipxinterface-v1-interfaces-interfaceId-version.
      operations:
      - method: GET
        name: getipxinterfaceversions
        description: Get Versions for an IPX Interface
        call: search-interface-ipx-configuration.getipxinterfaceversions
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{organizationid}/ipxinterface/v1/interfaces/{interfaceid}/versions/{versionnumber}
      name: rest-organizations-organizationid-ipxinterface-v1-interfaces-interfaceid-version
      description: REST surface for rest-organizations-organizationId-ipxinterface-v1-interfaces-interfaceId-version.
      operations:
      - method: GET
        name: getipxinterfaceversion
        description: Get an IPX Interface Version
        call: search-interface-ipx-configuration.getipxinterfaceversion
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{organizationid}/ipxinterface/v1/interfaces/{interfaceid}/versions/{versionnumber}/label
      name: rest-organizations-organizationid-ipxinterface-v1-interfaces-interfaceid-version
      description: REST surface for rest-organizations-organizationId-ipxinterface-v1-interfaces-interfaceId-version.
      operations:
      - method: PUT
        name: updateipxinterfaceversionlabel
        description: Update an IPX Interface Version Label
        call: search-interface-ipx-configuration.updateipxinterfaceversionlabel
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{organizationid}/ipxinterface/v1/interfaces/{interfaceid}/versions/{versionnumber}/restore
      name: rest-organizations-organizationid-ipxinterface-v1-interfaces-interfaceid-version
      description: REST surface for rest-organizations-organizationId-ipxinterface-v1-interfaces-interfaceId-version.
      operations:
      - method: POST
        name: restoreipxinterfaceversion
        description: Restore an IPX Interface Version
        call: search-interface-ipx-configuration.restoreipxinterfaceversion
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{organizationid}/ipxinterface/v1/projects/interfaces
      name: rest-organizations-organizationid-ipxinterface-v1-projects-interfaces
      description: REST surface for rest-organizations-organizationId-ipxinterface-v1-projects-interfaces.
      operations:
      - method: GET
        name: getprojectipxinterfaceconfigs
        description: List IPX Interface Configurations in Project
        call: search-interface-ipx-configuration.getprojectipxinterfaceconfigs
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: search-interface-ipx-configuration-mcp
    port: 9090
    transport: http
    description: MCP adapter for Coveo Search Interface Service API — IPX Configuration. One tool per consumed operation,
      routed inline through this capability's consumes block.
    tools:
    - name: list-all-ipx-interface-configurations
      description: List All IPX Interface Configurations
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: search-interface-ipx-configuration.getallipxinterfaceconfigs
      outputParameters:
      - type: object
        mapping: $.
    - name: create-ipx-interface-configuration
      description: Create IPX Interface Configuration
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: search-interface-ipx-configuration.createipxinterfaceconfig
      with:
        createPipelines: tools.createPipelines
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: show-ipx-interface-configuration
      description: Show IPX Interface Configuration
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: search-interface-ipx-configuration.getipxinterfaceconfig
      outputParameters:
      - type: object
        mapping: $.
    - name: update-ipx-interface-configuration
      description: Update IPX Interface Configuration
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: search-interface-ipx-configuration.updateipxinterfaceconfig
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-ipx-interface-configuration
      description: Delete IPX Interface Configuration
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: search-interface-ipx-configuration.deleteipxinterfaceconfig
      outputParameters:
      - type: object
        mapping: $.
    - name: get-ipx-interface-builder
      description: Get IPX Interface Builder
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: search-interface-ipx-configuration.getipxinterfaceedit
      outputParameters:
      - type: object
        mapping: $.
    - name: get-ipx-interface-login
      description: Get IPX Interface Login
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: search-interface-ipx-configuration.getipxinterfacelogin
      outputParameters:
      - type: object
        mapping: $.
    - name: get-ipx-interface-pipelines
      description: Get IPX Interface Pipelines
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: search-interface-ipx-configuration.getipxinterfacepipelines
      outputParameters:
      - type: object
        mapping: $.
    - name: preview-ipx-interface
      description: Preview IPX Interface
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: search-interface-ipx-configuration.previewipxinterface
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-ipx-interface-search-token
      description: Get IPX Interface Search Token
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: search-interface-ipx-configuration.getipxinterfacetoken
      outputParameters:
      - type: object
        mapping: $.
    - name: get-versions-ipx-interface
      description: Get Versions for an IPX Interface
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: search-interface-ipx-configuration.getipxinterfaceversions
      outputParameters:
      - type: object
        mapping: $.
    - name: get-ipx-interface-version
      description: Get an IPX Interface Version
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: search-interface-ipx-configuration.getipxinterfaceversion
      outputParameters:
      - type: object
        mapping: $.
    - name: update-ipx-interface-version-label
      description: Update an IPX Interface Version Label
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: search-interface-ipx-configuration.updateipxinterfaceversionlabel
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: restore-ipx-interface-version
      description: Restore an IPX Interface Version
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: search-interface-ipx-configuration.restoreipxinterfaceversion
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: list-ipx-interface-configurations-project
      description: List IPX Interface Configurations in Project
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: search-interface-ipx-configuration.getprojectipxinterfaceconfigs
      outputParameters:
      - type: object
        mapping: $.