Data Store
Create Data Store
Endpoint to create a new Data Store
post/data-store
Request
- Base URLhttps://oneuptime.com/api
- AuthAPI key in header APIKey
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Request body
Example request
{
"data": {
"projectId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
"name": "This is an example of longer text content that provides detailed information.",
"kind": "Example Text"
}
}Response
Created successfully
Example response
{
"data": {
"_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
"createdAt": {
"_type": "DateTime",
"value": "2023-10-01T12:00:00Z"
},
"updatedAt": {
"_type": "DateTime",
"value": "2023-10-01T12:00:00Z"
},
"deletedAt": {
"_type": "DateTime",
"value": "2023-10-01T12:00:00Z"
},
"project": {
"_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
},
"projectId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
"name": "This is an example of longer text content that provides detailed information.",
"description": "This is an example of longer text content that provides detailed information.",
"storeKey": "This is an example of longer text content that provides detailed information.",
"kind": "Example Text",
"provider": "Example Text",
"family": "Example Text",
"discoveredFrom": "Example Text",
"cloudAccount": {
"_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
},
"cloudAccountId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
"cloudResource": {
"_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
},
"cloudResourceId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
"cloudConnection": {
"_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
},
"cloudConnectionId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
"databaseServer": {
"_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
},
"databaseServerId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
"service": {
"_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
},
"serviceId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
"providerResourceId": "This is an example of longer text content that provides detailed information.",
"cloudAccountNumber": "Example Text",
"region": "Example Text",
"environment": "Example Text",
"sensitivity": "Example Text",
"sensitivityOverride": "Example Text",
"dataTypeIds": {
"key": "value",
"nested": {
"data": 123
}
},
"dataCategories": {
"key": "value",
"nested": {
"data": 123
}
},
"subjectCountries": {
"key": "value",
"nested": {
"data": 123
}
},
"exposure": "Example Text",
"posture": {
"key": "value",
"nested": {
"data": 123
}
},
"cloudTags": {
"key": "value",
"nested": {
"data": 123
}
},
"sizeInBytes": 42,
"objectCount": 42,
"estimatedRecords": 42,
"lastActivityAt": {
"_type": "DateTime",
"value": "2023-10-01T12:00:00Z"
},
"isPublicByDesign": true,
"isAiData": true,
"isContentScanEnabled": true,
"scanProbe": {
"_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
},
"scanProbeId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
"probeConnectionVariable": "Example Text",
"scanExclusions": {
"key": "value",
"nested": {
"data": 123
}
},
"watchedPaths": "This is an example of longer text content that provides detailed information.",
"purpose": "This is an example of longer text content that provides detailed information.",
"retention": "Example Text",
"configurationReadAt": {
"_type": "DateTime",
"value": "2023-10-01T12:00:00Z"
},
"contentScannedAt": {
"_type": "DateTime",
"value": "2023-10-01T12:00:00Z"
},
"contentScanStatus": "Example Text",
"nextContentScanAt": {
"_type": "DateTime",
"value": "2023-10-01T12:00:00Z"
},
"isTableHealthEnabled": true,
"tableHealthCollectedAt": {
"_type": "DateTime",
"value": "2023-10-01T12:00:00Z"
},
"tableHealthStatus": "Example Text",
"tableHealthMessage": "This is an example of longer text content that provides detailed information.",
"tableHealthAssetCount": 42,
"newPersonalDataColumns": {
"key": "value",
"nested": {
"data": 123
}
},
"findingCount": 42,
"openIssueCount": 42,
"highestIssueSeverity": "Example Text",
"riskScore": 42,
"isArchived": true,
"firstSeenAt": {
"_type": "DateTime",
"value": "2023-10-01T12:00:00Z"
},
"lastSeenAt": {
"_type": "DateTime",
"value": "2023-10-01T12:00:00Z"
},
"labels": [
{
"_id": "cccccccc-cccc-cccc-cccc-cccccccccccc"
},
{
"_id": "dddddddd-dddd-dddd-dddd-dddddddddddd"
}
],
"createdByUser": {
"_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
},
"createdByUserId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
"deletedByUser": {
"_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
},
"deletedByUserId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
}
}Changes
No recorded changes to this operation across all 1 revision of this API.