Sure, you can handle it. But should you?
Let our experts manage the tech maintenance while you focus on your business.
Let our experts manage the tech maintenance while you focus on your business.
Interface Description
api.v3.admin.SnapshotService
Copyright ©
Mindbreeze GmbH, A-4020 Linz. 2024.
All rights reserved. All hardware and software names are brand names and/or trademarks of their respective manufacturers.
These documents are strictly confidential. The submission and presentation of these documents does not confer any rights to our software, our services and service outcomes or other protected rights.
The dissemination, publication or reproduction hereof is prohibited.
For ease of readability, gender differentiation has been waived. Corresponding terms and definitions apply within the meaning and intent of the equal treatment principle for both sexes.
Introduction
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 Concepts
Snapshot
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
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 Convention
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 Snapshot
HTTP POST https://myinspire.com:8443/api/v3/admin/mindbreeze.api.v3.admin.SnapshotService/createSnapshot
CreateSnapshotRequest
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) |
CreateSnapshotOptions
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 |
SnapshotContentsSelector
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) |
ServiceConfigAndSearchApps
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 |
ServiceCredentials
Property | Description |
service_credentials: bool | Include service credentials |
kerberos_data: bool | Include kerberos data |
SearchExperience
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 |
Reporting
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 |
Resources
Property | Description |
default_resources: bool | Include default resources |
resource_patterns: string | Regular expression that defines included resources |
PersistedResources
Property | Description |
referenced_resources: bool | Includes referenced resources |
Plugins
Property | Description |
custom_plugins: bool | Includes custom (not builtin) plugins |
CreateSnapshotResponse
Property | Description |
snapshot_id : string | Id of the created snapshot |
Apply Snapshot
HTTP POST https://myinspire.com:8443/api/v3/admin/mindbreeze.api.v3.admin.SnapshotService/ applySnapshot
ApplySnapshotRequest
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 |
ApplySnapshotResponse
Property | Description |
snapshot_id: string | ID of the applied snapshot |
Export Snapshot Archive
HTTP POST https://myinspire.com:8443/api/v3/admin/mindbreeze.api.v3.admin.SnapshotService/ exportSnapshot
ExportSnapshotRequest
Property | Description |
snapshot_id: string | ID of the snapshot which needs to be exported |
ExportSnapshotResponse
Property | Description |
snapshot_archive_id: string | Archive ID of the exported snapshot |
snapshot_archive_url: string | Archive URL of the exported snapshot |
Import Snapshot
HTTP POST https://myinspire.com:8443/api/v3/admin/mindbreeze.api.v3.admin.SnapshotService/importSnapshot
ImportSnapshotRequest
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) |
ImportSnapshotOptions
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) |
NodeIdMapping
Property | Description |
mapping: MappingEntry | List of MappingEntries (see table below) |
MappingEntry
Property | Description |
key: string | Old Node ID |
value: string | New Node ID |
ConfigurationParametersEntry
Property | Description |
key: string | Key of the parameter |
value: string | Value of the parameter |
ImportSnapshotResponse
Property | Description |
snapshot_id: string | ID of the Snapshot |