# Models

## The Agent object

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"components":{"schemas":{"Agent":{"properties":{"session_id":{"type":"string","title":"Session Id"},"name":{"type":"string","title":"Name"},"listener":{"type":"string","title":"Listener"},"host_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Host Id"},"hostname":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Hostname"},"language":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Language"},"language_version":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Language Version"},"delay":{"type":"integer","title":"Delay"},"jitter":{"type":"number","title":"Jitter"},"external_ip":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"External Ip"},"internal_ip":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Internal Ip"},"username":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Username"},"high_integrity":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"High Integrity"},"process_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Process Id"},"process_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Process Name"},"os_details":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Os Details"},"nonce":{"type":"string","title":"Nonce"},"checkin_time":{"type":"string","format":"date-time","title":"Checkin Time"},"lastseen_time":{"type":"string","format":"date-time","title":"Lastseen Time"},"parent":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Parent"},"children":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Children"},"servers":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Servers"},"profile":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Profile"},"functions":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Functions"},"kill_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Kill Date"},"working_hours":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Working Hours"},"lost_limit":{"type":"integer","title":"Lost Limit"},"notes":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Notes"},"architecture":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Architecture"},"archived":{"type":"boolean","title":"Archived"},"stale":{"type":"boolean","title":"Stale"},"tags":{"items":{"$ref":"#/components/schemas/Tag"},"type":"array","title":"Tags"}},"type":"object","required":["session_id","name","listener","delay","jitter","nonce","checkin_time","lastseen_time","lost_limit","archived","stale","tags"],"title":"Agent"},"Tag":{"properties":{"id":{"type":"integer","title":"Id"},"name":{"type":"string","title":"Name"},"value":{"type":"string","title":"Value"},"label":{"type":"string","title":"Label"},"color":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Color"}},"type":"object","required":["id","name","value","label"],"title":"Tag"}}}}
```

## The AgentCheckIn object

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"components":{"schemas":{"AgentCheckIn":{"properties":{"agent_id":{"type":"string","title":"Agent Id"},"checkin_time":{"type":"string","format":"date-time","title":"Checkin Time"}},"type":"object","required":["agent_id","checkin_time"],"title":"AgentCheckIn"}}}}
```

## The AgentCheckInAggregate object

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"components":{"schemas":{"AgentCheckInAggregate":{"properties":{"count":{"type":"integer","title":"Count"},"checkin_time":{"type":"string","format":"date-time","title":"Checkin Time"}},"type":"object","required":["count","checkin_time"],"title":"AgentCheckInAggregate"}}}}
```

## The AgentCheckIns object

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"components":{"schemas":{"AgentCheckIns":{"properties":{"records":{"items":{"$ref":"#/components/schemas/AgentCheckIn"},"type":"array","title":"Records"},"limit":{"type":"integer","title":"Limit"},"page":{"type":"integer","title":"Page"},"total_pages":{"type":"integer","title":"Total Pages"},"total":{"type":"integer","title":"Total"}},"type":"object","required":["records","limit","page","total_pages","total"],"title":"AgentCheckIns"},"AgentCheckIn":{"properties":{"agent_id":{"type":"string","title":"Agent Id"},"checkin_time":{"type":"string","format":"date-time","title":"Checkin Time"}},"type":"object","required":["agent_id","checkin_time"],"title":"AgentCheckIn"}}}}
```

## The AgentCheckInsAggregate object

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"components":{"schemas":{"AgentCheckInsAggregate":{"properties":{"records":{"items":{"$ref":"#/components/schemas/AgentCheckInAggregate"},"type":"array","title":"Records"},"start_date":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Start Date"},"end_date":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"End Date"},"bucket_size":{"type":"string","title":"Bucket Size"}},"type":"object","required":["records","bucket_size"],"title":"AgentCheckInsAggregate"},"AgentCheckInAggregate":{"properties":{"count":{"type":"integer","title":"Count"},"checkin_time":{"type":"string","format":"date-time","title":"Checkin Time"}},"type":"object","required":["count","checkin_time"],"title":"AgentCheckInAggregate"}}}}
```

## The AgentFile object

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"components":{"schemas":{"AgentFile":{"properties":{"id":{"type":"integer","title":"Id"},"session_id":{"type":"string","title":"Session Id"},"name":{"type":"string","title":"Name"},"path":{"type":"string","title":"Path"},"is_file":{"type":"boolean","title":"Is File"},"parent_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Parent Id"},"downloads":{"items":{"$ref":"#/components/schemas/DownloadDescription"},"type":"array","title":"Downloads"},"children":{"items":{"$ref":"#/components/schemas/AgentFile"},"type":"array","title":"Children","default":[]}},"type":"object","required":["id","session_id","name","path","is_file","downloads"],"title":"AgentFile"},"DownloadDescription":{"properties":{"id":{"type":"integer","title":"Id"},"filename":{"type":"string","title":"Filename"},"link":{"type":"string","title":"Link"}},"type":"object","required":["id","filename","link"],"title":"DownloadDescription"}}}}
```

## The AgentTask object

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"components":{"schemas":{"AgentTask":{"properties":{"id":{"type":"integer","title":"Id"},"input":{"type":"string","title":"Input"},"full_input":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Full Input"},"output":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Output"},"original_output":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Original Output"},"user_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"User Id"},"username":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Username"},"agent_id":{"type":"string","title":"Agent Id"},"downloads":{"items":{"$ref":"#/components/schemas/DownloadDescription"},"type":"array","title":"Downloads"},"module_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Module Name"},"module_options":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Module Options"},"task_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Task Name"},"status":{"$ref":"#/components/schemas/AgentTaskStatus"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"},"tags":{"items":{"$ref":"#/components/schemas/Tag"},"type":"array","title":"Tags"}},"type":"object","required":["id","input","agent_id","downloads","status","created_at","updated_at","tags"],"title":"AgentTask"},"DownloadDescription":{"properties":{"id":{"type":"integer","title":"Id"},"filename":{"type":"string","title":"Filename"},"link":{"type":"string","title":"Link"}},"type":"object","required":["id","filename","link"],"title":"DownloadDescription"},"AgentTaskStatus":{"type":"string","enum":["queued","pulled","completed","error","continuous"],"title":"AgentTaskStatus"},"Tag":{"properties":{"id":{"type":"integer","title":"Id"},"name":{"type":"string","title":"Name"},"value":{"type":"string","title":"Value"},"label":{"type":"string","title":"Label"},"color":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Color"}},"type":"object","required":["id","name","value","label"],"title":"Tag"}}}}
```

## The AgentTaskOrderOptions object

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"components":{"schemas":{"AgentTaskOrderOptions":{"type":"string","enum":["id","updated_at","status","agent"],"title":"AgentTaskOrderOptions"}}}}
```

## The AgentTaskStatus object

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"components":{"schemas":{"AgentTaskStatus":{"type":"string","enum":["queued","pulled","completed","error","continuous"],"title":"AgentTaskStatus"}}}}
```

## The AgentTasks object

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"components":{"schemas":{"AgentTasks":{"properties":{"records":{"items":{"$ref":"#/components/schemas/AgentTask"},"type":"array","title":"Records"},"limit":{"type":"integer","title":"Limit"},"page":{"type":"integer","title":"Page"},"total_pages":{"type":"integer","title":"Total Pages"},"total":{"type":"integer","title":"Total"}},"type":"object","required":["records","limit","page","total_pages","total"],"title":"AgentTasks"},"AgentTask":{"properties":{"id":{"type":"integer","title":"Id"},"input":{"type":"string","title":"Input"},"full_input":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Full Input"},"output":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Output"},"original_output":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Original Output"},"user_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"User Id"},"username":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Username"},"agent_id":{"type":"string","title":"Agent Id"},"downloads":{"items":{"$ref":"#/components/schemas/DownloadDescription"},"type":"array","title":"Downloads"},"module_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Module Name"},"module_options":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Module Options"},"task_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Task Name"},"status":{"$ref":"#/components/schemas/AgentTaskStatus"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"},"tags":{"items":{"$ref":"#/components/schemas/Tag"},"type":"array","title":"Tags"}},"type":"object","required":["id","input","agent_id","downloads","status","created_at","updated_at","tags"],"title":"AgentTask"},"DownloadDescription":{"properties":{"id":{"type":"integer","title":"Id"},"filename":{"type":"string","title":"Filename"},"link":{"type":"string","title":"Link"}},"type":"object","required":["id","filename","link"],"title":"DownloadDescription"},"AgentTaskStatus":{"type":"string","enum":["queued","pulled","completed","error","continuous"],"title":"AgentTaskStatus"},"Tag":{"properties":{"id":{"type":"integer","title":"Id"},"name":{"type":"string","title":"Name"},"value":{"type":"string","title":"Value"},"label":{"type":"string","title":"Label"},"color":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Color"}},"type":"object","required":["id","name","value","label"],"title":"Tag"}}}}
```

## The AgentUpdateRequest object

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"components":{"schemas":{"AgentUpdateRequest":{"properties":{"name":{"type":"string","title":"Name"},"notes":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Notes"}},"type":"object","required":["name"],"title":"AgentUpdateRequest"}}}}
```

## The Agents object

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"components":{"schemas":{"Agents":{"properties":{"records":{"items":{"$ref":"#/components/schemas/Agent"},"type":"array","title":"Records"}},"type":"object","required":["records"],"title":"Agents"},"Agent":{"properties":{"session_id":{"type":"string","title":"Session Id"},"name":{"type":"string","title":"Name"},"listener":{"type":"string","title":"Listener"},"host_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Host Id"},"hostname":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Hostname"},"language":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Language"},"language_version":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Language Version"},"delay":{"type":"integer","title":"Delay"},"jitter":{"type":"number","title":"Jitter"},"external_ip":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"External Ip"},"internal_ip":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Internal Ip"},"username":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Username"},"high_integrity":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"High Integrity"},"process_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Process Id"},"process_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Process Name"},"os_details":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Os Details"},"nonce":{"type":"string","title":"Nonce"},"checkin_time":{"type":"string","format":"date-time","title":"Checkin Time"},"lastseen_time":{"type":"string","format":"date-time","title":"Lastseen Time"},"parent":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Parent"},"children":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Children"},"servers":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Servers"},"profile":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Profile"},"functions":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Functions"},"kill_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Kill Date"},"working_hours":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Working Hours"},"lost_limit":{"type":"integer","title":"Lost Limit"},"notes":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Notes"},"architecture":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Architecture"},"archived":{"type":"boolean","title":"Archived"},"stale":{"type":"boolean","title":"Stale"},"tags":{"items":{"$ref":"#/components/schemas/Tag"},"type":"array","title":"Tags"}},"type":"object","required":["session_id","name","listener","delay","jitter","nonce","checkin_time","lastseen_time","lost_limit","archived","stale","tags"],"title":"Agent"},"Tag":{"properties":{"id":{"type":"integer","title":"Id"},"name":{"type":"string","title":"Name"},"value":{"type":"string","title":"Value"},"label":{"type":"string","title":"Label"},"color":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Color"}},"type":"object","required":["id","name","value","label"],"title":"Tag"}}}}
```

## The AggregateBucket object

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"components":{"schemas":{"AggregateBucket":{"type":"string","enum":["second","minute","hour","day"],"title":"AggregateBucket"}}}}
```

## The Author object

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"components":{"schemas":{"Author":{"properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"handle":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Handle"},"link":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Link"}},"type":"object","title":"Author"}}}}
```

## The AutorunConfig object

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"components":{"schemas":{"AutorunConfig":{"properties":{"records":{"items":{"$ref":"#/components/schemas/ModulePostRequest"},"type":"array","title":"Records"}},"type":"object","required":["records"],"title":"AutorunConfig"},"ModulePostRequest":{"properties":{"module_id":{"type":"string","title":"Module Id"},"ignore_language_version_check":{"type":"boolean","title":"Ignore Language Version Check","default":false},"ignore_admin_check":{"type":"boolean","title":"Ignore Admin Check","default":false},"options":{"additionalProperties":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"number"}]},"type":"object","title":"Options"},"modified_input":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Modified Input"}},"type":"object","required":["module_id","options"],"title":"ModulePostRequest"}}}}
```

## The BadRequestResponse object

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"components":{"schemas":{"BadRequestResponse":{"properties":{"detail":{"type":"string","title":"Detail"}},"type":"object","required":["detail"],"title":"BadRequestResponse"}}}}
```

## The Body\_create\_avatar\_api\_v2\_users\_\_uid\_\_avatar\_post object

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"components":{"schemas":{"Body_create_avatar_api_v2_users__uid__avatar_post":{"properties":{"file":{"type":"string","format":"binary","title":"File"}},"type":"object","required":["file"],"title":"Body_create_avatar_api_v2_users__uid__avatar_post"}}}}
```

## The Body\_create\_download\_api\_v2\_downloads\_post object

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"components":{"schemas":{"Body_create_download_api_v2_downloads_post":{"properties":{"file":{"type":"string","format":"binary","title":"File"}},"type":"object","required":["file"],"title":"Body_create_download_api_v2_downloads_post"}}}}
```

## The Body\_login\_for\_access\_token\_token\_post object

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"components":{"schemas":{"Body_login_for_access_token_token_post":{"properties":{"grant_type":{"anyOf":[{"type":"string","pattern":"^password$"},{"type":"null"}],"title":"Grant Type"},"username":{"type":"string","title":"Username"},"password":{"type":"string","format":"password","title":"Password"},"scope":{"type":"string","title":"Scope","default":""},"client_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Client Id"},"client_secret":{"anyOf":[{"type":"string"},{"type":"null"}],"format":"password","title":"Client Secret"}},"type":"object","required":["username","password"],"title":"Body_login_for_access_token_token_post"}}}}
```

## The Bypass object

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"components":{"schemas":{"Bypass":{"properties":{"id":{"type":"integer","title":"Id"},"name":{"type":"string","title":"Name"},"authors":{"items":{"$ref":"#/components/schemas/Author"},"type":"array","title":"Authors"},"language":{"type":"string","title":"Language"},"code":{"type":"string","title":"Code"},"is_default":{"type":"boolean","title":"Is Default"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"}},"type":"object","required":["id","name","authors","language","code","is_default","created_at","updated_at"],"title":"Bypass"},"Author":{"properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"handle":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Handle"},"link":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Link"}},"type":"object","title":"Author"}}}}
```

## The BypassPostRequest object

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"components":{"schemas":{"BypassPostRequest":{"properties":{"name":{"type":"string","title":"Name"},"language":{"type":"string","title":"Language"},"code":{"type":"string","title":"Code"}},"type":"object","required":["name","language","code"],"title":"BypassPostRequest"}}}}
```

## The BypassUpdateRequest object

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"components":{"schemas":{"BypassUpdateRequest":{"properties":{"name":{"type":"string","title":"Name"},"language":{"type":"string","title":"Language"},"code":{"type":"string","title":"Code"}},"type":"object","required":["name","language","code"],"title":"BypassUpdateRequest"}}}}
```

## The Bypasses object

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"components":{"schemas":{"Bypasses":{"properties":{"records":{"items":{"$ref":"#/components/schemas/Bypass"},"type":"array","title":"Records"}},"type":"object","required":["records"],"title":"Bypasses"},"Bypass":{"properties":{"id":{"type":"integer","title":"Id"},"name":{"type":"string","title":"Name"},"authors":{"items":{"$ref":"#/components/schemas/Author"},"type":"array","title":"Authors"},"language":{"type":"string","title":"Language"},"code":{"type":"string","title":"Code"},"is_default":{"type":"boolean","title":"Is Default"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"}},"type":"object","required":["id","name","authors","language","code","is_default","created_at","updated_at"],"title":"Bypass"},"Author":{"properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"handle":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Handle"},"link":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Link"}},"type":"object","title":"Author"}}}}
```

## The CommsPostRequest object

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"components":{"schemas":{"CommsPostRequest":{"properties":{"new_listener_id":{"type":"integer","title":"New Listener Id"}},"type":"object","required":["new_listener_id"],"title":"CommsPostRequest"}}}}
```

## The Credential object

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"components":{"schemas":{"Credential":{"properties":{"id":{"type":"integer","title":"Id"},"credtype":{"type":"string","title":"Credtype"},"domain":{"type":"string","title":"Domain"},"username":{"type":"string","title":"Username"},"password":{"type":"string","title":"Password"},"host":{"type":"string","title":"Host"},"os":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Os"},"sid":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sid"},"notes":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Notes"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"},"tags":{"items":{"$ref":"#/components/schemas/Tag"},"type":"array","title":"Tags"}},"type":"object","required":["id","credtype","domain","username","password","host","created_at","updated_at","tags"],"title":"Credential"},"Tag":{"properties":{"id":{"type":"integer","title":"Id"},"name":{"type":"string","title":"Name"},"value":{"type":"string","title":"Value"},"label":{"type":"string","title":"Label"},"color":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Color"}},"type":"object","required":["id","name","value","label"],"title":"Tag"}}}}
```

## The CredentialPostRequest object

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"components":{"schemas":{"CredentialPostRequest":{"properties":{"credtype":{"type":"string","title":"Credtype"},"domain":{"type":"string","title":"Domain"},"username":{"type":"string","title":"Username"},"password":{"type":"string","title":"Password"},"host":{"type":"string","title":"Host"},"os":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Os"},"sid":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sid"},"notes":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Notes"}},"type":"object","required":["credtype","domain","username","password","host"],"title":"CredentialPostRequest"}}}}
```

## The CredentialUpdateRequest object

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"components":{"schemas":{"CredentialUpdateRequest":{"properties":{"credtype":{"type":"string","title":"Credtype"},"domain":{"type":"string","title":"Domain"},"username":{"type":"string","title":"Username"},"password":{"type":"string","title":"Password"},"host":{"type":"string","title":"Host"},"os":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Os"},"sid":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sid"},"notes":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Notes"}},"type":"object","required":["credtype","domain","username","password","host"],"title":"CredentialUpdateRequest"}}}}
```

## The Credentials object

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"components":{"schemas":{"Credentials":{"properties":{"records":{"items":{"$ref":"#/components/schemas/Credential"},"type":"array","title":"Records"}},"type":"object","required":["records"],"title":"Credentials"},"Credential":{"properties":{"id":{"type":"integer","title":"Id"},"credtype":{"type":"string","title":"Credtype"},"domain":{"type":"string","title":"Domain"},"username":{"type":"string","title":"Username"},"password":{"type":"string","title":"Password"},"host":{"type":"string","title":"Host"},"os":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Os"},"sid":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sid"},"notes":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Notes"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"},"tags":{"items":{"$ref":"#/components/schemas/Tag"},"type":"array","title":"Tags"}},"type":"object","required":["id","credtype","domain","username","password","host","created_at","updated_at","tags"],"title":"Credential"},"Tag":{"properties":{"id":{"type":"integer","title":"Id"},"name":{"type":"string","title":"Name"},"value":{"type":"string","title":"Value"},"label":{"type":"string","title":"Label"},"color":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Color"}},"type":"object","required":["id","name","value","label"],"title":"Tag"}}}}
```

## The CustomOptionSchema object

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"components":{"schemas":{"CustomOptionSchema":{"properties":{"description":{"type":"string","title":"Description"},"required":{"type":"boolean","title":"Required"},"value":{"type":"string","title":"Value"},"suggested_values":{"items":{"type":"string"},"type":"array","title":"Suggested Values"},"strict":{"type":"boolean","title":"Strict"},"editable":{"type":"boolean","title":"Editable","default":true},"value_type":{"$ref":"#/components/schemas/ValueType"},"internal":{"type":"boolean","title":"Internal"},"depends_on":{"items":{"$ref":"#/components/schemas/DependentOption"},"type":"array","title":"Depends On","default":[]}},"type":"object","required":["description","required","value","suggested_values","strict","value_type","internal"],"title":"CustomOptionSchema"},"ValueType":{"type":"string","enum":["STRING","FLOAT","INTEGER","BOOLEAN","FILE"],"title":"ValueType"},"DependentOption":{"properties":{"name":{"type":"string","title":"Name"},"values":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Values"}},"type":"object","required":["name","values"],"title":"DependentOption"}}}}
```

## The DependentOption object

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"components":{"schemas":{"DependentOption":{"properties":{"name":{"type":"string","title":"Name"},"values":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Values"}},"type":"object","required":["name","values"],"title":"DependentOption"}}}}
```

## The DirectoryListPostRequest object

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"components":{"schemas":{"DirectoryListPostRequest":{"properties":{"path":{"type":"string","title":"Path"}},"type":"object","required":["path"],"title":"DirectoryListPostRequest"}}}}
```

## The Download object

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"components":{"schemas":{"Download":{"properties":{"id":{"type":"integer","title":"Id"},"location":{"type":"string","title":"Location"},"filename":{"type":"string","title":"Filename"},"size":{"type":"integer","title":"Size"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"},"tags":{"items":{"$ref":"#/components/schemas/Tag"},"type":"array","title":"Tags"}},"type":"object","required":["id","location","filename","size","created_at","updated_at","tags"],"title":"Download"},"Tag":{"properties":{"id":{"type":"integer","title":"Id"},"name":{"type":"string","title":"Name"},"value":{"type":"string","title":"Value"},"label":{"type":"string","title":"Label"},"color":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Color"}},"type":"object","required":["id","name","value","label"],"title":"Tag"}}}}
```

## The DownloadDescription object

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"components":{"schemas":{"DownloadDescription":{"properties":{"id":{"type":"integer","title":"Id"},"filename":{"type":"string","title":"Filename"},"link":{"type":"string","title":"Link"}},"type":"object","required":["id","filename","link"],"title":"DownloadDescription"}}}}
```

## The DownloadOrderOptions object

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"components":{"schemas":{"DownloadOrderOptions":{"type":"string","enum":["filename","location","size","created_at","updated_at"],"title":"DownloadOrderOptions"}}}}
```

## The DownloadPostRequest object

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"components":{"schemas":{"DownloadPostRequest":{"properties":{"path_to_file":{"type":"string","title":"Path To File"}},"type":"object","required":["path_to_file"],"title":"DownloadPostRequest"}}}}
```

## The DownloadSourceFilter object

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"components":{"schemas":{"DownloadSourceFilter":{"type":"string","enum":["upload","stager","agent_file","agent_task"],"title":"DownloadSourceFilter"}}}}
```

## The Downloads object

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"components":{"schemas":{"Downloads":{"properties":{"records":{"items":{"$ref":"#/components/schemas/Download"},"type":"array","title":"Records"},"limit":{"type":"integer","title":"Limit"},"page":{"type":"integer","title":"Page"},"total_pages":{"type":"integer","title":"Total Pages"},"total":{"type":"integer","title":"Total"}},"type":"object","required":["records","limit","page","total_pages","total"],"title":"Downloads"},"Download":{"properties":{"id":{"type":"integer","title":"Id"},"location":{"type":"string","title":"Location"},"filename":{"type":"string","title":"Filename"},"size":{"type":"integer","title":"Size"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"},"tags":{"items":{"$ref":"#/components/schemas/Tag"},"type":"array","title":"Tags"}},"type":"object","required":["id","location","filename","size","created_at","updated_at","tags"],"title":"Download"},"Tag":{"properties":{"id":{"type":"integer","title":"Id"},"name":{"type":"string","title":"Name"},"value":{"type":"string","title":"Value"},"label":{"type":"string","title":"Label"},"color":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Color"}},"type":"object","required":["id","name","value","label"],"title":"Tag"}}}}
```

## The EmpireVersion object

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"components":{"schemas":{"EmpireVersion":{"properties":{"version":{"type":"string","title":"Version"}},"type":"object","required":["version"],"title":"EmpireVersion"}}}}
```

## The ExitPostRequest object

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"components":{"schemas":{"ExitPostRequest":{"properties":{},"type":"object","title":"ExitPostRequest"}}}}
```

## The HTTPValidationError object

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"components":{"schemas":{"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```

## The Host object

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"components":{"schemas":{"Host":{"properties":{"id":{"type":"integer","title":"Id"},"name":{"type":"string","title":"Name"},"internal_ip":{"type":"string","title":"Internal Ip"}},"type":"object","required":["id","name","internal_ip"],"title":"Host"}}}}
```

## The Hosts object

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"components":{"schemas":{"Hosts":{"properties":{"records":{"items":{"$ref":"#/components/schemas/Host"},"type":"array","title":"Records"}},"type":"object","required":["records"],"title":"Hosts"},"Host":{"properties":{"id":{"type":"integer","title":"Id"},"name":{"type":"string","title":"Name"},"internal_ip":{"type":"string","title":"Internal Ip"}},"type":"object","required":["id","name","internal_ip"],"title":"Host"}}}}
```

## The IP object

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"components":{"schemas":{"IP":{"properties":{"id":{"type":"integer","title":"Id"},"ip_address":{"type":"string","title":"Ip Address"},"list":{"$ref":"#/components/schemas/IpList"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"}},"type":"object","required":["id","ip_address","list","description","created_at","updated_at"],"title":"IP"},"IpList":{"type":"string","enum":["allow","deny"],"title":"IpList"}}}}
```

## The IpList object

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"components":{"schemas":{"IpList":{"type":"string","enum":["allow","deny"],"title":"IpList"}}}}
```

## The IpPostRequest object

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"components":{"schemas":{"IpPostRequest":{"properties":{"ip_address":{"type":"string","title":"Ip Address"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"list":{"$ref":"#/components/schemas/IpList"}},"type":"object","required":["ip_address","list"],"title":"IpPostRequest"},"IpList":{"type":"string","enum":["allow","deny"],"title":"IpList"}}}}
```

## The Ips object

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"components":{"schemas":{"Ips":{"properties":{"records":{"items":{"$ref":"#/components/schemas/IP"},"type":"array","title":"Records"}},"type":"object","required":["records"],"title":"Ips"},"IP":{"properties":{"id":{"type":"integer","title":"Id"},"ip_address":{"type":"string","title":"Ip Address"},"list":{"$ref":"#/components/schemas/IpList"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"}},"type":"object","required":["id","ip_address","list","description","created_at","updated_at"],"title":"IP"},"IpList":{"type":"string","enum":["allow","deny"],"title":"IpList"}}}}
```

## The Keyword object

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"components":{"schemas":{"Keyword":{"properties":{"id":{"type":"integer","title":"Id"},"keyword":{"type":"string","title":"Keyword"},"replacement":{"type":"string","title":"Replacement"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"}},"type":"object","required":["id","keyword","replacement","created_at","updated_at"],"title":"Keyword"}}}}
```

## The KeywordPostRequest object

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"components":{"schemas":{"KeywordPostRequest":{"properties":{"keyword":{"type":"string","minLength":3,"title":"Keyword"},"replacement":{"type":"string","minLength":3,"title":"Replacement"}},"type":"object","required":["keyword","replacement"],"title":"KeywordPostRequest"}}}}
```

## The KeywordUpdateRequest object

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"components":{"schemas":{"KeywordUpdateRequest":{"properties":{"keyword":{"type":"string","minLength":3,"title":"Keyword"},"replacement":{"type":"string","minLength":3,"title":"Replacement"}},"type":"object","required":["keyword","replacement"],"title":"KeywordUpdateRequest"}}}}
```

## The Keywords object

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"components":{"schemas":{"Keywords":{"properties":{"records":{"items":{"$ref":"#/components/schemas/Keyword"},"type":"array","title":"Records"}},"type":"object","required":["records"],"title":"Keywords"},"Keyword":{"properties":{"id":{"type":"integer","title":"Id"},"keyword":{"type":"string","title":"Keyword"},"replacement":{"type":"string","title":"Replacement"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"}},"type":"object","required":["id","keyword","replacement","created_at","updated_at"],"title":"Keyword"}}}}
```

## The KillDatePostRequest object

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"components":{"schemas":{"KillDatePostRequest":{"properties":{"kill_date":{"type":"string","title":"Kill Date"}},"type":"object","required":["kill_date"],"title":"KillDatePostRequest"}}}}
```

## The KillJobPostRequest object

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"components":{"schemas":{"KillJobPostRequest":{"properties":{"id":{"type":"integer","title":"Id"}},"type":"object","required":["id"],"title":"KillJobPostRequest"}}}}
```

## The LanguageEnum object

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"components":{"schemas":{"LanguageEnum":{"type":"string","enum":["python","powershell","csharp","ironpython","bof"],"title":"LanguageEnum"}}}}
```

## The Listener object

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"components":{"schemas":{"Listener":{"properties":{"id":{"type":"integer","title":"Id"},"name":{"type":"string","title":"Name"},"enabled":{"type":"boolean","title":"Enabled"},"template":{"type":"string","title":"Template"},"options":{"additionalProperties":{"type":"string"},"type":"object","title":"Options"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"host_address":{"type":"string","title":"Host Address"},"tags":{"items":{"$ref":"#/components/schemas/Tag"},"type":"array","title":"Tags"}},"type":"object","required":["id","name","enabled","template","options","created_at","host_address","tags"],"title":"Listener"},"Tag":{"properties":{"id":{"type":"integer","title":"Id"},"name":{"type":"string","title":"Name"},"value":{"type":"string","title":"Value"},"label":{"type":"string","title":"Label"},"color":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Color"}},"type":"object","required":["id","name","value","label"],"title":"Tag"}}}}
```

## The ListenerPostRequest object

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"components":{"schemas":{"ListenerPostRequest":{"properties":{"name":{"type":"string","title":"Name"},"template":{"type":"string","title":"Template"},"options":{"additionalProperties":{"type":"string"},"type":"object","title":"Options"}},"type":"object","required":["name","template","options"],"title":"ListenerPostRequest"}}}}
```

## The ListenerTemplate object

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"components":{"schemas":{"ListenerTemplate":{"properties":{"id":{"type":"string","title":"Id"},"name":{"type":"string","title":"Name"},"authors":{"items":{"$ref":"#/components/schemas/Author"},"type":"array","title":"Authors"},"description":{"type":"string","title":"Description"},"category":{"type":"string","title":"Category"},"comments":{"items":{"type":"string"},"type":"array","title":"Comments"},"tactics":{"items":{"type":"string"},"type":"array","title":"Tactics"},"techniques":{"items":{"type":"string"},"type":"array","title":"Techniques"},"software":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Software"},"options":{"additionalProperties":{"$ref":"#/components/schemas/CustomOptionSchema"},"type":"object","title":"Options"}},"type":"object","required":["id","name","authors","description","category","comments","tactics","techniques","options"],"title":"ListenerTemplate"},"Author":{"properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"handle":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Handle"},"link":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Link"}},"type":"object","title":"Author"},"CustomOptionSchema":{"properties":{"description":{"type":"string","title":"Description"},"required":{"type":"boolean","title":"Required"},"value":{"type":"string","title":"Value"},"suggested_values":{"items":{"type":"string"},"type":"array","title":"Suggested Values"},"strict":{"type":"boolean","title":"Strict"},"editable":{"type":"boolean","title":"Editable","default":true},"value_type":{"$ref":"#/components/schemas/ValueType"},"internal":{"type":"boolean","title":"Internal"},"depends_on":{"items":{"$ref":"#/components/schemas/DependentOption"},"type":"array","title":"Depends On","default":[]}},"type":"object","required":["description","required","value","suggested_values","strict","value_type","internal"],"title":"CustomOptionSchema"},"ValueType":{"type":"string","enum":["STRING","FLOAT","INTEGER","BOOLEAN","FILE"],"title":"ValueType"},"DependentOption":{"properties":{"name":{"type":"string","title":"Name"},"values":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Values"}},"type":"object","required":["name","values"],"title":"DependentOption"}}}}
```

## The ListenerTemplates object

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"components":{"schemas":{"ListenerTemplates":{"properties":{"records":{"items":{"$ref":"#/components/schemas/ListenerTemplate"},"type":"array","title":"Records"}},"type":"object","required":["records"],"title":"ListenerTemplates"},"ListenerTemplate":{"properties":{"id":{"type":"string","title":"Id"},"name":{"type":"string","title":"Name"},"authors":{"items":{"$ref":"#/components/schemas/Author"},"type":"array","title":"Authors"},"description":{"type":"string","title":"Description"},"category":{"type":"string","title":"Category"},"comments":{"items":{"type":"string"},"type":"array","title":"Comments"},"tactics":{"items":{"type":"string"},"type":"array","title":"Tactics"},"techniques":{"items":{"type":"string"},"type":"array","title":"Techniques"},"software":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Software"},"options":{"additionalProperties":{"$ref":"#/components/schemas/CustomOptionSchema"},"type":"object","title":"Options"}},"type":"object","required":["id","name","authors","description","category","comments","tactics","techniques","options"],"title":"ListenerTemplate"},"Author":{"properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"handle":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Handle"},"link":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Link"}},"type":"object","title":"Author"},"CustomOptionSchema":{"properties":{"description":{"type":"string","title":"Description"},"required":{"type":"boolean","title":"Required"},"value":{"type":"string","title":"Value"},"suggested_values":{"items":{"type":"string"},"type":"array","title":"Suggested Values"},"strict":{"type":"boolean","title":"Strict"},"editable":{"type":"boolean","title":"Editable","default":true},"value_type":{"$ref":"#/components/schemas/ValueType"},"internal":{"type":"boolean","title":"Internal"},"depends_on":{"items":{"$ref":"#/components/schemas/DependentOption"},"type":"array","title":"Depends On","default":[]}},"type":"object","required":["description","required","value","suggested_values","strict","value_type","internal"],"title":"CustomOptionSchema"},"ValueType":{"type":"string","enum":["STRING","FLOAT","INTEGER","BOOLEAN","FILE"],"title":"ValueType"},"DependentOption":{"properties":{"name":{"type":"string","title":"Name"},"values":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Values"}},"type":"object","required":["name","values"],"title":"DependentOption"}}}}
```

## The ListenerUpdateRequest object

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"components":{"schemas":{"ListenerUpdateRequest":{"properties":{"name":{"type":"string","title":"Name"},"enabled":{"type":"boolean","title":"Enabled"},"options":{"additionalProperties":{"type":"string"},"type":"object","title":"Options"}},"type":"object","required":["name","enabled","options"],"title":"ListenerUpdateRequest"}}}}
```

## The Listeners object

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"components":{"schemas":{"Listeners":{"properties":{"records":{"items":{"$ref":"#/components/schemas/Listener"},"type":"array","title":"Records"}},"type":"object","required":["records"],"title":"Listeners"},"Listener":{"properties":{"id":{"type":"integer","title":"Id"},"name":{"type":"string","title":"Name"},"enabled":{"type":"boolean","title":"Enabled"},"template":{"type":"string","title":"Template"},"options":{"additionalProperties":{"type":"string"},"type":"object","title":"Options"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"host_address":{"type":"string","title":"Host Address"},"tags":{"items":{"$ref":"#/components/schemas/Tag"},"type":"array","title":"Tags"}},"type":"object","required":["id","name","enabled","template","options","created_at","host_address","tags"],"title":"Listener"},"Tag":{"properties":{"id":{"type":"integer","title":"Id"},"name":{"type":"string","title":"Name"},"value":{"type":"string","title":"Value"},"label":{"type":"string","title":"Label"},"color":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Color"}},"type":"object","required":["id","name","value","label"],"title":"Tag"}}}}
```

## The MarketPlaceEntryVersionResponse object

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"components":{"schemas":{"MarketPlaceEntryVersionResponse":{"properties":{"name":{"type":"string","title":"Name"},"git_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Git Url"},"tar_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Tar Url"},"ref":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Ref"},"subdirectory":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Subdirectory"}},"type":"object","required":["name"],"title":"MarketPlaceEntryVersionResponse"}}}}
```

## The MarketplaceEntryRegistryResponse object

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"components":{"schemas":{"MarketplaceEntryRegistryResponse":{"properties":{"name":{"type":"string","title":"Name"},"registry":{"type":"string","title":"Registry"},"homepage_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Homepage Url"},"source_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Source Url"},"authors":{"items":{"$ref":"#/components/schemas/Author"},"type":"array","title":"Authors"},"versions":{"items":{"$ref":"#/components/schemas/MarketPlaceEntryVersionResponse"},"type":"array","title":"Versions"},"description":{"type":"string","title":"Description"}},"type":"object","required":["name","registry","authors","versions","description"],"title":"MarketplaceEntryRegistryResponse"},"Author":{"properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"handle":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Handle"},"link":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Link"}},"type":"object","title":"Author"},"MarketPlaceEntryVersionResponse":{"properties":{"name":{"type":"string","title":"Name"},"git_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Git Url"},"tar_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Tar Url"},"ref":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Ref"},"subdirectory":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Subdirectory"}},"type":"object","required":["name"],"title":"MarketPlaceEntryVersionResponse"}}}}
```

## The MarketplaceEntryResponse object

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"components":{"schemas":{"MarketplaceEntryResponse":{"properties":{"name":{"type":"string","title":"Name"},"registries":{"additionalProperties":{"$ref":"#/components/schemas/MarketplaceEntryRegistryResponse"},"type":"object","title":"Registries"},"installed":{"type":"boolean","title":"Installed","default":false},"installed_version":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Installed Version"}},"type":"object","required":["name","registries"],"title":"MarketplaceEntryResponse"},"MarketplaceEntryRegistryResponse":{"properties":{"name":{"type":"string","title":"Name"},"registry":{"type":"string","title":"Registry"},"homepage_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Homepage Url"},"source_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Source Url"},"authors":{"items":{"$ref":"#/components/schemas/Author"},"type":"array","title":"Authors"},"versions":{"items":{"$ref":"#/components/schemas/MarketPlaceEntryVersionResponse"},"type":"array","title":"Versions"},"description":{"type":"string","title":"Description"}},"type":"object","required":["name","registry","authors","versions","description"],"title":"MarketplaceEntryRegistryResponse"},"Author":{"properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"handle":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Handle"},"link":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Link"}},"type":"object","title":"Author"},"MarketPlaceEntryVersionResponse":{"properties":{"name":{"type":"string","title":"Name"},"git_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Git Url"},"tar_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Tar Url"},"ref":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Ref"},"subdirectory":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Subdirectory"}},"type":"object","required":["name"],"title":"MarketPlaceEntryVersionResponse"}}}}
```

## The MarketplaceResponse object

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"components":{"schemas":{"MarketplaceResponse":{"properties":{"records":{"items":{"$ref":"#/components/schemas/MarketplaceEntryResponse"},"type":"array","title":"Records"}},"type":"object","required":["records"],"title":"MarketplaceResponse"},"MarketplaceEntryResponse":{"properties":{"name":{"type":"string","title":"Name"},"registries":{"additionalProperties":{"$ref":"#/components/schemas/MarketplaceEntryRegistryResponse"},"type":"object","title":"Registries"},"installed":{"type":"boolean","title":"Installed","default":false},"installed_version":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Installed Version"}},"type":"object","required":["name","registries"],"title":"MarketplaceEntryResponse"},"MarketplaceEntryRegistryResponse":{"properties":{"name":{"type":"string","title":"Name"},"registry":{"type":"string","title":"Registry"},"homepage_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Homepage Url"},"source_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Source Url"},"authors":{"items":{"$ref":"#/components/schemas/Author"},"type":"array","title":"Authors"},"versions":{"items":{"$ref":"#/components/schemas/MarketPlaceEntryVersionResponse"},"type":"array","title":"Versions"},"description":{"type":"string","title":"Description"}},"type":"object","required":["name","registry","authors","versions","description"],"title":"MarketplaceEntryRegistryResponse"},"Author":{"properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"handle":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Handle"},"link":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Link"}},"type":"object","title":"Author"},"MarketPlaceEntryVersionResponse":{"properties":{"name":{"type":"string","title":"Name"},"git_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Git Url"},"tar_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Tar Url"},"ref":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Ref"},"subdirectory":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Subdirectory"}},"type":"object","required":["name"],"title":"MarketPlaceEntryVersionResponse"}}}}
```

## The Module object

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"components":{"schemas":{"Module":{"properties":{"id":{"type":"string","title":"Id"},"name":{"type":"string","title":"Name"},"enabled":{"type":"boolean","title":"Enabled"},"authors":{"items":{"$ref":"#/components/schemas/Author"},"type":"array","title":"Authors"},"description":{"type":"string","title":"Description"},"background":{"type":"boolean","title":"Background"},"language":{"$ref":"#/components/schemas/LanguageEnum"},"min_language_version":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Min Language Version"},"needs_admin":{"type":"boolean","title":"Needs Admin"},"opsec_safe":{"type":"boolean","title":"Opsec Safe"},"techniques":{"items":{"type":"string"},"type":"array","title":"Techniques"},"tactics":{"items":{"type":"string"},"type":"array","title":"Tactics"},"software":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Software"},"comments":{"items":{"type":"string"},"type":"array","title":"Comments"},"options":{"additionalProperties":{"$ref":"#/components/schemas/CustomOptionSchema"},"type":"object","title":"Options"}},"type":"object","required":["id","name","enabled","authors","description","background","language","needs_admin","opsec_safe","techniques","tactics","comments","options"],"title":"Module"},"Author":{"properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"handle":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Handle"},"link":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Link"}},"type":"object","title":"Author"},"LanguageEnum":{"type":"string","enum":["python","powershell","csharp","ironpython","bof"],"title":"LanguageEnum"},"CustomOptionSchema":{"properties":{"description":{"type":"string","title":"Description"},"required":{"type":"boolean","title":"Required"},"value":{"type":"string","title":"Value"},"suggested_values":{"items":{"type":"string"},"type":"array","title":"Suggested Values"},"strict":{"type":"boolean","title":"Strict"},"editable":{"type":"boolean","title":"Editable","default":true},"value_type":{"$ref":"#/components/schemas/ValueType"},"internal":{"type":"boolean","title":"Internal"},"depends_on":{"items":{"$ref":"#/components/schemas/DependentOption"},"type":"array","title":"Depends On","default":[]}},"type":"object","required":["description","required","value","suggested_values","strict","value_type","internal"],"title":"CustomOptionSchema"},"ValueType":{"type":"string","enum":["STRING","FLOAT","INTEGER","BOOLEAN","FILE"],"title":"ValueType"},"DependentOption":{"properties":{"name":{"type":"string","title":"Name"},"values":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Values"}},"type":"object","required":["name","values"],"title":"DependentOption"}}}}
```

## The ModuleBulkUpdateRequest object

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"components":{"schemas":{"ModuleBulkUpdateRequest":{"properties":{"modules":{"items":{"type":"string"},"type":"array","title":"Modules"},"enabled":{"type":"boolean","title":"Enabled"}},"type":"object","required":["modules","enabled"],"title":"ModuleBulkUpdateRequest"}}}}
```

## The ModulePostRequest object

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"components":{"schemas":{"ModulePostRequest":{"properties":{"module_id":{"type":"string","title":"Module Id"},"ignore_language_version_check":{"type":"boolean","title":"Ignore Language Version Check","default":false},"ignore_admin_check":{"type":"boolean","title":"Ignore Admin Check","default":false},"options":{"additionalProperties":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"number"}]},"type":"object","title":"Options"},"modified_input":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Modified Input"}},"type":"object","required":["module_id","options"],"title":"ModulePostRequest"}}}}
```

## The ModuleScript object

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"components":{"schemas":{"ModuleScript":{"properties":{"module_id":{"type":"string","title":"Module Id"},"script":{"type":"string","title":"Script"}},"type":"object","required":["module_id","script"],"title":"ModuleScript"}}}}
```

## The ModuleUpdateRequest object

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"components":{"schemas":{"ModuleUpdateRequest":{"properties":{"enabled":{"type":"boolean","title":"Enabled"}},"type":"object","required":["enabled"],"title":"ModuleUpdateRequest"}}}}
```

## The NotFoundResponse object

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"components":{"schemas":{"NotFoundResponse":{"properties":{"detail":{"type":"string","title":"Detail"}},"type":"object","required":["detail"],"title":"NotFoundResponse"}}}}
```

## The ObfuscationConfig object

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"components":{"schemas":{"ObfuscationConfig":{"properties":{"language":{"type":"string","title":"Language"},"enabled":{"type":"boolean","title":"Enabled"},"command":{"type":"string","title":"Command"},"module":{"type":"string","title":"Module"},"preobfuscatable":{"type":"boolean","title":"Preobfuscatable"}},"type":"object","required":["language","enabled","command","module","preobfuscatable"],"title":"ObfuscationConfig"}}}}
```

## The ObfuscationConfigUpdateRequest object

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"components":{"schemas":{"ObfuscationConfigUpdateRequest":{"properties":{"enabled":{"type":"boolean","title":"Enabled"},"command":{"type":"string","title":"Command"},"module":{"type":"string","title":"Module"}},"type":"object","required":["enabled","command","module"],"title":"ObfuscationConfigUpdateRequest"}}}}
```

## The ObfuscationConfigs object

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"components":{"schemas":{"ObfuscationConfigs":{"properties":{"records":{"items":{"$ref":"#/components/schemas/ObfuscationConfig"},"type":"array","title":"Records"}},"type":"object","required":["records"],"title":"ObfuscationConfigs"},"ObfuscationConfig":{"properties":{"language":{"type":"string","title":"Language"},"enabled":{"type":"boolean","title":"Enabled"},"command":{"type":"string","title":"Command"},"module":{"type":"string","title":"Module"},"preobfuscatable":{"type":"boolean","title":"Preobfuscatable"}},"type":"object","required":["language","enabled","command","module","preobfuscatable"],"title":"ObfuscationConfig"}}}}
```

## The OrderDirection object

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"components":{"schemas":{"OrderDirection":{"type":"string","enum":["asc","desc"],"title":"OrderDirection"}}}}
```

## The Plugin object

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"components":{"schemas":{"Plugin":{"properties":{"id":{"type":"string","title":"Id"},"name":{"type":"string","title":"Name"},"authors":{"items":{"$ref":"#/components/schemas/Author"},"type":"array","title":"Authors"},"readme":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Readme","default":""},"techniques":{"items":{"type":"string"},"type":"array","title":"Techniques","default":[]},"software":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Software"},"execution_options":{"anyOf":[{"additionalProperties":{"$ref":"#/components/schemas/CustomOptionSchema"},"type":"object"},{"type":"null"}],"title":"Execution Options"},"settings_options":{"anyOf":[{"additionalProperties":{"$ref":"#/components/schemas/CustomOptionSchema"},"type":"object"},{"type":"null"}],"title":"Settings Options"},"current_settings":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Current Settings"},"enabled":{"type":"boolean","title":"Enabled"},"loaded":{"type":"boolean","title":"Loaded","default":false},"execution_enabled":{"type":"boolean","title":"Execution Enabled","default":false},"python_deps":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Python Deps","default":[]}},"type":"object","required":["id","name","authors","enabled"],"title":"Plugin"},"Author":{"properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"handle":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Handle"},"link":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Link"}},"type":"object","title":"Author"},"CustomOptionSchema":{"properties":{"description":{"type":"string","title":"Description"},"required":{"type":"boolean","title":"Required"},"value":{"type":"string","title":"Value"},"suggested_values":{"items":{"type":"string"},"type":"array","title":"Suggested Values"},"strict":{"type":"boolean","title":"Strict"},"editable":{"type":"boolean","title":"Editable","default":true},"value_type":{"$ref":"#/components/schemas/ValueType"},"internal":{"type":"boolean","title":"Internal"},"depends_on":{"items":{"$ref":"#/components/schemas/DependentOption"},"type":"array","title":"Depends On","default":[]}},"type":"object","required":["description","required","value","suggested_values","strict","value_type","internal"],"title":"CustomOptionSchema"},"ValueType":{"type":"string","enum":["STRING","FLOAT","INTEGER","BOOLEAN","FILE"],"title":"ValueType"},"DependentOption":{"properties":{"name":{"type":"string","title":"Name"},"values":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Values"}},"type":"object","required":["name","values"],"title":"DependentOption"}}}}
```

## The PluginExecutePostRequest object

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"components":{"schemas":{"PluginExecutePostRequest":{"properties":{"options":{"additionalProperties":{"type":"string"},"type":"object","title":"Options"}},"type":"object","required":["options"],"title":"PluginExecutePostRequest"}}}}
```

## The PluginExecuteResponse object

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"components":{"schemas":{"PluginExecuteResponse":{"properties":{"detail":{"type":"string","title":"Detail","default":""}},"type":"object","title":"PluginExecuteResponse"}}}}
```

## The PluginInstallGitRequest object

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"components":{"schemas":{"PluginInstallGitRequest":{"properties":{"url":{"type":"string","title":"Url"},"ref":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Ref"},"subdirectory":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Subdirectory"}},"type":"object","required":["url"],"title":"PluginInstallGitRequest"}}}}
```

## The PluginInstallRequest object

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"components":{"schemas":{"PluginInstallRequest":{"properties":{"name":{"type":"string","title":"Name"},"version":{"type":"string","title":"Version"},"registry":{"type":"string","title":"Registry"}},"type":"object","required":["name","version","registry"],"title":"PluginInstallRequest"}}}}
```

## The PluginInstallTarRequest object

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"components":{"schemas":{"PluginInstallTarRequest":{"properties":{"url":{"type":"string","title":"Url"},"subdirectory":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Subdirectory"}},"type":"object","required":["url"],"title":"PluginInstallTarRequest"}}}}
```

## The PluginTask object

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"components":{"schemas":{"PluginTask":{"properties":{"id":{"type":"integer","title":"Id"},"input":{"type":"string","title":"Input"},"full_input":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Full Input"},"output":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Output"},"user_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"User Id"},"username":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Username"},"plugin_id":{"type":"string","title":"Plugin Id"},"plugin_options":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Plugin Options"},"downloads":{"items":{"$ref":"#/components/schemas/DownloadDescription"},"type":"array","title":"Downloads"},"status":{"anyOf":[{"$ref":"#/components/schemas/PluginTaskStatus"},{"type":"null"}]},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"},"tags":{"items":{"$ref":"#/components/schemas/Tag"},"type":"array","title":"Tags"}},"type":"object","required":["id","input","plugin_id","downloads","created_at","updated_at","tags"],"title":"PluginTask"},"DownloadDescription":{"properties":{"id":{"type":"integer","title":"Id"},"filename":{"type":"string","title":"Filename"},"link":{"type":"string","title":"Link"}},"type":"object","required":["id","filename","link"],"title":"DownloadDescription"},"PluginTaskStatus":{"type":"string","enum":["queued","started","completed","error","continuous"],"title":"PluginTaskStatus"},"Tag":{"properties":{"id":{"type":"integer","title":"Id"},"name":{"type":"string","title":"Name"},"value":{"type":"string","title":"Value"},"label":{"type":"string","title":"Label"},"color":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Color"}},"type":"object","required":["id","name","value","label"],"title":"Tag"}}}}
```

## The PluginTaskOrderOptions object

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"components":{"schemas":{"PluginTaskOrderOptions":{"type":"string","enum":["id","updated_at","status","plugin"],"title":"PluginTaskOrderOptions"}}}}
```

## The PluginTaskStatus object

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"components":{"schemas":{"PluginTaskStatus":{"type":"string","enum":["queued","started","completed","error","continuous"],"title":"PluginTaskStatus"}}}}
```

## The PluginTasks object

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"components":{"schemas":{"PluginTasks":{"properties":{"records":{"items":{"$ref":"#/components/schemas/PluginTask"},"type":"array","title":"Records"},"limit":{"type":"integer","title":"Limit"},"page":{"type":"integer","title":"Page"},"total_pages":{"type":"integer","title":"Total Pages"},"total":{"type":"integer","title":"Total"}},"type":"object","required":["records","limit","page","total_pages","total"],"title":"PluginTasks"},"PluginTask":{"properties":{"id":{"type":"integer","title":"Id"},"input":{"type":"string","title":"Input"},"full_input":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Full Input"},"output":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Output"},"user_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"User Id"},"username":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Username"},"plugin_id":{"type":"string","title":"Plugin Id"},"plugin_options":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Plugin Options"},"downloads":{"items":{"$ref":"#/components/schemas/DownloadDescription"},"type":"array","title":"Downloads"},"status":{"anyOf":[{"$ref":"#/components/schemas/PluginTaskStatus"},{"type":"null"}]},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"},"tags":{"items":{"$ref":"#/components/schemas/Tag"},"type":"array","title":"Tags"}},"type":"object","required":["id","input","plugin_id","downloads","created_at","updated_at","tags"],"title":"PluginTask"},"DownloadDescription":{"properties":{"id":{"type":"integer","title":"Id"},"filename":{"type":"string","title":"Filename"},"link":{"type":"string","title":"Link"}},"type":"object","required":["id","filename","link"],"title":"DownloadDescription"},"PluginTaskStatus":{"type":"string","enum":["queued","started","completed","error","continuous"],"title":"PluginTaskStatus"},"Tag":{"properties":{"id":{"type":"integer","title":"Id"},"name":{"type":"string","title":"Name"},"value":{"type":"string","title":"Value"},"label":{"type":"string","title":"Label"},"color":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Color"}},"type":"object","required":["id","name","value","label"],"title":"Tag"}}}}
```

## The PluginUpdateRequest object

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"components":{"schemas":{"PluginUpdateRequest":{"properties":{"enabled":{"type":"boolean","title":"Enabled"}},"type":"object","required":["enabled"],"title":"PluginUpdateRequest"}}}}
```

## The Plugins object

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"components":{"schemas":{"Plugins":{"properties":{"records":{"items":{"$ref":"#/components/schemas/Plugin"},"type":"array","title":"Records"}},"type":"object","required":["records"],"title":"Plugins"},"Plugin":{"properties":{"id":{"type":"string","title":"Id"},"name":{"type":"string","title":"Name"},"authors":{"items":{"$ref":"#/components/schemas/Author"},"type":"array","title":"Authors"},"readme":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Readme","default":""},"techniques":{"items":{"type":"string"},"type":"array","title":"Techniques","default":[]},"software":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Software"},"execution_options":{"anyOf":[{"additionalProperties":{"$ref":"#/components/schemas/CustomOptionSchema"},"type":"object"},{"type":"null"}],"title":"Execution Options"},"settings_options":{"anyOf":[{"additionalProperties":{"$ref":"#/components/schemas/CustomOptionSchema"},"type":"object"},{"type":"null"}],"title":"Settings Options"},"current_settings":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Current Settings"},"enabled":{"type":"boolean","title":"Enabled"},"loaded":{"type":"boolean","title":"Loaded","default":false},"execution_enabled":{"type":"boolean","title":"Execution Enabled","default":false},"python_deps":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Python Deps","default":[]}},"type":"object","required":["id","name","authors","enabled"],"title":"Plugin"},"Author":{"properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"handle":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Handle"},"link":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Link"}},"type":"object","title":"Author"},"CustomOptionSchema":{"properties":{"description":{"type":"string","title":"Description"},"required":{"type":"boolean","title":"Required"},"value":{"type":"string","title":"Value"},"suggested_values":{"items":{"type":"string"},"type":"array","title":"Suggested Values"},"strict":{"type":"boolean","title":"Strict"},"editable":{"type":"boolean","title":"Editable","default":true},"value_type":{"$ref":"#/components/schemas/ValueType"},"internal":{"type":"boolean","title":"Internal"},"depends_on":{"items":{"$ref":"#/components/schemas/DependentOption"},"type":"array","title":"Depends On","default":[]}},"type":"object","required":["description","required","value","suggested_values","strict","value_type","internal"],"title":"CustomOptionSchema"},"ValueType":{"type":"string","enum":["STRING","FLOAT","INTEGER","BOOLEAN","FILE"],"title":"ValueType"},"DependentOption":{"properties":{"name":{"type":"string","title":"Name"},"values":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Values"}},"type":"object","required":["name","values"],"title":"DependentOption"}}}}
```

## The Process object

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"components":{"schemas":{"Process":{"properties":{"process_id":{"type":"integer","title":"Process Id"},"process_name":{"type":"string","title":"Process Name"},"host_id":{"type":"integer","title":"Host Id"},"architecture":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Architecture"},"user":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"User"},"stale":{"type":"boolean","title":"Stale"},"agent_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Agent Id"}},"type":"object","required":["process_id","process_name","host_id","stale"],"title":"Process"}}}}
```

## The Processes object

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"components":{"schemas":{"Processes":{"properties":{"records":{"items":{"$ref":"#/components/schemas/Process"},"type":"array","title":"Records"}},"type":"object","required":["records"],"title":"Processes"},"Process":{"properties":{"process_id":{"type":"integer","title":"Process Id"},"process_name":{"type":"string","title":"Process Name"},"host_id":{"type":"integer","title":"Host Id"},"architecture":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Architecture"},"user":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"User"},"stale":{"type":"boolean","title":"Stale"},"agent_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Agent Id"}},"type":"object","required":["process_id","process_name","host_id","stale"],"title":"Process"}}}}
```

## The Profile object

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"components":{"schemas":{"Profile":{"properties":{"id":{"type":"integer","title":"Id"},"name":{"type":"string","title":"Name"},"file_path":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"File Path"},"category":{"type":"string","title":"Category"},"data":{"type":"string","title":"Data"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"}},"type":"object","required":["id","name","category","data","created_at","updated_at"],"title":"Profile"}}}}
```

## The ProfilePostRequest object

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"components":{"schemas":{"ProfilePostRequest":{"properties":{"name":{"type":"string","title":"Name"},"category":{"type":"string","title":"Category"},"data":{"type":"string","title":"Data"}},"type":"object","required":["name","category","data"],"title":"ProfilePostRequest"}}}}
```

## The ProfileUpdateRequest object

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"components":{"schemas":{"ProfileUpdateRequest":{"properties":{"data":{"type":"string","title":"Data"}},"type":"object","required":["data"],"title":"ProfileUpdateRequest"}}}}
```

## The Profiles object

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"components":{"schemas":{"Profiles":{"properties":{"records":{"items":{"$ref":"#/components/schemas/Profile"},"type":"array","title":"Records"}},"type":"object","required":["records"],"title":"Profiles"},"Profile":{"properties":{"id":{"type":"integer","title":"Id"},"name":{"type":"string","title":"Name"},"file_path":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"File Path"},"category":{"type":"string","title":"Category"},"data":{"type":"string","title":"Data"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"}},"type":"object","required":["id","name","category","data","created_at","updated_at"],"title":"Profile"}}}}
```

## The ShellPostRequest object

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"components":{"schemas":{"ShellPostRequest":{"properties":{"command":{"type":"string","title":"Command"},"literal":{"type":"boolean","title":"Literal","default":false}},"type":"object","required":["command"],"title":"ShellPostRequest"}}}}
```

## The SleepPostRequest object

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"components":{"schemas":{"SleepPostRequest":{"properties":{"delay":{"type":"integer","minimum":0,"title":"Delay"},"jitter":{"type":"number","maximum":1,"minimum":0,"title":"Jitter"}},"type":"object","required":["delay","jitter"],"title":"SleepPostRequest"}}}}
```

## The SocksPostRequest object

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"components":{"schemas":{"SocksPostRequest":{"properties":{"port":{"type":"integer","title":"Port"}},"type":"object","required":["port"],"title":"SocksPostRequest"}}}}
```

## The Stager object

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"components":{"schemas":{"Stager":{"properties":{"id":{"type":"integer","title":"Id"},"name":{"type":"string","title":"Name"},"template":{"type":"string","title":"Template"},"one_liner":{"type":"boolean","title":"One Liner"},"downloads":{"items":{"$ref":"#/components/schemas/DownloadDescription"},"type":"array","title":"Downloads"},"options":{"additionalProperties":{"type":"string"},"type":"object","title":"Options"},"user_id":{"type":"integer","title":"User Id"},"created_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At"},"updated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated At"}},"type":"object","required":["id","name","template","one_liner","downloads","options","user_id"],"title":"Stager"},"DownloadDescription":{"properties":{"id":{"type":"integer","title":"Id"},"filename":{"type":"string","title":"Filename"},"link":{"type":"string","title":"Link"}},"type":"object","required":["id","filename","link"],"title":"DownloadDescription"}}}}
```

## The StagerPostRequest object

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"components":{"schemas":{"StagerPostRequest":{"properties":{"name":{"type":"string","title":"Name"},"template":{"type":"string","title":"Template"},"options":{"additionalProperties":{"type":"string"},"type":"object","title":"Options"}},"type":"object","required":["name","template","options"],"title":"StagerPostRequest"}}}}
```

## The StagerTemplate object

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"components":{"schemas":{"StagerTemplate":{"properties":{"id":{"type":"string","title":"Id"},"name":{"type":"string","title":"Name"},"authors":{"items":{"$ref":"#/components/schemas/Author"},"type":"array","title":"Authors"},"description":{"type":"string","title":"Description"},"comments":{"items":{"type":"string"},"type":"array","title":"Comments"},"options":{"additionalProperties":{"$ref":"#/components/schemas/CustomOptionSchema"},"type":"object","title":"Options"}},"type":"object","required":["id","name","authors","description","comments","options"],"title":"StagerTemplate"},"Author":{"properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"handle":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Handle"},"link":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Link"}},"type":"object","title":"Author"},"CustomOptionSchema":{"properties":{"description":{"type":"string","title":"Description"},"required":{"type":"boolean","title":"Required"},"value":{"type":"string","title":"Value"},"suggested_values":{"items":{"type":"string"},"type":"array","title":"Suggested Values"},"strict":{"type":"boolean","title":"Strict"},"editable":{"type":"boolean","title":"Editable","default":true},"value_type":{"$ref":"#/components/schemas/ValueType"},"internal":{"type":"boolean","title":"Internal"},"depends_on":{"items":{"$ref":"#/components/schemas/DependentOption"},"type":"array","title":"Depends On","default":[]}},"type":"object","required":["description","required","value","suggested_values","strict","value_type","internal"],"title":"CustomOptionSchema"},"ValueType":{"type":"string","enum":["STRING","FLOAT","INTEGER","BOOLEAN","FILE"],"title":"ValueType"},"DependentOption":{"properties":{"name":{"type":"string","title":"Name"},"values":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Values"}},"type":"object","required":["name","values"],"title":"DependentOption"}}}}
```

## The StagerTemplates object

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"components":{"schemas":{"StagerTemplates":{"properties":{"records":{"items":{"$ref":"#/components/schemas/StagerTemplate"},"type":"array","title":"Records"}},"type":"object","required":["records"],"title":"StagerTemplates"},"StagerTemplate":{"properties":{"id":{"type":"string","title":"Id"},"name":{"type":"string","title":"Name"},"authors":{"items":{"$ref":"#/components/schemas/Author"},"type":"array","title":"Authors"},"description":{"type":"string","title":"Description"},"comments":{"items":{"type":"string"},"type":"array","title":"Comments"},"options":{"additionalProperties":{"$ref":"#/components/schemas/CustomOptionSchema"},"type":"object","title":"Options"}},"type":"object","required":["id","name","authors","description","comments","options"],"title":"StagerTemplate"},"Author":{"properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"handle":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Handle"},"link":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Link"}},"type":"object","title":"Author"},"CustomOptionSchema":{"properties":{"description":{"type":"string","title":"Description"},"required":{"type":"boolean","title":"Required"},"value":{"type":"string","title":"Value"},"suggested_values":{"items":{"type":"string"},"type":"array","title":"Suggested Values"},"strict":{"type":"boolean","title":"Strict"},"editable":{"type":"boolean","title":"Editable","default":true},"value_type":{"$ref":"#/components/schemas/ValueType"},"internal":{"type":"boolean","title":"Internal"},"depends_on":{"items":{"$ref":"#/components/schemas/DependentOption"},"type":"array","title":"Depends On","default":[]}},"type":"object","required":["description","required","value","suggested_values","strict","value_type","internal"],"title":"CustomOptionSchema"},"ValueType":{"type":"string","enum":["STRING","FLOAT","INTEGER","BOOLEAN","FILE"],"title":"ValueType"},"DependentOption":{"properties":{"name":{"type":"string","title":"Name"},"values":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Values"}},"type":"object","required":["name","values"],"title":"DependentOption"}}}}
```

## The StagerUpdateRequest object

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"components":{"schemas":{"StagerUpdateRequest":{"properties":{"name":{"type":"string","title":"Name"},"options":{"additionalProperties":{"type":"string"},"type":"object","title":"Options"}},"type":"object","required":["name","options"],"title":"StagerUpdateRequest"}}}}
```

## The Stagers object

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"components":{"schemas":{"Stagers":{"properties":{"records":{"items":{"$ref":"#/components/schemas/Stager"},"type":"array","title":"Records"}},"type":"object","required":["records"],"title":"Stagers"},"Stager":{"properties":{"id":{"type":"integer","title":"Id"},"name":{"type":"string","title":"Name"},"template":{"type":"string","title":"Template"},"one_liner":{"type":"boolean","title":"One Liner"},"downloads":{"items":{"$ref":"#/components/schemas/DownloadDescription"},"type":"array","title":"Downloads"},"options":{"additionalProperties":{"type":"string"},"type":"object","title":"Options"},"user_id":{"type":"integer","title":"User Id"},"created_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At"},"updated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated At"}},"type":"object","required":["id","name","template","one_liner","downloads","options","user_id"],"title":"Stager"},"DownloadDescription":{"properties":{"id":{"type":"integer","title":"Id"},"filename":{"type":"string","title":"Filename"},"link":{"type":"string","title":"Link"}},"type":"object","required":["id","filename","link"],"title":"DownloadDescription"}}}}
```

## The StopJobPostRequest object

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"components":{"schemas":{"StopJobPostRequest":{"properties":{"id":{"type":"integer","title":"Id"}},"type":"object","required":["id"],"title":"StopJobPostRequest"}}}}
```

## The SysinfoPostRequest object

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"components":{"schemas":{"SysinfoPostRequest":{"properties":{},"type":"object","title":"SysinfoPostRequest"}}}}
```

## The Tag object

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"components":{"schemas":{"Tag":{"properties":{"id":{"type":"integer","title":"Id"},"name":{"type":"string","title":"Name"},"value":{"type":"string","title":"Value"},"label":{"type":"string","title":"Label"},"color":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Color"}},"type":"object","required":["id","name","value","label"],"title":"Tag"}}}}
```

## The TagOrderOptions object

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"components":{"schemas":{"TagOrderOptions":{"type":"string","enum":["name","created_at","updated_at"],"title":"TagOrderOptions"}}}}
```

## The TagRequest object

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"components":{"schemas":{"TagRequest":{"properties":{"name":{"type":"string","pattern":"^[^:]+$","title":"Name"},"value":{"type":"string","pattern":"^[^:]+$","title":"Value"},"color":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Color"}},"type":"object","required":["name","value"],"title":"TagRequest"}}}}
```

## The TagSourceFilter object

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"components":{"schemas":{"TagSourceFilter":{"type":"string","enum":["listener","agent","agent_task","plugin_task","download","credential"],"title":"TagSourceFilter"}}}}
```

## The Token object

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"components":{"schemas":{"Token":{"properties":{"access_token":{"type":"string","title":"Access Token"},"token_type":{"type":"string","title":"Token Type"}},"type":"object","required":["access_token","token_type"],"title":"Token"}}}}
```

## The UploadPostRequest object

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"components":{"schemas":{"UploadPostRequest":{"properties":{"path_to_file":{"type":"string","title":"Path To File"},"file_id":{"type":"integer","title":"File Id"}},"type":"object","required":["path_to_file","file_id"],"title":"UploadPostRequest"}}}}
```

## The User object

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"components":{"schemas":{"User":{"properties":{"id":{"type":"integer","title":"Id"},"username":{"type":"string","title":"Username"},"enabled":{"type":"boolean","title":"Enabled"},"is_admin":{"type":"boolean","title":"Is Admin"},"avatar":{"anyOf":[{"$ref":"#/components/schemas/DownloadDescription"},{"type":"null"}]},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"}},"type":"object","required":["id","username","enabled","is_admin","created_at","updated_at"],"title":"User"},"DownloadDescription":{"properties":{"id":{"type":"integer","title":"Id"},"filename":{"type":"string","title":"Filename"},"link":{"type":"string","title":"Link"}},"type":"object","required":["id","filename","link"],"title":"DownloadDescription"}}}}
```

## The UserPostRequest object

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"components":{"schemas":{"UserPostRequest":{"properties":{"username":{"type":"string","title":"Username"},"password":{"type":"string","title":"Password"},"is_admin":{"type":"boolean","title":"Is Admin"}},"type":"object","required":["username","password","is_admin"],"title":"UserPostRequest"}}}}
```

## The UserUpdatePasswordRequest object

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"components":{"schemas":{"UserUpdatePasswordRequest":{"properties":{"password":{"type":"string","title":"Password"}},"type":"object","required":["password"],"title":"UserUpdatePasswordRequest"}}}}
```

## The UserUpdateRequest object

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"components":{"schemas":{"UserUpdateRequest":{"properties":{"username":{"type":"string","title":"Username"},"enabled":{"type":"boolean","title":"Enabled"},"is_admin":{"type":"boolean","title":"Is Admin"}},"type":"object","required":["username","enabled","is_admin"],"title":"UserUpdateRequest"}}}}
```

## The Users object

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"components":{"schemas":{"Users":{"properties":{"records":{"items":{"$ref":"#/components/schemas/User"},"type":"array","title":"Records"}},"type":"object","required":["records"],"title":"Users"},"User":{"properties":{"id":{"type":"integer","title":"Id"},"username":{"type":"string","title":"Username"},"enabled":{"type":"boolean","title":"Enabled"},"is_admin":{"type":"boolean","title":"Is Admin"},"avatar":{"anyOf":[{"$ref":"#/components/schemas/DownloadDescription"},{"type":"null"}]},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"}},"type":"object","required":["id","username","enabled","is_admin","created_at","updated_at"],"title":"User"},"DownloadDescription":{"properties":{"id":{"type":"integer","title":"Id"},"filename":{"type":"string","title":"Filename"},"link":{"type":"string","title":"Link"}},"type":"object","required":["id","filename","link"],"title":"DownloadDescription"}}}}
```

## The ValidationError object

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"components":{"schemas":{"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```

## The ValueType object

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"components":{"schemas":{"ValueType":{"type":"string","enum":["STRING","FLOAT","INTEGER","BOOLEAN","FILE"],"title":"ValueType"}}}}
```

## The WorkingHoursPostRequest object

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"components":{"schemas":{"WorkingHoursPostRequest":{"properties":{"working_hours":{"type":"string","title":"Working Hours"}},"type":"object","required":["working_hours"],"title":"WorkingHoursPostRequest"}}}}
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://bc-security.gitbook.io/empire-wiki/restful-api/models.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.