dataset_api
dataset_api
get_version
def get_version() -> str
Return dataset API version.
Returns:
The version inumber n a string
fetch_datasets
def fetch_datasets() -> Any
List all available datasets
Returns:
the list of manifests
fetch_dataset_by_uuid
def fetch_dataset_by_uuid(partial_dataset_id: str) -> Any
Get the full JSON manifest of a specific dataset
Arguments:
partial_dataset_id
: UUID of the dataset to fetch, or prefix of it that uniquely identifies the dataset If a full UUID is given, returns the identified dataset metadata if it exists. If a partial UUID (prefix of an existing UUID) is given, and this prefix uniquely identifies one and only one dataset, the latter's metadata is returned.
fetch_dataset_resource
def fetch_dataset_resource(partial_dataset_id: str, resource_type_str: str,
resource_id: UUID) -> Any
Get the description of a specific resource.
This function does not fetch the file(s) associated with one resource, it merely returns the portion of the JSON manifest that describes that particular resource. This JSON includes, in particular, the list of files included in the resource, and the URLs to download them. It is up to the user to manually fetch these URLs.
Arguments:
partial_dataset_id
: UUID of the dataset to which the resource belongs, or a prefix of it that uniquely identifies itresource_type_str
: type of the resource to fetch. Must be a string among "log", "pcap", "memory_dump", "redteam_report", "life_report"resource_id
: UUID of the resource
Returns:
JSON structure describing the resource
get_archive_infos_for_dataset
def get_archive_infos_for_dataset(partial_dataset_id: str) -> Any
Retrieve information about a zip archive for a partial_dataset_id.
Arguments:
partial_dataset_id
: the partial or complete UUID of the dataset
Returns:
a JSON structure containing size, url and if the archive exists.