---
title: "List Ftp Accounts"
method: GET
path: "/v1/sites/{id}/ftp/accounts"
tags: ["FTP Accounts"]
---

# List Ftp Accounts

`GET /v1/sites/{id}/ftp/accounts`

Get list of ftp accounts associated with given site, can be filtered by ftp username.

## Path parameters

- `id` integer, required — ID of the Site you are interacting with

## Query parameters

- `username` string — Search for usernames matching this string
- `page` integer — Page of results to include (default = 1)
- `per_page` integer — How many results to include in each page (default = 10)
- `sort` 'dir' | 'diskquota' | 'diskused' | 'reldir' | 'user'
- `direction` 'asc' | 'desc' | 'ASC' | 'DESC' — Direction to sort results in (asc = ascending, desc = descending)

## Response `200`

OK

- ListFtpAccountsResponse
  - `success` boolean — whether the request succeeded
  - `errors` string[]
  - `messages` string[], nullable
  - `metadata` object
    - `page` integer — Page number of the results
    - `page_size` integer — Number of results per page
    - `total` integer — Total number of results
    - `sort` string — Sorting criteria
    - `direction` 'asc' | 'desc' — Sorting direction
  - `result` FTPAccount[]
    - `dir` string — absolute path to the FTP account document root
    - `diskquota` union
      - integer — FTP disk space quota in MB (unlimited = unlimited)
      - 'unlimited' — FTP disk space quota in MB (0 or unlimited = unlimited)
    - `diskused` string — amount of disk space the FTP user has used (in MB)
    - `reldir` string — relative path of the FTP account document root
    - `user` string — FTP account username (with domain)

## Other responses

- `400` — Bad Request
- `401` — Authentication failed
- `403` — Not authorized to access endpoint
- `404` — Given site not found for user
- `405` — Invalid input
- `500` — Internal error

---

[API](https://skmtc.net/rocket/apis/rocket-net-api.md) · [All operations](https://skmtc.net/rocket/apis/rocket-net-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/rocket/rocket-net-api/revisions/db0dcbbc5764/schema)