CreateAsset

post

https://app.stairwell.com/v1/environments/{environment}/assets

Creates an asset in an environment.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

environment

string

required

Environment in which to create the asset.

Query Params

idempotencyKey

string

Client-generated key for idempotent asset creation. If provided, repeated
requests with the same key and environment return the existing asset
instead of creating a duplicate.

label

string

Label hint for automatic group assignment. Only takes effect on first
registration - subsequent registrations preserve the existing assignment.

string

OS hint for automatic group assignment. Only takes effect on first
registration - the forwarder reports actual values on subsequent checkins.

osVersion

string

OS version hint for automatic group assignment. Only takes effect on first
registration - the forwarder reports actual values on subsequent checkins.

forwarderVersion

string

Forwarder version hint for automatic group assignment. Only takes effect on
first registration - the forwarder reports actual values on subsequent checkins.

groups

array of strings

Static asset groups to add the asset to when this call creates it, as
group resource names (e.g. groups/VXKCDN-GSPRN8-M4QW7Z-2TPLJHK9; a bare
group ID is accepted too). An asset can belong to several groups. A value
that is not a group ID fails the call with 400 naming it, always. When
this call creates the asset, every group must also be a static group in
the environment: one that does not exist there or is dynamic
(rule-based) fails the call the same way, and nothing is created. Only
takes effect on first registration - when idempotency_key matches an
existing asset, its groups are neither checked nor changed: to change an
existing asset's groups, use ModifyGroupMembership.
ValidateForwarderConfig checks a set of groups before an install.

groups

Body Params

An asset represents an endpoint (workstation, server, VM, or container) that
runs the Stairwell forwarder. Assets continuously upload files for analysis and
maintain a complete history of every file ever observed, enabling retrospective
threat hunting and incident investigation.

label

string

required

Human-readable identifier, typically the machine hostname.

aliases

array of objects

Alternate identifiers this asset is known by. Settable on CreateAsset;
managed afterwards with ModifyAssetAliases. Includes identifiers this asset
no longer holds (state SUPERSEDED).

aliases

Response

200OK