Infomaniak Vod icon

Infomaniak Vod

Interact with Infomaniak Vod API

Actions349

V3 > Ftp → List FTP Users.

AI-generated

Summary

Retrieve a list of FTP users for a specified Infomaniak channel, supporting pagination and filtering options.

Inputs

  • Authentication (required) — Choose the authentication method: OAuth2 or API Key.
  • Channel (required) — The unique identifier of the channel to list FTP users for.
  • Additional Query Parameters — Optional query parameters to modify the response, including 'Return' (to get total count instead of items), 'Page' (page number), and 'Per Page' (items per page).
  • Return All — Whether to return all FTP users or limit the number of results.
  • Limit — When 'Return All' is false, limits the number of FTP users returned (1-500).
  • Return Full Response — Whether to return the complete API response including metadata instead of only the data items.

Output shape

a JSON object containing the list of FTP users or a total count, optionally paginated according to parameters; or the full API response if requested.

If 'Return All' is true, all FTP users for the specified channel are retrieved across all pages. If 'Return' is set to 'total', the response returns only the count of FTP users. Pagination parameters 'Page' and 'Per Page' control which subset of users is returned. If 'Return Full Response' is true, the entire response object including metadata is returned rather than just the data.

Examples

Example 1: List all FTP users in channel 123 using OAuth2 authentication.

Set Authentication to OAuth2, Channel to 123, and Return All to true.

Example 2: Retrieve the number of FTP users in channel 456.

Set Channel to 456, Additional Query Parameter 'Return' to 'total', and Return All to false.

Links

Discussion