Skip to main content
POST
Create an inventory asset.

Authorizations

​
X-API-Key
string
header
required

Infrawatch API key. Supply the complete key directly as the header value.

Path Parameters

​
project_uuid
string<uuid>
required

Body

application/json

Omit asset_kind for hostnames and IP values and the API infers domain, subdomain, ip_address, or ip_block from value. brand_name stores brand strings used for internet mention workflows. The API canonicalizes value, normalized_value, asset_type, and typed columns.

​
value
string
required

For page assets this is an HTTP or HTTPS URL without embedded user credentials. ASN assets require canonicalizable ASPLAIN text such as AS13335.

​
activity
string
Maximum string length: 256
​
added_by_method
enum<string>

Alias of source_kind. discovery is accepted and stored as auto_discovered.

Available options:
manual,
discovery,
auto_discovered,
import,
api,
integration
​
asn
integer<int64>

Optional for ASN creates; when supplied, it must match the ASPLAIN value.

Required range: 1 <= x <= 4294967295
​
asset_family
string

Defaults to asset_kind.

​
asset_kind
enum<string>

Optional for hostnames and IPs. Required for brand_name, certificates, ASN, contact, and page assets.

Available options:
domain,
subdomain,
page,
ssl_certificate,
asn,
ip_block,
ip_address,
contact,
brand_name
​
asset_type
string
​
brand_main_website_url
string<uri>

Required for brand_name assets. Must be an HTTP or HTTPS URL whose canonical percent-encoded form also fits the 2048-character limit.

Maximum string length: 2048
Pattern: ^[hH][tT][tT][pP][sS]?://[^/@\s]+([/?#].*)?$
​
certificate_issuer
string
​
certificate_not_after
string<date-time>
​
certificate_not_before
string<date-time>
​
certificate_sha256
string
Pattern: ^[0-9a-fA-F]{64}$
​
certificate_subject
string
​
cname_records
string[]
​
contact_email
string<email>

Normalized to a lower-case mailbox address and rejected when syntactically invalid.

​
contact_name
string
​
contact_type
string
​
discovery_channel
string
​
discovery_provider
string
​
display_name
string
​
dns_a_records
string[]
​
dns_aaaa_records
string[]
​
dns_name
string
​
domain_status
string

Domain/subdomain enrichment status. Invalid for non-domain inventory assets.

Maximum string length: 128
​
favicon_sha256
string
Pattern: ^[0-9a-fA-F]{64}$
​
final_url
string<uri>
Maximum string length: 2048
Pattern: ^[hH][tT][tT][pP][sS]?://[^/@\s]+([/?#].*)?$
​
first_seen_at
string<date-time>
​
host
string
​
ip
string
​
ip_addresses
string[]
​
ip_block
string
​
last_observed_at
string<date-time>
​
last_seen_at
string<date-time>
​
metadata
object
​
name_servers
string[]
​
normalized_value
string

Defaults to the asset-kind canonical value, such as a lower-case hostname or upper-case ASPLAIN ASN (AS13335).

​
os_family
string
​
owner_group_uuid
string<uuid>
​
owner_membership_uuid
string<uuid>
​
page_sha256
string
Pattern: ^[0-9a-fA-F]{64}$
​
parent_domain
string
​
primary_source_name
string
​
primary_source_ref
string
​
provider
string
Maximum string length: 256
​
registered_at
string<date-time>
​
registrar
string
Maximum string length: 512
​
root_domain
string
​
screenshot_sha256
string
Pattern: ^[0-9a-fA-F]{64}$
​
source_kind
enum<string>
Available options:
manual,
auto_discovered,
import,
api,
integration
​
status
enum<string>
Available options:
candidate,
approved,
monitored,
ignored,
removed,
archived
​
title
string
Maximum string length: 1024
​
url
string<uri>

HTTP or HTTPS URL without embedded user credentials. For page assets, omit it to derive from value; when supplied it must match value and host. The canonical percent-encoded URL must also fit the 2048-character limit.

Maximum string length: 2048
Pattern: ^[hH][tT][tT][pP][sS]?://[^/@\s]+([/?#].*)?$

Response

Inventory asset created.

​
asset
object
required