Infomaniak Vod icon

Infomaniak Vod

Interact with Infomaniak Vod API

Actions349

V3 > Filesystem → Browse Trash.

AI-generated

Summary

Retrieve items from the trash of a specified channel's filesystem, optionally supporting pagination, total count queries, and full response returns.

Inputs

  • Authentication (required) — Select the authentication method to use, either OAuth2 or API Key.
  • Channel (required) — Provide the unique identifier (number) of the channel whose trash you want to browse.
  • Additional Query Parameters — Optionally add query parameters such as 'Return' to get total item count instead of items, 'Page' to specify the page number for pagination, and 'Per Page' to specify the number of items per page.
  • Return All — Boolean flag to either return all items from trash or limit the returned items by the specified limit.
  • Limit — Number limiting the maximum amount of trash items to return when 'Return All' is false; valid range is 1 to 500.
  • Return Full Response — Boolean flag to return the complete API response instead of just the parsed item data.

Output shape

a list of trash items or a total count depending on 'Return' parameter; optionally the full API response if requested

If 'Return' parameter is set to 'total', the output will be a number representing total items instead of item details. Pagination parameters govern the subset of items retrieved unless 'Return All' is true. Errors returned by the API are propagated.

Examples

Example 1: Browse all trash items in channel 123 with default pagination

Authentication OAuth2, Channel 123, Return All true

Example 2: Get the total number of items in the trash for channel 456

Authentication API Key, Channel 456, Additional Query Parameter Return 'total'

Links

Discussion