list-folders

dci list-folders [flags]

Returns Cloud Analytics folders the current customer has access to. Folders are returned in id-ascending order.

CLI default view

dci list-folders presents a curated table by default:

• Columns: name, description, and parent folder (parentFolderId resolved to the folder name; blank for top-level folders).
• --output json and explicit -C/--fields selections return the raw fields documented below.

Flags

--max-results: (integer format:int64 default:50)

--page-token: (string)

Output

OK - The request succeeded.

By default dci renders the result as a table. Use --output json to get the full structure described below — see Output formats.

Field	Type	Description
pageToken	string	Page token, returned by a previous call, to request the next page of results.
rowCount	integer	Number of folders returned in this page.
folders	array of object
folders[].id	string	Folder ID.
folders[].name	string	Folder name.
folders[].description	string	Folder description.
folders[].parentFolderId	string	Identifier of the parent folder. Set to "root" if the folder is at the top level. Default: "root".

Raw JSON schema

{
  "type": "object",
  "properties": {
    "pageToken": {
      "type": "string",
      "description": "Page token, returned by a previous call, to request the next page of results."
    },
    "rowCount": {
      "type": "integer",
      "description": "Number of folders returned in this page."
    },
    "folders": {
      "type": "array",
      "items": {
        "type": "object",
        "description": "A Cloud Analytics folder.",
        "properties": {
          "id": {
            "type": "string",
            "description": "Folder ID."
          },
          "name": {
            "type": "string",
            "description": "Folder name."
          },
          "description": {
            "type": "string",
            "description": "Folder description."
          },
          "parentFolderId": {
            "type": "string",
            "description": "Identifier of the parent folder. Set to \"root\" if the folder is at the top level.",
            "default": "root",
            "example": "root"
          }
        }
      }
    }
  }
}

Errors

On failure, dci prints a single error message — with a hint when one is available — and exits with a typed code your scripts can branch on. See Errors and exit codes for the full contract.

HTTP status	Exit code	Error code	Meaning
400	30	VALIDATION_ERROR	The arguments or request body were rejected. Review the command's flags and payload.
401	10	AUTHENTICATION_FAILED	Not signed in, or the API token is invalid. Run dci login or check DCI_API_KEY.
403	11	PERMISSION_DENIED	The DoiT user or the active customer context does not have access.
500	40	API_SERVER_ERROR	The API failed to process the request. Retryable; contact DoiT support if it persists.

Aliases: listfolders