--- title: "Get Data Store" method: POST path: "/data-store/{id}/get-item" tags: ["Data Store"] --- # Get Data Store `POST /data-store/{id}/get-item` ## Request - Base URL: `https://oneuptime.com/api` - URL: `https://oneuptime.com/api/data-store/{id}/get-item` - Auth: API key in header `APIKey` - TypeScript: (a function with typed inputs; its response is checked against the schema) Endpoint to retrieve a single Data Store by ID ## Path parameters - `id` string, uuid, required ## Request body - object - `select` DataStoreSelectSchema: Select schema for DataStore. Set fields to true to include them in the response. - `_id` boolean - `createdAt` boolean - `updatedAt` boolean - `deletedAt` boolean - `projectId` boolean - `name` boolean - `description` boolean - `storeKey` boolean - `kind` boolean - `provider` boolean - `family` boolean - `discoveredFrom` boolean - `cloudAccountId` boolean - `cloudResourceId` boolean - `cloudConnectionId` boolean - `databaseServerId` boolean - `serviceId` boolean - `providerResourceId` boolean - `cloudAccountNumber` boolean - `region` boolean - `environment` boolean - `sensitivity` boolean - `sensitivityOverride` boolean - `dataTypeIds` boolean - `dataCategories` boolean - `subjectCountries` boolean - `exposure` boolean - `posture` boolean - `cloudTags` boolean - `sizeInBytes` boolean - `objectCount` boolean - `estimatedRecords` boolean - `lastActivityAt` boolean - `isPublicByDesign` boolean - `isAiData` boolean - `isContentScanEnabled` boolean - `scanProbeId` boolean - `probeConnectionVariable` boolean - `scanExclusions` boolean - `watchedPaths` boolean - `purpose` boolean - `retention` boolean - `configurationReadAt` boolean - `contentScannedAt` boolean - `contentScanStatus` boolean - `nextContentScanAt` boolean - `isTableHealthEnabled` boolean - `tableHealthCollectedAt` boolean - `tableHealthStatus` boolean - `tableHealthMessage` boolean - `tableHealthAssetCount` boolean - `newPersonalDataColumns` boolean - `findingCount` boolean - `openIssueCount` boolean - `highestIssueSeverity` boolean - `riskScore` boolean - `isArchived` boolean - `firstSeenAt` boolean - `lastSeenAt` boolean - `labels` LabelRelationSelectSchema: What a select may name of the Label records a relation holds: set a field to true to include it. - `_id` boolean - `createdAt` boolean - `updatedAt` boolean - `deletedAt` boolean - `name` boolean - `projectId` boolean - `color` boolean - `isArchived` boolean - `createdByUserId` boolean - `deletedByUserId` boolean ## Response `200` Successful response - object - `data` DataStore - `_id` string, uuid: ID of this object. Permissions - Create: [Project Owner, Project Admin, Security Admin, Security Member, Create Data Store], Read: [Project Owner, Project Admin, Security Admin, Security Member, Security Viewer, Read Data Store], Update: [Project Owner, Project Admin, Security Admin, Security Member, Edit Data Store] - `createdAt` object: Date and Time when the object was created. Permissions - Create: [Project Owner, Project Admin, Security Admin, Security Member, Create Data Store], Read: [Project Owner, Project Admin, Security Admin, Security Member, Security Viewer, Read Data Store], Update: [Project Owner, Project Admin, Security Admin, Security Member, Edit Data Store] - `updatedAt` object: Date and Time when the object was updated. Permissions - Create: [Project Owner, Project Admin, Security Admin, Security Member, Create Data Store], Read: [Project Owner, Project Admin, Security Admin, Security Member, Security Viewer, Read Data Store], Update: [Project Owner, Project Admin, Security Admin, Security Member, Edit Data Store] - `deletedAt` object: Date and Time when the object was deleted. Permissions - Create: [Project Owner, Project Admin, Security Admin, Security Member, Create Data Store], Read: [Project Owner, Project Admin, Security Admin, Security Member, Security Viewer, Read Data Store], Update: [Project Owner, Project Admin, Security Admin, Security Member, Edit Data Store] - `version` number: Object version - `projectId` string, uuid, required: ID of the project this data store belongs to. Permissions - Create: [Project Owner, Project Admin, Security Admin, Security Member, Create Data Store], Read: [Project Owner, Project Admin, Security Admin, Security Member, Security Viewer, Read Data Store], Update: [No access - you don't have permission for this operation] - `name` string, required: The store's name: a bucket, database, dataset or service name. Permissions - Create: [Project Owner, Project Admin, Security Admin, Security Member, Create Data Store], Read: [Project Owner, Project Admin, Security Admin, Security Member, Security Viewer, Read Data Store], Update: [Project Owner, Project Admin, Security Admin, Security Member, Edit Data Store] - `description` string: What the store is for, in your team's words. Permissions - Create: [Project Owner, Project Admin, Security Admin, Security Member, Create Data Store], Read: [Project Owner, Project Admin, Security Admin, Security Member, Security Viewer, Read Data Store], Update: [Project Owner, Project Admin, Security Admin, Security Member, Edit Data Store] - `storeKey` string, required: What identifies the store within the project: its provider, kind and native id. One row per store, however often it is discovered. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Security Admin, Security Member, Security Viewer, Read Data Store], Update: [No access - you don't have permission for this operation] - `kind` 'AWS S3 Bucket' | 'AWS RDS Instance' | 'AWS Aurora Cluster' | 'AWS RDS Snapshot' | 'AWS DynamoDB Table' | 'AWS Redshift Cluster' | 'AWS DocumentDB Cluster' | 'AWS OpenSearch Domain' | 'AWS ElastiCache Cluster' | 'AWS EFS File System' | 'Azure Storage Account' | 'Azure SQL Database' | 'Azure Cosmos DB Account' | 'Azure PostgreSQL Server' | 'Azure MySQL Server' | 'Google Cloud Storage Bucket' | 'Google Cloud SQL Instance' | 'Google BigQuery Dataset' | 'Google Firestore Database' | 'Google Spanner Instance' | 'Google Bigtable Instance' | 'PostgreSQL' | 'MySQL' | 'MongoDB' | 'SQL Server' | 'Oracle' | 'Redis' | 'Elasticsearch' | 'Snowflake' | 'ClickHouse' | 'Databricks' | 'Amazon Athena' | 'Logs' | 'Traces' | 'Exceptions' | 'Session Replays' | 'AI Conversations', required: What kind of store it is: an S3 bucket, an RDS instance, a PostgreSQL database, a service's logs. Permissions - Create: [Project Owner, Project Admin, Security Admin, Security Member, Create Data Store], Read: [Project Owner, Project Admin, Security Admin, Security Member, Security Viewer, Read Data Store], Update: [No access - you don't have permission for this operation] - `provider` string: Where the store lives: aws, azure, gcp, self-managed or oneuptime. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Security Admin, Security Member, Security Viewer, Read Data Store], Update: [No access - you don't have permission for this operation] - `family` string: The store's family: object storage, database, warehouse, search, cache, file system, snapshot or telemetry. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Security Admin, Security Member, Security Viewer, Read Data Store], Update: [No access - you don't have permission for this operation] - `discoveredFrom` string: How OneUptime found the store: cloud inventory, the Database product, telemetry, the service map, or added by hand. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Security Admin, Security Member, Security Viewer, Read Data Store], Update: [No access - you don't have permission for this operation] - `cloudAccountId` string, uuid: The cloud account the store belongs to, for a cloud store. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Security Admin, Security Member, Security Viewer, Read Data Store], Update: [No access - you don't have permission for this operation] - `cloudResourceId` string, uuid: The cloud resource the store was discovered from, if any. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Security Admin, Security Member, Security Viewer, Read Data Store], Update: [No access - you don't have permission for this operation] - `cloudConnectionId` string, uuid: The cloud connection that reads the store's configuration, if any. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Security Admin, Security Member, Security Viewer, Read Data Store], Update: [No access - you don't have permission for this operation] - `databaseServerId` string, uuid: The Database product server the store is, for a self-managed database. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Security Admin, Security Member, Security Viewer, Read Data Store], Update: [No access - you don't have permission for this operation] - `serviceId` string, uuid: The telemetry service whose logs, traces, exceptions, replays or AI conversations the store is. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Security Admin, Security Member, Security Viewer, Read Data Store], Update: [No access - you don't have permission for this operation] - `providerResourceId` string: The store's id in its cloud: an ARN, an Azure resource id or a Google Cloud resource name. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Security Admin, Security Member, Security Viewer, Read Data Store], Update: [No access - you don't have permission for this operation] - `cloudAccountNumber` string: The cloud's own id for the account: an AWS account id, an Azure subscription id or a Google Cloud project id. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Security Admin, Security Member, Security Viewer, Read Data Store], Update: [No access - you don't have permission for this operation] - `region` string: The region the store lives in. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Security Admin, Security Member, Security Viewer, Read Data Store], Update: [No access - you don't have permission for this operation] - `environment` 'Production' | 'Staging' | 'Development' | 'Test' | 'Unknown', required: Which environment the store serves: Production, Staging, Development, Test or Unknown. Read from its tags and name; people may set it. Permissions - Create: [Project Owner, Project Admin, Security Admin, Security Member, Create Data Store], Read: [Project Owner, Project Admin, Security Admin, Security Member, Security Viewer, Read Data Store], Update: [Project Owner, Project Admin, Security Admin, Security Member, Edit Data Store] - `sensitivity` 'Restricted' | 'Confidential' | 'Internal' | 'Public', required: How sensitive the store is: Restricted, Confidential, Internal or Public, from the most sensitive data type found in it. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Security Admin, Security Member, Security Viewer, Read Data Store], Update: [No access - you don't have permission for this operation] - `sensitivityOverride` 'Restricted' | 'Confidential' | 'Internal' | 'Public': A sensitivity people set by hand, which the store is treated as instead of what the scans found. Permissions - Create: [Project Owner, Project Admin, Security Admin, Security Member, Create Data Store], Read: [Project Owner, Project Admin, Security Admin, Security Member, Security Viewer, Read Data Store], Update: [Project Owner, Project Admin, Security Admin, Security Member, Edit Data Store] - `dataTypeIds` object: The data types found in the store with at least Medium confidence. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Security Admin, Security Member, Security Viewer, Read Data Store], Update: [No access - you don't have permission for this operation] - `dataCategories` object: The categories of those data types. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Security Admin, Security Member, Security Viewer, Read Data Store], Update: [No access - you don't have permission for this operation] - `subjectCountries` object: Countries whose people's data the store holds, from country-bound data types (ISO 3166-1 alpha-2). Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Security Admin, Security Member, Security Viewer, Read Data Store], Update: [No access - you don't have permission for this operation] - `exposure` 'Public' | 'Other accounts' | 'Internet reachable' | 'Private' | 'Unknown', required: Where the store sits relative to the internet and other organizations: Public, Other accounts, Internet reachable, Private or Unknown. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Security Admin, Security Member, Security Viewer, Read Data Store], Update: [No access - you don't have permission for this operation] - `posture` object: What the store's configuration says about its safety: public access, encryption, backups, logging and the rest. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Security Admin, Security Member, Security Viewer, Read Data Store], Update: [No access - you don't have permission for this operation] - `cloudTags` object: The store's tags or labels in its cloud. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Security Admin, Security Member, Security Viewer, Read Data Store], Update: [No access - you don't have permission for this operation] - `sizeInBytes` number: How much data the store holds, from the metrics already collected. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Security Admin, Security Member, Security Viewer, Read Data Store], Update: [No access - you don't have permission for this operation] - `objectCount` number: How many objects, rows or documents the store holds, when known. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Security Admin, Security Member, Security Viewer, Read Data Store], Update: [No access - you don't have permission for this operation] - `estimatedRecords` number: An estimate of how many records with sensitive data the store holds, from its samples. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Security Admin, Security Member, Security Viewer, Read Data Store], Update: [No access - you don't have permission for this operation] - `lastActivityAt` object: When the store was last read or written, when its metrics or traces say. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Security Admin, Security Member, Security Viewer, Read Data Store], Update: [No access - you don't have permission for this operation] - `isPublicByDesign` boolean, required: The store is meant to be public, such as a website's assets. Public access checks pass for it. Permissions - Create: [Project Owner, Project Admin, Security Admin, Security Member, Create Data Store], Read: [Project Owner, Project Admin, Security Admin, Security Member, Security Viewer, Read Data Store], Update: [Project Owner, Project Admin, Security Admin, Security Member, Edit Data Store] - `isAiData` boolean, required: The store holds data used to train or ground an AI model. Permissions - Create: [Project Owner, Project Admin, Security Admin, Security Member, Create Data Store], Read: [Project Owner, Project Admin, Security Admin, Security Member, Security Viewer, Read Data Store], Update: [Project Owner, Project Admin, Security Admin, Security Member, Edit Data Store] - `isContentScanEnabled` boolean, required: Whether Data Security samples the store's content. Configuration checks run either way. Permissions - Create: [Project Owner, Project Admin, Security Admin, Security Member, Create Data Store], Read: [Project Owner, Project Admin, Security Admin, Security Member, Security Viewer, Read Data Store], Update: [Project Owner, Project Admin, Security Admin, Security Member, Edit Data Store] - `scanProbeId` string, uuid: A probe that scans the store's content from inside your network instead of OneUptime's workers. Permissions - Create: [Project Owner, Project Admin, Security Admin, Security Member, Create Data Store], Read: [Project Owner, Project Admin, Security Admin, Security Member, Security Viewer, Read Data Store], Update: [Project Owner, Project Admin, Security Admin, Security Member, Edit Data Store] - `probeConnectionVariable` string: For a database scanned from a probe: the environment variable on that probe that holds its connection string. The connection string itself never reaches OneUptime. Permissions - Create: [Project Owner, Project Admin, Security Admin, Security Member, Create Data Store], Read: [Project Owner, Project Admin, Security Admin, Security Member, Security Viewer, Read Data Store], Update: [Project Owner, Project Admin, Security Admin, Security Member, Edit Data Store] - `scanExclusions` object: Path prefixes, tables or attribute keys the content scan skips. Permissions - Create: [Project Owner, Project Admin, Security Admin, Security Member, Create Data Store], Read: [Project Owner, Project Admin, Security Admin, Security Member, Security Viewer, Read Data Store], Update: [Project Owner, Project Admin, Security Admin, Security Member, Edit Data Store] - `watchedPaths` string: The paths of a bucket Data Observability watches like tables, one per line. Permissions - Create: [Project Owner, Project Admin, Security Admin, Security Member, Create Data Store], Read: [Project Owner, Project Admin, Security Admin, Security Member, Security Viewer, Read Data Store], Update: [Project Owner, Project Admin, Security Admin, Security Member, Edit Data Store] - `purpose` string: Why the store holds personal data, for the GDPR record of processing. Permissions - Create: [Project Owner, Project Admin, Security Admin, Security Member, Create Data Store], Read: [Project Owner, Project Admin, Security Admin, Security Member, Security Viewer, Read Data Store], Update: [Project Owner, Project Admin, Security Admin, Security Member, Edit Data Store] - `retention` string: How long data is kept in the store, for the GDPR record of processing. Permissions - Create: [Project Owner, Project Admin, Security Admin, Security Member, Create Data Store], Read: [Project Owner, Project Admin, Security Admin, Security Member, Security Viewer, Read Data Store], Update: [Project Owner, Project Admin, Security Admin, Security Member, Edit Data Store] - `configurationReadAt` object: When the store's configuration and access were last read. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Security Admin, Security Member, Security Viewer, Read Data Store], Update: [No access - you don't have permission for this operation] - `contentScannedAt` object: When the store's content was last sampled. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Security Admin, Security Member, Security Viewer, Read Data Store], Update: [No access - you don't have permission for this operation] - `contentScanStatus` string: How the last content scan ended, or why it could not run. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Security Admin, Security Member, Security Viewer, Read Data Store], Update: [No access - you don't have permission for this operation] - `nextContentScanAt` object: When the store's content is next sampled. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Security Admin, Security Member, Security Viewer, Read Data Store], Update: [No access - you don't have permission for this operation] - `isTableHealthEnabled` boolean, required: Data Observability collects the store's tables every few minutes: their columns, row counts, sizes and when they last changed. Only the catalog is read, never a row. Permissions - Create: [Project Owner, Project Admin, Security Admin, Security Member, Create Data Store], Read: [Project Owner, Project Admin, Security Admin, Security Member, Security Viewer, Read Data Store], Update: [Project Owner, Project Admin, Security Admin, Security Member, Edit Data Store] - `tableHealthCollectedAt` object: When Data Observability last collected the store's tables. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Security Admin, Security Member, Security Viewer, Read Data Store], Update: [No access - you don't have permission for this operation] - `tableHealthStatus` string: How the last collection of the store's tables ended: Collected, or Failed. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Security Admin, Security Member, Security Viewer, Read Data Store], Update: [No access - you don't have permission for this operation] - `tableHealthMessage` string: Why the last collection failed, or what it had to leave out. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Security Admin, Security Member, Security Viewer, Read Data Store], Update: [No access - you don't have permission for this operation] - `tableHealthAssetCount` number: How many tables and views the last collection found. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Security Admin, Security Member, Security Viewer, Read Data Store], Update: [No access - you don't have permission for this operation] - `newPersonalDataColumns` object: Columns added lately whose names say they hold personal data, as a collection saw them appear. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Security Admin, Security Member, Security Viewer, Read Data Store], Update: [No access - you don't have permission for this operation] - `findingCount` number, required: How many data types were found at how many locations. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Security Admin, Security Member, Security Viewer, Read Data Store], Update: [No access - you don't have permission for this operation] - `openIssueCount` number, required: How many of the store's issues are open. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Security Admin, Security Member, Security Viewer, Read Data Store], Update: [No access - you don't have permission for this operation] - `highestIssueSeverity` 'Critical' | 'High' | 'Medium' | 'Low': The severity of the store's worst open issue. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Security Admin, Security Member, Security Viewer, Read Data Store], Update: [No access - you don't have permission for this operation] - `riskScore` number, required: The risk score of the store's worst open issue, from 0 to 100. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Security Admin, Security Member, Security Viewer, Read Data Store], Update: [No access - you don't have permission for this operation] - `isArchived` boolean, required: The store is gone from its cloud or source; it is kept with its history. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Security Admin, Security Member, Security Viewer, Read Data Store], Update: [No access - you don't have permission for this operation] - `firstSeenAt` object: When OneUptime first found the store. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Security Admin, Security Member, Security Viewer, Read Data Store], Update: [No access - you don't have permission for this operation] - `lastSeenAt` object: When OneUptime last found the store. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Security Admin, Security Member, Security Viewer, Read Data Store], Update: [No access - you don't have permission for this operation] - `labels` object[]: Labels to group and filter by. Permissions - Create: [Project Owner, Project Admin, Security Admin, Security Member, Create Data Store], Read: [Project Owner, Project Admin, Security Admin, Security Member, Security Viewer, Read Data Store], Update: [Project Owner, Project Admin, Security Admin, Security Member, Edit Data Store] - `_id` string, uuid: Unique identifier for the entity - `createdByUserId` string, uuid: ID of the user who created this data store. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Security Admin, Security Member, Security Viewer, Read Data Store], Update: [No access - you don't have permission for this operation] - `deletedByUserId` string, uuid: ID of the user who deleted this data store. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Security Admin, Security Member, Security Viewer, Read Data Store], Update: [No access - you don't have permission for this operation] ## Other responses - `400`: Bad request. This response indicates that the request was malformed or contained invalid data. - `401`: Unauthorized. This response indicates that the request requires user authentication. - `402`: Payment Required. This response indicates that the request requires payment or a valid subscription. - `403`: Forbidden. This response indicates that the server understood the request, but refuses to authorize it. - `404`: Not found. The record does not exist, belongs to another project, or is one you may not read - the same answer for each. - `405`: Project not found. This response indicates that the requested project does not exist or is not accessible. - `408`: Request Timeout. This response indicates that the server timed out waiting for the request. - `415`: Unable to reach server. This response indicates that the server is currently unreachable or down. - `422`: Not authorized. This response indicates that the user does not have permission to access the requested resource. - `500`: Internal Server Error. This response indicates that the server encountered an unexpected condition that prevented it from fulfilling the request. --- [API](https://skmtc.dev/oneuptime/apis/oneuptime-openapi-specification.md) - [All operations](https://skmtc.dev/oneuptime/apis/oneuptime-openapi-specification/llms.txt) - [OpenAPI document](https://skmtc.dev/oneuptime/apis/oneuptime-openapi-specification/revisions/ba3307d00304?raw)