Home
Home
German Version
Support
Impressum
25.3 Release ►

Start Chat with Collection

    Main Navigation

    • Preparation
      • Connectors
      • Create an InSpire VM on Hyper-V
      • Initial Startup for G7 appliances
      • Setup InSpire G7 primary and Standby Appliances
    • Datasources
      • Configuration - Atlassian Confluence Connector
      • Configuration - Best Bets Connector
      • Configuration - Box Connector
      • Configuration - COYO Connector
      • Configuration - Data Integration Connector
      • Configuration - Database Connector
      • Configuration - Documentum Connector
      • Configuration - Dropbox Connector
      • Configuration - Egnyte Connector
      • Configuration - GitHub Connector
      • Configuration - Google Drive Connector
      • Configuration - GSA Adapter Service
      • Configuration - HL7 Connector
      • Configuration - IBM Connections Connector
      • Configuration - IBM Lotus Connector
      • Configuration - Jira Connector
      • Configuration - JVM Launcher Service
      • Configuration - LDAP Connector
      • Configuration - Microsoft Azure Principal Resolution Service
      • Configuration - Microsoft Dynamics CRM Connector
      • Configuration - Microsoft Exchange Connector
      • Configuration - Microsoft File Connector (Legacy)
      • Configuration - Microsoft File Connector
      • Configuration - Microsoft Graph Connector
      • Configuration - Microsoft Loop Connector
      • Configuration - Microsoft Project Connector
      • Configuration - Microsoft SharePoint Connector
      • Configuration - Microsoft SharePoint Online Connector
      • Configuration - Microsoft Stream Connector
      • Configuration - Microsoft Teams Connector
      • Configuration - Salesforce Connector
      • Configuration - SCIM Principal Resolution Service
      • Configuration - SemanticWeb Connector
      • Configuration - ServiceNow Connector
      • Configuration - Web Connector
      • Configuration - Yammer Connector
      • Data Integration Guide with SQL Database by Example
      • Indexing user-specific properties (Documentum)
      • Installation & Configuration - Atlassian Confluence Sitemap Generator Add-On
      • Installation & Configuration - Caching Principal Resolution Service
      • Installation & Configuration - Mindbreeze InSpire Insight Apps in Microsoft SharePoint On-Prem
      • Mindbreeze InSpire Insight Apps in Microsoft SharePoint Online
      • Mindbreeze Web Parts for Microsoft SharePoint
      • User Defined Properties (SharePoint 2013 Connector)
      • Whitepaper - Mindbreeze InSpire Insight Apps in Salesforce
      • Whitepaper - Web Connector - Setting Up Advanced Javascript Usecases
    • Configuration
      • CAS_Authentication
      • Configuration - Alerts
      • Configuration - Alternative Search Suggestions and Automatic Search Expansion
      • Configuration - Back-End Credentials
      • Configuration - Chinese Tokenization Plugin (Jieba)
      • Configuration - CJK Tokenizer Plugin
      • Configuration - Collected Results
      • Configuration - CSV Metadata Mapping Item Transformation Service
      • Configuration - Entity Recognition
      • Configuration - Exporting Results
      • Configuration - External Query Service
      • Configuration - Filter Plugins
      • Configuration - GSA Late Binding Authentication
      • Configuration - Identity Conversion Service - Replacement Conversion
      • Configuration - InceptionImageFilter
      • Configuration - Index-Servlets
      • Configuration - InSpire AI Chat and Insight Services for Retrieval Augmented Generation
      • Configuration - Item Property Generator
      • Configuration - Japanese Language Tokenizer
      • Configuration - Kerberos Authentication
      • Configuration - Management Center Menu
      • Configuration - Metadata Enrichment
      • Configuration - Metadata Reference Builder Plugin
      • Configuration - Mindbreeze Proxy Environment (Remote Connector)
      • Configuration - Personalized Relevance
      • Configuration - Plugin Installation
      • Configuration - Principal Validation Plugin
      • Configuration - Profile
      • Configuration - Reporting Query Logs
      • Configuration - Reporting Query Performance Tests
      • Configuration - Request Header Session Authentication
      • Configuration - Shared Configuration (Windows)
      • Configuration - Vocabularies for Synonyms and Suggest
      • Configuration of Thumbnail Images
      • Cookie-Authentication
      • Documentation - Mindbreeze InSpire
      • I18n Item Transformation
      • Installation & Configuration - Outlook Add-In
      • Installation - GSA Base Configuration Package
      • JWT Authentication
      • Language detection - LanguageDetector Plugin
      • Mindbreeze Personalization
      • Mindbreeze Property Expression Language
      • Mindbreeze Query Expression Transformation
      • SAML-based Authentication
      • Trusted Peer Authentication for Mindbreeze InSpire
      • Using the InSpire Snapshot for Development in a CI_CD Scenario
      • Whitepaper - AI Chat
      • Whitepaper - Create a Google Compute Cloud Virtual Machine InSpire Appliance
      • Whitepaper - Create a Microsoft Azure Virtual Machine InSpire Appliance
      • Whitepaper - Create AWS 10M InSpire Appliance
      • Whitepaper - Create AWS 1M InSpire Appliance
      • Whitepaper - Create AWS 2M InSpire Appliance
      • Whitepaper - Create Oracle Cloud 10M InSpire Application
      • Whitepaper - Create Oracle Cloud 1M InSpire Application
      • Whitepaper - MMC_ Services
      • Whitepaper - Natural Language Question Answering (NLQA)
      • Whitepaper - SSO with Microsoft AAD or AD FS
      • Whitepaper - Text Classification Insight Services
    • Operations
      • Adjusting the InSpire Host OpenSSH Settings - Set LoginGraceTime to 0 (Mitigation for CVE-2024-6387)
      • app.telemetry Statistics Regarding Search Queries
      • CIS Level 2 Hardening - Setting SELinux to Enforcing mode
      • Configuration - app.telemetry dashboards for usage analysis
      • Configuration - Usage Analysis
      • Deletion of Hard Disks
      • Handbook - Backup & Restore
      • Handbook - Command Line Tools
      • Handbook - Distributed Operation (G7)
      • Handbook - Filemanager
      • Handbook - Indexing and Search Logs
      • Handbook - Updates and Downgrades
      • Index Operating Concepts
      • Inspire Diagnostics and Resource Monitoring
      • Provision of app.telemetry Information on G7 Appliances via SNMPv3
      • Restoring to As-Delivered Condition
      • Whitepaper - Administration of Insight Services for Retrieval Augmented Generation
    • User Manual
      • Browser Extension
      • Cheat Sheet
      • iOS App
      • Keyboard Operation
    • SDK
      • api.chat.v1beta.generate Interface Description
      • api.v2.alertstrigger Interface Description
      • api.v2.export Interface Description
      • api.v2.personalization Interface Description
      • api.v2.search Interface Description
      • api.v2.suggest Interface Description
      • api.v3.admin.SnapshotService Interface Description
      • Debugging (Eclipse)
      • Developing an API V2 search request response transformer
      • Developing Item Transformation and Post Filter Plugins with the Mindbreeze SDK
      • Development of a Query Expression Transformer
      • Development of Insight Apps
      • Embedding the Insight App Designer
      • Java API Interface Description
      • OpenAPI Interface Description
    • Release Notes
      • Release Notes 20.1 Release - Mindbreeze InSpire
      • Release Notes 20.2 Release - Mindbreeze InSpire
      • Release Notes 20.3 Release - Mindbreeze InSpire
      • Release Notes 20.4 Release - Mindbreeze InSpire
      • Release Notes 20.5 Release - Mindbreeze InSpire
      • Release Notes 21.1 Release - Mindbreeze InSpire
      • Release Notes 21.2 Release - Mindbreeze InSpire
      • Release Notes 21.3 Release - Mindbreeze InSpire
      • Release Notes 22.1 Release - Mindbreeze InSpire
      • Release Notes 22.2 Release - Mindbreeze InSpire
      • Release Notes 22.3 Release - Mindbreeze InSpire
      • Release Notes 23.1 Release - Mindbreeze InSpire
      • Release Notes 23.2 Release - Mindbreeze InSpire
      • Release Notes 23.3 Release - Mindbreeze InSpire
      • Release Notes 23.4 Release - Mindbreeze InSpire
      • Release Notes 23.5 Release - Mindbreeze InSpire
      • Release Notes 23.6 Release - Mindbreeze InSpire
      • Release Notes 23.7 Release - Mindbreeze InSpire
      • Release Notes 24.1 Release - Mindbreeze InSpire
      • Release Notes 24.2 Release - Mindbreeze InSpire
      • Release Notes 24.3 Release - Mindbreeze InSpire
      • Release Notes 24.4 Release - Mindbreeze InSpire
      • Release Notes 24.5 Release - Mindbreeze InSpire
      • Release Notes 24.6 Release - Mindbreeze InSpire
      • Release Notes 24.7 Release - Mindbreeze InSpire
      • Release Notes 24.8 Release - Mindbreeze InSpire
      • Release Notes 25.1 Release - Mindbreeze InSpire
      • Release Notes 25.2 Release - Mindbreeze InSpire
      • Release Notes 25.3 Release - Mindbreeze InSpire
    • Security
      • Known Vulnerablities
    • Product Information
      • Product Information - Mindbreeze InSpire - Standby
      • Product Information - Mindbreeze InSpire
    Home

    Path

    Sure, you can handle it. But should you?
    Let our experts manage the tech maintenance while you focus on your business.
    See Consulting Packages

    Interface Description
    api.v3.admin.SnapshotService

    IntroductionPermanent link for this heading

    The current document is a description of the Mindbreeze InSpire api.v3.admin.SnapshotService API use cases and interface. Through configuration parameters and so-called “Development Snapshots”, changes to …

    • the Mindbreeze Service configuration (add/remove and customize connectors, indices, filters, client services, ...)
    • the semantics pipeline
    • the Query Transformation Pipeline
    • InSpire Insight Apps
    • Any resource files like boosts, relevance parameters

    ... can be exported as a development snapshot and then automatically transferred to production. Any settings (e.g. the data source URL to be indexed) can be overwritten locally as parameters on the respective environment. This ensures that the production data sources are indexed productively and the developer data sources in the development system. Credentials, certificates are not stored and are preserved.

    Using the api.v3.admin.SnapshotService API operations on Mindbreeze InSpire snapshots are possible.

    Snapshot ConceptsPermanent link for this heading

    SnapshotPermanent link for this heading

    A Mindbreeze InSpire snapshot is a state of the appliance configuration and data. This state can contain the Mindbreeze InSpire configuration, installed extensions, Insight Apps etc.

    Snapshot Archive Permanent link for this heading

    A snapshot archive is a transportable snapshot. To restore a snapshot on another appliance an archive has to be created by exporting the snapshot. This archive is imported on the target appliance. After importing the archive, the snapshot is available on the target Mindbreeze InSpire appliance and can be restored there. Applying a snapshot restores the configuration and optional data in the state of the snapshot at the time of snapshot creation.

    Authentication and Service Calling ConventionPermanent link for this heading

    The Mindbreeze InSpire Administration API is available under the path (/api/v3/admin/) this includes the SnapshotService. The api is authenticated via Oauth Bearer Token authentication. For details to our Service Calling Convention please take a look at our SnapshotClient Java Sample in the Mindbreeze SDK.

    Create SnapshotPermanent link for this heading

    HTTP POST https://myinspire.com:8443/api/v3/admin/mindbreeze.api.v3.admin.SnapshotService/createSnapshot

    CreateSnapshotRequestPermanent link for this heading

    Property

    Description

    name: string

    Name to group snapshots into a family of related snapshots

    description: string

    Textual detail information

    dry_run: bool

    Simply run without creating the snapshot

    options: CreateSnapshotOptions

    Options for create snapshot. (see table below)

    CreateSnapshotOptionsPermanent link for this heading

    Property

    Description

    include_contents: SnapshotContentsSelector

    Includes the service configuration in the snapshot (see table below)

    profile: CUSTOM | APPLIANCE_MIGRATION | DEVELOPMENT | SEARCH_EXPERIENCE | COMPLETE

    The above include options are only used for the CUSTOM profile

    SnapshotContentsSelectorPermanent link for this heading

    Property

    Description

    service_config_and_search_apps: ServiceConfigAndSearchApps

    Options for including server config and Insight Apps (see table below)

    service_credentials: ServiceCredentials

    Options for including service credentials (see table below)

    search_experience: SearchExperience

    Options for including search experience (see table below)

    reporting: Reporting

    Options for including reporting (see table below)

    resources: Resources

    Options for including resources (see table below)

    persisted_resources: PersistedResources

    Options for including persisted resources (see table below)

    plugins: Plugins

    Options for including plugins (see table below)

    ServiceConfigAndSearchAppsPermanent link for this heading

    Property

    Description

    service_config: bool

    Include the service config

    referenced_search_apps: bool

    Include referenced Insight Apps

    all_search_apps: bool

    Include all Insight Apps

    authenticators: bool

    Include authenticators

    ServiceCredentialsPermanent link for this heading

    Property

    Description

    service_credentials: bool

    Include service credentials

    kerberos_data: bool

    Include kerberos data

    SearchExperiencePermanent link for this heading

    Property

    Description

    synonyms: bool

    Include synonyms

    replacements: bool

    Include replacements

    vocabulary: bool

    Include vocabulary

    relevance_query_boostings: bool

    Include relevance query boostings

    relevance_options: bool

    Include relevance options

    ReportingPermanent link for this heading

    Property

    Description

    apptelemetry_config: bool

    Include app.telemetry config

    apptelemetry_data: bool

    Include app.telemetry data

    all_apptelemetry_data: bool

    Include all app.telemetry data

    ResourcesPermanent link for this heading

    Property

    Description

    default_resources: bool

    Include default resources

    resource_patterns: string

    Regular expression that defines included resources

    PersistedResourcesPermanent link for this heading

    Property

    Description

    referenced_resources: bool

    Includes referenced resources

    PluginsPermanent link for this heading

    Property

    Description

    custom_plugins: bool

    Includes custom (not builtin) plugins

    CreateSnapshotResponsePermanent link for this heading

    Property

    Description

    snapshot_id : string

    Id of the created snapshot

    Apply SnapshotPermanent link for this heading

    HTTP POST https://myinspire.com:8443/api/v3/admin/mindbreeze.api.v3.admin.SnapshotService/ applySnapshot

    ApplySnapshotRequestPermanent link for this heading

    Property

    Description

    snapshot_id: string

    ID of the snapshot to apply

    reset: bool

    When set to true, if an Insight App is imported, all old resources are deleted

    ApplySnapshotResponsePermanent link for this heading

    Property

    Description

    snapshot_id: string

    ID of the applied snapshot

    Export Snapshot ArchivePermanent link for this heading

    HTTP POST https://myinspire.com:8443/api/v3/admin/mindbreeze.api.v3.admin.SnapshotService/ exportSnapshot

    ExportSnapshotRequest Permanent link for this heading

    Property

    Description

    snapshot_id: string

    ID of the snapshot which needs to be exported

    ExportSnapshotResponsePermanent link for this heading

    Property

    Description

    snapshot_archive_id: string

    Archive ID of the exported snapshot

    snapshot_archive_url: string

    Archive URL of the exported snapshot

    Import SnapshotPermanent link for this heading

    HTTP POST https://myinspire.com:8443/api/v3/admin/mindbreeze.api.v3.admin.SnapshotService/importSnapshot

    ImportSnapshotRequestPermanent link for this heading

    Property

    Description

    snapshot_archive_id: string

    ID of the snapshot archive (alternative to snapshot_archive_url)

    snapshot_archive_url: string

    URL of the snapshot archive (alternative to snapshot_archive_id)

    import_options: ImportSnapshotOptions

    Options for import (see table below)

    ImportSnapshotOptionsPermanent link for this heading

    Property

    Description

    exclude_contents: SnapshotContentsSelector

    Defines which Content is imported (see table above)

    node_id_mapping : NodeIdMapping

    Map of node IDs <old node id, new node id> (see table below)

    configuration_parameters: ConfigurationParametersEntry

    Sets the concrete values of parameterized options (see table below)

    NodeIdMappingPermanent link for this heading

    Property

    Description

    mapping: MappingEntry

    List of MappingEntries (see table below)

    MappingEntryPermanent link for this heading

    Property

    Description

    key: string

    Old Node ID

    value: string

    New Node ID

    ConfigurationParametersEntryPermanent link for this heading

    Property

    Description

    key: string

    Key of the parameter

    value: string

    Value of the parameter

    ImportSnapshotResponsePermanent link for this heading

    Property

    Description

    snapshot_id: string

    ID of the Snapshot

    Download PDF

    • api.v3.admin.SnapshotService Interface Description

    Content

    • Introduction
    • Snapshot Concepts
    • Authentication and Service Calling Convention
    • Create Snapshot
    • Apply Snapshot
    • Export Snapshot Archive
    • Import Snapshot

    Download PDF

    • api.v3.admin.SnapshotService Interface Description