Get Inventory Objects.

Prev Next
Get
/api/v1/discovery/inventory_objects

Get Inventory Objects.

Security
OAuth

OAuth 2.0 client credential flow, see https://datatracker.ietf.org/doc/html/rfc6749#section-4.4.

FlowClient Credentials
Token URLhttps://api.armor.fortanix.com/api/v1/iam/session/oauth2/token
Query parameters
DiscoveryInventoryObjectsParams
object
filter
string
limit
integer
previous_id
string (uuid)
previous_sort_value
string
sort_by
string
Responses
2XX

Success result

Expand All
object
items
object
property*
object additionalProperties
acct_id
string (uuid)

KI account extension id

connection_id
string (uuid)

KI account's connection id

external_id

an enum that maps to unique identifier provided by Cloud/Onprem

OneOf
object
object
$type
string
Valid values[ "aws" ]
arn
string

fully qualified resource id as defined by AWS

service
string
Valid values[ "acm", "ebs", "kms", "s3", "rds", "dynamo_db", "eks", "efs", "redshift" ]
object
object
$type
string
Valid values[ "azure" ]
resource_id
string

fully qualified resource id as defined by Azure

service
string
Valid values[ "key_vaults", "storage_accounts", "sql_server", "cosmos_db", "container_groups", "managed_disks", "managed_clusters", "storage_account_blobs" ]
object
object
$type
string
Valid values[ "dsm" ]
deployment
OneOf
object
object
$type
string
Valid values[ "saas" ]
region
string
Valid values[ "north_america", "european_union", "united_kingdom", "asia_pacific", "australia", "saudi_arabia" ]
object
object
$type
string
Valid values[ "other" ]
url
string (url)
id
string (uuid)
resource_type
string

Useful for specifying [InventoryObjectExternalId]s

Valid values[ "dsm_sobject" ]
object
object
$type
string
Valid values[ "on_prem" ]
resource_id
string

unique id

resource_type
string
Valid values[ "on_prem_key", "on_prem_ms_sql_database", "on_prem_oracle_database", "on_prem_source_code_repo", "on_prem_source_code_component", "filesystem" ]
service_uri
string

Db/filesystem uri which yielded this resource

object
object
$type
string
Valid values[ "on_prem_fs" ]
file_path
string
machine_id
string
group_id
string (uuid)

KI group extension id

id
string (uuid)

generated by KI. remains static throughout lifetime of account

last_scan_inventory_object
object
id
string (uuid)
scan_id
string (uuid)
object_info
object
ownership_details
object
description
string | null
primary_owner
object
email
string
name
string
secondary_owner
object
email
string
name
string