---
title: "Get Residency Rule"
method: POST
path: "/data-security-residency-rule/{id}/get-item"
tags: ["Residency Rule"]
---

# Get Residency Rule

`POST /data-security-residency-rule/{id}/get-item`

## Request

- Base URL: `https://oneuptime.com/api`
- URL: `https://oneuptime.com/api/data-security-residency-rule/{id}/get-item`
- Auth: API key in header `APIKey`
- TypeScript: <https://skmtc.dev/oneuptime/apis/oneuptime-openapi-specification/docs/data-security-residency-rule/:id/get-item/post.ts> (a function with typed inputs; its response is checked against the schema)

Endpoint to retrieve a single Residency Rule by ID

## Path parameters

- `id` string, uuid, required

## Request body

- object
  - `select` DataSecurityResidencyRuleSelectSchema: Select schema for DataSecurityResidencyRule. Set fields to true to include them in the response.
    - `_id` boolean
    - `createdAt` boolean
    - `updatedAt` boolean
    - `deletedAt` boolean
    - `projectId` boolean
    - `name` boolean
    - `description` boolean
    - `dataCategories` boolean
    - `subjectCountries` boolean
    - `allowedRegions` boolean
    - `isEnabled` boolean
    - `createdByUserId` boolean
    - `deletedByUserId` boolean

## Response `200`

Successful response

- object
  - `data` DataSecurityResidencyRule
    - `_id` string, uuid: ID of this object. Permissions - Create: [Project Owner, Project Admin, Security Admin, Security Member, Create Residency Rule], Read: [Project Owner, Project Admin, Security Admin, Security Member, Security Viewer, Read Residency Rule], Update: [Project Owner, Project Admin, Security Admin, Security Member, Edit Residency Rule]
    - `createdAt` object: Date and Time when the object was created. Permissions - Create: [Project Owner, Project Admin, Security Admin, Security Member, Create Residency Rule], Read: [Project Owner, Project Admin, Security Admin, Security Member, Security Viewer, Read Residency Rule], Update: [Project Owner, Project Admin, Security Admin, Security Member, Edit Residency Rule]
    - `updatedAt` object: Date and Time when the object was updated. Permissions - Create: [Project Owner, Project Admin, Security Admin, Security Member, Create Residency Rule], Read: [Project Owner, Project Admin, Security Admin, Security Member, Security Viewer, Read Residency Rule], Update: [Project Owner, Project Admin, Security Admin, Security Member, Edit Residency Rule]
    - `deletedAt` object: Date and Time when the object was deleted. Permissions - Create: [Project Owner, Project Admin, Security Admin, Security Member, Create Residency Rule], Read: [Project Owner, Project Admin, Security Admin, Security Member, Security Viewer, Read Residency Rule], Update: [Project Owner, Project Admin, Security Admin, Security Member, Edit Residency Rule]
    - `version` number: Object version
    - `projectId` string, uuid, required: ID of the project this residency rule belongs to. Permissions - Create: [Project Owner, Project Admin, Security Admin, Security Member, Create Residency Rule], Read: [Project Owner, Project Admin, Security Admin, Security Member, Security Viewer, Read Residency Rule], Update: [No access - you don't have permission for this operation]
    - `name` string, required: The rule's name, such as EU personal data stays in the EU. Permissions - Create: [Project Owner, Project Admin, Security Admin, Security Member, Create Residency Rule], Read: [Project Owner, Project Admin, Security Admin, Security Member, Security Viewer, Read Residency Rule], Update: [Project Owner, Project Admin, Security Admin, Security Member, Edit Residency Rule]
    - `description` string: What the rule is for. Permissions - Create: [Project Owner, Project Admin, Security Admin, Security Member, Create Residency Rule], Read: [Project Owner, Project Admin, Security Admin, Security Member, Security Viewer, Read Residency Rule], Update: [Project Owner, Project Admin, Security Admin, Security Member, Edit Residency Rule]
    - `dataCategories` object: The categories of data the rule covers. Empty means every kind of personal data. Permissions - Create: [Project Owner, Project Admin, Security Admin, Security Member, Create Residency Rule], Read: [Project Owner, Project Admin, Security Admin, Security Member, Security Viewer, Read Residency Rule], Update: [Project Owner, Project Admin, Security Admin, Security Member, Edit Residency Rule]
    - `subjectCountries` object: Only data about people in these countries (ISO 3166-1 alpha-2). Empty means data about anyone. Permissions - Create: [Project Owner, Project Admin, Security Admin, Security Member, Create Residency Rule], Read: [Project Owner, Project Admin, Security Admin, Security Member, Security Viewer, Read Residency Rule], Update: [Project Owner, Project Admin, Security Admin, Security Member, Edit Residency Rule]
    - `allowedRegions` object: The regions the data may live in. A * matches any characters: eu-*, europe-*, westeurope. Permissions - Create: [Project Owner, Project Admin, Security Admin, Security Member, Create Residency Rule], Read: [Project Owner, Project Admin, Security Admin, Security Member, Security Viewer, Read Residency Rule], Update: [Project Owner, Project Admin, Security Admin, Security Member, Edit Residency Rule]
    - `isEnabled` boolean, required: Whether the rule is checked. Permissions - Create: [Project Owner, Project Admin, Security Admin, Security Member, Create Residency Rule], Read: [Project Owner, Project Admin, Security Admin, Security Member, Security Viewer, Read Residency Rule], Update: [Project Owner, Project Admin, Security Admin, Security Member, Edit Residency Rule]
    - `createdByUserId` string, uuid: ID of the user who created this residency rule. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Security Admin, Security Member, Security Viewer, Read Residency Rule], Update: [No access - you don't have permission for this operation]
    - `deletedByUserId` string, uuid: ID of the user who deleted this residency rule. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Security Admin, Security Member, Security Viewer, Read Residency Rule], 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)