x-cpod-domain: assets

Assets

Physical and cloud assets in the inventory.

Try in explorer client.assets · client.cloudResources

PhysicalAsset

A tracked physical asset (laptop, monitor, IoT device).

REST path/api/v1/physical-assets

Operations

listgetcreateupdatedelete

SDK

// list — returns only your records; add filters/search:
await client.assets.physicalAssets.list()

// create:
await client.assets.physicalAssets.create({
  id: "rec_01HXEXAMPLE",
  tenant_id: "example tenant_id",
  created_at: "2026-01-01T00:00:00Z",
  updated_at: "2026-01-01T00:00:00Z",
  app_id: "example app_id",
  created_by: "rec_01HXEXAMPLE",
})

Field	Type	Description
id*	uuid	Server-assigned ULID with type prefix (e.g. per_…).
tenant_id*	string	Tenant scope — auto-stamped from the caller's JWT.
app_id	string	App scope. Stamped ONLY when the caller's JWT was minted for a specific Application (integration API keys). Absent for human-user sessions. Filters reads when present.
created_at*	date-time	Server stamp.
updated_at*	date-time	Server stamp; updated on every patch.
created_by	uuid	Person id from the caller's JWT (sub).
updated_by	uuid	Person id from the last writer's JWT (sub).
source	string	Provenance tag — defaults to 'edm'.
source_type	enum	Where the write originated. Defaults to 'api'.`frontendbackendserversystemapi`
is_deleted	boolean	Soft-delete flag. Excluded from default list queries.
deleted_at	date-time	Stamped when soft-deleted; null otherwise.
deleted_by	uuid	Person id who soft-deleted; null otherwise.
schema_version	number	Document schema version. Bumped on incompatible writes.
asset_tag	string	Enterprise inventory asset tag — the physical or logical label affixed to or associated with the device by IT.
name	string	Human-readable name or hostname for the device.
serial_number	string	Manufacturer serial number of the device. Used for warranty lookups and insurance claims.
model	string	Manufacturer model name or product line.
manufacturer	string	Name of the device manufacturer.
type	string	Hardware category of this physical asset.
status	string	Current operational status. 'lost_stolen' assets should trigger immediate security review of associated accounts.
assigned_to	json	Current assignment details for this device.
purchase_date	date-time	Date on which this device was purchased by the enterprise.
purchase_cost	json	Original purchase cost of this device.
warranty_expiry	date-time	Date on which the manufacturer or extended warranty expires.
os	json	Operating system installed on this device.
managed_by	string	Name of the MDM or endpoint management tool currently managing this device (e.g. 'Jamf Pro', 'Microsoft Intune', 'CrowdStrike Falcon').
last_seen_at	date-time	ISO 8601 timestamp of the last check-in or heartbeat received from this device by the MDM system. Set by the platform during sync.

CloudResource

A cloud resource discovered or managed (EC2, S3, GKE node).

REST path/api/v1/cloud-resources

Operations

listgetcreateupdatedelete

SDK

// list — returns only your records; add filters/search:
await client.assets.cloudResources.list()

// create:
await client.assets.cloudResources.create({
  id: "rec_01HXEXAMPLE",
  tenant_id: "example tenant_id",
  created_at: "2026-01-01T00:00:00Z",
  updated_at: "2026-01-01T00:00:00Z",
  app_id: "example app_id",
  created_by: "rec_01HXEXAMPLE",
})

Field	Type	Description
id*	uuid	Server-assigned ULID with type prefix (e.g. per_…).
tenant_id*	string	Tenant scope — auto-stamped from the caller's JWT.
app_id	string	App scope. Stamped ONLY when the caller's JWT was minted for a specific Application (integration API keys). Absent for human-user sessions. Filters reads when present.
created_at*	date-time	Server stamp.
updated_at*	date-time	Server stamp; updated on every patch.
created_by	uuid	Person id from the caller's JWT (sub).
updated_by	uuid	Person id from the last writer's JWT (sub).
source	string	Provenance tag — defaults to 'edm'.
source_type	enum	Where the write originated. Defaults to 'api'.`frontendbackendserversystemapi`
is_deleted	boolean	Soft-delete flag. Excluded from default list queries.
deleted_at	date-time	Stamped when soft-deleted; null otherwise.
deleted_by	uuid	Person id who soft-deleted; null otherwise.
schema_version	number	Document schema version. Bumped on incompatible writes.
external_id	string	Native cloud provider resource identifier (e.g. EC2 instance ID 'i-0a1b2c3d4e5f67890', Azure resource ID, GCP resource name).
provider	string	Cloud provider hosting this resource.
account_id	string	Cloud provider account or subscription ID where this resource resides.
region	string	Cloud provider region where this resource is located.
resource_type	string	Cloud provider resource type in dot-notation format (e.g. 'ec2.instance', 's3.bucket', 'rds.instance', 'lambda.function', 'azure.vm', 'gcp.compute.instance').
resource_name	string	Human-readable name or tag-based name of this cloud resource. May be the 'Name' tag value for AWS resources.
arn	string	Amazon Resource Name (ARN) for AWS resources. Null for non-AWS resources.
status	string	Current operational state of the cloud resource as reported by the cloud provider.
asset_id	uuid	UUID of the TechnologyAsset this CloudResource is part of or implements. Links infrastructure-level resources to business-level asset records.
tags	json	Cloud provider tags applied to this resource as key-value pairs. Synced directly from the cloud provider.
cost	json	Estimated monthly cost for this cloud resource based on cloud provider billing data.

Docs

PhysicalAsset

CloudResource