GET /datastore

Updated on 23 Jan 2024
1 Minute to read

Dark
Light

Article summary

Did you find this summary helpful?

Thank you for your feedback

GET /datastore

Description

Use this API to extract data context on any datastore. For RDS this will return the details of all the databases in the RDS instance.
#### Example

curl -i -X GET -G https://<api-gateway-url>/v1/datacatalog-backend/datastore \
  -H "x-api-key: <api-key>" \
  -H "Accept: application/json" \
  -d datastore_arn="arn:aws:rds:us-east-2:123456789012:db:my-mysql-instance-1"

Arguments

datastore_arn

REQUIRED
TYPE: String
Description: The unique resource identifier from AWS or Databricks

Response

application/json

[
  {
    "datastore_name":"...",
    "resource_type":"...",
    "sensitivity_level_priority":"...",
    "data_classes":"[...]",
    "highest_risk_score_criticality_label":"...",
    "highest_risk_score_criticality_label_datasets_count":"...",
    "access_activity_label":"...", // OPTIONAL: Low, Medium, High
  },
  {
    ...
  }
]

Response Field Descriptions

Response is an array of Datastores and their data context. For each datastore, following fields are provided:

Response Field	Description
datastoreName	Name of datastore e.g. S3 bucket name or database name in the RDS instance
resourceType	Datastore type. Values can be {S3-bucket, SQL-RDS-mysql, SQL-RDS-postgres, Databricks-catalog, ...}
sensitivityLevelPriority	Highest Sensitivity Level of the data present in the datastore. Values may be {P1-Restricted, P2-Confidential, P3-Internal, P4-Public} These values can be customized by the user in the Acante UI
dataClasses	Data Classes for the data present in the data store. Values may be {PCI, PII, GDPR, …} Customer can define custom data classes
highestRiskScoreCriticalityLabel	Highest risk level for any tables in the database. These are Acante-defined. Values can be {Extremely High, Elevated, Moderate, Low, Minimal}
highestRiskScoreCriticalityLabelDatasetsCount	Count of tables in the database at the above highest risk level
access_activity_label	Indicates access activity level (based on number of users, request count, data volume) for the datastore. “High” activity datastores are strong candidates for backup or similar data protection actions. Values can be {High, Medium, Low}