list-datahub-datasets

dci list-datahub-datasets

Returns a list of all DataHub datasets for the customer.

Output

OK - List of datasets returned successfully.

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
datasets	array of object
datasets[].name	string	The name of the dataset.
datasets[].description	string	The description of the dataset.
datasets[].records	integer (int64)	The number of records in the dataset.
datasets[].updatedBy	string	The email of the user who last updated the dataset.
datasets[].lastUpdated	string	The timestamp of the last update.

Raw JSON schema

{
  "type": "object",
  "properties": {
    "datasets": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "description": "The name of the dataset.",
            "example": "My Custom Dataset"
          },
          "description": {
            "type": "string",
            "description": "The description of the dataset.",
            "example": "Dataset for tracking custom business metrics"
          },
          "records": {
            "type": "integer",
            "format": "int64",
            "description": "The number of records in the dataset.",
            "example": 1500
          },
          "updatedBy": {
            "type": "string",
            "description": "The email of the user who last updated the dataset.",
            "example": "[email protected]"
          },
          "lastUpdated": {
            "type": "string",
            "description": "The timestamp of the last update.",
            "example": "2024-03-10T23:00:00Z"
          }
        }
      }
    }
  }
}

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
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: listdatahubdatasets