Snyk API — Inventory Assets

naftiko: 1.0.0-alpha2
info:
  label: Snyk API — Inventory Assets
  description: 'Snyk API — Inventory Assets. 36 operations. Lead operation: List or search all assets (synchronous) - Group
    scope (Early Access). Self-contained Naftiko capability covering one Snyk business surface.'
  tags:
  - Snyk
  - Inventory Assets
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    SNYK_API_KEY: SNYK_API_KEY
capability:
  consumes:
  - type: http
    namespace: rest-inventory-assets
    baseUri: https://api.snyk.io/rest
    description: Snyk API — Inventory Assets business capability. Self-contained, no shared references.
    resources:
    - name: groups-group_id-inventory-assets
      path: /groups/{group_id}/inventory/assets
      operations:
      - name: listassetsgroup
        method: GET
        description: List or search all assets (synchronous) - Group scope (Early Access)
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: group_id
          in: path
          type: string
          description: The unique identifier of the group
          required: true
        - name: version
          in: query
          type: string
          description: The requested API version
        - name: sort
          in: query
          type: string
          description: Comma-separated sort fields. Prefix with `-` for descending order.
        - name: limit
          in: query
          type: integer
          description: Number of results to return per page
        - name: starting_after
          in: query
          type: string
          description: Cursor for fetching the next page of results
        - name: ending_before
          in: query
          type: string
          description: Cursor for fetching the previous page of results
      - name: updateassetsbulkgroup
        method: PATCH
        description: Bulk update asset attributes - Group scope (Early Access)
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: group_id
          in: path
          type: string
          description: The unique identifier of the group
          required: true
        - name: version
          in: query
          type: string
          description: The requested API version
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: groups-group_id-inventory-assets-filters
      path: /groups/{group_id}/inventory/assets/filters
      operations:
      - name: getfilterfieldsgroup
        method: GET
        description: Get available filter fields - Group scope (Early Access)
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: group_id
          in: path
          type: string
          description: The unique identifier of the group
          required: true
        - name: version
          in: query
          type: string
          description: The requested API version
        - name: asset_types
          in: query
          type: string
          description: Comma-separated list of asset types to filter the available filter fields
        - name: limit
          in: query
          type: integer
          description: Number of results to return
        - name: starting_after
          in: query
          type: string
          description: Cursor for fetching the next page of results
        - name: ending_before
          in: query
          type: string
          description: Cursor for fetching the previous page of results
    - name: groups-group_id-inventory-assets-filters-filter_id-values
      path: /groups/{group_id}/inventory/assets/filters/{filter_id}/values
      operations:
      - name: getfiltervaluesgroup
        method: GET
        description: Get filter value suggestions (autocomplete) - Group scope (Early Access)
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: group_id
          in: path
          type: string
          description: The unique identifier of the group
          required: true
        - name: version
          in: query
          type: string
          description: The requested API version
        - name: filter_id
          in: path
          type: string
          description: The UUID of the filter field to get values for (from the filter fields list endpoint)
          required: true
        - name: q
          in: query
          type: string
          description: Full text search term to filter the list of values. If keys_only is true, this will filter the keys
            of the object filter values. If key is provided, this will f
        - name: limit
          in: query
          type: integer
          description: Number of results to return
        - name: starting_after
          in: query
          type: string
          description: Cursor for fetching the next page of results
        - name: ending_before
          in: query
          type: string
          description: Cursor for fetching the previous page of results
        - name: keys_only
          in: query
          type: boolean
          description: Return only the keys of the object filter values
        - name: key
          in: query
          type: string
          description: Return only the value for a specific key of the object filter values
    - name: groups-group_id-inventory-assets-groups
      path: /groups/{group_id}/inventory/assets/groups
      operations:
      - name: getgroupfieldsgroup
        method: GET
        description: Get available group fields - Group scope (Early Access)
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: group_id
          in: path
          type: string
          description: The unique identifier of the group
          required: true
        - name: version
          in: query
          type: string
          description: The requested API version
        - name: asset_types
          in: query
          type: string
          description: Comma-separated list of asset types to filter group fields
        - name: limit
          in: query
          type: integer
          description: Maximum number of results to return
        - name: starting_after
          in: query
          type: string
          description: Cursor for forward pagination
        - name: ending_before
          in: query
          type: string
          description: Cursor for backward pagination
    - name: groups-group_id-inventory-assets-groups-group_field_id-values
      path: /groups/{group_id}/inventory/assets/groups/{group_field_id}/values
      operations:
      - name: getgroupvaluesgroup
        method: GET
        description: Get group value aggregation - Group scope (Early Access)
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: group_id
          in: path
          type: string
          description: The unique identifier of the group
          required: true
        - name: version
          in: query
          type: string
          description: The requested API version
        - name: group_field_id
          in: path
          type: string
          description: The UUID of the group field to get values for (from the group fields list endpoint)
          required: true
        - name: asset_types
          in: query
          type: string
          description: Comma-separated list of asset types to filter the aggregation
        - name: limit
          in: query
          type: integer
          description: Maximum number of group values to return
        - name: starting_after
          in: query
          type: string
          description: Cursor for forward pagination
        - name: ending_before
          in: query
          type: string
          description: Cursor for backward pagination
    - name: groups-group_id-inventory-assets-searches
      path: /groups/{group_id}/inventory/assets/searches
      operations:
      - name: createassetsearchgroup
        method: POST
        description: Create an asset search (asynchronous) - Group scope (Early Access)
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: group_id
          in: path
          type: string
          description: The unique identifier of the group
          required: true
        - name: version
          in: query
          type: string
          description: The requested API version
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: groups-group_id-inventory-assets-searches-search_id-results
      path: /groups/{group_id}/inventory/assets/searches/{search_id}/results
      operations:
      - name: getassetsearchresultsgroup
        method: GET
        description: Retrieve asset search results (asynchronous) - Group scope (Early Access)
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: group_id
          in: path
          type: string
          description: The unique identifier of the group
          required: true
        - name: version
          in: query
          type: string
          description: The requested API version
        - name: sort
          in: query
          type: string
          description: Sort order for results (e.g., -created_at for descending)
        - name: limit
          in: query
          type: integer
          description: Maximum number of results to return
        - name: starting_after
          in: query
          type: string
          description: Cursor for forward pagination
        - name: ending_before
          in: query
          type: string
          description: Cursor for backward pagination
    - name: groups-group_id-inventory-assets-asset_id
      path: /groups/{group_id}/inventory/assets/{asset_id}
      operations:
      - name: getassetgroup
        method: GET
        description: Get a single asset by ID - Group scope (Early Access)
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: group_id
          in: path
          type: string
          description: The unique identifier of the group
          required: true
        - name: asset_id
          in: path
          type: string
          description: The unique identifier of the asset
          required: true
        - name: version
          in: query
          type: string
          description: The requested API version
      - name: updateassetgroup
        method: PATCH
        description: Update asset attributes - Group scope (Early Access)
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: group_id
          in: path
          type: string
          description: The unique identifier of the group
          required: true
        - name: asset_id
          in: path
          type: string
          description: The unique identifier of the asset
          required: true
        - name: version
          in: query
          type: string
          description: The requested API version
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: groups-group_id-inventory-assets-asset_id-relationships-projects
      path: /groups/{group_id}/inventory/assets/{asset_id}/relationships/projects
      operations:
      - name: listassetprojectsgroup
        method: GET
        description: List projects for an asset (group scope) (Early Access)
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: group_id
          in: path
          type: string
          description: The unique identifier of the group
          required: true
        - name: asset_id
          in: path
          type: string
          description: The unique identifier of the asset
          required: true
        - name: version
          in: query
          type: string
          description: The requested API version
        - name: starting_after
          in: query
          type: string
          description: Cursor for fetching the next page of results
        - name: ending_before
          in: query
          type: string
          description: Cursor for fetching the previous page of results
        - name: limit
          in: query
          type: integer
          description: Maximum number of results to return per page
        - name: canonical
          in: query
          type: string
          description: Filter projects by canonical status.
        - name: target_id
          in: query
          type: string
          description: Filter projects by target ID. When provided, returns only projects that belong to
    - name: groups-group_id-inventory-assets-asset_id-relationships-targets
      path: /groups/{group_id}/inventory/assets/{asset_id}/relationships/targets
      operations:
      - name: listassettargetsgroup
        method: GET
        description: List targets for an asset (group scope) (Early Access)
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: group_id
          in: path
          type: string
          description: The unique identifier of the group
          required: true
        - name: asset_id
          in: path
          type: string
          description: The unique identifier of the asset
          required: true
        - name: version
          in: query
          type: string
          description: The requested API version
        - name: starting_after
          in: query
          type: string
          description: Cursor for fetching the next page of results
        - name: ending_before
          in: query
          type: string
          description: Cursor for fetching the previous page of results
        - name: limit
          in: query
          type: integer
          description: Maximum number of results to return per page
    - name: orgs-org_id-inventory-assets
      path: /orgs/{org_id}/inventory/assets
      operations:
      - name: listassetsorg
        method: GET
        description: List or search all assets (synchronous) - Org scope (Early Access)
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: org_id
          in: path
          type: string
          description: The unique identifier of the organization
          required: true
        - name: version
          in: query
          type: string
          description: The requested API version
        - name: sort
          in: query
          type: string
          description: Comma-separated sort fields. Prefix with `-` for descending order.
        - name: limit
          in: query
          type: integer
          description: Number of results to return per page
        - name: starting_after
          in: query
          type: string
          description: Cursor for fetching the next page of results
        - name: ending_before
          in: query
          type: string
          description: Cursor for fetching the previous page of results
      - name: updateassetsbulkorg
        method: PATCH
        description: Bulk update asset attributes - Org scope (Early Access)
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: org_id
          in: path
          type: string
          description: The unique identifier of the organization
          required: true
        - name: version
          in: query
          type: string
          description: The requested API version
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: orgs-org_id-inventory-assets-filters
      path: /orgs/{org_id}/inventory/assets/filters
      operations:
      - name: getfilterfieldsorg
        method: GET
        description: Get available filter fields - Org scope (Early Access)
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: org_id
          in: path
          type: string
          description: The unique identifier of the organization
          required: true
        - name: version
          in: query
          type: string
          description: The requested API version
        - name: asset_types
          in: query
          type: string
          description: Comma-separated list of asset types to filter the available filter fields
        - name: limit
          in: query
          type: integer
          description: Number of results to return
        - name: starting_after
          in: query
          type: string
          description: Cursor for fetching the next page of results
        - name: ending_before
          in: query
          type: string
          description: Cursor for fetching the previous page of results
    - name: orgs-org_id-inventory-assets-filters-filter_id-values
      path: /orgs/{org_id}/inventory/assets/filters/{filter_id}/values
      operations:
      - name: getfiltervaluesorg
        method: GET
        description: Get filter value suggestions (autocomplete) - Org scope (Early Access)
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: org_id
          in: path
          type: string
          description: The unique identifier of the organization
          required: true
        - name: version
          in: query
          type: string
          description: The requested API version
        - name: filter_id
          in: path
          type: string
          description: The UUID of the filter field to get values for (from the filter fields list endpoint)
          required: true
        - name: q
          in: query
          type: string
          description: Full text search term to filter the list of values. If keys_only is true, this will filter the keys
            of the object filter values. If key is provided, this will f
        - name: limit
          in: query
          type: integer
          description: Number of results to return
        - name: starting_after
          in: query
          type: string
          description: Cursor for fetching the next page of results
        - name: ending_before
          in: query
          type: string
          description: Cursor for fetching the previous page of results
        - name: keys_only
          in: query
          type: boolean
          description: Return only the keys of the object filter values
        - name: key
          in: query
          type: string
          description: Return only the value for a specific key of the object filter values
    - name: orgs-org_id-inventory-assets-groups
      path: /orgs/{org_id}/inventory/assets/groups
      operations:
      - name: getgroupfieldsorg
        method: GET
        description: Get available group fields - Org scope (Early Access)
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: org_id
          in: path
          type: string
          description: The unique identifier of the organization
          required: true
        - name: version
          in: query
          type: string
          description: The requested API version
        - name: asset_types
          in: query
          type: string
          description: Comma-separated list of asset types to filter group fields
        - name: limit
          in: query
          type: integer
          description: Maximum number of results to return
        - name: starting_after
          in: query
          type: string
          description: Cursor for forward pagination
        - name: ending_before
          in: query
          type: string
          description: Cursor for backward pagination
    - name: orgs-org_id-inventory-assets-groups-group_field_id-values
      path: /orgs/{org_id}/inventory/assets/groups/{group_field_id}/values
      operations:
      - name: getgroupvaluesorg
        method: GET
        description: Get group value aggregation - Org scope (Early Access)
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: org_id
          in: path
          type: string
          description: The unique identifier of the organization
          required: true
        - name: version
          in: query
          type: string
          description: The requested API version
        - name: group_field_id
          in: path
          type: string
          description: The UUID of the group field to get values for (from the group fields list endpoint)
          required: true
        - name: asset_types
          in: query
          type: string
          description: Comma-separated list of asset types to filter the aggregation
        - name: limit
          in: query
          type: integer
          description: Maximum number of group values to return
        - name: starting_after
          in: query
          type: string
          description: Cursor for forward pagination
        - name: ending_before
          in: query
          type: string
          description: Cursor for backward pagination
    - name: orgs-org_id-inventory-assets-searches
      path: /orgs/{org_id}/inventory/assets/searches
      operations:
      - name: createassetsearchorg
        method: POST
        description: Create an asset search (asynchronous) - Org scope (Early Access)
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: org_id
          in: path
          type: string
          description: The unique identifier of the organization
          required: true
        - name: version
          in: query
          type: string
          description: The requested API version
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: orgs-org_id-inventory-assets-searches-search_id-results
      path: /orgs/{org_id}/inventory/assets/searches/{search_id}/results
      operations:
      - name: getassetsearchresultsorg
        method: GET
        description: Retrieve asset search results (asynchronous) - Org scope (Early Access)
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: org_id
          in: path
          type: string
          description: The unique identifier of the organization
          required: true
        - name: version
          in: query
          type: string
          description: The requested API version
        - name: sort
          in: query
          type: string
          description: Sort order for results (e.g., -created_at for descending)
        - name: limit
          in: query
          type: integer
          description: Maximum number of results to return
        - name: starting_after
          in: query
          type: string
          description: Cursor for forward pagination
        - name: ending_before
          in: query
          type: string
          description: Cursor for backward pagination
    - name: orgs-org_id-inventory-assets-asset_id
      path: /orgs/{org_id}/inventory/assets/{asset_id}
      operations:
      - name: getassetorg
        method: GET
        description: Get a single asset by ID - Org scope (Early Access)
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: org_id
          in: path
          type: string
          description: The unique identifier of the organization
          required: true
        - name: asset_id
          in: path
          type: string
          description: The unique identifier of the asset
          required: true
        - name: version
          in: query
          type: string
          description: The requested API version
      - name: updateassetorg
        method: PATCH
        description: Update asset attributes - Org scope (Early Access)
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: org_id
          in: path
          type: string
          description: The unique identifier of the organization
          required: true
        - name: asset_id
          in: path
          type: string
          description: The unique identifier of the asset
          required: true
        - name: version
          in: query
          type: string
          description: The requested API version
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: orgs-org_id-inventory-assets-asset_id-relationships-projects
      path: /orgs/{org_id}/inventory/assets/{asset_id}/relationships/projects
      operations:
      - name: listassetprojectsorg
        method: GET
        description: List projects for an asset (org scope) (Early Access)
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: org_id
          in: path
          type: string
          description: The unique identifier of the organization
          required: true
        - name: asset_id
          in: path
          type: string
          description: The unique identifier of the asset
          required: true
        - name: version
          in: query
          type: string
          description: The requested API version
        - name: starting_after
          in: query
          type: string
          description: Cursor for fetching the next page of results
        - name: ending_before
          in: query
          type: string
          description: Cursor for fetching the previous page of results
        - name: limit
          in: query
          type: integer
          description: Maximum number of results to return per page
        - name: canonical
          in: query
          type: string
          description: Filter projects by canonical status.
        - name: target_id
          in: query
          type: string
          description: Filter projects by target ID. When provided, returns only projects that belong to
    - name: orgs-org_id-inventory-assets-asset_id-relationships-targets
      path: /orgs/{org_id}/inventory/assets/{asset_id}/relationships/targets
      operations:
      - name: listassettargetsorg
        method: GET
        description: List targets for an asset (org scope) (Early Access)
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: org_id
          in: path
          type: string
          description: The unique identifier of the organization
          required: true
        - name: asset_id
          in: path
          type: string
          description: The unique identifier of the asset
          required: true
        - name: version
          in: query
          type: string
          description: The requested API version
        - name: starting_after
          in: query
          type: string
          description: Cursor for fetching the next page of results
        - name: ending_before
          in: query
          type: string
          description: Cursor for fetching the previous page of results
        - name: limit
          in: query
          type: integer
          description: Maximum number of results to return per page
    - name: tenants-tenant_id-inventory-assets
      path: /tenants/{tenant_id}/inventory/assets
      operations:
      - name: listassetstenant
        method: GET
        description: List or search all assets (synchronous) (Early Access)
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: tenant_id
          in: path
          type: string
          description: The unique identifier of the tenant
          required: true
        - name: version
          in: query
          type: string
          description: The requested API version
        - name: sort
          in: query
          type: string
          description: Comma-separated sort fields. Prefix with `-` for descending order.
        - name: limit
          in: query
          type: integer
          description: Number of results to return per page
        - name: starting_after
          in: query
          type: string
          description: Cursor for fetching the next page of results
        - name: ending_before
          in: query
          type: string
          description: Cursor for fetching the previous page of results
      - name: updateassetsbulktenant
        method: PATCH
        description: Bulk update asset attributes (Early Access)
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: tenant_id
          in: path
          type: string
          description: The unique identifier of the tenant
          required: true
        - name: version
          in: query
          type: string
          description: The requested API version
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: tenants-tenant_id-inventory-assets-filters
      path: /tenants/{tenant_id}/inventory/assets/filters
      operations:
      - name: getfilterfieldstenant
        method: GET
        description: Get available filter fields (Early Access)
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: tenant_id
          in: path
          type: string
          description: The unique identifier of the tenant
          required: true
        - name: version
          in: query
          type: string
          description: The requested API version
        - name: asset_types
          in: query
          type: string
          description: Comma-separated list of asset types to filter the available filter fields
        - name: limit
          in: query
          type: integer
          description: Number of results to return
        - name: starting_after
          in: query
          type: string
          description: Cursor for fetching the next page of results
        - name: ending_before
          in: query
          type: string
          description: Cursor for fetching the previous page of results
    - name: tenants-tenant_id-inventory-assets-filters-filter_id-values
      path: /tenants/{tenant_id}/inventory/assets/filters/{filter_id}/values
      operations:
      - name: getfiltervaluestenant
        method: GET
        description: Get filter value suggestions (autocomplete) (Early Access)
        outputRawFormat: json
        outputParameters:
        - name: result
          type: ob

# --- truncated at 32 KB (85 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/snyk/refs/heads/main/capabilities/rest-inventory-assets.yaml