GET /api/v1/internal/projects/:projectUuid/apps/:appUuid/sftp-users

Returns a sftp users resource.

This endpoint documentation is generated from the current Fastify route implementation and should be treated as the implementation-level contract for this version of the API.

Source route file: src/api/routes/internal/private/bearer/projects/apps/sftp-users/getAll.ts

Request Method

GET

Base URL

https://api.userdocks.local:5000

Endpoint

/api/v1/internal/projects/:projectUuid/apps/:appUuid/sftp-users

Path Variables

Variable	Type	Required	Description
projectUuid	string	true	Path variable from route pattern.
appUuid	string	true	Path variable from route pattern.

Query Parameters

Variable	Type	Required	Description
page	string	false	Query parameter parsed by route handler.
limit	string	false	Query parameter parsed by route handler.

HTTP Headers

Variable	Type	Required	Description
Authorization	string	true	Bearer token in the form Bearer <jwt>.
Content-Type	string	false	Use application/json for JSON request bodies.

Successful Response

Success status code(s): 200.

{
  "kind": "SFTPUsers",
  "totalItems": 1,
  "itemsLength": 1,
  "items": [
    {
      "uuid": "00000000-0000-0000-0000-000000000000"
    }
  ]
}

Error Responses

HTTP Status	Example Error
401	{"errors":[{"validation":"error","code":"[E4010]","message":"Unauthorized Token"}]}
403	{"errors":[{"validation":"error","code":"[E4030]","message":"App Is Disabled"}]}
400	{"errors":[{"validation":"error","code":"[E4000]","message":"Bad Request / validation error"}]}
500	{"errors":[{"validation":"error","code":"[E0000]","message":"Internal Server Error"}]}

Example

const query = new URLSearchParams({
  page: 'page-value',
  limit: 'limit-value',
});
const url = `https://api.userdocks.local:5000/api/v1/internal/projects/projectUuid-value/apps/appUuid-value/sftp-users?${query.toString()}`;

const response = await fetch(url, {
  method: 'GET',
  headers: {
    Authorization: 'Bearer <jwt>',
  },
});
const data = await response.json();
console.log(response.status, data);