# Calagopus Client endpoints (Client API: account)

> 27 FeatherPanel Client API: account endpoints from user/calagopus-client.php: methods, paths, auth, permissions, rate limits, parameters and responses.

Source: https://featherpanel.com/docs/api/reference/user/calagopus-client/

Defined in [`backend/app/routes/user/calagopus-client.php`](https://github.com/MythicalLTD/FeatherPanel/blob/15b94e9fc9df233123706b47c42728b81e48cb3d/backend/app/routes/user/calagopus-client.php). Authentication used here: **Signed-in user**. Read [Authentication](https://featherpanel.com/docs/api/authentication/) for how to send credentials and [Rate limits and errors](https://featherpanel.com/docs/api/rate-limits-and-errors/) for the response envelope.

Paths, methods, permissions and rate limits come from the route file. Summaries, parameters and response codes come from the OpenAPI annotations on the controllers; endpoints without annotations show only what the route file declares.

## Endpoints

### GET `/api/settings`

- Auth: Signed-in user
- Default rate limit: 60 / minute (`calagopus-client`)
- Route name: `calagopus-settings`
- [route source](https://github.com/MythicalLTD/FeatherPanel/blob/15b94e9fc9df233123706b47c42728b81e48cb3d/backend/app/routes/user/calagopus-client.php#L28)

```bash
curl -X GET "$PANEL_URL/api/settings" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"
```

### GET `/api/client/account`

- Auth: Signed-in user
- Default rate limit: 60 / minute (`calagopus-client`)
- Route name: `calagopus-account`
- [route source](https://github.com/MythicalLTD/FeatherPanel/blob/15b94e9fc9df233123706b47c42728b81e48cb3d/backend/app/routes/user/calagopus-client.php#L40)

```bash
curl -X GET "$PANEL_URL/api/client/account" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"
```

### GET `/api/client/account/command-snippets`

- Auth: Signed-in user
- Default rate limit: 30 / minute (`calagopus-client`)
- Route name: `calagopus-command-snippets-list`
- [route source](https://github.com/MythicalLTD/FeatherPanel/blob/15b94e9fc9df233123706b47c42728b81e48cb3d/backend/app/routes/user/calagopus-client.php#L52)

```bash
curl -X GET "$PANEL_URL/api/client/account/command-snippets" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"
```

### POST `/api/client/account/command-snippets`

- Auth: Signed-in user
- Default rate limit: 20 / minute (`calagopus-client`)
- Route name: `calagopus-command-snippets-create`
- [route source](https://github.com/MythicalLTD/FeatherPanel/blob/15b94e9fc9df233123706b47c42728b81e48cb3d/backend/app/routes/user/calagopus-client.php#L64)

```bash
curl -X POST "$PANEL_URL/api/client/account/command-snippets" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"
```

### PATCH `/api/client/account/command-snippets/{snippetUuid}`

- Auth: Signed-in user
- Default rate limit: 20 / minute (`calagopus-client`)
- Route name: `calagopus-command-snippets-update`
- [route source](https://github.com/MythicalLTD/FeatherPanel/blob/15b94e9fc9df233123706b47c42728b81e48cb3d/backend/app/routes/user/calagopus-client.php#L76)

| Parameter | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `snippetUuid` | path | \- | yes |  |

```bash
curl -X PATCH "$PANEL_URL/api/client/account/command-snippets/$SNIPPET_UUID" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"
```

### DELETE `/api/client/account/command-snippets/{snippetUuid}`

- Auth: Signed-in user
- Default rate limit: 20 / minute (`calagopus-client`)
- Route name: `calagopus-command-snippets-delete`
- [route source](https://github.com/MythicalLTD/FeatherPanel/blob/15b94e9fc9df233123706b47c42728b81e48cb3d/backend/app/routes/user/calagopus-client.php#L88)

| Parameter | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `snippetUuid` | path | \- | yes |  |

```bash
curl -X DELETE "$PANEL_URL/api/client/account/command-snippets/$SNIPPET_UUID" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"
```

### GET `/api/client/servers`

- Auth: Signed-in user
- Default rate limit: 60 / minute (`calagopus-client`)
- Route name: `calagopus-servers-list`
- [route source](https://github.com/MythicalLTD/FeatherPanel/blob/15b94e9fc9df233123706b47c42728b81e48cb3d/backend/app/routes/user/calagopus-client.php#L100)

```bash
curl -X GET "$PANEL_URL/api/client/servers" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"
```

### GET `/api/client/servers/{uuid}`

- Auth: Signed-in user
- Default rate limit: 60 / minute (`calagopus-client`)
- Route name: `calagopus-server-get`
- [route source](https://github.com/MythicalLTD/FeatherPanel/blob/15b94e9fc9df233123706b47c42728b81e48cb3d/backend/app/routes/user/calagopus-client.php#L112)

| Parameter | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `uuid` | path | \- | yes |  |

```bash
curl -X GET "$PANEL_URL/api/client/servers/$UUID" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"
```

### GET `/api/client/servers/{uuid}/websocket`

- Auth: Signed-in user
- Default rate limit: 30 / minute (`calagopus-client`)
- Route name: `calagopus-server-websocket`
- [route source](https://github.com/MythicalLTD/FeatherPanel/blob/15b94e9fc9df233123706b47c42728b81e48cb3d/backend/app/routes/user/calagopus-client.php#L124)

| Parameter | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `uuid` | path | \- | yes |  |

```bash
curl -X GET "$PANEL_URL/api/client/servers/$UUID/websocket" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"
```

### POST `/api/client/servers/{uuid}/power`

- Auth: Signed-in user
- Default rate limit: 20 / minute (`calagopus-client`)
- Route name: `calagopus-server-power`
- [route source](https://github.com/MythicalLTD/FeatherPanel/blob/15b94e9fc9df233123706b47c42728b81e48cb3d/backend/app/routes/user/calagopus-client.php#L136)

| Parameter | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `uuid` | path | \- | yes |  |

```bash
curl -X POST "$PANEL_URL/api/client/servers/$UUID/power" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"
```

### GET `/api/client/servers/{uuid}/files/list`

- Auth: Signed-in user
- Default rate limit: 60 / minute (`calagopus-client`)
- Route name: `calagopus-files-list`
- [route source](https://github.com/MythicalLTD/FeatherPanel/blob/15b94e9fc9df233123706b47c42728b81e48cb3d/backend/app/routes/user/calagopus-client.php#L148)

| Parameter | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `uuid` | path | \- | yes |  |

```bash
curl -X GET "$PANEL_URL/api/client/servers/$UUID/files/list" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"
```

### GET `/api/client/servers/{uuid}/files/contents`

- Auth: Signed-in user
- Default rate limit: 60 / minute (`calagopus-client`)
- Route name: `calagopus-files-contents`
- [route source](https://github.com/MythicalLTD/FeatherPanel/blob/15b94e9fc9df233123706b47c42728b81e48cb3d/backend/app/routes/user/calagopus-client.php#L160)

| Parameter | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `uuid` | path | \- | yes |  |

```bash
curl -X GET "$PANEL_URL/api/client/servers/$UUID/files/contents" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"
```

### POST `/api/client/servers/{uuid}/files/write`

- Auth: Signed-in user
- Default rate limit: 60 / minute (`calagopus-client`)
- Route name: `calagopus-files-write`
- [route source](https://github.com/MythicalLTD/FeatherPanel/blob/15b94e9fc9df233123706b47c42728b81e48cb3d/backend/app/routes/user/calagopus-client.php#L172)

| Parameter | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `uuid` | path | \- | yes |  |

```bash
curl -X POST "$PANEL_URL/api/client/servers/$UUID/files/write" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"
```

### GET `/api/client/servers/{uuid}/files/upload`

- Auth: Signed-in user
- Default rate limit: 30 / minute (`calagopus-client`)
- Route name: `calagopus-files-upload`
- [route source](https://github.com/MythicalLTD/FeatherPanel/blob/15b94e9fc9df233123706b47c42728b81e48cb3d/backend/app/routes/user/calagopus-client.php#L184)

| Parameter | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `uuid` | path | \- | yes |  |

```bash
curl -X GET "$PANEL_URL/api/client/servers/$UUID/files/upload" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"
```

### GET `/api/client/servers/{uuid}/files/download`

- Auth: Signed-in user
- Default rate limit: 30 / minute (`calagopus-client`)
- Route name: `calagopus-files-download`
- [route source](https://github.com/MythicalLTD/FeatherPanel/blob/15b94e9fc9df233123706b47c42728b81e48cb3d/backend/app/routes/user/calagopus-client.php#L196)

| Parameter | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `uuid` | path | \- | yes |  |

```bash
curl -X GET "$PANEL_URL/api/client/servers/$UUID/files/download" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"
```

### POST `/api/client/servers/{uuid}/files/create-directory`

- Auth: Signed-in user
- Default rate limit: 30 / minute (`calagopus-client`)
- Route name: `calagopus-files-create-directory`
- [route source](https://github.com/MythicalLTD/FeatherPanel/blob/15b94e9fc9df233123706b47c42728b81e48cb3d/backend/app/routes/user/calagopus-client.php#L208)

| Parameter | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `uuid` | path | \- | yes |  |

```bash
curl -X POST "$PANEL_URL/api/client/servers/$UUID/files/create-directory" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"
```

### PUT `/api/client/servers/{uuid}/files/rename`

- Auth: Signed-in user
- Default rate limit: 30 / minute (`calagopus-client`)
- Route name: `calagopus-files-rename`
- [route source](https://github.com/MythicalLTD/FeatherPanel/blob/15b94e9fc9df233123706b47c42728b81e48cb3d/backend/app/routes/user/calagopus-client.php#L220)

| Parameter | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `uuid` | path | \- | yes |  |

```bash
curl -X PUT "$PANEL_URL/api/client/servers/$UUID/files/rename" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"
```

### POST `/api/client/servers/{uuid}/files/delete`

- Auth: Signed-in user
- Default rate limit: 30 / minute (`calagopus-client`)
- Route name: `calagopus-files-delete`
- [route source](https://github.com/MythicalLTD/FeatherPanel/blob/15b94e9fc9df233123706b47c42728b81e48cb3d/backend/app/routes/user/calagopus-client.php#L232)

| Parameter | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `uuid` | path | \- | yes |  |

```bash
curl -X POST "$PANEL_URL/api/client/servers/$UUID/files/delete" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"
```

### POST `/api/client/servers/{uuid}/files/search`

- Auth: Signed-in user
- Default rate limit: 30 / minute (`calagopus-client`)
- Route name: `calagopus-files-search`
- [route source](https://github.com/MythicalLTD/FeatherPanel/blob/15b94e9fc9df233123706b47c42728b81e48cb3d/backend/app/routes/user/calagopus-client.php#L244)

| Parameter | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `uuid` | path | \- | yes |  |

```bash
curl -X POST "$PANEL_URL/api/client/servers/$UUID/files/search" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"
```

### GET `/api/client/servers/{uuid}/files/revisions`

- Auth: Signed-in user
- Default rate limit: 30 / minute (`calagopus-client`)
- Route name: `calagopus-files-revisions`
- [route source](https://github.com/MythicalLTD/FeatherPanel/blob/15b94e9fc9df233123706b47c42728b81e48cb3d/backend/app/routes/user/calagopus-client.php#L256)

| Parameter | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `uuid` | path | \- | yes |  |

```bash
curl -X GET "$PANEL_URL/api/client/servers/$UUID/files/revisions" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"
```

### GET `/api/client/servers/{uuid}/files/revisions/{id}`

- Auth: Signed-in user
- Default rate limit: 30 / minute (`calagopus-client`)
- Route name: `calagopus-files-revision`
- [route source](https://github.com/MythicalLTD/FeatherPanel/blob/15b94e9fc9df233123706b47c42728b81e48cb3d/backend/app/routes/user/calagopus-client.php#L268)

| Parameter | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `uuid` | path | \- | yes |  |
| `id` | path | \- | yes |  |

```bash
curl -X GET "$PANEL_URL/api/client/servers/$UUID/files/revisions/$ID" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"
```

### POST `/api/client/servers/{uuid}/files/compress`

- Auth: Signed-in user
- Default rate limit: 10 / minute (`calagopus-client`)
- Route name: `calagopus-files-compress`
- [route source](https://github.com/MythicalLTD/FeatherPanel/blob/15b94e9fc9df233123706b47c42728b81e48cb3d/backend/app/routes/user/calagopus-client.php#L284)

| Parameter | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `uuid` | path | \- | yes |  |

```bash
curl -X POST "$PANEL_URL/api/client/servers/$UUID/files/compress" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"
```

### POST `/api/client/servers/{uuid}/files/decompress`

- Auth: Signed-in user
- Default rate limit: 10 / minute (`calagopus-client`)
- Route name: `calagopus-files-decompress`
- [route source](https://github.com/MythicalLTD/FeatherPanel/blob/15b94e9fc9df233123706b47c42728b81e48cb3d/backend/app/routes/user/calagopus-client.php#L296)

| Parameter | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `uuid` | path | \- | yes |  |

```bash
curl -X POST "$PANEL_URL/api/client/servers/$UUID/files/decompress" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"
```

### PUT `/api/client/servers/{uuid}/files/chmod`

- Auth: Signed-in user
- Default rate limit: 20 / minute (`calagopus-client`)
- Route name: `calagopus-files-chmod`
- [route source](https://github.com/MythicalLTD/FeatherPanel/blob/15b94e9fc9df233123706b47c42728b81e48cb3d/backend/app/routes/user/calagopus-client.php#L308)

| Parameter | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `uuid` | path | \- | yes |  |

```bash
curl -X PUT "$PANEL_URL/api/client/servers/$UUID/files/chmod" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"
```

### POST `/api/client/servers/{uuid}/files/copy-many`

- Auth: Signed-in user
- Default rate limit: 20 / minute (`calagopus-client`)
- Route name: `calagopus-files-copy-many`
- [route source](https://github.com/MythicalLTD/FeatherPanel/blob/15b94e9fc9df233123706b47c42728b81e48cb3d/backend/app/routes/user/calagopus-client.php#L320)

| Parameter | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `uuid` | path | \- | yes |  |

```bash
curl -X POST "$PANEL_URL/api/client/servers/$UUID/files/copy-many" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"
```

### POST `/api/client/servers/{uuid}/files/copy-remote`

- Auth: Signed-in user
- Default rate limit: 10 / minute (`calagopus-client`)
- Route name: `calagopus-files-copy-remote`
- [route source](https://github.com/MythicalLTD/FeatherPanel/blob/15b94e9fc9df233123706b47c42728b81e48cb3d/backend/app/routes/user/calagopus-client.php#L332)

| Parameter | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `uuid` | path | \- | yes |  |

```bash
curl -X POST "$PANEL_URL/api/client/servers/$UUID/files/copy-remote" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"
```

### DELETE `/api/client/servers/{uuid}/files/operations/{operation}`

- Auth: Signed-in user
- Default rate limit: 30 / minute (`calagopus-client`)
- Route name: `calagopus-files-operation-cancel`
- [route source](https://github.com/MythicalLTD/FeatherPanel/blob/15b94e9fc9df233123706b47c42728b81e48cb3d/backend/app/routes/user/calagopus-client.php#L344)

| Parameter | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `uuid` | path | \- | yes |  |
| `operation` | path | \- | yes |  |

```bash
curl -X DELETE "$PANEL_URL/api/client/servers/$UUID/files/operations/$OPERATION" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"
```