Residency Rule
Update Residency Rule
Endpoint to update an existing Residency Rule
put/data-security-residency-rule/{id}
Request
- Base URLhttps://oneuptime.com/api
- AuthAPI key in header APIKey
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
idstring uuid required
ID of the Residency Rule to update
Request body
Example request
{
"data": {
"name": "Example Text",
"allowedRegions": {
"key": "value",
"nested": {
"data": 123
}
},
"isEnabled": true
}
}Response
Updated 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": "Example Text",
"description": "This is an example of longer text content that provides detailed information.",
"dataCategories": {
"key": "value",
"nested": {
"data": 123
}
},
"subjectCountries": {
"key": "value",
"nested": {
"data": 123
}
},
"allowedRegions": {
"key": "value",
"nested": {
"data": 123
}
},
"isEnabled": true,
"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.