Snyk/inventory
@webframp/snyk/inventoryv2026.09.08.1
01README
Snyk Inventory — asset discovery for packages, containers, repos, and cloud resources
02Release Notes
2026.09.08.1
Added: Initial code-generated release of @webframp/snyk/inventory with 24 methods covering the Snyk inventory API surface.
03Models
@webframp/snyk/inventoryv2026.09.08.1snyk/inventory.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| apiToken | string | Snyk API token |
| orgId | string | Snyk organization ID |
| version | string | Snyk API version date |
fn list_assets_group(group_id: string, filter?: string, sort?: string, fields?: string, meta_count?: enum)
List or search all assets (synchronous) - Group scope (Early Access)
| Argument | Type | Description |
|---|---|---|
| group_id | string | The unique identifier of the group |
| filter? | string | RSQL filter expression for filtering results. See schema for full documentation. |
| sort? | string | Comma-separated sort fields. Prefix with `-` for descending order. |
| fields? | string | Sparse fieldsets allow clients to request only specific fields for a given re... |
| meta_count? | enum | Provide summary count in the response meta object when requested. When `with`... |
fn update_assets_bulk_group(group_id: string, data: array)
Bulk update asset attributes - Group scope (Early Access)
| Argument | Type | Description |
|---|---|---|
| group_id | string | The unique identifier of the group |
| data | array |
fn get_filter_fields_group(group_id: string, asset_types?: string)
Get available filter fields - Group scope (Early Access)
| Argument | Type | Description |
|---|---|---|
| group_id | string | The unique identifier of the group |
| asset_types? | string | Comma-separated list of asset types to filter the available filter fields |
fn get_filter_values_group(group_id: string, filter_id: string, q?: string, keys_only?: boolean, key?: string)
Get filter value suggestions (autocomplete) - Group scope (Early Access)
| Argument | Type | Description |
|---|---|---|
| group_id | string | The unique identifier of the group |
| filter_id | string | |
| q? | string | Full text search term to filter the list of values. If keys_only is true, thi... |
| keys_only? | boolean | Return only the keys of the object filter values |
| key? | string | Return only the value for a specific key of the object filter values |
fn get_group_fields_group(group_id: string, asset_types?: string)
Get available group fields - Group scope (Early Access)
| Argument | Type | Description |
|---|---|---|
| group_id | string | The unique identifier of the group |
| asset_types? | string | Comma-separated list of asset types to filter group fields |
fn get_group_values_group(group_id: string, group_field_id: string, asset_types?: string, filter?: string, sort?: string, meta_fields?: string, aggregate?: string)
Get group value aggregation - Group scope (Early Access)
| Argument | Type | Description |
|---|---|---|
| group_id | string | The unique identifier of the group |
| group_field_id | string | |
| asset_types? | string | Comma-separated list of asset types to filter the aggregation |
| filter? | string | RSQL filter expression for filtering which assets are included in aggregation... |
| sort? | string | Comma-separated sort fields for group values. Prefix with `-` for descending ... |
| meta_fields? | string | Meta fields to include in the response. Multiple fields can be specified. Ava... |
| aggregate? | string | Per-field aggregate function override for meta fields. All fields default to ... |
fn create_asset_search_group(group_id: string, data?: object)
Create an asset search (asynchronous) - Group scope (Early Access)
| Argument | Type | Description |
|---|---|---|
| group_id | string | The unique identifier of the group |
| data? | object |
fn get_asset_search_results_group(group_id: string, search_id: string, sort?: string, fields?: string)
Retrieve asset search results (asynchronous) - Group scope (Early Access)
| Argument | Type | Description |
|---|---|---|
| group_id | string | The unique identifier of the group |
| search_id | string | The unique identifier of the search operation |
| sort? | string | Sort order for results (e.g., -created_at for descending) |
| fields? | string | Sparse fieldsets allow clients to request only specific fields for a given re... |
fn get_asset_group(group_id: string, asset_id: string, fields?: string)
Get a single asset by ID - Group scope (Early Access)
| Argument | Type | Description |
|---|---|---|
| group_id | string | The unique identifier of the group |
| asset_id | string | The unique identifier of the asset |
| fields? | string | Sparse fieldsets allow clients to request only specific fields for a given re... |
fn update_asset_group(group_id: string, asset_id: string, data: unknown)
Update asset attributes - Group scope (Early Access)
| Argument | Type | Description |
|---|---|---|
| group_id | string | The unique identifier of the group |
| asset_id | string | The unique identifier of the asset |
| data | unknown |
fn list_asset_projects_group(group_id: string, asset_id: string, canonical?: enum, target_id?: string, sort?: enum)
List projects for an asset (group scope) (Early Access)
| Argument | Type | Description |
|---|---|---|
| group_id | string | The unique identifier of the group |
| asset_id | string | The unique identifier of the asset |
| canonical? | enum | |
| target_id? | string | Filter projects by target ID. When provided, returns only projects that belon... |
| sort? | enum | Sort field with optional direction prefix. Prefix with `-` for descending ord... |
fn list_asset_targets_group(group_id: string, asset_id: string)
List targets for an asset (group scope) (Early Access)
| Argument | Type | Description |
|---|---|---|
| group_id | string | The unique identifier of the group |
| asset_id | string | The unique identifier of the asset |
fn list_assets_org(filter?: string, sort?: string, fields?: string, meta_count?: enum)
List or search all assets (synchronous) - Org scope (Early Access)
| Argument | Type | Description |
|---|---|---|
| filter? | string | RSQL filter expression for filtering results. See schema for full documentation. |
| sort? | string | Comma-separated sort fields. Prefix with `-` for descending order. |
| fields? | string | Sparse fieldsets allow clients to request only specific fields for a given re... |
| meta_count? | enum | Provide summary count in the response meta object when requested. When `with`... |
fn update_assets_bulk_org(data: array)
Bulk update asset attributes - Org scope (Early Access)
| Argument | Type | Description |
|---|---|---|
| data | array |
fn get_filter_fields_org(asset_types?: string)
Get available filter fields - Org scope (Early Access)
| Argument | Type | Description |
|---|---|---|
| asset_types? | string | Comma-separated list of asset types to filter the available filter fields |
fn get_filter_values_org(filter_id: string, q?: string, keys_only?: boolean, key?: string)
Get filter value suggestions (autocomplete) - Org scope (Early Access)
| Argument | Type | Description |
|---|---|---|
| filter_id | string | |
| q? | string | Full text search term to filter the list of values. If keys_only is true, thi... |
| keys_only? | boolean | Return only the keys of the object filter values |
| key? | string | Return only the value for a specific key of the object filter values |
fn get_group_fields_org(asset_types?: string)
Get available group fields - Org scope (Early Access)
| Argument | Type | Description |
|---|---|---|
| asset_types? | string | Comma-separated list of asset types to filter group fields |
fn get_group_values_org(group_field_id: string, asset_types?: string, filter?: string, sort?: string, meta_fields?: string, aggregate?: string)
Get group value aggregation - Org scope (Early Access)
| Argument | Type | Description |
|---|---|---|
| group_field_id | string | |
| asset_types? | string | Comma-separated list of asset types to filter the aggregation |
| filter? | string | RSQL filter expression for filtering which assets are included in aggregation... |
| sort? | string | Comma-separated sort fields for group values. Prefix with `-` for descending ... |
| meta_fields? | string | Meta fields to include in the response. Multiple fields can be specified. Ava... |
| aggregate? | string | Per-field aggregate function override for meta fields. All fields default to ... |
fn create_asset_search_org(data?: object)
Create an asset search (asynchronous) - Org scope (Early Access)
| Argument | Type | Description |
|---|---|---|
| data? | object |
fn get_asset_search_results_org(search_id: string, sort?: string, fields?: string)
Retrieve asset search results (asynchronous) - Org scope (Early Access)
| Argument | Type | Description |
|---|---|---|
| search_id | string | The unique identifier of the search operation |
| sort? | string | Sort order for results (e.g., -created_at for descending) |
| fields? | string | Sparse fieldsets allow clients to request only specific fields for a given re... |
fn get_asset_org(asset_id: string, fields?: string)
Get a single asset by ID - Org scope (Early Access)
| Argument | Type | Description |
|---|---|---|
| asset_id | string | The unique identifier of the asset |
| fields? | string | Sparse fieldsets allow clients to request only specific fields for a given re... |
fn update_asset_org(asset_id: string, data: unknown)
Update asset attributes - Org scope (Early Access)
| Argument | Type | Description |
|---|---|---|
| asset_id | string | The unique identifier of the asset |
| data | unknown |
fn list_asset_projects_org(asset_id: string, canonical?: enum, target_id?: string, sort?: enum)
List projects for an asset (org scope) (Early Access)
| Argument | Type | Description |
|---|---|---|
| asset_id | string | The unique identifier of the asset |
| canonical? | enum | |
| target_id? | string | Filter projects by target ID. When provided, returns only projects that belon... |
| sort? | enum | Sort field with optional direction prefix. Prefix with `-` for descending ord... |
fn list_asset_targets_org(asset_id: string)
List targets for an asset (org scope) (Early Access)
| Argument | Type | Description |
|---|---|---|
| asset_id | string | The unique identifier of the asset |
Resources
assets_group(infinite)— List or search all assets (synchronous) - Group scope (Early Access)
assets_bulk_group(infinite)— Bulk update asset attributes - Group scope (Early Access)
get_filter_fields_group(infinite)— Get available filter fields - Group scope (Early Access)
get_filter_values_group(infinite)— Get filter value suggestions (autocomplete) - Group scope (Early Access)
get_group_fields_group(infinite)— Get available group fields - Group scope (Early Access)
get_group_values_group(infinite)— Get group value aggregation - Group scope (Early Access)
asset_search_group(infinite)— Create an asset search (asynchronous) - Group scope (Early Access)
get_asset_search_results_group(infinite)— Retrieve asset search results (asynchronous) - Group scope (Early Access)
asset_group(infinite)— Get a single asset by ID - Group scope (Early Access)
asset_projects_group(infinite)— List projects for an asset (group scope) (Early Access)
asset_targets_group(infinite)— List targets for an asset (group scope) (Early Access)
assets_org(infinite)— List or search all assets (synchronous) - Org scope (Early Access)
assets_bulk_org(infinite)— Bulk update asset attributes - Org scope (Early Access)
get_filter_fields_org(infinite)— Get available filter fields - Org scope (Early Access)
get_filter_values_org(infinite)— Get filter value suggestions (autocomplete) - Org scope (Early Access)
get_group_fields_org(infinite)— Get available group fields - Org scope (Early Access)
get_group_values_org(infinite)— Get group value aggregation - Org scope (Early Access)
asset_search_org(infinite)— Create an asset search (asynchronous) - Org scope (Early Access)
get_asset_search_results_org(infinite)— Retrieve asset search results (asynchronous) - Org scope (Early Access)
asset_org(infinite)— Get a single asset by ID - Org scope (Early Access)
asset_projects_org(infinite)— List projects for an asset (org scope) (Early Access)
asset_targets_org(infinite)— List targets for an asset (org scope) (Early Access)
04Previous Versions
2026.08.28.2
2026.08.28.2
Hardened codegen: instance names sanitized against path traversal; 429 rate-limit retry with Retry-After; string schema patterns emit regex validation; output schemas passthrough unknown fields.
updated labels
2026.08.28.1
2026.08.28.1
Changed: Normalized the extension license to Apache-2.0 and corrected the copyright holder to "Sean Escriva". Extensions that previously shipped an MIT LICENSE.md are now Apache-2.0, consistent with the repository root and every other extension. No code or behavioral changes.
Upgrade note: License text only. No API, schema, or runtime behavior changed.
2026.08.26.2
Fixed: Restored inline npm:zod@4.4.3 import specifiers so the registry
quality scorer can resolve dependencies and score the extension. An earlier
release used a bare "zod" import-map specifier, which published but scored as
unscored.
Changed: Retained explicit compilerOptions.strict in deno.json. No
behavioral or schema changes.
2026.08.26.2
2026.08.26.2
Fixed: Restored inline npm:zod@4.4.3 import specifiers so the registry
quality scorer can resolve dependencies and score the extension. An earlier
release used a bare "zod" import-map specifier, which published but scored as
unscored.
Changed: Retained explicit compilerOptions.strict in deno.json. No
behavioral or schema changes.
2026.08.25.1
2026.08.25.1
Changed: Updated labels for improved extension discoverability. Added cross-cutting category labels (security, observability, finops, infrastructure, networking, compliance, devops, ai, incident-response) where applicable.
updated labels
2026.08.24.1
2026.08.24.1
Added: Output metadata attributes for observability.
durationMs: Method execution duration in milliseconds.collectedBy: Extension name that produced the data.fetchedAt: ISO 8601 timestamp when data was fetched (added to resources that previously lacked it).
2026.08.21.2
2026.08.21.2
Changed:
- Snyk API request failures now name the HTTP method and path that was
attempted (e.g.
Snyk API PATCH /groups/{groupId}/inventory/assets failed with HTTP 403: ...) instead of surfacing only the raw status and body. Network-level failures (DNS, timeout, connection reset) are also caught and re-raised with the same context and the original error preserved ascause, rather than propagating an unlabeled fetch error. update_assets_bulk_groupandupdate_assets_bulk_orgnow reject an emptydataarray with a clear local validation error instead of sending a no-op bulk update request to the Snyk API.
Upgrade note: No changes to stored resource schemas. Existing instances need no migration.
2026.08.21.1
2026.08.21.1
Changed: Schema tightening sweep — no behavioral changes.
- Added
.min(1)toapiTokenandorgIdin the global arguments schema. - Added
.describe(...)to previously undocumented fields on the asset projects schemas (group and org scope): thebase_image_remediationsub-fields (base_image,base_image_name,base_image_outdated,code,distro_alert,proposed_base_images) and theissuesseverity-count breakdown.
2026.07.20.1
2026.07.20.1
Fixed: Group-scoped methods (paths under /groups/{group_id}/...) dropped
their group_id path parameter. The generated code referenced args.group_id,
but the argument was never declared or forwarded, so requests went to
/groups/undefined/... and returned HTTP 404. These methods now declare and
forward group_id correctly.
Upgrade note: Group-scoped methods now take a required group_id argument.
Calls that previously failed with a 404 succeed once group_id is supplied.
2026.07.19.1
2026.07.19.1
Added: Initial code-generated release of @webframp/snyk/inventory with 24 methods covering the Snyk inventory API surface.
05Stats
A
100 / 100
Downloads
0
Archive size
24.6 KB
- Has README or module doc2/2earned
- README has a code example1/1earned
- README is substantive1/1earned
- Most symbols documented1/1earned
- No slow types (deprecated)1/1earned
- Dependencies pass trust audit2/2earned
- Has description1/1earned
- Platform support declared (or universal)2/2earned
- License declared1/1earned
- Verified public repository2/2earned
06Platforms
07Labels