> For the complete documentation index, see [llms.txt](https://docs.malwation.com/threatzone/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.malwation.com/threatzone/api-docs/models.md).

# Models

## The MetafieldDto object

```json
{"openapi":"3.0.0","info":{"title":"Threat.Zone Public API","version":"1.0.0"},"components":{"schemas":{"MetafieldDto":{"type":"object","properties":{"metafieldId":{"type":"string","description":"Metafield key"},"value":{"description":"Metafield value","oneOf":[{"type":"string"},{"type":"boolean"},{"type":"number"}]}},"required":["metafieldId","value"]}}}}
```

## The LevelDto object

```json
{"openapi":"3.0.0","info":{"title":"Threat.Zone Public API","version":"1.0.0"},"components":{"schemas":{"LevelDto":{"type":"object","properties":{"value":{"type":"number","description":"Level number"},"description":{"type":"string","description":"Level description"}},"required":["value","description"]}}}}
```

## The StatusDto object

```json
{"openapi":"3.0.0","info":{"title":"Threat.Zone Public API","version":"1.0.0"},"components":{"schemas":{"StatusDto":{"type":"object","properties":{"value":{"type":"number","description":"Status number"},"description":{"type":"string","description":"Status description"}},"required":["value","description"]}}}}
```

## The WorkspaceInfo object

```json
{"openapi":"3.0.0","info":{"title":"Threat.Zone Public API","version":"1.0.0"},"components":{"schemas":{"WorkspaceInfo":{"type":"object","properties":{"name":{"type":"string"},"alias":{"type":"string"},"private":{"type":"boolean"},"type":{"type":"string"}},"required":["name","alias","private","type"]}}}}
```

## The LimitsCount object

```json
{"openapi":"3.0.0","info":{"title":"Threat.Zone Public API","version":"1.0.0"},"components":{"schemas":{"LimitsCount":{"type":"object","properties":{"apiRequestCount":{"type":"number"},"dailySubmissionCount":{"type":"number"},"concurrentSubmissionCount":{"type":"number"}},"required":["apiRequestCount","dailySubmissionCount","concurrentSubmissionCount"]}}}}
```

## The UserInfo object

```json
{"openapi":"3.0.0","info":{"title":"Threat.Zone Public API","version":"1.0.0"},"components":{"schemas":{"UserInfo":{"type":"object","properties":{"email":{"type":"string"},"fullName":{"type":"string"},"workspace":{"$ref":"#/components/schemas/WorkspaceInfo"},"limitsCount":{"$ref":"#/components/schemas/LimitsCount"}},"required":["email","fullName","workspace","limitsCount"]},"WorkspaceInfo":{"type":"object","properties":{"name":{"type":"string"},"alias":{"type":"string"},"private":{"type":"boolean"},"type":{"type":"string"}},"required":["name","alias","private","type"]},"LimitsCount":{"type":"object","properties":{"apiRequestCount":{"type":"number"},"dailySubmissionCount":{"type":"number"},"concurrentSubmissionCount":{"type":"number"}},"required":["apiRequestCount","dailySubmissionCount","concurrentSubmissionCount"]}}}}
```

## The FileLimits object

```json
{"openapi":"3.0.0","info":{"title":"Threat.Zone Public API","version":"1.0.0"},"components":{"schemas":{"FileLimits":{"type":"object","properties":{"extensions":{"type":"object"},"fileSize":{"type":"string"}},"required":["extensions","fileSize"]}}}}
```

## The SubmissionLimits object

```json
{"openapi":"3.0.0","info":{"title":"Threat.Zone Public API","version":"1.0.0"},"components":{"schemas":{"SubmissionLimits":{"type":"object","properties":{"apiLimit":{"type":"number"},"dailyLimit":{"type":"number"},"concurrentLimit":{"type":"number"}},"required":["apiLimit","dailyLimit","concurrentLimit"]}}}}
```

## The PlanInfo object

```json
{"openapi":"3.0.0","info":{"title":"Threat.Zone Public API","version":"1.0.0"},"components":{"schemas":{"PlanInfo":{"type":"object","properties":{"planName":{"type":"string"},"startTime":{"type":"string"},"endTime":{"type":"string"},"subsTime":{"type":"string"},"fileLimits":{"$ref":"#/components/schemas/FileLimits"},"submissionLimits":{"$ref":"#/components/schemas/SubmissionLimits"}},"required":["planName","startTime","endTime","subsTime","fileLimits","submissionLimits"]},"FileLimits":{"type":"object","properties":{"extensions":{"type":"object"},"fileSize":{"type":"string"}},"required":["extensions","fileSize"]},"SubmissionLimits":{"type":"object","properties":{"apiLimit":{"type":"number"},"dailyLimit":{"type":"number"},"concurrentLimit":{"type":"number"}},"required":["apiLimit","dailyLimit","concurrentLimit"]}}}}
```

## The ModuleInfo object

```json
{"openapi":"3.0.0","info":{"title":"Threat.Zone Public API","version":"1.0.0"},"components":{"schemas":{"ModuleInfo":{"type":"object","properties":{"moduleId":{"type":"string"},"moduleName":{"type":"string"},"startTime":{"type":"string"},"endTime":{"type":"string"}},"required":["moduleId","moduleName","startTime","endTime"]}}}}
```

## The UserInfoResponseDto object

```json
{"openapi":"3.0.0","info":{"title":"Threat.Zone Public API","version":"1.0.0"},"components":{"schemas":{"UserInfoResponseDto":{"type":"object","properties":{"userInfo":{"$ref":"#/components/schemas/UserInfo"},"plan":{"$ref":"#/components/schemas/PlanInfo"},"modules":{"type":"array","items":{"$ref":"#/components/schemas/ModuleInfo"}}},"required":["userInfo","plan","modules"]},"UserInfo":{"type":"object","properties":{"email":{"type":"string"},"fullName":{"type":"string"},"workspace":{"$ref":"#/components/schemas/WorkspaceInfo"},"limitsCount":{"$ref":"#/components/schemas/LimitsCount"}},"required":["email","fullName","workspace","limitsCount"]},"WorkspaceInfo":{"type":"object","properties":{"name":{"type":"string"},"alias":{"type":"string"},"private":{"type":"boolean"},"type":{"type":"string"}},"required":["name","alias","private","type"]},"LimitsCount":{"type":"object","properties":{"apiRequestCount":{"type":"number"},"dailySubmissionCount":{"type":"number"},"concurrentSubmissionCount":{"type":"number"}},"required":["apiRequestCount","dailySubmissionCount","concurrentSubmissionCount"]},"PlanInfo":{"type":"object","properties":{"planName":{"type":"string"},"startTime":{"type":"string"},"endTime":{"type":"string"},"subsTime":{"type":"string"},"fileLimits":{"$ref":"#/components/schemas/FileLimits"},"submissionLimits":{"$ref":"#/components/schemas/SubmissionLimits"}},"required":["planName","startTime","endTime","subsTime","fileLimits","submissionLimits"]},"FileLimits":{"type":"object","properties":{"extensions":{"type":"object"},"fileSize":{"type":"string"}},"required":["extensions","fileSize"]},"SubmissionLimits":{"type":"object","properties":{"apiLimit":{"type":"number"},"dailyLimit":{"type":"number"},"concurrentLimit":{"type":"number"}},"required":["apiLimit","dailyLimit","concurrentLimit"]},"ModuleInfo":{"type":"object","properties":{"moduleId":{"type":"string"},"moduleName":{"type":"string"},"startTime":{"type":"string"},"endTime":{"type":"string"}},"required":["moduleId","moduleName","startTime","endTime"]}}}}
```