---
title: "Get Network Device Link Rule"
method: POST
path: "/network-device-link-rule/{id}/get-item"
tags: ["Network Device Link Rule"]
---

# Get Network Device Link Rule

`POST /network-device-link-rule/{id}/get-item`

## Request

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

Endpoint to retrieve a single Network Device Link Rule by ID

## Path parameters

- `id` string, uuid, required

## Request body

- object
  - `select` NetworkDeviceLinkRuleSelectSchema: Select schema for NetworkDeviceLinkRule. Set fields to true to include them in the response.
    - `_id` boolean
    - `createdAt` boolean
    - `updatedAt` boolean
    - `deletedAt` boolean
    - `projectId` boolean
    - `name` boolean
    - `description` boolean
    - `isEnabled` boolean
    - `childDeviceLabels` LabelRelationSelectSchema: What a select may name of the Label records a relation holds: set a field to true to include it.
      - `_id` boolean
      - `createdAt` boolean
      - `updatedAt` boolean
      - `deletedAt` boolean
      - `name` boolean
      - `projectId` boolean
      - `color` boolean
      - `isArchived` boolean
    - `parentDeviceLabels` LabelRelationSelectSchema: What a select may name of the Label records a relation holds: set a field to true to include it.
      - `_id` boolean
      - `createdAt` boolean
      - `updatedAt` boolean
      - `deletedAt` boolean
      - `name` boolean
      - `projectId` boolean
      - `color` boolean
      - `isArchived` boolean
    - `scope` boolean
    - `createdByUserId` boolean
    - `deletedByUserId` boolean

## Response `200`

Successful response

- object
  - `data` NetworkDeviceLinkRule
    - `_id` string, uuid: ID of this object. Permissions - Create: [Project Owner, Project Admin, Create Network Device Link Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Read Network Device Link Rule], Update: [Project Owner, Project Admin, Edit Network Device Link Rule]
    - `createdAt` object: Date and Time when the object was created. Permissions - Create: [Project Owner, Project Admin, Create Network Device Link Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Read Network Device Link Rule], Update: [Project Owner, Project Admin, Edit Network Device Link Rule]
    - `updatedAt` object: Date and Time when the object was updated. Permissions - Create: [Project Owner, Project Admin, Create Network Device Link Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Read Network Device Link Rule], Update: [Project Owner, Project Admin, Edit Network Device Link Rule]
    - `deletedAt` object: Date and Time when the object was deleted. Permissions - Create: [Project Owner, Project Admin, Create Network Device Link Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Read Network Device Link Rule], Update: [Project Owner, Project Admin, Edit Network Device Link Rule]
    - `version` number: Object version
    - `projectId` string, uuid, required: ID of your OneUptime Project in which this object belongs. Permissions - Create: [Project Owner, Project Admin, Create Network Device Link Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Read Network Device Link Rule], Update: [No access - you don't have permission for this operation]
    - `name` string, required: Friendly name for this rule. Permissions - Create: [Project Owner, Project Admin, Create Network Device Link Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Read Network Device Link Rule], Update: [Project Owner, Project Admin, Edit Network Device Link Rule]
    - `description` string: Description of this rule. Permissions - Create: [Project Owner, Project Admin, Create Network Device Link Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Read Network Device Link Rule], Update: [Project Owner, Project Admin, Edit Network Device Link Rule]
    - `isEnabled` boolean, required: Whether this rule draws links. Disable to take its edges off the map without deleting the rule. Permissions - Create: [Project Owner, Project Admin, Create Network Device Link Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Read Network Device Link Rule], Update: [Project Owner, Project Admin, Edit Network Device Link Rule]
    - `childDeviceLabels` object[], required: Devices carrying ALL of these labels each get one uplink drawn to the parent device. Empty matches nothing — a rule that linked every device in the project is never what anyone meant. Permissions - Create: [Project Owner, Project Admin, Create Network Device Link Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Read Network Device Link Rule], Update: [Project Owner, Project Admin, Edit Network Device Link Rule]
      - `_id` string, uuid: Unique identifier for the entity
    - `parentDeviceLabels` object[], required: The device carrying ALL of these labels is what the children uplink to. It has to identify exactly one device: match none and the rule draws nothing, match several and the rule is ambiguous and also draws nothing. Permissions - Create: [Project Owner, Project Admin, Create Network Device Link Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Read Network Device Link Rule], Update: [Project Owner, Project Admin, Edit Network Device Link Rule]
      - `_id` string, uuid: Unique identifier for the entity
    - `scope` string: How wide the 'exactly one parent device' question is asked. Project (the default) looks for one parent across the whole project. Site asks once per site, so the same rule can draw an uplink in every building. Rules created before this existed are Project. Permissions - Create: [Project Owner, Project Admin, Create Network Device Link Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Read Network Device Link Rule], Update: [Project Owner, Project Admin, Edit Network Device Link Rule]
    - `createdByUserId` string, uuid: User ID who created this object (if this object was created by a User). Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Read Network Device Link Rule], Update: [No access - you don't have permission for this operation]
    - `deletedByUserId` string, uuid: User ID who deleted this object (if this object was deleted by a User). Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Read Network Device Link 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)