Snyk

Snyk Inventory Assets API

The Inventory Assets API from Snyk — 30 operation(s) for inventory assets.

GitHub OpenAPI

Operations 36

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /groups/{group_id}/inventory/assets List or filter inventory assets across a group · List or search all assets (synchronous) - Group scope (Early Access) #
Ask an LLM
“Can I see every asset in my Snyk group's inventory in one list?”
“Is there a way to filter a group's inventory assets with an RSQL expression right away, without starting an async search?”
Tell an agent
List all inventory assets in group {group_id}.
List group {group_id} inventory assets matching the filter {filter}, sorted by {sort}.
PATCH /groups/{group_id}/inventory/assets Bulk update up to 100 assets in a group · Bulk update asset attributes - Group scope (Early Access) #
Ask an LLM
“Can I relabel many assets in a group's inventory in one request?”
“What is the maximum number of assets a group-scope bulk update accepts?”
Tell an agent
Bulk update the class, labels and tags of several assets in group {group_id} in a single transaction.
Apply these attribute changes to up to 100 assets at once in group {group_id}.
GET /groups/{group_id}/inventory/assets/filters List fields usable for filtering group assets · Get available filter fields - Group scope (Early Access) #
Ask an LLM
“Which fields can I use in an RSQL filter on my group's asset inventory?”
“What data type is each filterable asset field at group scope?”
Tell an agent
List the filterable asset fields for group {group_id}.
Show group {group_id}'s filter fields that apply to asset type {asset_types}.
GET /groups/{group_id}/inventory/assets/filters/{filter_id}/values Suggest values for a group asset filter field · Get filter value suggestions (autocomplete) - Group scope (Early Access) #
Ask an LLM
“What distinct values exist for a given asset filter field across my group?”
“Can I get autocomplete suggestions for a group-level asset filter as a user types?”
Tell an agent
Suggest values for filter field {filter_id} in group {group_id}.
Autocomplete group {group_id} filter {filter_id} values starting with {q}.
GET /groups/{group_id}/inventory/assets/groups List fields for grouping assets in a group · Get available group fields - Group scope (Early Access) #
Ask an LLM
“Which fields can I group my Snyk group's assets by?”
“What grouping dimensions are available for group-scope asset aggregation?”
Tell an agent
List the asset grouping fields available in group {group_id}.
Show grouping fields in group {group_id} that apply to {asset_types} assets.
GET /groups/{group_id}/inventory/assets/groups/{group_field_id}/values Count group assets by each value of a field · Get group value aggregation - Group scope (Early Access) #
Ask an LLM
“How many assets in my group fall under each value of a grouping field?”
“Can I get asset counts per distinct value, filtered, across a whole group?”
Tell an agent
Aggregate group {group_id} assets by grouping field {group_field_id}.
Count assets per value of field {group_field_id} in group {group_id} where {filter}.
POST /groups/{group_id}/inventory/assets/searches Start an async asset search in a group · Create an asset search (asynchronous) - Group scope (Early Access) #
Ask an LLM
“Can I kick off a background asset search across a whole group?”
“Is there an asynchronous way to search a group's inventory for large result sets?”
Tell an agent
Start an asynchronous asset search in group {group_id}.
Launch a background inventory search across group {group_id} with these criteria.
GET /groups/{group_id}/inventory/assets/searches/{search_id}/results Get results of a group asset search · Retrieve asset search results (asynchronous) - Group scope (Early Access) #
Ask an LLM
“Where do I pick up the results of an asset search I started for my group?”
“Can I page through async search results at group scope?”
Tell an agent
Fetch the results of asset search {search_id} in group {group_id}.
Get the next {limit} results from group {group_id} search {search_id}.
GET /groups/{group_id}/inventory/assets/{asset_id} Get one asset in a group by ID · Get a single asset by ID - Group scope (Early Access) #
Ask an LLM
“Can I look up a single inventory asset by its ID within my group?”
“What details come back for one asset at group scope?”
Tell an agent
Get asset {asset_id} in group {group_id}.
Show only the {fields} fields for asset {asset_id} in group {group_id}.
PATCH /groups/{group_id}/inventory/assets/{asset_id} Update one asset's class, labels or tags in a group · Update asset attributes - Group scope (Early Access) #
Ask an LLM
“Can I change the class of a single asset within my group?”
“Is it possible to add or remove tags on one asset at group scope?”
Tell an agent
Update the class of asset {asset_id} in group {group_id}.
Add and remove labels on asset {asset_id} in group {group_id}.
GET /groups/{group_id}/inventory/assets/{asset_id}/relationships/projects List Snyk projects linked to an asset in a group · List projects for an asset (group scope) (Early Access) #
Ask an LLM
“Which Snyk projects are linked to an asset in my group?”
“Can I see only canonical projects for an asset at group scope?”
Tell an agent
List projects linked to asset {asset_id} in group {group_id}.
List group {group_id} projects for asset {asset_id} under target {target_id}.
GET /groups/{group_id}/inventory/assets/{asset_id}/relationships/targets List Snyk targets linked to an asset in a group · List targets for an asset (group scope) (Early Access) #
Ask an LLM
“Which Snyk targets is an asset in my group connected to?”
“Can I page through the targets tied to a group-level asset?”
Tell an agent
List targets linked to asset {asset_id} in group {group_id}.
Show the first {limit} targets for group {group_id} asset {asset_id}.
GET /orgs/{org_id}/inventory/assets List or filter inventory assets in an organization · List or search all assets (synchronous) - Org scope (Early Access) #
Ask an LLM
“Can I list all the assets in one Snyk organization's inventory?”
“Is there a way to filter an org's assets with RSQL and get a total count immediately?”
Tell an agent
List all inventory assets in organization {org_id}.
List org {org_id} assets matching {filter}, sorted by {sort}.
PATCH /orgs/{org_id}/inventory/assets Bulk update up to 100 assets in an organization · Bulk update asset attributes - Org scope (Early Access) #
Ask an LLM
“Can I retag a batch of assets in one organization with a single call?”
“Is an org-scope bulk asset update all-or-nothing?”
Tell an agent
Bulk update labels and tags on several assets in organization {org_id} in one transaction.
Apply these class changes to up to 100 assets in org {org_id}.
GET /orgs/{org_id}/inventory/assets/filters List fields usable for filtering org assets · Get available filter fields - Org scope (Early Access) #
Ask an LLM
“Which fields can I filter my organization's inventory assets on?”
“What asset types does each org-level filter field apply to?”
Tell an agent
List the filterable asset fields for organization {org_id}.
Show org {org_id} filter fields for {asset_types} assets.
GET /orgs/{org_id}/inventory/assets/filters/{filter_id}/values Suggest values for an org asset filter field · Get filter value suggestions (autocomplete) - Org scope (Early Access) #
Ask an LLM
“What values can a particular asset filter field take in my organization?”
“Can I autocomplete an org-level asset filter from a partial string?”
Tell an agent
Suggest values for filter field {filter_id} in organization {org_id}.
Autocomplete org {org_id} filter {filter_id} values matching {q}.
GET /orgs/{org_id}/inventory/assets/groups List fields for grouping assets in an org · Get available group fields - Org scope (Early Access) #
Ask an LLM
“Which fields can I group an organization's assets by?”
“What aggregation dimensions exist for org-scope asset inventory?”
Tell an agent
List the asset grouping fields available in organization {org_id}.
Show org {org_id} grouping fields for {asset_types} assets.
GET /orgs/{org_id}/inventory/assets/groups/{group_field_id}/values Count org assets by each value of a field · Get group value aggregation - Org scope (Early Access) #
Ask an LLM
“How are my organization's assets distributed across the values of one field?”
“Can I get per-value asset counts for an org with a filter applied?”
Tell an agent
Aggregate org {org_id} assets by grouping field {group_field_id}.
Count assets per value of field {group_field_id} in org {org_id} where {filter}.
POST /orgs/{org_id}/inventory/assets/searches Start an async asset search in an organization · Create an asset search (asynchronous) - Org scope (Early Access) #
Ask an LLM
“Can I run a background asset search limited to one organization?”
“Is there an asynchronous search option for an org's inventory?”
Tell an agent
Start an asynchronous asset search in organization {org_id}.
Launch a background inventory search in org {org_id} with these criteria.
GET /orgs/{org_id}/inventory/assets/searches/{search_id}/results Get results of an org asset search · Retrieve asset search results (asynchronous) - Org scope (Early Access) #
Ask an LLM
“Where do I read the results of an asset search I started in my organization?”
“Can I sort the results of an org-level async asset search?”
Tell an agent
Fetch the results of asset search {search_id} in organization {org_id}.
Get org {org_id} search {search_id} results sorted by {sort}.
GET /orgs/{org_id}/inventory/assets/{asset_id} Get one asset in an organization by ID · Get a single asset by ID - Org scope (Early Access) #
Ask an LLM
“Can I fetch one inventory asset by ID inside a specific organization?”
“What does a single org-scope asset record contain?”
Tell an agent
Get asset {asset_id} in organization {org_id}.
Show only the {fields} fields of asset {asset_id} in org {org_id}.
PATCH /orgs/{org_id}/inventory/assets/{asset_id} Update one asset's class, labels or tags in an org · Update asset attributes - Org scope (Early Access) #
Ask an LLM
“Can I change the tags on a single asset inside my organization?”
“Is it possible to reclassify one org-level asset?”
Tell an agent
Update the class of asset {asset_id} in organization {org_id}.
Add and remove tags on asset {asset_id} in org {org_id}.
GET /orgs/{org_id}/inventory/assets/{asset_id}/relationships/projects List Snyk projects linked to an asset in an org · List projects for an asset (org scope) (Early Access) #
Ask an LLM
“Which projects in my organization are linked to a given asset?”
“Can I filter an org asset's related projects by target?”
Tell an agent
List projects linked to asset {asset_id} in organization {org_id}.
List org {org_id} projects for asset {asset_id} under target {target_id}.
GET /orgs/{org_id}/inventory/assets/{asset_id}/relationships/targets List Snyk targets linked to an asset in an org · List targets for an asset (org scope) (Early Access) #
Ask an LLM
“Which targets in my organization are tied to a given asset?”
“Can I page through an org asset's linked targets?”
Tell an agent
List targets linked to asset {asset_id} in organization {org_id}.
Show the first {limit} targets for org {org_id} asset {asset_id}.
GET /tenants/{tenant_id}/inventory/assets List or filter inventory assets across a tenant · List or search all assets (synchronous) (Early Access) #
Ask an LLM
“Can I get one unified list of containers, images and other assets across my whole tenant?”
“How do I filter tenant-wide inventory assets synchronously with RSQL?”
Tell an agent
List all inventory assets in tenant {tenant_id}.
List tenant {tenant_id} assets matching {filter}, sorted by {sort}.
PATCH /tenants/{tenant_id}/inventory/assets Bulk update up to 100 assets across a tenant · Bulk update asset attributes (Early Access) #
Ask an LLM
“Can I update labels on many assets across my tenant in a single transactional request?”
“What's the per-request cap for tenant-wide bulk asset updates?”
Tell an agent
Bulk update class, labels and tags on several assets in tenant {tenant_id} in one transaction.
Apply these tag changes to up to 100 assets in tenant {tenant_id}.
GET /tenants/{tenant_id}/inventory/assets/filters List fields usable for filtering tenant assets · Get available filter fields (Early Access) #
Ask an LLM
“Which fields can I filter tenant-wide inventory assets on?”
“What data types do the tenant-level asset filter fields have?”
Tell an agent
List the filterable asset fields for tenant {tenant_id}.
Show tenant {tenant_id} filter fields for {asset_types} assets.
GET /tenants/{tenant_id}/inventory/assets/filters/{filter_id}/values Suggest values for a tenant asset filter field · Get filter value suggestions (autocomplete) (Early Access) #
Ask an LLM
“What distinct values does a filter field have across my entire tenant?”
“Can I build filter autocomplete over tenant-wide assets?”
Tell an agent
Suggest values for filter field {filter_id} in tenant {tenant_id}.
Autocomplete tenant {tenant_id} filter {filter_id} values matching {q}.
GET /tenants/{tenant_id}/inventory/assets/groups List fields for grouping assets in a tenant · Get available group fields (Early Access) #
Ask an LLM
“Which fields can I aggregate tenant-wide assets by?”
“What grouping fields apply to container images across my tenant?”
Tell an agent
List the asset grouping fields available in tenant {tenant_id}.
Show tenant {tenant_id} grouping fields for {asset_types} assets.
GET /tenants/{tenant_id}/inventory/assets/groups/{group_field_id}/values Count tenant assets by each value of a field · Get group value aggregation (Early Access) #
Ask an LLM
“How many assets across my tenant have each value of a given field?”
“Can I get filtered per-value asset counts at tenant scope?”
Tell an agent
Aggregate tenant {tenant_id} assets by grouping field {group_field_id}.
Count assets per value of field {group_field_id} in tenant {tenant_id} where {filter}.
POST /tenants/{tenant_id}/inventory/assets/searches Start an async asset search across a tenant · Create an asset search (asynchronous) (Early Access) #
Ask an LLM
“Can I start a background search over every asset in my tenant?”
“Does a tenant-wide async asset search redirect me to its results?”
Tell an agent
Start an asynchronous asset search in tenant {tenant_id}.
Launch a background inventory search across tenant {tenant_id} with these criteria.
GET /tenants/{tenant_id}/inventory/assets/searches/{search_id}/results Get results of a tenant asset search · Retrieve asset search results (asynchronous) (Early Access) #
Ask an LLM
“Where can I read the results of a tenant-wide asset search I started?”
“Can I choose which fields come back in tenant async search results?”
Tell an agent
Fetch the results of asset search {search_id} in tenant {tenant_id}.
Get the next {limit} results from tenant {tenant_id} search {search_id}.
GET /tenants/{tenant_id}/inventory/assets/{asset_id} Get one asset in a tenant by ID · Get a single asset by ID (Early Access) #
Ask an LLM
“Can I look up any asset in my tenant by its unique ID?”
“What type-specific details come back for a single tenant asset?”
Tell an agent
Get asset {asset_id} in tenant {tenant_id}.
Show only the {fields} fields of asset {asset_id} in tenant {tenant_id}.
PATCH /tenants/{tenant_id}/inventory/assets/{asset_id} Update one asset's class, labels or tags in a tenant · Update asset attributes (Early Access) #
Ask an LLM
“Can I edit the labels of a single asset at tenant scope?”
“What must I include when updating one tenant asset's attributes?”
Tell an agent
Update the class of asset {asset_id} in tenant {tenant_id}.
Add and remove labels on asset {asset_id} in tenant {tenant_id}.
GET /tenants/{tenant_id}/inventory/assets/{asset_id}/relationships/projects List Snyk projects linked to an asset in a tenant · List projects for an asset (Early Access) #
Ask an LLM
“Which Snyk projects anywhere in my tenant are linked to an asset?”
“Can I restrict a tenant asset's projects to canonical ones?”
Tell an agent
List projects linked to asset {asset_id} in tenant {tenant_id}.
List tenant {tenant_id} projects for asset {asset_id} under target {target_id}.
GET /tenants/{tenant_id}/inventory/assets/{asset_id}/relationships/targets List Snyk targets linked to an asset in a tenant · List targets for an asset (Early Access) #
Ask an LLM
“Which targets across my tenant are tied to a given asset?”
“Can I paginate the targets linked to a tenant asset?”
Tell an agent
List targets linked to asset {asset_id} in tenant {tenant_id}.
Show the first {limit} targets for tenant {tenant_id} asset {asset_id}.

Documentation

📖
Documentation
https://apidocs.snyk.io/?version=2024-10-15
📖
Documentation
https://apidocs.snyk.io/?version=2024-10-15#tag/Orgs
📖
Documentation
https://apidocs.snyk.io/?version=2024-10-15#tag/Projects
📖
Documentation
https://apidocs.snyk.io/?version=2024-10-15#tag/Issues
📖
Documentation
https://apidocs.snyk.io/?version=2024-10-15#tag/Targets
📖
Documentation
https://apidocs.snyk.io/?version=2024-10-15#tag/Integrations
📖
Documentation
https://apidocs.snyk.io/?version=2024-10-15#tag/Audit-Logs
📖
Documentation
https://apidocs.snyk.io/?version=2024-10-15#tag/SBOM
📖
Documentation
https://apidocs.snyk.io/?version=2024-10-15#tag/Container-Images
📖
Documentation
https://apidocs.snyk.io/?version=2024-10-15#tag/Custom-Base-Images
📖
Documentation
https://apidocs.snyk.io/?version=2024-10-15#tag/Webhooks
📖
Documentation
https://apidocs.snyk.io/?version=2024-10-15#tag/Issues-Export

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/snyk/refs/heads/main/openapi/snyk-inventory-assets-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/snyk/refs/heads/main/json-schema/snyk-create-search-request-body-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/snyk/refs/heads/main/json-schema/snyk-polymorphic-asset-data-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/snyk/refs/heads/main/json-schema/snyk-asset-list-response-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/snyk/refs/heads/main/json-schema/snyk-group-values-response-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/snyk/refs/heads/main/json-schema/snyk-filter-fields-response-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/snyk/refs/heads/main/json-schema/snyk-group-fields-response-schema.json

Other Resources

🔗
Overlay
https://raw.githubusercontent.com/api-evangelist/snyk/refs/heads/main/overlays/snyk-inventory-assets-api-overlay.yaml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/snyk:snyk-inventory-assets-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

snyk-inventory-assets-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Snyk Inventory Assets API
  version: REST
servers:
- description: Snyk REST API
  url: https://api.snyk.io/rest
security:
- APIToken: []
- BearerAuth: []
tags:


# --- truncated at 32 KB (172 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/snyk/refs/heads/main/openapi/snyk-inventory-assets-api-openapi.yml