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

# Models

## The ChmodFilesRequest object

```json
{"openapi":"3.1.0","info":{"title":"Reviactyl","version":"0.0.1"},"components":{"schemas":{"ChmodFilesRequest":{"type":"object","properties":{"root":{"type":["string","null"]},"files":{"type":"array","items":{"type":"object","properties":{"file":{"type":"string"},"mode":{"type":"number"}},"required":["file","mode"]},"minItems":1}},"required":["root","files"],"title":"ChmodFilesRequest"}}}}
```

## The ClientApiRequest object

```json
{"openapi":"3.1.0","info":{"title":"Reviactyl","version":"0.0.1"},"components":{"schemas":{"ClientApiRequest":{"type":"object","title":"ClientApiRequest"}}}}
```

## The CompressFilesRequest object

```json
{"openapi":"3.1.0","info":{"title":"Reviactyl","version":"0.0.1"},"components":{"schemas":{"CompressFilesRequest":{"type":"object","properties":{"root":{"type":["string","null"]},"files":{"type":"array","items":{"type":"string"},"minItems":1},"format":{"type":"string","enum":["tar.gz","zip"]}},"required":["files"],"title":"CompressFilesRequest"}}}}
```

## The CopyFileRequest object

```json
{"openapi":"3.1.0","info":{"title":"Reviactyl","version":"0.0.1"},"components":{"schemas":{"CopyFileRequest":{"type":"object","properties":{"location":{"type":"string"}},"required":["location"],"title":"CopyFileRequest"}}}}
```

## The CreateFolderRequest object

```json
{"openapi":"3.1.0","info":{"title":"Reviactyl","version":"0.0.1"},"components":{"schemas":{"CreateFolderRequest":{"type":"object","properties":{"root":{"type":["string","null"]},"name":{"type":"string"}},"required":["name"],"title":"CreateFolderRequest"}}}}
```

## The DecompressFilesRequest object

```json
{"openapi":"3.1.0","info":{"title":"Reviactyl","version":"0.0.1"},"components":{"schemas":{"DecompressFilesRequest":{"type":"object","properties":{"root":{"type":["string","null"]},"file":{"type":"string"}},"required":["file"],"title":"DecompressFilesRequest"}}}}
```

## The DeleteFileRequest object

```json
{"openapi":"3.1.0","info":{"title":"Reviactyl","version":"0.0.1"},"components":{"schemas":{"DeleteFileRequest":{"type":"object","properties":{"root":{"type":["string","null"]},"files":{"type":"array","items":{"type":"string"},"minItems":1}},"required":["root","files"],"title":"DeleteFileRequest"}}}}
```

## The PasskeyRegistrationRequest object

```json
{"openapi":"3.1.0","info":{"title":"Reviactyl","version":"0.0.1"},"components":{"schemas":{"PasskeyRegistrationRequest":{"type":"object","properties":{"name":{"type":"string","maxLength":255},"credential":{"type":"object","properties":{"id":{"type":"string"},"rawId":{"type":"string"},"type":{"type":"string","enum":["public-key"]},"response":{"type":"array","items":{"type":"string"},"minItems":1}},"required":["id","rawId","type","response"]}},"required":["name","credential"],"title":"PasskeyRegistrationRequest"}}}}
```

## The PullFileRequest object

```json
{"openapi":"3.1.0","info":{"title":"Reviactyl","version":"0.0.1"},"components":{"schemas":{"PullFileRequest":{"type":"object","properties":{"url":{"type":"string","format":"uri"},"directory":{"type":["string","null"]},"filename":{"type":["string","null"]},"use_header":{"type":"boolean"},"foreground":{"type":"boolean"}},"required":["url"],"title":"PullFileRequest"}}}}
```

## The RenameFileRequest object

```json
{"openapi":"3.1.0","info":{"title":"Reviactyl","version":"0.0.1"},"components":{"schemas":{"RenameFileRequest":{"type":"object","properties":{"root":{"type":["string","null"]},"files":{"type":"array","items":{"type":"object","properties":{"to":{"type":"string"},"from":{"type":"string"}},"required":["to","from"]},"minItems":1}},"required":["root","files"],"title":"RenameFileRequest"}}}}
```

## The RenameServerRequest object

```json
{"openapi":"3.1.0","info":{"title":"Reviactyl","version":"0.0.1"},"components":{"schemas":{"RenameServerRequest":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":191},"description":{"type":["string","null"]}},"required":["name"],"title":"RenameServerRequest"}}}}
```

## The RestoreBackupRequest object

```json
{"openapi":"3.1.0","info":{"title":"Reviactyl","version":"0.0.1"},"components":{"schemas":{"RestoreBackupRequest":{"type":"object","properties":{"truncate":{"type":"boolean"}},"required":["truncate"],"title":"RestoreBackupRequest"}}}}
```

## The SendCommandRequest object

```json
{"openapi":"3.1.0","info":{"title":"Reviactyl","version":"0.0.1"},"components":{"schemas":{"SendCommandRequest":{"type":"object","properties":{"command":{"type":"string","minLength":1}},"required":["command"],"title":"SendCommandRequest"}}}}
```

## The SendPowerRequest object

```json
{"openapi":"3.1.0","info":{"title":"Reviactyl","version":"0.0.1"},"components":{"schemas":{"SendPowerRequest":{"type":"object","properties":{"signal":{"type":"string","enum":["start","stop","restart","kill"]}},"required":["signal"],"title":"SendPowerRequest"}}}}
```

## The SetCategoryRequest object

```json
{"openapi":"3.1.0","info":{"title":"Reviactyl","version":"0.0.1"},"components":{"schemas":{"SetCategoryRequest":{"type":"object","properties":{"category":{"type":["string","null"]}},"title":"SetCategoryRequest"}}}}
```

## The SetDockerImageRequest object

```json
{"openapi":"3.1.0","info":{"title":"Reviactyl","version":"0.0.1"},"components":{"schemas":{"SetDockerImageRequest":{"type":"object","properties":{"docker_image":{"type":"string","pattern":"^[\\w#\\.\\/\\- ]*\\|?~?[\\w\\.\\/\\-:@ ]*$","maxLength":191}},"required":["docker_image"],"title":"SetDockerImageRequest"}}}}
```

## The SetTimezoneRequest object

```json
{"openapi":"3.1.0","info":{"title":"Reviactyl","version":"0.0.1"},"components":{"schemas":{"SetTimezoneRequest":{"type":"object","properties":{"timezone":{"type":["string","null"],"maxLength":64}},"required":["timezone"],"title":"SetTimezoneRequest"}}}}
```

## The StoreApiKeyRequest object

```json
{"openapi":"3.1.0","info":{"title":"Reviactyl","version":"0.0.1"},"components":{"schemas":{"StoreApiKeyRequest":{"type":"object","properties":{"description":{"type":["string","null"],"maxLength":500},"allowed_ips":{"type":["array","null"],"items":{"type":"string"},"maxItems":50}},"required":["description"],"title":"StoreApiKeyRequest"}}}}
```

## The StoreBackupRequest object

```json
{"openapi":"3.1.0","info":{"title":"Reviactyl","version":"0.0.1"},"components":{"schemas":{"StoreBackupRequest":{"type":"object","properties":{"name":{"type":["string","null"],"maxLength":191},"is_locked":{"type":["boolean","null"]},"ignored":{"type":["string","null"]},"format":{"type":"string","enum":["tar.gz","zip"]}},"title":"StoreBackupRequest"}}}}
```

## The StoreDatabaseRequest object

```json
{"openapi":"3.1.0","info":{"title":"Reviactyl","version":"0.0.1"},"components":{"schemas":{"StoreDatabaseRequest":{"type":"object","properties":{"database":{"type":"string","minLength":3,"maxLength":48},"remote":{"type":"string","pattern":"^[\\w\\-\\/.%:]+$"}},"required":["database","remote"],"title":"StoreDatabaseRequest"}}}}
```

## The StoreSSHKeyRequest object

```json
{"openapi":"3.1.0","info":{"title":"Reviactyl","version":"0.0.1"},"components":{"schemas":{"StoreSSHKeyRequest":{"type":"object","properties":{"name":{"type":"string"},"public_key":{"type":"string","maxLength":16384}},"required":["name","public_key"],"title":"StoreSSHKeyRequest"}}}}
```

## The StoreScheduleRequest object

```json
{"openapi":"3.1.0","info":{"title":"Reviactyl","version":"0.0.1"},"components":{"schemas":{"StoreScheduleRequest":{"type":"object","properties":{"name":{"type":"string","maxLength":191},"is_active":{"type":"boolean"},"minute":{"type":"string"},"hour":{"type":"string"},"day_of_month":{"type":"string"},"day_of_week":{"type":"string"}},"required":["name","minute","hour","day_of_month","day_of_week"],"title":"StoreScheduleRequest"}}}}
```

## The StoreServerCategoryRequest object

```json
{"openapi":"3.1.0","info":{"title":"Reviactyl","version":"0.0.1"},"components":{"schemas":{"StoreServerCategoryRequest":{"type":"object","properties":{"name":{"type":"string","maxLength":191},"description":{"type":["string","null"]},"color":{"type":["string","null"],"pattern":"^#([a-f0-9]{6}|[a-f0-9]{3})$","maxLength":7}},"required":["name"],"title":"StoreServerCategoryRequest"}}}}
```

## The StoreSubuserRequest object

```json
{"openapi":"3.1.0","info":{"title":"Reviactyl","version":"0.0.1"},"components":{"schemas":{"StoreSubuserRequest":{"type":"object","properties":{"email":{"type":"string","format":"email","minLength":1,"maxLength":191},"permissions":{"type":"array","items":{"type":"string"},"minItems":1}},"required":["email","permissions"],"title":"StoreSubuserRequest"}}}}
```

## The StoreTaskRequest object

```json
{"openapi":"3.1.0","info":{"title":"Reviactyl","version":"0.0.1"},"components":{"schemas":{"StoreTaskRequest":{"type":"object","properties":{"action":{"type":"string","enum":["command","power","backup"]},"payload":{"type":["string","null"],"enum":["start","stop","restart","kill",null]},"time_offset":{"type":"number","minimum":0,"maximum":900},"sequence_id":{"type":"number","minimum":1},"continue_on_failure":{"type":"boolean"}},"required":["action","time_offset"],"title":"StoreTaskRequest"}}}}
```

## The UpdateAllocationRequest object

```json
{"openapi":"3.1.0","info":{"title":"Reviactyl","version":"0.0.1"},"components":{"schemas":{"UpdateAllocationRequest":{"type":"object","properties":{"notes":{"type":["string","null"],"maxLength":256}},"required":["notes"],"title":"UpdateAllocationRequest"}}}}
```

## The UpdateAvatarRequest object

```json
{"openapi":"3.1.0","info":{"title":"Reviactyl","version":"0.0.1"},"components":{"schemas":{"UpdateAvatarRequest":{"type":"object","properties":{"avatar_style":{"type":"string","enum":["gravatar","initials","identicon","loops","waves","critters","pixelbot","thumbs"]},"avatar_animated":{"type":"boolean"}},"required":["avatar_style","avatar_animated"],"title":"UpdateAvatarRequest"}}}}
```

## The UpdateEmailRequest object

```json
{"openapi":"3.1.0","info":{"title":"Reviactyl","version":"0.0.1"},"components":{"schemas":{"UpdateEmailRequest":{"type":"object","properties":{"email":{"type":"string","format":"email","minLength":1,"maxLength":191}},"required":["email"],"title":"UpdateEmailRequest"}}}}
```

## The UpdateFileContentRequest object

```json
{"openapi":"3.1.0","info":{"title":"Reviactyl","version":"0.0.1"},"components":{"schemas":{"UpdateFileContentRequest":{"type":"object","properties":{"file":{"type":"string"}},"required":["file"],"title":"UpdateFileContentRequest"}}}}
```

## The UpdatePasswordRequest object

```json
{"openapi":"3.1.0","info":{"title":"Reviactyl","version":"0.0.1"},"components":{"schemas":{"UpdatePasswordRequest":{"type":"object","properties":{"password":{"type":"string","minLength":8},"password_confirmation":{"type":"string","minLength":8}},"required":["password","password_confirmation"],"title":"UpdatePasswordRequest"}}}}
```

## The UpdateScheduleRequest object

```json
{"openapi":"3.1.0","info":{"title":"Reviactyl","version":"0.0.1"},"components":{"schemas":{"UpdateScheduleRequest":{"type":"object","properties":{"name":{"type":"string","maxLength":191},"is_active":{"type":"boolean"},"minute":{"type":"string"},"hour":{"type":"string"},"day_of_month":{"type":"string"},"day_of_week":{"type":"string"}},"required":["name","minute","hour","day_of_month","day_of_week"],"title":"UpdateScheduleRequest"}}}}
```

## The UpdateServerCategoryRequest object

```json
{"openapi":"3.1.0","info":{"title":"Reviactyl","version":"0.0.1"},"components":{"schemas":{"UpdateServerCategoryRequest":{"type":"object","properties":{"name":{"type":"string","maxLength":191},"description":{"type":["string","null"]},"color":{"type":["string","null"],"pattern":"^#([a-f0-9]{6}|[a-f0-9]{3})$","maxLength":7}},"title":"UpdateServerCategoryRequest"}}}}
```

## The UpdateStartupVariableRequest object

```json
{"openapi":"3.1.0","info":{"title":"Reviactyl","version":"0.0.1"},"components":{"schemas":{"UpdateStartupVariableRequest":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key","value"],"title":"UpdateStartupVariableRequest"}}}}
```

## The UpdateSubuserRequest object

```json
{"openapi":"3.1.0","info":{"title":"Reviactyl","version":"0.0.1"},"components":{"schemas":{"UpdateSubuserRequest":{"type":"object","properties":{"permissions":{"type":"array","items":{"type":"string"},"minItems":1}},"required":["permissions"],"title":"UpdateSubuserRequest"}}}}
```

## The User object

```json
{"openapi":"3.1.0","info":{"title":"Reviactyl","version":"0.0.1"},"components":{"schemas":{"User":{"type":"object","properties":{"id":{"type":"integer"},"external_id":{"type":["string","null"]},"uuid":{"type":"string"},"username":{"type":"string"},"email":{"type":"string"},"name_first":{"type":["string","null"]},"name_last":{"type":["string","null"]},"language":{"type":"string"},"root_admin":{"type":"boolean"},"use_totp":{"type":"boolean"},"gravatar":{"type":"boolean"},"avatar_style":{"type":"string"},"avatar_animated":{"type":"boolean"},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"last_seen":{"type":["string","null"],"format":"date-time"},"editor":{"type":"string"},"archive_format":{"type":"string"}},"required":["id","external_id","uuid","username","email","name_first","name_last","language","root_admin","use_totp","gravatar","avatar_style","avatar_animated","created_at","updated_at","last_seen","editor","archive_format"],"title":"User"}}}}
```

## The WriteFileContentRequest object

```json
{"openapi":"3.1.0","info":{"title":"Reviactyl","version":"0.0.1"},"components":{"schemas":{"WriteFileContentRequest":{"type":"object","properties":{"file":{"type":"string"}},"required":["file"],"title":"WriteFileContentRequest"}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

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

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.reviactyl.app/client-api/models.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.