Lookup node

POST

/api/v1/nodes/lookup

curl --request POST \
  --url https://osctrl.net/api/v1/nodes/lookup \
  --header 'Authorization: <Authorization>' \
  --header 'Content-Type: application/json' \
  --data '{ "identifier": "example" }'

Looks up a node by UUID, hostname, or local name.

Authorizations

• ApiKeyAuth

Request Body^required

Request body

Media typeapplication/json

object

identifier

string

Example^generated

{
  "identifier": "example"
}

Responses

200

OK

Media typeapplication/json

object

bytes_received

integer

config_hash

string

cpu

string

created_at

string

daemon_hash

string

environment

string

environment_id

integer

extra_data

string

hardware_serial

string

hostname

string

id

integer

ip_address

string

last_seen

string

localname

string

memory

string

osquery_user

string

osquery_version

string

platform

string

platform_version

string

updated_at

string

user_id

integer

username

string

uuid

string

Example^generated

{
  "bytes_received": 1,
  "config_hash": "example",
  "cpu": "example",
  "created_at": "example",
  "daemon_hash": "example",
  "environment": "example",
  "environment_id": 1,
  "extra_data": "example",
  "hardware_serial": "example",
  "hostname": "example",
  "id": 1,
  "ip_address": "example",
  "last_seen": "example",
  "localname": "example",
  "memory": "example",
  "osquery_user": "example",
  "osquery_version": "example",
  "platform": "example",
  "platform_version": "example",
  "updated_at": "example",
  "user_id": 1,
  "username": "example",
  "uuid": "example"
}

400

Bad request

Media typeapplication/json

object

code

string

error

string

Example^generated

{
  "code": "example",
  "error": "example"
}

401

Unauthorized

Media typeapplication/json

object

code

string

error

string

Example^generated

{
  "code": "example",
  "error": "example"
}

403

Forbidden

Media typeapplication/json

object

code

string

error

string

Example^generated

{
  "code": "example",
  "error": "example"
}

404

Not found

Media typeapplication/json

object

code

string

error

string

Example^generated

{
  "code": "example",
  "error": "example"
}

409

Conflict

Media typeapplication/json

object

code

string

error

string

Example^generated

{
  "code": "example",
  "error": "example"
}

429

Too many requests

Media typeapplication/json

object

code

string

error

string

Example^generated

{
  "code": "example",
  "error": "example"
}

500

Internal server error

Media typeapplication/json

object

code

string

error

string

Example^generated

{
  "code": "example",
  "error": "example"
}

503

Service unavailable

Media typeapplication/json

object

code

string

error

string

Example^generated

{
  "code": "example",
  "error": "example"
}