Set node flags override

PUT

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

curl --request PUT \
  --url https://example.com/api/v1/nodes/example/node/example/flags \
  --header 'Authorization: <Authorization>' \
  --header 'Content-Type: application/json' \
  --data '{ "expires_at": "example", "override": "example" }'

Sets the node’s osquery flags override, one flag per line, merged over the environment flags osctrld fetches. Flags that control the connection to osctrl and repeated flags are refused. The osctrld apply_result, apply_error, apply_at, osquery_running, down_since, flags_stage and extensions_stage fields are reported by the host and are untrusted; reported_at is the server’s receive time and report_stale is set when it is older than 15 minutes.

Authorizations

• ApiKeyAuth

Parameters

Path Parameters

env

required

string

Environment name or UUID

uuid

required

string

Node UUID

Request Body^required

Request body

Media typeapplication/json

object

expires_at

string

override

string

Example^generated

{
  "expires_at": "example",
  "override": "example"
}

Responses

200

OK

Media typeapplication/json

object

applied

string

conflicts

Array<string>

environment

string

expired

boolean

expires_at

string

osctrld

object

apply_at

string

apply_error

string

apply_result

string

down_since

string

extensions_stage

string

flags_stage

string

last_fetched_at

string

osquery_running

Health report: osquery_running, down_since and the stages come from the host; reported_at is the server’s receive time.

boolean

rejected_current

boolean

report_stale

boolean

reported_at

string

override

string

updated_at

string

updated_by

string

Example^generated

{
  "applied": "example",
  "conflicts": [
    "example"
  ],
  "environment": "example",
  "expired": true,
  "expires_at": "example",
  "osctrld": {
    "apply_at": "example",
    "apply_error": "example",
    "apply_result": "example",
    "down_since": "example",
    "extensions_stage": "example",
    "flags_stage": "example",
    "last_fetched_at": "example",
    "osquery_running": true,
    "rejected_current": true,
    "report_stale": true,
    "reported_at": "example"
  },
  "override": "example",
  "updated_at": "example",
  "updated_by": "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"
}

413

Request body too large

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"
}