### GET /api/system/product-features

Source: https://www.filescan.io/openapi.json

Get product features

```markdown
### Responses

#### 200 - Successful Response


#### 404 - Item not found

**ErrorMessageModel**
- **detail** (string) (required)

### Example Usage

```bash
curl -X GET "https://api.example.com/api/system/product-features"
```

```

--------------------------------

### GET /api/threatintel/get-similars

Source: https://www.filescan.io/openapi.json

Get reports with the same special hashes

```markdown
### Parameters

- **exclude_report_ids** (array (string), query, optional)
- **imphash** (string, query, optional)
- **ssdeep** (string, query, optional)
- **fuzzyfsiohash** (string, query, optional)
- **authentihash** (string, query, optional)
- **days** (integer, query, optional)

### Responses

#### 200 - Successful Response


#### 400 - Bad request

**ErrorMessageModel**
- **detail** (string) (required)

#### 401 - Not authorized

**ErrorMessageModel**
- **detail** (string) (required)

#### 422 - Validation Error

**HTTPValidationError**
- **detail** (array (object))
  Array items:
    - **loc** (array (string)) (required)
    - **msg** (string) (required)
    - **type** (string) (required)

### Example Usage

```bash
curl -X GET "https://api.example.com/api/threatintel/get-similars?exclude_report_ids=item1,item2&imphash=string&ssdeep=string&fuzzyfsiohash=string&authentihash=string&days=-1"
```

```

--------------------------------

### GET /api/system/config

Source: https://www.filescan.io/openapi.json

Obtain project configuration to use on front-end

```markdown
### Responses

#### 200 - Successful Response

**SystemConfig**
- **baseUrl** (string) (required)
- **allowAnonymousUsers** (boolean) (required)
- **appTitle** (string) (required)
- **appDescription** (string) (required)
- **adFrequency** (integer) (required)
- **buildType** (string (default|community|develop|onpremise)) (required): An enumeration. ("default"|"community"|"develop"|"onpremise")
- **maxUploadSize** (integer) (required)
- **maxUploadSizeLimit** (integer) (required)
- **username** (object) (required): Username config model for SystemConfig response model
  - **maximum_length** (integer) (required)
  - **regex** (string) (required)
- **password** (object) (required): Password config model for SystemConfig response model
  - **alpha_numeric** (boolean) (required)
  - **minimum_length** (integer) (required)
  - **mixed_case** (boolean) (required)
  - **special_characters** (boolean) (required)
- **tokenExpire** (object) (required): TokenExpire config model for SystemConfig response model
  - **signupConfirm** (integer) (required)
  - **passwordReset** (integer) (required)
  - **invite** (integer) (required)
- **reports** (object) (required): Reports config model for SystemConfig response model
  - **queryInterval** (object) (required): QueryInterval config model for ReportsConfig model
    - **initial** (integer) (required)
    - **withData** (integer) (required)
  - **signalTypeUpperLimit** (object) (required): SignalTypeUpperLimit config model for ReportsConfig model
    - **informational** (number) (required)
    - **suspicious** (number) (required)
  - **search** (object) (required): Search config model for ReportsConfig model
    - **page_size** (integer) (required)
    - **page_size_options** (array (integer)) (required)
    - **reportsLimit** (integer) (required)
    - **monthsLimit** (integer) (required)
  - **maxRetryCount** (integer) (required)
  - **viewFileContentSizeLimit** (integer) (required)
  - **keepJobResultSeconds** (integer) (required)
- **queueJobTimeout** (integer) (required)
- **languages** (object) (required): Languages config model for SystemConfig response model
  - **language** (string) (required)
  - **code** (string) (required)
- **scanFilesPerUpload** (integer) (required)
- **googleTagManagerID** (string) (required)
- **supportedTypes** (array (string (ace|apk|bat|64bits|bmp|csv|doc|docm|docx|dot|dotm|dotx|elf|eml|gif|hta|htm|html|iso|java|java-bytecode|javascript|jpg|lnk|mbox|mhtml|msg|msi|mso|odp|ods|odt|odg|odf|odc|odb|odi|ole|one|pdf|pedll|peexe|png|pot|potm|potx|powershell|ppt|pptm|pptx|ps|pub|rar|rfc822|rtf|svg|txt|vbs|wmv|wsf|xlm|xls|xlsb|xlsm|xlsx|xlt|xltm|xltx|xml|xsl|zip|7zip|exe|mail|ms-office|script))) (required)
- **fileCategories** (object) (required)
- **fileGeneralTypes** (object) (required)
- **constantStrings** (array (string)) (required)
- **defaultTheme** (string) (required)
- **iocs** (object) (required): IOCs config model for SystemConfig response model
  - **prevalenceExceptWhitelists** (boolean) (required)
  - **genQueryExceptWhitelists** (boolean) (required)
  - **prevalenceDayOptions** (array (integer)) (required)
- **admin** (object) (required): Admin config model for SystemConfig response model
  - **pageSize** (integer) (required)
- **logoSelectedTime** (object) (required): LogoSelectedTime config model for SystemConfig response model
  - **light** (object) (required): LogoTypeSelectedTime config model for LogoSelectedTimeConfig model
    - **main** (integer) (required)
    - **top_menu** (integer) (required)
    - **footer** (integer) (required)
  - **dark** (object) (required): LogoTypeSelectedTime config model for LogoSelectedTimeConfig model
- **askTermsConsent** (boolean) (required)
- **scanBigFileSize** (integer) (required)
- **statOverview** (object) (required): StatOverview config model for SystemConfig response model
  - **timelineMonths** (array (string)) (required)
  - **topItemsLimit** (integer) (required)
  - **leaderboardItemsLimit** (integer) (required)
- **jobs** (object) (required): Jobs config model for SystemConfig response model
  - **memoryLimit** (integer) (required)
  - **chartControlTime** (integer) (required)
  - **memoryUsageTop** (integer) (required)
- **similaritySearchEnabled** (boolean) (required)
- **TLDTypes** (array (string (com|org|edu|gov|uk|net|ca|de|jp|fr|au|us|ru|ch|it|nl|se|no|es|mil|aero|biz|coop|info|museum|name|pro|ac|ad|ae|af|ag|al|ai|am|ao|aq|ar|as|at|az|ba|bb|be|bf|bg|bh|bm|bn|bo|br|bt|bw|by|bz|cc|cd|cg|cl|cm|co|cr|cu|cx|cy|cz|dj|dk|do|dz|ec|ee|eg|et|fi|fj|fm|fo|ga|ge|gg|gh|gi|gl|gr|gs|gt|hk|hm|hn|hr|hu|id|ie|il|im|io|ir|je|jm|jo|ke|kg|kh|ki|kr|kw|ky|kz|la|lb|li|lk|lt|lu|lv|ly|ma|mc|md|mg|mk|mm|mn|mo|mp|mr|ms|mt|mu|mv|mx|my|mz|na|nc|ne|ng|ni|np|nr|nu|nz|om|pa|pe|pf|pg|ph|pk|pl|pr|pt|pw|qa|re|ro|rw|sa|sc|sg|sh|si|sk|sm|sn|sr|st|sv|sy|tc|tf|th|tj|tk|tm|tn|to|tp|tr|tt|tv|tw|tz|ua|ug|uy|uz|va|vc|ve|vg|vi|vn|vu|ws|ye|yu|za|zm|zw))) (required)
- **showFooter** (boolean) (required)
- **maintenance** (object) (required): Maintenance config model for SystemConfig response model
  - **blockScan** (boolean) (required)
  - **blockScanNotification** (string) (required)
  - **blockSearch** (boolean) (required)
  - **blockSearchNotification** (string) (required)
- **allowedFeatures** (array (string)) (required)
- **ocm** (object) (required): OCM config model for SystemConfig response model
  - **clientUrl** (string) (required)
- **extraButton** (object) (required): ExtraButton config model for SystemConfig response model
  - **text** (string) (required)
  - **link** (string) (required)
  - **active** (boolean) (required)
- **newsLimit** (integer) (required)
- **automaticReportFilesDownload** (boolean) (required)

### Example Usage

```bash
curl -X GET "https://api.example.com/api/system/config"
```

```

--------------------------------

### GET /api/system/info

Source: https://www.filescan.io/openapi.json

Return general information about webservice, just to indicate that API is working

```markdown
### Responses

#### 200 - Successful Response

**GeneralSystemInfo**
- **title** (string) (required)
- **description** (string) (required)
- **api_version** (string) (required)
- **release_version** (string) (required)
- **release_date** (string (date-time)) (required)

### Example Usage

```bash
curl -X GET "https://api.example.com/api/system/info"
```

```

--------------------------------

### GET /api/system/version

Source: https://www.filescan.io/openapi.json

Return the version of the webservice

```markdown
### Responses

#### 200 - Successful Response


### Example Usage

```bash
curl -X GET "https://api.example.com/api/system/version"
```

```

--------------------------------

### GET /api/docs/sitemap

Source: https://www.filescan.io/openapi.json

Get sitemap xml

```markdown
### Responses

#### 200 - Successful Response


### Example Usage

```bash
curl -X GET "https://api.example.com/api/docs/sitemap"
```

```

--------------------------------

### GET /api/system/mitre

Source: https://www.filescan.io/openapi.json

Obtain MITRE tactics and techniques

```markdown
### Responses

#### 200 - Successful Response


#### 404 - Item not found

**ErrorMessageModel**
- **detail** (string) (required)

### Example Usage

```bash
curl -X GET "https://api.example.com/api/system/mitre"
```

```

--------------------------------

### GET /api/docs

Source: https://www.filescan.io/openapi.json

Return API docs UI

```markdown
### Responses

#### 200 - Successful Response


### Example Usage

```bash
curl -X GET "https://api.example.com/api/docs"
```

```

--------------------------------

### GET /api/docs/styles

Source: https://www.filescan.io/openapi.json

Return styles for api docs

```markdown
### Responses

#### 200 - Successful Response


### Example Usage

```bash
curl -X GET "https://api.example.com/api/docs/styles"
```

```

--------------------------------

### POST /api/reputation/{ioc_type}

Source: https://www.filescan.io/openapi.json

Get the reputation for more IOCs

```markdown
### Parameters

- **ioc_type** (ReputationIocType, path, required)

### Request Body

**Content-Type:** application/json

- Array of string

### Responses

#### 200 - Successful Response

- Array of object
  - **ioc_type** (string) (required)
  - **ioc_value** (string) (required)
  - **overall_verdict** (string (unknown|benign|informational|no_threat|suspicious|likely_malicious|malicious)) (required): An enumeration. ("unknown"|"benign"|"informational"|"no_threat"|"suspicious"|"likely_malicious"|"malicious")
  - **mdcloud** (object): Result of one lookup for IP, domain or URL
    - **scan_time** (string (date-time)) (required)
    - **detected** (integer) (required)
  - **community** (object)
    - **vote_malicious** (integer) (required)
    - **vote_benign** (integer) (required)
  - **filescan_reports** (array (object)) (required)
    Array items:
      - **verdict** (string (unknown|benign|informational|no_threat|suspicious|likely_malicious|malicious)) (required): An enumeration. ("unknown"|"benign"|"informational"|"no_threat"|"suspicious"|"likely_malicious"|"malicious")
      - **report_date** (string)
      - **report_id** (string) (required)
      - **flow_id** (string)

#### 400 - Bad request

**ErrorMessageModel**
- **detail** (string) (required)

#### 401 - Not authorized

**ErrorMessageModel**
- **detail** (string) (required)

#### 415 - Unsupported media type

**ErrorMessageModel**
- **detail** (string) (required)

#### 422 - Validation Error

**HTTPValidationError**
- **detail** (array (object))
  Array items:
    - **loc** (array (string)) (required)
    - **msg** (string) (required)
    - **type** (string) (required)

### Example Usage

```bash
curl -X POST "https://api.example.com/api/reputation/{ioc_type}" \
  -H "Content-Type: application/json" \
  -d '[
  "string"
]'
```

```

--------------------------------

### GET /api/backend/reputation

Source: https://www.filescan.io/openapi.json

Wrapper for reputation api

```markdown
### Parameters

- **sha256** (string, query, optional): SHA256 digest as found in the response of submit or extracted resource in the report.
- **hashes** (array (string), query, required): Array of one or more hashes

### Responses

#### 200 - Successful Response

**ReputationResponse**
- **processTime** (integer) (required)
- **reputationResults** (object) (required): Model for reputationResults field
  - **INTERNAL** (object) (required): Model for INTERNAL field
    - **processTime** (integer) (required)
    - **whitelistedHashes** (array (unknown)) (required)
    - **invalidHashes** (array (unknown)) (required)

#### 422 - Validation Error

**HTTPValidationError**
- **detail** (array (object))
  Array items:
    - **loc** (array (string)) (required)
    - **msg** (string) (required)
    - **type** (string) (required)

#### 500 - Internal server error

**ErrorMessageModel**
- **detail** (string) (required)

### Example Usage

```bash
curl -X GET "https://api.example.com/api/backend/reputation?sha256=string&hashes=item1,item2"
```

```

--------------------------------

### GET /api/system/languages

Source: https://www.filescan.io/openapi.json

Obtain list of all detectable (and probably even more) languages

```markdown
### Responses

#### 200 - Successful Response


#### 404 - Item not found

**ErrorMessageModel**
- **detail** (string) (required)

### Example Usage

```bash
curl -X GET "https://api.example.com/api/system/languages"
```

```

--------------------------------

### Schema: SiteTheme

Source: https://www.filescan.io/openapi.json

All available themes

```markdown
## Schema: SiteTheme

All available themes

**Type:** string


```

--------------------------------

### GET /api/system/news

Source: https://www.filescan.io/openapi.json

Get news

```markdown
### Responses

#### 200 - Successful Response

- Array of object
  - **id** (string) (required)
  - **link** (string) (required)
  - **date** (string) (required): Represenation of news date, is shown as is
  - **text** (string) (required)
  - **images** (string): Comma separated list of images URLs
  - **order** (integer) (required): In what order news should be shown
  - **active** (boolean) (required): If this news item should be shown

### Example Usage

```bash
curl -X GET "https://api.example.com/api/system/news"
```

```

--------------------------------

### GET /api/users/stat/iocs

Source: https://www.filescan.io/openapi.json

Get app statistics

```markdown
### Responses

#### 200 - Successful Response

**StatForResponse**
- **count** (integer) (required)
- **updated** (string (date-time)) (required)

#### 401 - Not authorized

**ErrorMessageModel**
- **detail** (string) (required)

### Example Usage

```bash
curl -X GET "https://api.example.com/api/users/stat/iocs"
```

```

--------------------------------

### GET /api/similarity-search/similarity

Source: https://www.filescan.io/openapi.json

Get similar reports

```markdown
### Parameters

- **hash** (string, query, optional)
- **min_similarity** (integer, query, optional)
- **verdict** (ReportVerdict, query, optional)
- **tags** (array (string), query, optional)

### Responses

#### 200 - Successful Response

**SimilaritiesResponse**
- **note** (string): Optinal notification about demo data
- **most_similar** (array (object))
  Array items:
    - **sha256** (string) (required)
    - **overall_similarity** (number) (required)
    - **similarities** (object) (required)
      - **extracted** (number)
      - **threat_indicators** (number)
      - **sections** (number)
      - **mitre_techniques** (number)
      - **binary_metadata** (number)
      - **certificates** (number)
      - **characteristic** (number)
      - **disassembly_sections** (number)
      - **dotnet_info** (number)
      - **header_info** (number)
      - **imports** (number)
      - **pdb_guid** (number)
      - **resources** (number)
      - **rich_header_compiler_ids** (number)
      - **strings** (number)
      - **version_info** (number)
      - **apk** (number)
      - **biffopcodes** (number)
      - **emulation** (number)
      - **extendeddata** (number)
      - **metadata** (number)
      - **segments** (number)
      - **content_parse** (number)
      - **image_ocr** (number)
      - **binary_internal** (number)
      - **strings_input_file** (number)
      - **triggeredconsumerids** (number)
      - **vba_emulation** (number)
      - **yara** (number)
      - **signal_ids** (number)
      - **certifications** (number)
      - **weighted_numerics** (number)
    - **details** (object) (required)
      - **start_date** (string (date-time)) (required)
      - **file_size** (number) (required)
      - **tags** (array (string)) (required)
      - **verdict** (string (unknown|benign|informational|no_threat|suspicious|likely_malicious|malicious)) (required): An enumeration. ("unknown"|"benign"|"informational"|"no_threat"|"suspicious"|"likely_malicious"|"malicious")
      - **is_dotnet** (integer)
      - **architecture** (string)
      - **entropy** (number)
- **most_recent** (array (object))
  Array items:

#### 400 - Bad request

**ErrorMessageModel**
- **detail** (string) (required)

#### 401 - Not authorized

**ErrorMessageModel**
- **detail** (string) (required)

#### 422 - Validation Error

**HTTPValidationError**
- **detail** (array (object))
  Array items:
    - **loc** (array (string)) (required)
    - **msg** (string) (required)
    - **type** (string) (required)

### Example Usage

```bash
curl -X GET "https://api.example.com/api/similarity-search/similarity?hash=string&min_similarity=0&verdict=value&tags=item1,item2"
```

```

--------------------------------

### Schema: ScanEngineServerInfo

Source: https://www.filescan.io/openapi.json

Server general info, including license data

```markdown
## Schema: ScanEngineServerInfo

Server general info, including license data

**Type:** object

- **version_info** (object)
- **license_data** (object)
- **is_healthy** (boolean)

```

--------------------------------

### Schema: PEEmulationFile

Source: https://www.filescan.io/openapi.json

PE emulation file names

```markdown
## Schema: PEEmulationFile

PE emulation file names

**Type:** string


```

--------------------------------

### GET /api/users/uploads

Source: https://www.filescan.io/openapi.json

Get all public reports

```markdown
### Parameters

- **page** (integer, query, optional): Page number starting from 1
- **page_size** (union, query, optional): Page size

### Responses

#### 200 - Successful Response

**ReportSearchResponse**
- **items** (array (unknown)) (required)
- **count** (integer) (required)
- **count_search_params** (integer)
- **method** (string) (required)
- **dbs_sync** (boolean)

#### 400 - Bad request

**ErrorMessageModel**
- **detail** (string) (required)

#### 401 - Not authorized

**ErrorMessageModel**
- **detail** (string) (required)

#### 422 - Validation Error

**HTTPValidationError**
- **detail** (array (object))
  Array items:
    - **loc** (array (string)) (required)
    - **msg** (string) (required)
    - **type** (string) (required)

### Example Usage

```bash
curl -X GET "https://api.example.com/api/users/uploads?page=1&page_size=10"
```

```

--------------------------------

### Schema: MainTaskSimplifiedState

Source: https://www.filescan.io/openapi.json

An enumeration.

```markdown
## Schema: MainTaskSimplifiedState

An enumeration.

**Type:** string


```

--------------------------------

### GET /api/reports

Source: https://www.filescan.io/openapi.json

Get all public reports

```markdown
### Parameters

- **page** (integer, query, optional): Page number starting from 1
- **page_size** (union, query, optional): Page size

### Responses

#### 200 - Successful Response

**ReportSearchResponse**
- **items** (array (unknown)) (required)
- **count** (integer) (required)
- **count_search_params** (integer)
- **method** (string) (required)
- **dbs_sync** (boolean)

#### 400 - Bad request

**ErrorMessageModel**
- **detail** (string) (required)

#### 401 - Not authorized

**ErrorMessageModel**
- **detail** (string) (required)

#### 422 - Validation Error

**HTTPValidationError**
- **detail** (array (object))
  Array items:
    - **loc** (array (string)) (required)
    - **msg** (string) (required)
    - **type** (string) (required)

### Example Usage

```bash
curl -X GET "https://api.example.com/api/reports?page=1&page_size=10"
```

```

--------------------------------

### Schema: SignupPayload

Source: https://www.filescan.io/openapi.json

Schema definition for SignupPayload

```markdown
## Schema: SignupPayload

Schema definition for SignupPayload

**Type:** object

- **username** (string)
- **email** (string) (required)
- **email_confirm** (string)
- **password** (string) (required)
- **password_confirm** (string) (required)
- **invite_token** (string)
- **policy_accepted** (boolean) (required)

```

--------------------------------

### GET /api/system/logo

Source: https://www.filescan.io/openapi.json

Get logo image

```markdown
### Parameters

- **type** (union, query, optional)
- **theme** (union, query, optional)
- **name** (string, query, optional)

### Responses

#### 200 - Successful Response

Empty response body

#### 404 - Item not found

**ErrorMessageModel**
- **detail** (string) (required)

#### 422 - Validation Error

**HTTPValidationError**
- **detail** (array (object))
  Array items:
    - **loc** (array (string)) (required)
    - **msg** (string) (required)
    - **type** (string) (required)

### Example Usage

```bash
curl -X GET "https://api.example.com/api/system/logo?type=main&theme=light&name=string"
```

```

--------------------------------

### Schema: ScanState

Source: https://www.filescan.io/openapi.json

Scan state of ScanInit instance

```markdown
## Schema: ScanState

Scan state of ScanInit instance

**Type:** string


```

--------------------------------

### GET /api/feed/info

Source: https://www.filescan.io/openapi.json

Get reports feed info

```markdown
### Responses

#### 200 - Successful Response

**FeedInfo**
- **count** (integer) (required)
- **length** (integer) (required)
- **updated** (number) (required)
- **download_allowed** (boolean) (required)

#### 401 - Not authorized

**ErrorMessageModel**
- **detail** (string) (required)

### Example Usage

```bash
curl -X GET "https://api.example.com/api/feed/info"
```

```

--------------------------------

### GET /api/feed/reports/info

Source: https://www.filescan.io/openapi.json

Get reports feed info

```markdown
### Responses

#### 200 - Successful Response

**FeedInfo**
- **count** (integer) (required)
- **length** (integer) (required)
- **updated** (number) (required)
- **download_allowed** (boolean) (required)

#### 401 - Not authorized

**ErrorMessageModel**
- **detail** (string) (required)

### Example Usage

```bash
curl -X GET "https://api.example.com/api/feed/reports/info"
```

```

--------------------------------

### Schema: EmailFirstFetchMode

Source: https://www.filescan.io/openapi.json

What emails to fetch on first time accessing account

```markdown
## Schema: EmailFirstFetchMode

What emails to fetch on first time accessing account

**Type:** string


```

--------------------------------

### GET /api/users/most-interesting

Source: https://www.filescan.io/openapi.json

Get most interesting report recently

```markdown
### Responses

#### 200 - Successful Response

**MostInterestingResponse**
- **report** (object)
- **updated** (string (date-time))

#### 401 - Not authorized

**ErrorMessageModel**
- **detail** (string) (required)

### Example Usage

```bash
curl -X GET "https://api.example.com/api/users/most-interesting"
```

```

--------------------------------

### Schema: ExtraButtonConfig

Source: https://www.filescan.io/openapi.json

ExtraButton config model for SystemConfig response model

```markdown
## Schema: ExtraButtonConfig

ExtraButton config model for SystemConfig response model

**Type:** object

- **text** (string) (required)
- **link** (string) (required)
- **active** (boolean) (required)

```

--------------------------------

### Schema: GeneralSystemInfo

Source: https://www.filescan.io/openapi.json

Response model for /api/system/info endpoint

```markdown
## Schema: GeneralSystemInfo

Response model for /api/system/info endpoint

**Type:** object

- **title** (string) (required)
- **description** (string) (required)
- **api_version** (string) (required)
- **release_version** (string) (required)
- **release_date** (string (date-time)) (required)

```

--------------------------------

### GET /api/reputation/hash

Source: https://www.filescan.io/openapi.json

Get the reputation for one given hash

```markdown
### Parameters

- **sha256** (string, query, required)

### Responses

#### 200 - Successful Response

**ReputationResultHash**
- **sha256** (string) (required)
- **overall_verdict** (string (unknown|benign|informational|no_threat|suspicious|likely_malicious|malicious)) (required): An enumeration. ("unknown"|"benign"|"informational"|"no_threat"|"suspicious"|"likely_malicious"|"malicious")
- **fuzzyhash** (object): Fuzzy hash verdict
  - **hash** (string)
  - **verdict** (string (unknown|benign|informational|no_threat|suspicious|likely_malicious|malicious)) (required): An enumeration. ("unknown"|"benign"|"informational"|"no_threat"|"suspicious"|"likely_malicious"|"malicious")
- **mdcloud** (object): Result of one multiscan
  - **total_av_engines** (integer) (required)
  - **detected_av_engines** (integer) (required)
  - **scan_time** (string (date-time)) (required)
- **filescan_reports** (array (object)) (required)
  Array items:
    - **verdict** (string (unknown|benign|informational|no_threat|suspicious|likely_malicious|malicious)) (required): An enumeration. ("unknown"|"benign"|"informational"|"no_threat"|"suspicious"|"likely_malicious"|"malicious")
    - **report_date** (string)
    - **report_id** (string) (required)
    - **flow_id** (string)

#### 400 - Bad request

**ErrorMessageModel**
- **detail** (string) (required)

#### 401 - Not authorized

**ErrorMessageModel**
- **detail** (string) (required)

#### 415 - Unsupported media type

**ErrorMessageModel**
- **detail** (string) (required)

#### 422 - Validation Error

**HTTPValidationError**
- **detail** (array (object))
  Array items:
    - **loc** (array (string)) (required)
    - **msg** (string) (required)
    - **type** (string) (required)

### Example Usage

```bash
curl -X GET "https://api.example.com/api/reputation/hash?sha256=string"
```

```

--------------------------------

### Schema: BuildType

Source: https://www.filescan.io/openapi.json

An enumeration.

```markdown
## Schema: BuildType

An enumeration.

**Type:** string


```

--------------------------------

### GET /api/users/get-frequent-tags

Source: https://www.filescan.io/openapi.json

Get most frequently seen tags recently

```markdown
### Responses

#### 200 - Successful Response

**FrequentTagsResponse**
- **tags** (array (object))
- **updated** (string (date-time))

#### 401 - Not authorized

**ErrorMessageModel**
- **detail** (string) (required)

### Example Usage

```bash
curl -X GET "https://api.example.com/api/users/get-frequent-tags"
```

```

--------------------------------

### Schema: SystemConfig

Source: https://www.filescan.io/openapi.json

Response model for /api/system/config endpoint

```markdown
## Schema: SystemConfig

Response model for /api/system/config endpoint

**Type:** object

- **baseUrl** (string) (required)
- **allowAnonymousUsers** (boolean) (required)
- **appTitle** (string) (required)
- **appDescription** (string) (required)
- **adFrequency** (integer) (required)
- **buildType** (string (default|community|develop|onpremise)) (required): An enumeration. ("default"|"community"|"develop"|"onpremise")
- **maxUploadSize** (integer) (required)
- **maxUploadSizeLimit** (integer) (required)
- **username** (object) (required): Username config model for SystemConfig response model
  - **maximum_length** (integer) (required)
  - **regex** (string) (required)
- **password** (object) (required): Password config model for SystemConfig response model
  - **alpha_numeric** (boolean) (required)
  - **minimum_length** (integer) (required)
  - **mixed_case** (boolean) (required)
  - **special_characters** (boolean) (required)
- **tokenExpire** (object) (required): TokenExpire config model for SystemConfig response model
  - **signupConfirm** (integer) (required)
  - **passwordReset** (integer) (required)
  - **invite** (integer) (required)
- **reports** (object) (required): Reports config model for SystemConfig response model
  - **queryInterval** (object) (required): QueryInterval config model for ReportsConfig model
    - **initial** (integer) (required)
    - **withData** (integer) (required)
  - **signalTypeUpperLimit** (object) (required): SignalTypeUpperLimit config model for ReportsConfig model
    - **informational** (number) (required)
    - **suspicious** (number) (required)
  - **search** (object) (required): Search config model for ReportsConfig model
    - **page_size** (integer) (required)
    - **page_size_options** (array (integer)) (required)
    - **reportsLimit** (integer) (required)
    - **monthsLimit** (integer) (required)
  - **maxRetryCount** (integer) (required)
  - **viewFileContentSizeLimit** (integer) (required)
  - **keepJobResultSeconds** (integer) (required)
- **queueJobTimeout** (integer) (required)
- **languages** (object) (required): Languages config model for SystemConfig response model
  - **language** (string) (required)
  - **code** (string) (required)
- **scanFilesPerUpload** (integer) (required)
- **googleTagManagerID** (string) (required)
- **supportedTypes** (array (string (ace|apk|bat|64bits|bmp|csv|doc|docm|docx|dot|dotm|dotx|elf|eml|gif|hta|htm|html|iso|java|java-bytecode|javascript|jpg|lnk|mbox|mhtml|msg|msi|mso|odp|ods|odt|odg|odf|odc|odb|odi|ole|one|pdf|pedll|peexe|png|pot|potm|potx|powershell|ppt|pptm|pptx|ps|pub|rar|rfc822|rtf|svg|txt|vbs|wmv|wsf|xlm|xls|xlsb|xlsm|xlsx|xlt|xltm|xltx|xml|xsl|zip|7zip|exe|mail|ms-office|script))) (required)
- **fileCategories** (object) (required)
- **fileGeneralTypes** (object) (required)
- **constantStrings** (array (string)) (required)
- **defaultTheme** (string) (required)
- **iocs** (object) (required): IOCs config model for SystemConfig response model
  - **prevalenceExceptWhitelists** (boolean) (required)
  - **genQueryExceptWhitelists** (boolean) (required)
  - **prevalenceDayOptions** (array (integer)) (required)
- **admin** (object) (required): Admin config model for SystemConfig response model
  - **pageSize** (integer) (required)
- **logoSelectedTime** (object) (required): LogoSelectedTime config model for SystemConfig response model
  - **light** (object) (required): LogoTypeSelectedTime config model for LogoSelectedTimeConfig model
    - **main** (integer) (required)
    - **top_menu** (integer) (required)
    - **footer** (integer) (required)
  - **dark** (object) (required): LogoTypeSelectedTime config model for LogoSelectedTimeConfig model
- **askTermsConsent** (boolean) (required)
- **scanBigFileSize** (integer) (required)
- **statOverview** (object) (required): StatOverview config model for SystemConfig response model
  - **timelineMonths** (array (string)) (required)
  - **topItemsLimit** (integer) (required)
  - **leaderboardItemsLimit** (integer) (required)
- **jobs** (object) (required): Jobs config model for SystemConfig response model
  - **memoryLimit** (integer) (required)
  - **chartControlTime** (integer) (required)
  - **memoryUsageTop** (integer) (required)
- **similaritySearchEnabled** (boolean) (required)
- **TLDTypes** (array (string (com|org|edu|gov|uk|net|ca|de|jp|fr|au|us|ru|ch|it|nl|se|no|es|mil|aero|biz|coop|info|museum|name|pro|ac|ad|ae|af|ag|al|ai|am|ao|aq|ar|as|at|az|ba|bb|be|bf|bg|bh|bm|bn|bo|br|bt|bw|by|bz|cc|cd|cg|cl|cm|co|cr|cu|cx|cy|cz|dj|dk|do|dz|ec|ee|eg|et|fi|fj|fm|fo|ga|ge|gg|gh|gi|gl|gr|gs|gt|hk|hm|hn|hr|hu|id|ie|il|im|io|ir|je|jm|jo|ke|kg|kh|ki|kr|kw|ky|kz|la|lb|li|lk|lt|lu|lv|ly|ma|mc|md|mg|mk|mm|mn|mo|mp|mr|ms|mt|mu|mv|mx|my|mz|na|nc|ne|ng|ni|np|nr|nu|nz|om|pa|pe|pf|pg|ph|pk|pl|pr|pt|pw|qa|re|ro|rw|sa|sc|sg|sh|si|sk|sm|sn|sr|st|sv|sy|tc|tf|th|tj|tk|tm|tn|to|tp|tr|tt|tv|tw|tz|ua|ug|uy|uz|va|vc|ve|vg|vi|vn|vu|ws|ye|yu|za|zm|zw))) (required)
- **showFooter** (boolean) (required)
- **maintenance** (object) (required): Maintenance config model for SystemConfig response model
  - **blockScan** (boolean) (required)
  - **blockScanNotification** (string) (required)
  - **blockSearch** (boolean) (required)
  - **blockSearchNotification** (string) (required)
- **allowedFeatures** (array (string)) (required)
- **ocm** (object) (required): OCM config model for SystemConfig response model
  - **clientUrl** (string) (required)
- **extraButton** (object) (required): ExtraButton config model for SystemConfig response model
  - **text** (string) (required)
  - **link** (string) (required)
  - **active** (boolean) (required)
- **newsLimit** (integer) (required)
- **automaticReportFilesDownload** (boolean) (required)

```

--------------------------------

### GET /api/reputation/{ioc_type}

Source: https://www.filescan.io/openapi.json

Get the reputation for one given IOC

```markdown
### Parameters

- **ioc_type** (ReputationIocType, path, required)
- **ioc_value** (string, query, required)

### Responses

#### 200 - Successful Response

**ReputationResultIoc**
- **ioc_type** (string) (required)
- **ioc_value** (string) (required)
- **overall_verdict** (string (unknown|benign|informational|no_threat|suspicious|likely_malicious|malicious)) (required): An enumeration. ("unknown"|"benign"|"informational"|"no_threat"|"suspicious"|"likely_malicious"|"malicious")
- **mdcloud** (object): Result of one lookup for IP, domain or URL
  - **scan_time** (string (date-time)) (required)
  - **detected** (integer) (required)
- **community** (object)
  - **vote_malicious** (integer) (required)
  - **vote_benign** (integer) (required)
- **filescan_reports** (array (object)) (required)
  Array items:
    - **verdict** (string (unknown|benign|informational|no_threat|suspicious|likely_malicious|malicious)) (required): An enumeration. ("unknown"|"benign"|"informational"|"no_threat"|"suspicious"|"likely_malicious"|"malicious")
    - **report_date** (string)
    - **report_id** (string) (required)
    - **flow_id** (string)

#### 400 - Bad request

**ErrorMessageModel**
- **detail** (string) (required)

#### 401 - Not authorized

**ErrorMessageModel**
- **detail** (string) (required)

#### 415 - Unsupported media type

**ErrorMessageModel**
- **detail** (string) (required)

#### 422 - Validation Error

**HTTPValidationError**
- **detail** (array (object))
  Array items:
    - **loc** (array (string)) (required)
    - **msg** (string) (required)
    - **type** (string) (required)

### Example Usage

```bash
curl -X GET "https://api.example.com/api/reputation/{ioc_type}?ioc_value=string"
```

```

--------------------------------

### Schema: LicenseResponse

Source: https://www.filescan.io/openapi.json

Fsbroker health log

```markdown
## Schema: LicenseResponse

Fsbroker health log

**Type:** object

- **http_info** (object) (required): HTTP health log
  - **response_time_ms** (integer)
  - **response_code_http** (integer)
  - **request_success** (boolean) (required)
- **response** (object)
- **message** (string)
- **calculated_health** (boolean)

```

--------------------------------

### GET /api/users/{account_id}/avatar

Source: https://www.filescan.io/openapi.json

Get use avatar image

```markdown
### Parameters

- **account_id** (string, path, required)

### Responses

#### 200 - Successful Response


#### 401 - Not authorized

**ErrorMessageModel**
- **detail** (string) (required)

#### 404 - Item not found

**ErrorMessageModel**
- **detail** (string) (required)

#### 422 - Validation Error

**HTTPValidationError**
- **detail** (array (object))
  Array items:
    - **loc** (array (string)) (required)
    - **msg** (string) (required)
    - **type** (string) (required)

### Example Usage

```bash
curl -X GET "https://api.example.com/api/users/{account_id}/avatar"
```

```

--------------------------------

### GET /api/feed/atom

Source: https://www.filescan.io/openapi.json

Get reports feed.

For API documentation page we show smaller amount of reports. To get full feed, query feed endpoint directly from browser address bar or from any suitable app.

```markdown
### Responses

#### 200 - Successful Response


#### 401 - Not authorized

**ErrorMessageModel**
- **detail** (string) (required)

### Example Usage

```bash
curl -X GET "https://api.example.com/api/feed/atom"
```

```

--------------------------------

### GET /api/feed/reports

Source: https://www.filescan.io/openapi.json

Get reports feed.

For API documentation page we show smaller amount of reports. To get full feed, query feed endpoint directly from browser address bar or from any suitable app.

```markdown
### Responses

#### 200 - Successful Response


#### 401 - Not authorized

**ErrorMessageModel**
- **detail** (string) (required)

### Example Usage

```bash
curl -X GET "https://api.example.com/api/feed/reports"
```

```

--------------------------------

### Schema: ScheduleTaskTriggerUnit

Source: https://www.filescan.io/openapi.json

An enumeration.

```markdown
## Schema: ScheduleTaskTriggerUnit

An enumeration.

**Type:** string


```

--------------------------------

### Schema: AdminGenericLogsResponse

Source: https://www.filescan.io/openapi.json

Customize admin response models

```markdown
## Schema: AdminGenericLogsResponse

Customize admin response models

**Type:** object

- **items** (array (object)) (required)
  Array items:
    - **id** (string) (required)
    - **key** (string) (required)
    - **key_type** (string (scan_init_id|new_search)) (required): Type of key attribute for logging record ("scan_init_id"|"new_search")
    - **data** (unknown): Logging data itself
    - **note** (string): Note describing log specifics
    - **related_url** (string): Related site page, if it exists
    - **saved_date** (string (date-time)): Date when logging record was created
- **total_count** (integer) (required)
- **matched_count** (integer)

```