--- title: "Get Data Store Finding" method: POST path: "/data-store-finding/{id}/get-item" tags: ["Data Store Finding"] --- # Get Data Store Finding `POST /data-store-finding/{id}/get-item` ## Request - Base URL: `https://oneuptime.com/api` - URL: `https://oneuptime.com/api/data-store-finding/{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 Finding by ID ## Path parameters - `id` string, uuid, required ## Request body - object - `select` DataStoreFindingSelectSchema: Select schema for DataStoreFinding. Set fields to true to include them in the response. - `_id` boolean - `createdAt` boolean - `updatedAt` boolean - `deletedAt` boolean - `projectId` boolean - `dataStoreId` boolean - `findingKey` boolean - `dataTypeId` boolean - `dataTypeName` boolean - `dataCategory` boolean - `sensitivity` boolean - `location` boolean - `locationKind` boolean - `confidence` boolean - `matchCount` boolean - `valueCount` boolean - `matchPercent` boolean - `distinctValues` boolean - `testValueCount` boolean - `maskedSamples` boolean - `isFreeText` boolean - `isNameHinted` boolean - `isFoundByName` boolean - `isScrubbed` boolean - `isSuppressed` boolean - `suppressedReason` boolean - `isConfirmed` boolean - `isAiSuggested` boolean - `aiReason` boolean - `lastScanId` boolean - `firstSeenAt` boolean - `lastSeenAt` boolean ## Response `200` Successful response - object - `data` DataStoreFinding - `_id` string, uuid: ID of this object. 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 Finding], Update: [Project Owner, Project Admin, Security Admin, Security Member, Edit Data Store Finding] - `createdAt` object: Date and Time when the object was created. 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 Finding], Update: [Project Owner, Project Admin, Security Admin, Security Member, Edit Data Store Finding] - `updatedAt` object: Date and Time when the object was updated. 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 Finding], Update: [Project Owner, Project Admin, Security Admin, Security Member, Edit Data Store Finding] - `deletedAt` object: Date and Time when the object was deleted. 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 Finding], Update: [Project Owner, Project Admin, Security Admin, Security Member, Edit Data Store Finding] - `version` number: Object version - `projectId` string, uuid, required: ID of the project this finding belongs to. 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 Finding], Update: [No access - you don't have permission for this operation] - `dataStoreId` string, uuid, required: The store the finding is 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 Finding], Update: [No access - you don't have permission for this operation] - `findingKey` string, required: The data type and location, which identify the finding within its 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 Finding], Update: [No access - you don't have permission for this operation] - `dataTypeId` string, required: The data type found: a built-in id such as credit-card-number, or custom: and a custom type's 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 Finding], Update: [No access - you don't have permission for this operation] - `dataTypeName` string: The data type's name when it was 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 Finding], Update: [No access - you don't have permission for this operation] - `dataCategory` 'Contact and identity' | 'Government ID' | 'Financial' | 'Health' | 'Secrets and credentials' | 'Special category' | 'Business confidential': The data type's category. 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 Finding], Update: [No access - you don't have permission for this operation] - `sensitivity` 'Restricted' | 'Confidential' | 'Internal' | 'Public': The data type's sensitivity. 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 Finding], Update: [No access - you don't have permission for this operation] - `location` string, required: Where in the store it was found: a table and column, a field path, an object path pattern, or a telemetry attribute. 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 Finding], Update: [No access - you don't have permission for this operation] - `locationKind` string: What the location is: Column, Field, Object, Attribute, Body or Text. 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 Finding], Update: [No access - you don't have permission for this operation] - `confidence` 'High' | 'Medium' | 'Low', required: How sure the scan is: High, Medium or Low. 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 Finding], Update: [No access - you don't have permission for this operation] - `matchCount` number, required: How many sampled values matched. 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 Finding], Update: [No access - you don't have permission for this operation] - `valueCount` number, required: How many values were sampled at the location. 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 Finding], Update: [No access - you don't have permission for this operation] - `matchPercent` number, required: The share of sampled values that matched, 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 Finding], Update: [No access - you don't have permission for this operation] - `distinctValues` number, required: How many different values matched, estimated from hashes that never leave the scan. 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 Finding], Update: [No access - you don't have permission for this operation] - `testValueCount` number, required: How many matches were well-known test values, which are never findings. 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 Finding], Update: [No access - you don't have permission for this operation] - `maskedSamples` object: At most three masked samples, such as j***@e******.com. Never a raw value. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Security Admin, Security Member, Read Data Store Finding], Update: [No access - you don't have permission for this operation] - `isFreeText` boolean, required: The location holds free text, so the finding is about values inside it rather than the whole field. 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 Finding], Update: [No access - you don't have permission for this operation] - `isNameHinted` boolean, required: The location's name hints at the data type. 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 Finding], Update: [No access - you don't have permission for this operation] - `isFoundByName` boolean, required: Found from the location's name alone, for a data type no value pattern can confirm. 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 Finding], Update: [No access - you don't have permission for this operation] - `isScrubbed` boolean, required: For telemetry: a scrub rule already masks this data at ingest. 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 Finding], Update: [No access - you don't have permission for this operation] - `isSuppressed` boolean, required: A person marked the finding as not sensitive. It no longer counts toward the store's sensitivity or checks. 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 Finding], Update: [Project Owner, Project Admin, Security Admin, Security Member, Edit Data Store Finding] - `suppressedReason` string: Why the finding was marked not sensitive. 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 Finding], Update: [Project Owner, Project Admin, Security Admin, Security Member, Edit Data Store Finding] - `isConfirmed` boolean, required: A person confirmed the finding holds this data. A confirmed finding counts as High confidence toward the store's sensitivity and checks, whatever the scan or OneUptime AI was sure of. 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 Finding], Update: [Project Owner, Project Admin, Security Admin, Security Member, Edit Data Store Finding] - `isAiSuggested` boolean, required: OneUptime AI suggested this data type for a field no detector placed, from the field's name, the names beside it and the shapes of its values - never a value. It counts only once a person confirms 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 Finding], Update: [No access - you don't have permission for this operation] - `aiReason` string: OneUptime AI's reason for its suggestion, in a sentence. 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 Finding], Update: [No access - you don't have permission for this operation] - `lastScanId` string, uuid: The scan that last saw the finding. 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 Finding], Update: [No access - you don't have permission for this operation] - `firstSeenAt` object: When a scan first found 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 Finding], Update: [No access - you don't have permission for this operation] - `lastSeenAt` object: When a scan last found 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 Finding], 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)