Skip to main content

​
Get System Status

This endpoint returns information about the MCRIT system status.
GET /status
​
with_pichash
boolean
default:"false"
Include PicHash information in the status response
​
status
string
Response status (“successful” or “failed”)
​
data
object
System status information including database statistics

​
Get Version

GET /version
Returns the MCRIT version information. 
{
  "status": "successful",
  "data": {
    "version": "1.0.0"
  }
}

​
Get Configuration

GET /config
This endpoint is currently not implemented.
Returns the MCRIT configuration settings.

​
Export Data

GET /export
Exports all MCRIT data.
​
compress
boolean
default:"false"
Compress the exported data
​
status
string
Response status
​
data
object
Exported data including samples, families, and functions

​
Export Selection

GET /export/{comma_separated_sample_ids}
Exports specific samples by their IDs.
​
comma_separated_sample_ids
string
required
Comma-separated list of sample IDs (e.g., “1,2,3”)
​
compress
boolean
default:"false"
Compress the exported data

​
Import Data

POST /import
Imports MCRIT data from a previously exported dataset.
​
import_data
object
required
Exported data to import
​
status
string
Response status
​
data
object
Import report with statistics

​
Respawn Instance

POST /respawn
This operation resets the entire MCRIT instance and deletes all data.
Resets the MCRIT instance by clearing all data from the database.

​
Complete MinHashes

GET /complete_minhashes
Calculates all missing MinHashes for all samples and functions.
​
status
string
Response status
​
data
object
Report with number of MinHashes calculated

​
Rebuild Index

GET /rebuild_index
Drops all MinHash bands and rebuilds the index using all existing MinHashes.

​
Recalculate PicHashes

GET /recalculate_pichashes
Recalculates all PicHashes for functions that may have outdated values.

​
Recalculate MinHashes

GET /recalculate_minhashes
Recalculates all MinHashes for functions that may have outdated values.

​
Search Families

GET /search/families
Searches for families based on a query string.
​
query
string
required
Search term to find families
​
cursor
string
Pagination cursor
​
sort_by
string
Field to sort results by
​
is_ascending
boolean
default:"true"
Sort order (true for ascending, false for descending)
​
limit
integer
Maximum number of results to return

​
Search Samples

GET /search/samples
Searches for samples based on a query string.
​
query
string
required
Search term to find samples
​
cursor
string
Pagination cursor
​
sort_by
string
Field to sort results by
​
is_ascending
boolean
default:"true"
Sort order
​
limit
integer
Maximum number of results to return

​
Search Functions

GET /search/functions
Searches for functions based on a query string.
​
query
string
required
Search term to find functions
​
cursor
string
Pagination cursor
​
sort_by
string
Field to sort results by
​
is_ascending
boolean
default:"true"
Sort order
​
limit
integer
Maximum number of results to return

Build docs developers (and LLMs) love

Get started for freeTalk to us