---
title: "Get Network Endpoint"
method: POST
path: "/network-endpoint/{id}/get-item"
tags: ["Network Endpoint"]
---

# Get Network Endpoint

`POST /network-endpoint/{id}/get-item`

## Request

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

Endpoint to retrieve a single Network Endpoint by ID

## Path parameters

- `id` string, uuid, required

## Request body

- object
  - `select` NetworkEndpointSelectSchema: Select schema for NetworkEndpoint. Set fields to true to include them in the response.
    - `_id` boolean
    - `createdAt` boolean
    - `updatedAt` boolean
    - `deletedAt` boolean
    - `projectId` boolean
    - `macAddress` boolean
    - `ipAddress` boolean
    - `hostname` boolean
    - `attachmentSource` boolean
    - `vendor` boolean
    - `classification` boolean
    - `attachedNetworkDeviceId` boolean
    - `attachedInterfaceIndex` boolean
    - `attachedPortName` boolean
    - `vlanId` boolean
    - `siteId` boolean
    - `firstSeenAt` boolean
    - `lastSeenAt` boolean
    - `createdByUserId` boolean
    - `deletedByUserId` boolean

## Response `200`

Successful response

- object
  - `data` NetworkEndpoint
    - `_id` string, uuid: ID of this object. Permissions - Create: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Create Network Endpoint], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read Network Endpoint], Update: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Edit Network Endpoint]
    - `createdAt` object: Date and Time when the object was created. Permissions - Create: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Create Network Endpoint], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read Network Endpoint], Update: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Edit Network Endpoint]
    - `updatedAt` object: Date and Time when the object was updated. Permissions - Create: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Create Network Endpoint], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read Network Endpoint], Update: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Edit Network Endpoint]
    - `deletedAt` object: Date and Time when the object was deleted. Permissions - Create: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Create Network Endpoint], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read Network Endpoint], Update: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Edit Network Endpoint]
    - `version` number: Object version
    - `projectId` string, uuid, required: ID of your OneUptime Project in which this object belongs. Permissions - Create: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Create Network Endpoint], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read Network Endpoint], Update: [No access - you don't have permission for this operation]
    - `macAddress` string, required: MAC address of this endpoint, colon-separated hex. One row per MAC per project. Permissions - Create: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Create Network Endpoint], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read Network Endpoint], Update: [No access - you don't have permission for this operation]
    - `ipAddress` string: Last IP address seen for this endpoint in ARP tables. Managed by the server. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read Network Endpoint], Update: [Project Owner, Project Admin, Edit Network Endpoint]
    - `hostname` string: What a network controller calls this endpoint, such as the name in its Meraki client list. Managed by the server. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read Network Endpoint], Update: [No access - you don't have permission for this operation]
    - `attachmentSource` string: The network controller that reported where this endpoint is attached, such as meraki. Empty when a walk of a switch or router found it. Managed by the server. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read Network Endpoint], Update: [No access - you don't have permission for this operation]
    - `vendor` string: Hardware vendor derived from the MAC OUI prefix. Managed by the server. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read Network Endpoint], Update: [Project Owner, Project Admin, Edit Network Endpoint]
    - `classification` string: User-editable classification of this endpoint (POS, Kiosk, Camera, Printer, ...). Permissions - Create: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Create Network Endpoint], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read Network Endpoint], Update: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Edit Network Endpoint]
    - `attachedNetworkDeviceId` string, uuid, required: ID of the Network Device this endpoint was last seen attached to. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read Network Endpoint], Update: [No access - you don't have permission for this operation]
    - `attachedInterfaceIndex` number: SNMP ifIndex of the switch port this endpoint was last seen on. Managed by the server. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read Network Endpoint], Update: [No access - you don't have permission for this operation]
    - `attachedPortName` string: Name of the switch port this endpoint was last seen on. Managed by the server. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read Network Endpoint], Update: [No access - you don't have permission for this operation]
    - `vlanId` number: VLAN this endpoint was last seen on, from the FDB walk. Managed by the server. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read Network Endpoint], Update: [No access - you don't have permission for this operation]
    - `siteId` string, uuid: ID of the Network Site this endpoint belongs to. Permissions - Create: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Create Network Endpoint], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read Network Endpoint], Update: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Edit Network Endpoint]
    - `firstSeenAt` object: When this endpoint was first discovered on the network. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read Network Endpoint], Update: [No access - you don't have permission for this operation]
    - `lastSeenAt` object: When this endpoint was last seen in an ARP or FDB walk. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read Network Endpoint], Update: [No access - you don't have permission for this operation]
    - `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, Settings Admin, Settings Member, Settings Viewer, Read Network Endpoint], 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, Settings Admin, Settings Member, Settings Viewer, Read Network Endpoint], 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)