Skip to main content

get-folder 

dci get-folder <id>

Returns the specified Cloud Analytics folder.

  • id — Folder ID as shown by dci list-folders.

Examples​

# Show one folder.
dci get-folder <folder-id>
# The full record as JSON, for scripts (`parentFolderId` is `root` for a top-level folder).
dci get-folder <folder-id> --output json

Output​

OK - Folder returned.

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

FieldTypeDescription
idstringFolder ID.
namestringFolder name.
descriptionstringFolder description.
parentFolderIdstringIdentifier of the parent folder. Set to "root" if the folder is at the top level. Default: "root".
Raw JSON schema
{
  "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 to exit code mapping
HTTP statusExit codeError codeMeaning
40110AUTHENTICATION_FAILEDNot signed in, or the API token is invalid. Run dci login or check DCI_API_KEY.
40311PERMISSION_DENIEDThe DoiT user or the active customer context does not have access.
40420RESOURCE_NOT_FOUNDThe requested resource does not exist. Check the identifier argument.
50040API_SERVER_ERRORThe API failed to process the request. Retryable; contact DoiT support if it persists.

Aliases: getfolder