Infomaniak Kdrive icon

Infomaniak Kdrive

Interact with Infomaniak Kdrive API

Actions178

Others → Accessibles Drives

AI-generated

Summary

Retrieve a list of drives accessible to the account in the Infomaniak Kdrive service.

Inputs

  • authentication (required) — Authentication method to use for the API request. Options: OAuth2 or API Key. Default: OAuth2.
  • query_account_id (required) — Account identifier. Default: 0 (current account). Must be provided.
  • queryParameters — Additional query parameters for filtering, tagging, maintenance status, and pagination. Default: empty object.
  • query_with — Optional: Allows loading additional data about a resource, which may include related resources. Type: string. Default: empty string.
  • query_in_maintenance — Filter items in maintenance status. Type: boolean. Default: false.
  • query_maintenance_reasons — Filter items by maintenance reasons. Type: JSON. Default: empty object.
  • query_tags — Filter items by tags. Type: JSON. Default: empty object.
  • query_page — Optional parameter that defines the page number. Part of the pagination capacity. Type: number. Default: 0.
  • query_per_page — Optional parameter that defines the number of items per page. Part of the pagination capacity. Type: number. Default: 0.
  • query_total — If true, return the total number of items and total pages in the response. Equivalent to using the ?with=total parameter. Type: boolean. Default: false.
  • returnAll — When true, retrieve all items available from the query. When false, the limit parameter controls the number of items returned. Type: boolean. Default: true.
  • limit — Maximum number of items to return. Part of the pagination capacity. Applied when returnAll is false. Type: number. Default: 50. Min: 1, Max: 500.
  • returnFullResponse — If true, return the full API response without item transformation. Type: boolean. Default: false.

Output shape

A list of drive objects representing accessible drives. The shape and count of items depend on returnAll, limit, and queryParameters settings.

When returnAll is true, pagination parameters (query_page, query_per_page) affect how items are fetched but all items are ultimately returned. When query_total is true, the response includes pages and total fields.

Examples

Example 1: List all accessible drives for the current account using OAuth2 authentication.

authentication: OAuth2; query_account_id: 0 (current account); returnAll: true; all other query parameters omitted.

Links

Discussion