Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.blinkops.com/llms.txt

Use this file to discover all available pages before exploring further.

Retrieve all supported objects for a specific datastore, including unclassified objects. Required Permissions:
  • cyera.read.datastore
  • cyera.read.classification
External DocumentationTo learn more, visit the Cyera documentation.

​
Parameters

ParameterDescription
Datastore UIDThe UID of a scanned datastore to retrieve objects for.
File NameFilter objects by matching text within the fileName or relativePath properties.
LimitThe maximum number of objects to retrieve in the result. Valid range is 1-500.
OffsetThe pagination offset indicating the starting point for the next set of results.
Return All PagesAutomatically fetch all resources, page by page.
Return File SignaturesSelect to include file signature information in the response.

​
Example Output

{
	"limit": 10,
	"offset": 0,
	"results": [
		{
			"classifications": [
				{
					"classificationGroup": "Data Category",
					"classificationLevel": "Classification Level",
					"classificationName": "Client Full Name, Brazil",
					"collections": [
						"Learned",
						"File"
					],
					"context": {
						"businessContext": [
							{
								"key": "string",
								"value": "string"
							}
						],
						"dataSubjectAge": "13-15",
						"geoLocations": [
							"EU",
							"California",
							"Brazil"
						],
						"identifiability": "Indicates whether the data class can uniquely identify individuals.",
						"identified": false,
						"role": "Customer",
						"synthetic": false,
						"tokenization": "Tokenization"
					},
					"customCollections": [
						"Custom 1",
						"Custom 2"
					],
					"dataCategory": "Data Category",
					"dataClassName": "Full Name",
					"defaultSensitivity": "Default Sensitivity",
					"defaultSensitivityDisplayName": "Top Secret",
					"frameworks": [
						"GDPR - Personal",
						"Reportable Data Breach"
					],
					"learned": false,
					"name": "Full Name",
					"recordsCount": 74928899,
					"sensitivity": "Sensitivity",
					"sensitivityDisplayName": "Top Secret",
					"uid": "d0d033c7-5cca-48d2-a270-f6848443f4a6"
				}
			],
			"creationDate": "2022-11-05T12:51:08.000Z",
			"dbName": "Company_Data_Warehouse",
			"name": "Servicing.DataWarehouse_History",
			"rowCount": 12467730,
			"schemaName": "db_schema",
			"sensitiveRecordsCount": 163661377,
			"sensitivity": "VerySensitive",
			"sensitivityDisplayName": "Top Secret",
			"tableLevelClassifications": [
				{
					"classificationGroup": "Data Category",
					"classificationLevel": "Classification Level",
					"classificationName": "Client Full Name, Brazil",
					"collections": [
						"Learned",
						"File"
					],
					"context": {
						"businessContext": [
							{
								"key": "string",
								"value": "string"
							}
						],
						"dataSubjectAge": "13-15",
						"geoLocations": [
							"EU",
							"California",
							"Brazil"
						],
						"identifiability": "Indicates whether the data class can uniquely identify individuals.",
						"identified": false,
						"role": "Customer",
						"synthetic": false,
						"tokenization": "Tokenization"
					},
					"customCollections": [
						"Custom 1",
						"Custom 2"
					],
					"dataCategory": "Data Category",
					"dataClassName": "Full Name",
					"defaultSensitivity": "Default Sensitivity",
					"defaultSensitivityDisplayName": "Top Secret",
					"frameworks": [
						"GDPR - Personal",
						"Reportable Data Breach"
					],
					"learned": false,
					"name": "Full Name",
					"sensitivity": "Sensitivity",
					"sensitivityDisplayName": "Top Secret",
					"uid": "d0d033c7-5cca-48d2-a270-f6848443f4a6"
				}
			],
			"uid": "43cc6fc7-96ea-4f50-837b-5v8b0ecbl593"
		}
	],
	"total": 1,
	"type": "TABLES"
}

​
Workflow Library Example

List Datastore Objects with Cyera and Send Results Via Email
Workflow LibraryPreview this Workflow on desktop