--- title: "Create Data Observability Setting" method: POST path: "/data-observability-setting" tags: ["Data Observability Setting"] --- # Create Data Observability Setting `POST /data-observability-setting` ## Request - Base URL: `https://oneuptime.com/api` - URL: `https://oneuptime.com/api/data-observability-setting` - Auth: API key in header `APIKey` - TypeScript: (a function with typed inputs; its response is checked against the schema) Endpoint to create a new Data Observability Setting ## Request body - object - `data` DataObservabilitySettingCreateSchema, required: Create schema for DataObservabilitySetting model. Create - `projectId` string, uuid: ID of the project these settings belong to. Permissions - Create: [Project Owner, Project Admin, Telemetry Admin, Edit Data Asset], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Data Asset], Update: [No access - you don't have permission for this operation] - `maxGigabytesScannedPerCheck` number: BigQuery and Athena bill by bytes read. A check that would read more is stopped, and says so. Permissions - Create: [Project Owner, Project Admin, Telemetry Admin, Edit Data Asset], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Data Asset], Update: [Project Owner, Project Admin, Telemetry Admin, Edit Data Asset] - `waitWhenDatabaseIsBusy` boolean: Checks wait for the next collection when a database is close to its connection limit or has many statements running. Permissions - Create: [Project Owner, Project Admin, Telemetry Admin, Edit Data Asset], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Data Asset], Update: [Project Owner, Project Admin, Telemetry Admin, Edit Data Asset] - `keepFailingRows` boolean: A failing check keeps up to 20 of the rows that broke it, with sensitive columns masked. They are stored in OneUptime. Turning this off deletes them. Permissions - Create: [Project Owner, Project Admin, Telemetry Admin, Edit Data Asset], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Data Asset], Update: [Project Owner, Project Admin, Telemetry Admin, Edit Data Asset] ## Response `201` Created successfully - object - `data` DataObservabilitySettingReadSchema: Read schema for DataObservabilitySetting model. Read - `_id` string, uuid: ID of this object. Permissions - Create: [Project Owner, Project Admin, Telemetry Admin, Edit Data Asset], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Data Asset], Update: [Project Owner, Project Admin, Telemetry Admin, Edit Data Asset] - `createdAt` object: Date and Time when the object was created. Permissions - Create: [Project Owner, Project Admin, Telemetry Admin, Edit Data Asset], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Data Asset], Update: [Project Owner, Project Admin, Telemetry Admin, Edit Data Asset] - `updatedAt` object: Date and Time when the object was updated. Permissions - Create: [Project Owner, Project Admin, Telemetry Admin, Edit Data Asset], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Data Asset], Update: [Project Owner, Project Admin, Telemetry Admin, Edit Data Asset] - `deletedAt` object: Date and Time when the object was deleted. Permissions - Create: [Project Owner, Project Admin, Telemetry Admin, Edit Data Asset], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Data Asset], Update: [Project Owner, Project Admin, Telemetry Admin, Edit Data Asset] - `projectId` string, uuid: ID of the project these settings belong to. Permissions - Create: [Project Owner, Project Admin, Telemetry Admin, Edit Data Asset], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Data Asset], Update: [No access - you don't have permission for this operation] - `maxGigabytesScannedPerCheck` number: BigQuery and Athena bill by bytes read. A check that would read more is stopped, and says so. Permissions - Create: [Project Owner, Project Admin, Telemetry Admin, Edit Data Asset], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Data Asset], Update: [Project Owner, Project Admin, Telemetry Admin, Edit Data Asset] - `waitWhenDatabaseIsBusy` boolean: Checks wait for the next collection when a database is close to its connection limit or has many statements running. Permissions - Create: [Project Owner, Project Admin, Telemetry Admin, Edit Data Asset], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Data Asset], Update: [Project Owner, Project Admin, Telemetry Admin, Edit Data Asset] - `keepFailingRows` boolean: A failing check keeps up to 20 of the rows that broke it, with sensitive columns masked. They are stored in OneUptime. Turning this off deletes them. Permissions - Create: [Project Owner, Project Admin, Telemetry Admin, Edit Data Asset], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Data Asset], Update: [Project Owner, Project Admin, Telemetry Admin, Edit Data Asset] ## 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. - `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)