Integration API — synchronizationRuns

naftiko: 1.0.0-alpha2
info:
  label: Integration API — synchronizationRuns
  description: 'Integration API — synchronizationRuns. 14 operations. Lead operation: synchronizationRuns. Self-contained
    Naftiko capability covering one Leanix business surface.'
  tags:
  - Leanix
  - synchronizationRuns
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    LEANIX_API_KEY: LEANIX_API_KEY
capability:
  consumes:
  - type: http
    namespace: leanix-synchronizationruns
    baseUri: ''
    description: Integration API — synchronizationRuns business capability. Self-contained, no shared references.
    resources:
    - name: synchronizationRuns
      path: /synchronizationRuns
      operations:
      - name: getsynchronizationrunsstatuslist
        method: GET
        description: Returns the status of all existing synchronization runs
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: createsynchronizationrun
        method: POST
        description: Creates a synchronization run.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: string
    - name: synchronizationRuns-withConfig
      path: /synchronizationRuns/withConfig
      operations:
      - name: createsynchronizationrunwithconfig
        method: POST
        description: Starts a new synchronization run using the processor configuration and input object provided in the request.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: string
    - name: synchronizationRuns-withExecutionGroup
      path: /synchronizationRuns/withExecutionGroup
      operations:
      - name: createsynchronizationrunwithexecutiongroup
        method: POST
        description: Starts a new synchronization run using combined processor configuration within an execution group and
          input object provided in the request.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: groupName
          in: query
          type: string
          description: The name of execution group
        - name: body
          in: body
          type: string
    - name: synchronizationRuns-withExecutionGroupAndUrlInput
      path: /synchronizationRuns/withExecutionGroupAndUrlInput
      operations:
      - name: createsynchronizationrunwithexecutiongroupandurlinput
        method: POST
        description: Starts a new synchronization run using a DataProvider information to obtain the LDIF input, but choose
          a configuration based on execution group.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: groupName
          in: query
          type: string
          description: The name of execution group
        - name: body
          in: body
          type: string
    - name: synchronizationRuns-withUrlInput
      path: /synchronizationRuns/withUrlInput
      operations:
      - name: createsynchronizationrunwithurlinput
        method: POST
        description: Starts a new synchronization run using a DataProvider information to obtain the LDIF input
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: string
    - name: synchronizationRuns-id-progress
      path: /synchronizationRuns/{id}/progress
      operations:
      - name: getsynchronizationrunprogress
        method: GET
        description: Shows the progress of a synchronization run, it gives updated counters of the run level that is in execution.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: synchronizationRuns-id-results
      path: /synchronizationRuns/{id}/results
      operations:
      - name: getsynchronizationrunresults
        method: GET
        description: Returns the results of a finished synchronization run
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: synchronizationRuns-id-resultsUrl
      path: /synchronizationRuns/{id}/resultsUrl
      operations:
      - name: getsynchronizationrunresultsurl
        method: GET
        description: Returns the url to the results of a finished synchronization run
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: synchronizationRuns-id-start
      path: /synchronizationRuns/{id}/start
      operations:
      - name: startsynchronizationrun
        method: POST
        description: Starts an existing but not yet started synchronization run
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: synchronizationRuns-id-stats
      path: /synchronizationRuns/{id}/stats
      operations:
      - name: getsynchronizationrunstats
        method: GET
        description: Returns detailed statistics about the execution of a synchronization run
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: synchronizationRuns-id-status
      path: /synchronizationRuns/{id}/status
      operations:
      - name: getsynchronizationrunstatus
        method: GET
        description: Returns the status of an existing synchronization run
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: synchronizationRuns-id-stop
      path: /synchronizationRuns/{id}/stop
      operations:
      - name: stopsynchronizationrun
        method: POST
        description: Stops a running synchronization run
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: synchronizationRuns-id-warnings
      path: /synchronizationRuns/{id}/warnings
      operations:
      - name: getsynchronizationrunwarnings
        method: GET
        description: Returns the warnings of a synchronization run
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: offset
          in: query
          type: integer
          description: The zero-based index of the first element to retrieve
        - name: limit
          in: query
          type: integer
          description: The number of elements that should be retrieved
  exposes:
  - type: rest
    namespace: leanix-synchronizationruns-rest
    port: 8080
    description: REST adapter for Integration API — synchronizationRuns. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/synchronizationruns
      name: synchronizationruns
      description: REST surface for synchronizationRuns.
      operations:
      - method: GET
        name: getsynchronizationrunsstatuslist
        description: Returns the status of all existing synchronization runs
        call: leanix-synchronizationruns.getsynchronizationrunsstatuslist
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createsynchronizationrun
        description: Creates a synchronization run.
        call: leanix-synchronizationruns.createsynchronizationrun
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/synchronizationruns/withconfig
      name: synchronizationruns-withconfig
      description: REST surface for synchronizationRuns-withConfig.
      operations:
      - method: POST
        name: createsynchronizationrunwithconfig
        description: Starts a new synchronization run using the processor configuration and input object provided in the request.
        call: leanix-synchronizationruns.createsynchronizationrunwithconfig
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/synchronizationruns/withexecutiongroup
      name: synchronizationruns-withexecutiongroup
      description: REST surface for synchronizationRuns-withExecutionGroup.
      operations:
      - method: POST
        name: createsynchronizationrunwithexecutiongroup
        description: Starts a new synchronization run using combined processor configuration within an execution group and
          input object provided in the request.
        call: leanix-synchronizationruns.createsynchronizationrunwithexecutiongroup
        with:
          groupName: rest.groupName
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/synchronizationruns/withexecutiongroupandurlinput
      name: synchronizationruns-withexecutiongroupandurlinput
      description: REST surface for synchronizationRuns-withExecutionGroupAndUrlInput.
      operations:
      - method: POST
        name: createsynchronizationrunwithexecutiongroupandurlinput
        description: Starts a new synchronization run using a DataProvider information to obtain the LDIF input, but choose
          a configuration based on execution group.
        call: leanix-synchronizationruns.createsynchronizationrunwithexecutiongroupandurlinput
        with:
          groupName: rest.groupName
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/synchronizationruns/withurlinput
      name: synchronizationruns-withurlinput
      description: REST surface for synchronizationRuns-withUrlInput.
      operations:
      - method: POST
        name: createsynchronizationrunwithurlinput
        description: Starts a new synchronization run using a DataProvider information to obtain the LDIF input
        call: leanix-synchronizationruns.createsynchronizationrunwithurlinput
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/synchronizationruns/{id}/progress
      name: synchronizationruns-id-progress
      description: REST surface for synchronizationRuns-id-progress.
      operations:
      - method: GET
        name: getsynchronizationrunprogress
        description: Shows the progress of a synchronization run, it gives updated counters of the run level that is in execution.
        call: leanix-synchronizationruns.getsynchronizationrunprogress
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/synchronizationruns/{id}/results
      name: synchronizationruns-id-results
      description: REST surface for synchronizationRuns-id-results.
      operations:
      - method: GET
        name: getsynchronizationrunresults
        description: Returns the results of a finished synchronization run
        call: leanix-synchronizationruns.getsynchronizationrunresults
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/synchronizationruns/{id}/resultsurl
      name: synchronizationruns-id-resultsurl
      description: REST surface for synchronizationRuns-id-resultsUrl.
      operations:
      - method: GET
        name: getsynchronizationrunresultsurl
        description: Returns the url to the results of a finished synchronization run
        call: leanix-synchronizationruns.getsynchronizationrunresultsurl
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/synchronizationruns/{id}/start
      name: synchronizationruns-id-start
      description: REST surface for synchronizationRuns-id-start.
      operations:
      - method: POST
        name: startsynchronizationrun
        description: Starts an existing but not yet started synchronization run
        call: leanix-synchronizationruns.startsynchronizationrun
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/synchronizationruns/{id}/stats
      name: synchronizationruns-id-stats
      description: REST surface for synchronizationRuns-id-stats.
      operations:
      - method: GET
        name: getsynchronizationrunstats
        description: Returns detailed statistics about the execution of a synchronization run
        call: leanix-synchronizationruns.getsynchronizationrunstats
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/synchronizationruns/{id}/status
      name: synchronizationruns-id-status
      description: REST surface for synchronizationRuns-id-status.
      operations:
      - method: GET
        name: getsynchronizationrunstatus
        description: Returns the status of an existing synchronization run
        call: leanix-synchronizationruns.getsynchronizationrunstatus
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/synchronizationruns/{id}/stop
      name: synchronizationruns-id-stop
      description: REST surface for synchronizationRuns-id-stop.
      operations:
      - method: POST
        name: stopsynchronizationrun
        description: Stops a running synchronization run
        call: leanix-synchronizationruns.stopsynchronizationrun
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/synchronizationruns/{id}/warnings
      name: synchronizationruns-id-warnings
      description: REST surface for synchronizationRuns-id-warnings.
      operations:
      - method: GET
        name: getsynchronizationrunwarnings
        description: Returns the warnings of a synchronization run
        call: leanix-synchronizationruns.getsynchronizationrunwarnings
        with:
          offset: rest.offset
          limit: rest.limit
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: leanix-synchronizationruns-mcp
    port: 9090
    transport: http
    description: MCP adapter for Integration API — synchronizationRuns. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: returns-status-all-existing-synchronization
      description: Returns the status of all existing synchronization runs
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: leanix-synchronizationruns.getsynchronizationrunsstatuslist
      outputParameters:
      - type: object
        mapping: $.
    - name: creates-synchronization-run
      description: Creates a synchronization run.
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: leanix-synchronizationruns.createsynchronizationrun
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: starts-new-synchronization-run-using
      description: Starts a new synchronization run using the processor configuration and input object provided in the request.
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: leanix-synchronizationruns.createsynchronizationrunwithconfig
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: starts-new-synchronization-run-using-2
      description: Starts a new synchronization run using combined processor configuration within an execution group and input
        object provided in the request.
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: leanix-synchronizationruns.createsynchronizationrunwithexecutiongroup
      with:
        groupName: tools.groupName
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: starts-new-synchronization-run-using-3
      description: Starts a new synchronization run using a DataProvider information to obtain the LDIF input, but choose
        a configuration based on execution group.
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: leanix-synchronizationruns.createsynchronizationrunwithexecutiongroupandurlinput
      with:
        groupName: tools.groupName
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: starts-new-synchronization-run-using-4
      description: Starts a new synchronization run using a DataProvider information to obtain the LDIF input
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: leanix-synchronizationruns.createsynchronizationrunwithurlinput
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: shows-progress-synchronization-run-it
      description: Shows the progress of a synchronization run, it gives updated counters of the run level that is in execution.
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: leanix-synchronizationruns.getsynchronizationrunprogress
      outputParameters:
      - type: object
        mapping: $.
    - name: returns-results-finished-synchronization-run
      description: Returns the results of a finished synchronization run
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: leanix-synchronizationruns.getsynchronizationrunresults
      outputParameters:
      - type: object
        mapping: $.
    - name: returns-url-results-finished-synchronization
      description: Returns the url to the results of a finished synchronization run
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: leanix-synchronizationruns.getsynchronizationrunresultsurl
      outputParameters:
      - type: object
        mapping: $.
    - name: starts-existing-but-not-yet
      description: Starts an existing but not yet started synchronization run
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: leanix-synchronizationruns.startsynchronizationrun
      outputParameters:
      - type: object
        mapping: $.
    - name: returns-detailed-statistics-about-execution
      description: Returns detailed statistics about the execution of a synchronization run
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: leanix-synchronizationruns.getsynchronizationrunstats
      outputParameters:
      - type: object
        mapping: $.
    - name: returns-status-existing-synchronization-run
      description: Returns the status of an existing synchronization run
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: leanix-synchronizationruns.getsynchronizationrunstatus
      outputParameters:
      - type: object
        mapping: $.
    - name: stops-running-synchronization-run
      description: Stops a running synchronization run
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: leanix-synchronizationruns.stopsynchronizationrun
      outputParameters:
      - type: object
        mapping: $.
    - name: returns-warnings-synchronization-run
      description: Returns the warnings of a synchronization run
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: leanix-synchronizationruns.getsynchronizationrunwarnings
      with:
        offset: tools.offset
        limit: tools.limit
      outputParameters:
      - type: object
        mapping: $.