Get node osquery upgrade state

GET

/api/v1/nodes/{env}/node/{uuid}/osquery

curl --request GET \
  --url https://example.com/api/v1/nodes/example/node/example/osquery \
  --header 'Authorization: <Authorization>'

Returns the node’s pin, the version it is rolled out to (the unexpired pin, else the environment target), the osquery version it reports as installed, whether its platform is unsupported by osctrld upgrades (no package, e.g. freebsd), its stage in the environment rollout (rollout, null unless the environment target is a running or paused rollout; eligible_at is when that stage opens and is null when paused or already open), the names (no digests) of the library versions it can be pinned to and the last upgrade report of its osctrld. The installed version and the upgrade result, version, reason and request_id are reported by the host and are untrusted; reported_at is the server’s receive time. Environment admins.

Authorizations

• ApiKeyAuth

Parameters

Path Parameters

env

required

string

Environment name or UUID

uuid

required

string

Node UUID

Responses

200

OK

Media typeapplication/json

object

available

Available lists the library version names (no digests), ascending.

Array<string>

installed_version

string

pin

object

expires_at

string

request_id

string

updated_at

string

updated_by

string

version

string

platform_unsupported

PlatformUnsupported is true when the node’s stored platform has no osquery package (for example freebsd), so osctrld cannot upgrade it. Windows is supported.

boolean

rollout

Rollout is set only while the environment’s staged rollout (running or paused) is what the node’s target comes from; null otherwise.

object

eligible_at

string

stage

integer

stages

Array<integer>

state

string

target

object

source

Pin or environment

string

version

string

upgrade

object

reason

string

reported_at

string

request_id

string

result

string

version

string

Example^generated

{
  "available": [
    "example"
  ],
  "installed_version": "example",
  "pin": {
    "expires_at": "example",
    "request_id": "example",
    "updated_at": "example",
    "updated_by": "example",
    "version": "example"
  },
  "platform_unsupported": true,
  "rollout": {
    "eligible_at": "example",
    "stage": 1,
    "stages": [
      1
    ],
    "state": "example"
  },
  "target": {
    "source": "example",
    "version": "example"
  },
  "upgrade": {
    "reason": "example",
    "reported_at": "example",
    "request_id": "example",
    "result": "example",
    "version": "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"
}

500

Internal server error

Media typeapplication/json

object

code

string

error

string

Example^generated

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