Skip to content

Get endpoint

GET
/v1/endpoints/{endpointId}

Returns a single endpoint by ID.

endpointId
required
string format: uuid

The endpoint ID.

The requested endpoint.

Endpoint

A device or system managed by Furl.

object
id
required
ID

Unique identifier for the endpoint.

string format: uuid
hostname
required
Hostname

The hostname of the endpoint.

string
ip
required
IP Address

The IP address of the endpoint.

string
nullable
mac_address
required
MAC Address

The MAC address of the endpoint.

string
nullable
operating_system
required
Operating System

Operating system information for the endpoint.

object
name
required
Name

The name of the operating system (e.g., “macOS”, “Windows 11”).

string
version
Version

The version of the operating system.

string
nullable
family
required
Family

The operating system family.

string
Allowed values: macos windows linux other
vendor
Vendor

The vendor of the operating system.

string
nullable
architecture
Architecture

The CPU architecture (e.g., “x86_64”, “arm64”).

string
nullable
agent_id
required
Agent ID

The Furl agent ID if an agent is installed.

string format: uuid
nullable
agent_version
required
Agent Version

The version of the Furl agent installed on this endpoint.

string
nullable
created_at
required
Created At

When the endpoint was first discovered.

string format: date-time
updated_at
required
Updated At

When the endpoint was last updated.

string format: date-time

Invalid endpoint ID format.

object
error
required

Human-readable error message.

string

Missing or invalid API key.

object
error
required

Human-readable error message.

string

Endpoint not found.

object
error
required

Human-readable error message.

string

Internal server error.

object
error
required

Human-readable error message.

string