Inventory Assets

This document uses the REST API. For more details, see the Authentication for API page.

Bulk update asset attributes (Early Access)

patch

Partially updates multiple assets in a single request.
Maximum of 100 assets can be updated per request. The operation is transactional - all updates succeed or all fail. Supports updating class, labels (add/remove), and tags (add/remove).

Required permissions

Edit Tenant Details (tenant.edit)

Authorizations

AuthorizationstringRequired

API key value must be prefixed with "Token ".

Path parameters

tenant_idstring · uuidRequired

The unique identifier of the tenant

Query parameters

versionstringOptional

The requested API version

Example: 2024-10-15Pattern: ^\d{4}-\d{2}-\d{2}$

Body

Responses

204

Assets updated successfully

400

Bad Request: A parameter provided as a part of the request was invalid.

application/vnd.api+json

401

Unauthorized: the request requires an authentication token.

application/vnd.api+json

403

Forbidden: the request requires an authentication token with more or different permissions.

application/vnd.api+json

404

Not Found: The resource being operated on could not be found.

application/vnd.api+json

500

Internal Server Error: An error was encountered while attempting to process the request.

application/vnd.api+json

patch

/tenants/{tenant_id}/inventory/assets

PATCH /rest/tenants/{tenant_id}/inventory/assets HTTP/1.1
Host: api.snyk.io
Authorization: YOUR_API_KEY
Content-Type: application/vnd.api+json
Accept: */*
Content-Length: 261

{
  "data": [
    {
      "attributes": {
        "class": {
          "display_name": "A",
          "locked": true,
          "rank": 1
        },
        "labels": {
          "add": [
            "text"
          ],
          "remove": [
            "text"
          ]
        },
        "tags": {
          "add": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "remove": [
            "text"
          ]
        }
      },
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "type": "container_images"
    }
  ]
}

No content

List or search all assets (synchronous) (Early Access)

get

Retrieves a polymorphic list of all asset types for a given tenant. The response includes different asset types (containers, container images, etc.) in a single unified response following the JSON:API specification.

This endpoint supports both simple listing and synchronous search with filtering, sorting, and cursor-based pagination through query parameters.

Required permissions

View Tenant Details (tenant.read)

Authorizations

AuthorizationstringRequired

API key value must be prefixed with "Token ".

Path parameters

tenant_idstring · uuidRequired

The unique identifier of the tenant

Query parameters

versionstringOptional

The requested API version

Example: 2024-10-15Pattern: ^\d{4}-\d{2}-\d{2}$

filterstringOptional

RSQL filter expression for filtering results.

Supported operators:

== (equal), != (not equal)
< or =lt= (less than), > or =gt= (greater than)
<= or =le= (less than or equal), >= or =ge= (greater than or equal)
=in=(val1,val2) (IN list), =out=(val1,val2) (NOT IN list)
; or and (logical AND), , or or (logical OR) - word operators are case-insensitive

Wildcard pattern matching: Use * (asterisk) for flexible string matching with == and != operators:

*value* - Contains (e.g., registry==*docker* matches "docker.io")
value* - Starts with (e.g., registry==docker* matches "docker.io")
*value - Ends with (e.g., name==*nginx matches "library/nginx")
!=*value* - Does not contain (e.g., class!=*test*)

Note: Special SQL characters (%, _) are automatically escaped for security.

Quoted values: Values can optionally be wrapped in single quotes ('...') or double quotes ("..."). Quotes are stripped before comparison, so registry=='docker.io' is equivalent to registry==docker.io. Escaped quotes inside quoted values are supported (e.g., name=="O\"Reilly"). Quoting is required when filtering for empty values (see below).

Filtering for empty values: Use empty quotes ('' or "") with == or != to filter by empty fields:

registry=='' - Matches assets where registry is empty
registry!='' - Matches assets where registry has a value

Multi-field substring search: Use the special q field to search across multiple fields simultaneously using case-insensitive substring matching:

q==<search_term> - Searches across all searchable string fields (labels, tags, registry, repository, name, config_digest, manifest_digest, index_digest, image_tag)
Only supports the == operator (no wildcards needed - automatically searches for substring matches)
Uses case-insensitive pattern matching (PostgreSQL ILIKE)
Does not support linguistic features like stemming or ranking
Special characters are automatically escaped for security
Can be combined with other filters: q==nginx;type==container_images

Supported fields:

Common fields (apply to all asset types):

q (string) - Multi-field substring search (see above)
id (UUID) - Asset ID
type (string) - Type of asset. Allowed values: container_images
class (string) - Class of asset (e.g., A, B)
created_at (timestamp) - Asset creation timestamp (ISO 8601 format)
updated_at (timestamp) - Asset last update timestamp (ISO 8601 format)
labels (string array) - Asset labels
tags (object) - Asset tags. Requires a sub-field (e.g., tags.env==production)

Container image fields (apply when type is container_images):

registry (string) - Container image registry (e.g., docker.io)
repository (string) - Container image repository path
name (string) - Container image name
config_digest (string) - Image config digest
manifest_digest (string) - Distribution manifest digest
index_digest (string) - Distribution index digest
image_tag (string) - Image tag from discovery source
image_labels (object) - OCI image config labels. Requires a sub-field (e.g., image_labels.vendor==nginx)

Examples:

q==nginx - Multi-field substring search for "nginx"
q==docker.io;type==container_images - Search "docker.io" substring in container images only
type==container_images - Exact match on asset type
registry==*docker* - Registry contains "docker" (wildcard)
created_at>2024-01-01 or created_at=gt=2024-01-01 - Date comparison
class==A;created_at=ge=2024-01-01 - AND combination
labels=in=(production,staging) - Labels IN list
tags.env==production - Tag sub-field filter
image_labels.vendor==nginx - Image label sub-field filter
registry=='docker.io' - Quoted value (equivalent to registry==docker.io)
registry=='' - Assets where registry is empty
registry!='' - Assets where registry has a value

Example: type==container_images;created_at>2024-01-01

sortstringOptional

Comma-separated sort fields. Prefix with - for descending order.

Supported fields:

created_at - Asset creation timestamp
updated_at - Asset last update timestamp
type - Asset type (container_images)
class - Asset class
risk_score - Asset risk score (max across project sources)
issues - Issue counts by severity (critical, high, medium, low)
built_at - Image build timestamp (container images only)
last_scan - Last scan timestamp

Example: -created_at

limitinteger · min: 10 · max: 100Optional

Number of results to return per page

Default: 10

starting_afterstringOptional

Cursor for fetching the next page of results

Example: v1.MTIzNDU2Nzg5MHxhYmNkZWY=

ending_beforestringOptional

Cursor for fetching the previous page of results

Example: v1.MTIzNDU2Nzg5MHxhYmNkZWY=

meta_countstring · enumOptional

Provide summary count in the response meta object when requested. When with is provided, the count will be included in the response meta object. When only is provided, the count will be included in the response meta object and no data will be returned.

Example: withPossible values:

Responses

200

Successful response with a polymorphic list of assets

application/vnd.api+json

400

Bad Request: A parameter provided as a part of the request was invalid.

application/vnd.api+json

401

Unauthorized: the request requires an authentication token.

application/vnd.api+json

403

Forbidden: the request requires an authentication token with more or different permissions.

application/vnd.api+json

500

Internal Server Error: An error was encountered while attempting to process the request.

application/vnd.api+json

get

/tenants/{tenant_id}/inventory/assets

GET /rest/tenants/{tenant_id}/inventory/assets HTTP/1.1
Host: api.snyk.io
Authorization: YOUR_API_KEY
Accept: */*

{
  "data": [
    {
      "attributes": {
        "class": {
          "display_name": "A",
          "locked": false,
          "rank": 1
        },
        "created_at": "2026-03-30T19:49:44.485Z",
        "issues": {
          "critical": 1,
          "high": 1,
          "low": 1,
          "medium": 1
        },
        "labels": [
          "text"
        ],
        "last_scan": "2026-03-30T19:49:44.485Z",
        "last_seen_at": "2026-03-30T19:49:44.485Z",
        "risk_score": 1,
        "scan_engines": [
          {
            "issues": {
              "critical": 1,
              "high": 1,
              "low": 1,
              "medium": 1
            },
            "last_seen": "2026-03-30T19:49:44.485Z",
            "link": "https://example.com",
            "name": "text",
            "type": "sca"
          }
        ],
        "tags": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "teams": [
          "text"
        ],
        "test_surfaces": [
          "text"
        ],
        "updated_at": "2026-03-30T19:49:44.485Z",
        "architecture": "386",
        "author": "text",
        "built_at": "2026-03-30T19:49:44.485Z",
        "config": {
          "args_escaped": true,
          "cmd": [
            "text"
          ],
          "entry_point": [
            "text"
          ],
          "env": [
            "text"
          ],
          "exposed_ports": [
            "text"
          ],
          "labels": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "stop_signal": "text",
          "user": "text",
          "volumes": [
            "text"
          ],
          "working_dir": "text"
        },
        "config_digest": "text",
        "distribution_digests": [
          {
            "index_digest": "text",
            "manifest_digest": "text"
          }
        ],
        "history": [
          {
            "author": "text",
            "comment": "text",
            "created_at": "2026-03-30T19:49:44.485Z",
            "created_by": "text",
            "empty_layer": true
          }
        ],
        "image_tags": [
          "text"
        ],
        "inferred_base_images": [
          "text"
        ],
        "os": "aix",
        "os_features": [
          "text"
        ],
        "os_version": "text",
        "registry": "text",
        "repository": "text",
        "root_fs": {
          "diff_ids": [
            "text"
          ],
          "type": "text"
        },
        "size_bytes": 1,
        "total_image_tags": 1,
        "variant": "text"
      },
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "links": {
        "self": "https://example.com"
      },
      "relationships": {
        "projects": {
          "links": {
            "related": "text"
          }
        },
        "targets": {
          "links": {
            "related": "text"
          }
        }
      },
      "type": "container_images"
    }
  ],
  "links": {
    "first": "https://example.com",
    "next": "https://example.com",
    "prev": "https://example.com",
    "self": "https://example.com"
  },
  "meta": {
    "count": 1
  }
}

Update asset attributes (Early Access)

patch

Partially updates an asset's attributes. Supports updating class, labels (add/remove), and tags (add/remove). At least one attribute must be provided in the request.

Required permissions

Edit Tenant Details (tenant.edit)

Authorizations

AuthorizationstringRequired

API key value must be prefixed with "Token ".

Path parameters

tenant_idstring · uuidRequired

The unique identifier of the tenant

asset_idstring · uuidRequired

The unique identifier of the asset

Query parameters

versionstringOptional

The requested API version

Example: 2024-10-15Pattern: ^\d{4}-\d{2}-\d{2}$

Body

Responses

200

Asset updated successfully

application/vnd.api+json

400

Bad Request: A parameter provided as a part of the request was invalid.

application/vnd.api+json

401

Unauthorized: the request requires an authentication token.

application/vnd.api+json

403

Forbidden: the request requires an authentication token with more or different permissions.

application/vnd.api+json

404

Not Found: The resource being operated on could not be found.

application/vnd.api+json

500

Internal Server Error: An error was encountered while attempting to process the request.

application/vnd.api+json

patch

/tenants/{tenant_id}/inventory/assets/{asset_id}

PATCH /rest/tenants/{tenant_id}/inventory/assets/{asset_id} HTTP/1.1
Host: api.snyk.io
Authorization: YOUR_API_KEY
Content-Type: application/vnd.api+json
Accept: */*
Content-Length: 259

{
  "data": {
    "attributes": {
      "class": {
        "display_name": "A",
        "locked": true,
        "rank": 1
      },
      "labels": {
        "add": [
          "text"
        ],
        "remove": [
          "text"
        ]
      },
      "tags": {
        "add": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "remove": [
          "text"
        ]
      }
    },
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "type": "container_images"
  }
}

{
  "data": {
    "attributes": {
      "class": {
        "display_name": "A",
        "locked": false,
        "rank": 1
      },
      "created_at": "2026-03-30T19:49:44.485Z",
      "issues": {
        "critical": 1,
        "high": 1,
        "low": 1,
        "medium": 1
      },
      "labels": [
        "text"
      ],
      "last_scan": "2026-03-30T19:49:44.485Z",
      "last_seen_at": "2026-03-30T19:49:44.485Z",
      "risk_score": 1,
      "scan_engines": [
        {
          "issues": {
            "critical": 1,
            "high": 1,
            "low": 1,
            "medium": 1
          },
          "last_seen": "2026-03-30T19:49:44.485Z",
          "link": "https://example.com",
          "name": "text",
          "type": "sca"
        }
      ],
      "tags": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "teams": [
        "text"
      ],
      "test_surfaces": [
        "text"
      ],
      "updated_at": "2026-03-30T19:49:44.485Z",
      "architecture": "386",
      "author": "text",
      "built_at": "2026-03-30T19:49:44.485Z",
      "config": {
        "args_escaped": true,
        "cmd": [
          "text"
        ],
        "entry_point": [
          "text"
        ],
        "env": [
          "text"
        ],
        "exposed_ports": [
          "text"
        ],
        "labels": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "stop_signal": "text",
        "user": "text",
        "volumes": [
          "text"
        ],
        "working_dir": "text"
      },
      "config_digest": "text",
      "distribution_digests": [
        {
          "index_digest": "text",
          "manifest_digest": "text"
        }
      ],
      "history": [
        {
          "author": "text",
          "comment": "text",
          "created_at": "2026-03-30T19:49:44.485Z",
          "created_by": "text",
          "empty_layer": true
        }
      ],
      "image_tags": [
        "text"
      ],
      "inferred_base_images": [
        "text"
      ],
      "os": "aix",
      "os_features": [
        "text"
      ],
      "os_version": "text",
      "registry": "text",
      "repository": "text",
      "root_fs": {
        "diff_ids": [
          "text"
        ],
        "type": "text"
      },
      "size_bytes": 1,
      "total_image_tags": 1,
      "variant": "text"
    },
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "links": {
      "self": "https://example.com"
    },
    "relationships": {
      "projects": {
        "links": {
          "related": "text"
        }
      },
      "targets": {
        "links": {
          "related": "text"
        }
      }
    },
    "type": "container_images"
  },
  "jsonapi": {
    "version": "1.0"
  },
  "links": {
    "self": "https://example.com"
  }
}

Get a single asset by ID (Early Access)

get

Retrieves a single asset by its unique identifier. The response includes the asset's details in JSON:API format. The asset type is determined from the database and the appropriate details are returned polymorphically.

Required permissions

View Tenant Details (tenant.read)

Authorizations

AuthorizationstringRequired

API key value must be prefixed with "Token ".

Path parameters

tenant_idstring · uuidRequired

The unique identifier of the tenant

asset_idstring · uuidRequired

The unique identifier of the asset

Query parameters

versionstringOptional

The requested API version

Example: 2024-10-15Pattern: ^\d{4}-\d{2}-\d{2}$

Responses

200

Asset retrieved successfully

application/vnd.api+json

400

Bad Request: A parameter provided as a part of the request was invalid.

application/vnd.api+json

401

Unauthorized: the request requires an authentication token.

application/vnd.api+json

403

Forbidden: the request requires an authentication token with more or different permissions.

application/vnd.api+json

404

Not Found: The resource being operated on could not be found.

application/vnd.api+json

500

Internal Server Error: An error was encountered while attempting to process the request.

application/vnd.api+json

get

/tenants/{tenant_id}/inventory/assets/{asset_id}

GET /rest/tenants/{tenant_id}/inventory/assets/{asset_id} HTTP/1.1
Host: api.snyk.io
Authorization: YOUR_API_KEY
Accept: */*

{
  "data": {
    "attributes": {
      "class": {
        "display_name": "A",
        "locked": false,
        "rank": 1
      },
      "created_at": "2026-03-30T19:49:44.485Z",
      "issues": {
        "critical": 1,
        "high": 1,
        "low": 1,
        "medium": 1
      },
      "labels": [
        "text"
      ],
      "last_scan": "2026-03-30T19:49:44.485Z",
      "last_seen_at": "2026-03-30T19:49:44.485Z",
      "risk_score": 1,
      "scan_engines": [
        {
          "issues": {
            "critical": 1,
            "high": 1,
            "low": 1,
            "medium": 1
          },
          "last_seen": "2026-03-30T19:49:44.485Z",
          "link": "https://example.com",
          "name": "text",
          "type": "sca"
        }
      ],
      "tags": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "teams": [
        "text"
      ],
      "test_surfaces": [
        "text"
      ],
      "updated_at": "2026-03-30T19:49:44.485Z",
      "architecture": "386",
      "author": "text",
      "built_at": "2026-03-30T19:49:44.485Z",
      "config": {
        "args_escaped": true,
        "cmd": [
          "text"
        ],
        "entry_point": [
          "text"
        ],
        "env": [
          "text"
        ],
        "exposed_ports": [
          "text"
        ],
        "labels": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "stop_signal": "text",
        "user": "text",
        "volumes": [
          "text"
        ],
        "working_dir": "text"
      },
      "config_digest": "text",
      "distribution_digests": [
        {
          "index_digest": "text",
          "manifest_digest": "text"
        }
      ],
      "history": [
        {
          "author": "text",
          "comment": "text",
          "created_at": "2026-03-30T19:49:44.485Z",
          "created_by": "text",
          "empty_layer": true
        }
      ],
      "image_tags": [
        "text"
      ],
      "inferred_base_images": [
        "text"
      ],
      "os": "aix",
      "os_features": [
        "text"
      ],
      "os_version": "text",
      "registry": "text",
      "repository": "text",
      "root_fs": {
        "diff_ids": [
          "text"
        ],
        "type": "text"
      },
      "size_bytes": 1,
      "total_image_tags": 1,
      "variant": "text"
    },
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "links": {
      "self": "https://example.com"
    },
    "relationships": {
      "projects": {
        "links": {
          "related": "text"
        }
      },
      "targets": {
        "links": {
          "related": "text"
        }
      }
    },
    "type": "container_images"
  },
  "links": {
    "self": "https://example.com"
  }
}

List targets for an asset (Early Access)

get

Retrieves a paginated list of Snyk targets linked to this asset with full attributes. Returns the id, type, and attributes of each related target.

Required permissions

View Tenant Details (tenant.read)

Authorizations

AuthorizationstringRequired

API key value must be prefixed with "Token ".

Path parameters

tenant_idstring · uuidRequired

The unique identifier of the tenant

asset_idstring · uuidRequired

The unique identifier of the asset

Query parameters

versionstringOptional

The requested API version

Example: 2024-10-15Pattern: ^\d{4}-\d{2}-\d{2}$

starting_afterstringOptional

Cursor for fetching the next page of results

ending_beforestringOptional

Cursor for fetching the previous page of results

limitinteger · min: 10 · max: 100Optional

Maximum number of results to return per page

Default: 10

Responses

200

Successfully retrieved linked targets

application/vnd.api+json

400

Bad Request: A parameter provided as a part of the request was invalid.

application/vnd.api+json

401

Unauthorized: the request requires an authentication token.

application/vnd.api+json

403

Forbidden: the request requires an authentication token with more or different permissions.

application/vnd.api+json

404

Not Found: The resource being operated on could not be found.

application/vnd.api+json

500

Internal Server Error: An error was encountered while attempting to process the request.

application/vnd.api+json

get

/tenants/{tenant_id}/inventory/assets/{asset_id}/relationships/targets

GET /rest/tenants/{tenant_id}/inventory/assets/{asset_id}/relationships/targets HTTP/1.1
Host: api.snyk.io
Authorization: YOUR_API_KEY
Accept: */*

{
  "data": [
    {
      "attributes": {
        "imported_at": "2026-03-30T19:49:44.485Z",
        "integration_id": "123e4567-e89b-12d3-a456-426614174000",
        "target_file": "text",
        "target_origin": "text",
        "target_ref": "text"
      },
      "id": "66666666-7777-8888-9999-000000000000",
      "type": "target"
    }
  ],
  "jsonapi": {
    "version": "1.0"
  },
  "links": {
    "related": "https://example.com",
    "self": "https://example.com",
    "first": "https://example.com",
    "next": "https://example.com",
    "prev": "https://example.com"
  }
}

List projects for an asset (Early Access)

get

Retrieves a paginated list of Snyk projects linked to this asset with full attributes. Returns the id, type, and attributes of each related project.

Required permissions

View Tenant Details (tenant.read)

Authorizations

AuthorizationstringRequired

API key value must be prefixed with "Token ".

Path parameters

tenant_idstring · uuidRequired

The unique identifier of the tenant

asset_idstring · uuidRequired

The unique identifier of the asset

Query parameters

versionstringOptional

The requested API version

Example: 2024-10-15Pattern: ^\d{4}-\d{2}-\d{2}$

starting_afterstringOptional

Cursor for fetching the next page of results

ending_beforestringOptional

Cursor for fetching the previous page of results

limitinteger · min: 10 · max: 100Optional

Maximum number of results to return per page

Default: 10

canonicalstring · enumOptional

Filter projects by canonical status.

with: Returns all projects (canonical attribute is populated).
only: Returns only canonical projects (those used for vulnerability counts).
none: Returns only non-canonical projects. When omitted, returns all projects without canonical filtering.

Possible values:

target_idstring · uuidOptional

Filter projects by target ID. When provided, returns only projects that belong to the specified target. When omitted, returns projects from all targets.

Responses

200

Successfully retrieved linked projects

application/vnd.api+json

400

Bad Request: A parameter provided as a part of the request was invalid.

application/vnd.api+json

401

Unauthorized: the request requires an authentication token.

application/vnd.api+json

403

Forbidden: the request requires an authentication token with more or different permissions.

application/vnd.api+json

404

Not Found: The resource being operated on could not be found.

application/vnd.api+json

500

Internal Server Error: An error was encountered while attempting to process the request.

application/vnd.api+json

get

/tenants/{tenant_id}/inventory/assets/{asset_id}/relationships/projects

GET /rest/tenants/{tenant_id}/inventory/assets/{asset_id}/relationships/projects HTTP/1.1
Host: api.snyk.io
Authorization: YOUR_API_KEY
Accept: */*

{
  "data": [
    {
      "attributes": {
        "base_image_remediation": {
          "base_image": {
            "issues_by_severity": {
              "critical": 1,
              "high": 1,
              "low": 1,
              "medium": 1
            },
            "name": "text",
            "repo": "text",
            "tag": "text",
            "total_issues": 1
          },
          "base_image_name": "text",
          "base_image_outdated": true,
          "code": "text",
          "distro_alert": "text",
          "proposed_base_images": {
            "alternative_upgrade": [
              {
                "issues_by_severity": {
                  "critical": 1,
                  "high": 1,
                  "low": 1,
                  "medium": 1
                },
                "name": "text",
                "repo": "text",
                "tag": "text",
                "total_issues": 1
              }
            ],
            "major_upgrade": [
              {
                "issues_by_severity": {
                  "critical": 1,
                  "high": 1,
                  "low": 1,
                  "medium": 1
                },
                "name": "text",
                "repo": "text",
                "tag": "text",
                "total_issues": 1
              }
            ],
            "minor_upgrade": [
              {
                "issues_by_severity": {
                  "critical": 1,
                  "high": 1,
                  "low": 1,
                  "medium": 1
                },
                "name": "text",
                "repo": "text",
                "tag": "text",
                "total_issues": 1
              }
            ]
          }
        },
        "is_canonical": true,
        "issues": {
          "critical": 1,
          "high": 1,
          "low": 1,
          "medium": 1
        },
        "monitor_created_at": "2026-03-30T19:49:44.485Z",
        "monitor_id": "123e4567-e89b-12d3-a456-426614174000",
        "org_id": "123e4567-e89b-12d3-a456-426614174000",
        "project_type": "rubygems",
        "risk_score": 1,
        "snapshot_created_at": "2026-03-30T19:49:44.485Z",
        "snapshot_id": "123e4567-e89b-12d3-a456-426614174000",
        "target_file": "text",
        "target_id": "123e4567-e89b-12d3-a456-426614174000",
        "target_origin": "text",
        "target_ref": "text"
      },
      "id": "11111111-2222-3333-4444-555555555555",
      "type": "project"
    }
  ],
  "jsonapi": {
    "version": "1.0"
  },
  "links": {
    "related": "https://example.com",
    "self": "https://example.com",
    "first": "https://example.com",
    "next": "https://example.com",
    "prev": "https://example.com"
  }
}

Create an asset search (asynchronous) (Early Access)

post

Initiates an asynchronous search for assets and returns a redirect to the search results endpoint

Required permissions

View Tenant Details (tenant.read)

Authorizations

AuthorizationstringRequired

API key value must be prefixed with "Token ".

Path parameters

tenant_idstring · uuidRequired

The unique identifier of the tenant

Query parameters

versionstringOptional

The requested API version

Example: 2024-10-15Pattern: ^\d{4}-\d{2}-\d{2}$

Body

Responses

302

Found - Redirects to search results endpoint

application/vnd.api+json

400

Bad Request: A parameter provided as a part of the request was invalid.

application/vnd.api+json

500

Internal Server Error: An error was encountered while attempting to process the request.

application/vnd.api+json

post

/tenants/{tenant_id}/inventory/assets/searches

POST /rest/tenants/{tenant_id}/inventory/assets/searches HTTP/1.1
Host: api.snyk.io
Authorization: YOUR_API_KEY
Content-Type: application/vnd.api+json
Accept: */*
Content-Length: 151

{
  "data": {
    "attributes": {
      "filter": "type==container_images;created_at>2024-01-01",
      "limit": 10,
      "meta_count": "with",
      "sort": "-created_at"
    },
    "type": "searches"
  }
}

{
  "jsonapi": {
    "version": "text"
  }
}

Retrieve asset search results (asynchronous) (Early Access)

get

Gets paginated results for a previously initiated asset search

Required permissions

View Tenant Details (tenant.read)

Authorizations

AuthorizationstringRequired

API key value must be prefixed with "Token ".

Path parameters

tenant_idstring · uuidRequired

The unique identifier of the tenant

search_idstring · uuidRequired

The unique identifier of the search operation

Query parameters

versionstringOptional

The requested API version

Example: 2024-10-15Pattern: ^\d{4}-\d{2}-\d{2}$

sortstringOptional

Comma-separated sort fields. Prefix with - for descending order.

Supported fields:

created_at - Asset creation timestamp
updated_at - Asset last update timestamp
type - Asset type (container_images)
class - Asset class
risk_score - Asset risk score (max across project sources)
issues - Issue counts by severity (critical, high, medium, low)
built_at - Image build timestamp (container images only)
last_scan - Last scan timestamp

Example: -created_at

limitinteger · min: 10 · max: 100Optional

Number of results to return

Default: 10

starting_afterstringOptional

Cursor for next page

ending_beforestringOptional

Cursor for previous page

Responses

200

Search results retrieved successfully

application/vnd.api+json

404

Not Found: The resource being operated on could not be found.

application/vnd.api+json

500

Internal Server Error: An error was encountered while attempting to process the request.

application/vnd.api+json

get

/tenants/{tenant_id}/inventory/assets/searches/{search_id}/results

GET /rest/tenants/{tenant_id}/inventory/assets/searches/{search_id}/results HTTP/1.1
Host: api.snyk.io
Authorization: YOUR_API_KEY
Accept: */*

{
  "data": [
    {
      "attributes": {
        "class": {
          "display_name": "A",
          "locked": false,
          "rank": 1
        },
        "created_at": "2026-03-30T19:49:44.485Z",
        "issues": {
          "critical": 1,
          "high": 1,
          "low": 1,
          "medium": 1
        },
        "labels": [
          "text"
        ],
        "last_scan": "2026-03-30T19:49:44.485Z",
        "last_seen_at": "2026-03-30T19:49:44.485Z",
        "risk_score": 1,
        "scan_engines": [
          {
            "issues": {
              "critical": 1,
              "high": 1,
              "low": 1,
              "medium": 1
            },
            "last_seen": "2026-03-30T19:49:44.485Z",
            "link": "https://example.com",
            "name": "text",
            "type": "sca"
          }
        ],
        "tags": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "teams": [
          "text"
        ],
        "test_surfaces": [
          "text"
        ],
        "updated_at": "2026-03-30T19:49:44.485Z",
        "architecture": "386",
        "author": "text",
        "built_at": "2026-03-30T19:49:44.485Z",
        "config": {
          "args_escaped": true,
          "cmd": [
            "text"
          ],
          "entry_point": [
            "text"
          ],
          "env": [
            "text"
          ],
          "exposed_ports": [
            "text"
          ],
          "labels": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "stop_signal": "text",
          "user": "text",
          "volumes": [
            "text"
          ],
          "working_dir": "text"
        },
        "config_digest": "text",
        "distribution_digests": [
          {
            "index_digest": "text",
            "manifest_digest": "text"
          }
        ],
        "history": [
          {
            "author": "text",
            "comment": "text",
            "created_at": "2026-03-30T19:49:44.485Z",
            "created_by": "text",
            "empty_layer": true
          }
        ],
        "image_tags": [
          "text"
        ],
        "inferred_base_images": [
          "text"
        ],
        "os": "aix",
        "os_features": [
          "text"
        ],
        "os_version": "text",
        "registry": "text",
        "repository": "text",
        "root_fs": {
          "diff_ids": [
            "text"
          ],
          "type": "text"
        },
        "size_bytes": 1,
        "total_image_tags": 1,
        "variant": "text"
      },
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "links": {
        "self": "https://example.com"
      },
      "relationships": {
        "projects": {
          "links": {
            "related": "text"
          }
        },
        "targets": {
          "links": {
            "related": "text"
          }
        }
      },
      "type": "container_images"
    }
  ],
  "links": {
    "first": "https://example.com",
    "next": "https://example.com",
    "prev": "https://example.com",
    "self": "https://example.com"
  },
  "meta": {
    "count": 1
  }
}

Get available group fields (Early Access)

get

Returns a list of valid group field names that can be used for grouping assets. Each field includes its name, data type, and which asset types it applies to.

Required permissions

View Tenant Details (tenant.read)

Authorizations

AuthorizationstringRequired

API key value must be prefixed with "Token ".

Path parameters

tenant_idstring · uuidRequired

The unique identifier of the tenant

Query parameters

versionstringOptional

The requested API version

Example: 2024-10-15Pattern: ^\d{4}-\d{2}-\d{2}$

asset_typesstringOptional

Comma-separated list of asset types to filter the available group fields

Example: container_images

limitinteger · min: 10 · max: 100Optional

Number of results to return

Default: 10

starting_afterstringOptional

Cursor for fetching the next page of results

ending_beforestringOptional

Cursor for fetching the previous page of results

Responses

200

List of available group fields

application/vnd.api+json

400

Bad Request: A parameter provided as a part of the request was invalid.

application/vnd.api+json

401

Unauthorized: the request requires an authentication token.

application/vnd.api+json

403

Forbidden: the request requires an authentication token with more or different permissions.

application/vnd.api+json

500

Internal Server Error: An error was encountered while attempting to process the request.

application/vnd.api+json

get

/tenants/{tenant_id}/inventory/assets/groups

GET /rest/tenants/{tenant_id}/inventory/assets/groups HTTP/1.1
Host: api.snyk.io
Authorization: YOUR_API_KEY
Accept: */*

{
  "data": [
    {
      "attributes": {
        "asset_types": [
          "text"
        ],
        "name": "text"
      },
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "relationships": {
        "values": {
          "links": {
            "related": "../folder"
          }
        }
      },
      "type": "group_fields"
    }
  ],
  "links": {
    "self": "https://example.com"
  }
}

Get group value aggregation (Early Access)

get

Returns aggregated values for a specific group field id, showing the count of assets for each distinct value.

Use the UUID from the group fields list endpoint to identify which field to query.

Required permissions

View Tenant Details (tenant.read)

Authorizations

AuthorizationstringRequired

API key value must be prefixed with "Token ".

Path parameters

tenant_idstring · uuidRequired

The unique identifier of the tenant

group_field_idstring · uuidRequired

The UUID of the group field to get values for (from the group fields list endpoint)

Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6

Query parameters

versionstringOptional

The requested API version

Example: 2024-10-15Pattern: ^\d{4}-\d{2}-\d{2}$

asset_typesstringOptional

Comma-separated list of asset types to filter the aggregation

Example: container_images

filterstringOptional

RSQL filter expression for filtering results.

Supported operators:

== (equal), != (not equal)
< or =lt= (less than), > or =gt= (greater than)
<= or =le= (less than or equal), >= or =ge= (greater than or equal)
=in=(val1,val2) (IN list), =out=(val1,val2) (NOT IN list)
; or and (logical AND), , or or (logical OR) - word operators are case-insensitive

Wildcard pattern matching: Use * (asterisk) for flexible string matching with == and != operators:

*value* - Contains (e.g., registry==*docker* matches "docker.io")
value* - Starts with (e.g., registry==docker* matches "docker.io")
*value - Ends with (e.g., name==*nginx matches "library/nginx")
!=*value* - Does not contain (e.g., class!=*test*)

Note: Special SQL characters (%, _) are automatically escaped for security.

Filtering for empty values: Use empty quotes ('' or "") with == or != to filter by empty fields:

registry=='' - Matches assets where registry is empty
registry!='' - Matches assets where registry has a value

Multi-field substring search: Use the special q field to search across multiple fields simultaneously using case-insensitive substring matching:

q==<search_term> - Searches across all searchable string fields (labels, tags, registry, repository, name, config_digest, manifest_digest, index_digest, image_tag)
Only supports the == operator (no wildcards needed - automatically searches for substring matches)
Uses case-insensitive pattern matching (PostgreSQL ILIKE)
Does not support linguistic features like stemming or ranking
Special characters are automatically escaped for security
Can be combined with other filters: q==nginx;type==container_images

Supported fields:

Common fields (apply to all asset types):

q (string) - Multi-field substring search (see above)
id (UUID) - Asset ID
type (string) - Type of asset. Allowed values: container_images
class (string) - Class of asset (e.g., A, B)
created_at (timestamp) - Asset creation timestamp (ISO 8601 format)
updated_at (timestamp) - Asset last update timestamp (ISO 8601 format)
labels (string array) - Asset labels
tags (object) - Asset tags. Requires a sub-field (e.g., tags.env==production)

Container image fields (apply when type is container_images):

registry (string) - Container image registry (e.g., docker.io)
repository (string) - Container image repository path
name (string) - Container image name
config_digest (string) - Image config digest
manifest_digest (string) - Distribution manifest digest
index_digest (string) - Distribution index digest
image_tag (string) - Image tag from discovery source
image_labels (object) - OCI image config labels. Requires a sub-field (e.g., image_labels.vendor==nginx)

Examples:

q==nginx - Multi-field substring search for "nginx"
q==docker.io;type==container_images - Search "docker.io" substring in container images only
type==container_images - Exact match on asset type
registry==*docker* - Registry contains "docker" (wildcard)
created_at>2024-01-01 or created_at=gt=2024-01-01 - Date comparison
class==A;created_at=ge=2024-01-01 - AND combination
labels=in=(production,staging) - Labels IN list
tags.env==production - Tag sub-field filter
image_labels.vendor==nginx - Image label sub-field filter
registry=='docker.io' - Quoted value (equivalent to registry==docker.io)
registry=='' - Assets where registry is empty
registry!='' - Assets where registry has a value

Example: type==container_images;created_at>2024-01-01

sortstringOptional

Comma-separated sort fields for group values. Prefix with - for descending order. Multiple sort fields are supported (e.g., -issues,count). Defaults to count (ascending) when not specified. Results are always tie-broken by value for deterministic ordering.

Available sort fields:

value - Sort by the group value string (alphabetical)
count - Sort by the number of assets in each group
last_seen_at - Sort by the aggregated last_seen_at timestamp
updated_at - Sort by the aggregated updated_at timestamp
risk_score - Sort by the aggregated risk score
issues - Sort by issue severity (critical → high → medium → low)

Example: -count

limitinteger · min: 10 · max: 100Optional

Number of results to return

Default: 10

starting_afterstringOptional

Cursor for fetching the next page of results

ending_beforestringOptional

Cursor for fetching the previous page of results

Responses

200

List of group values with aggregated metadata

application/vnd.api+json

400

Bad Request: A parameter provided as a part of the request was invalid.

application/vnd.api+json

401

Unauthorized: the request requires an authentication token.

application/vnd.api+json

403

Forbidden: the request requires an authentication token with more or different permissions.

application/vnd.api+json

404

Not Found: The resource being operated on could not be found.

application/vnd.api+json

500

Internal Server Error: An error was encountered while attempting to process the request.

application/vnd.api+json

get

/tenants/{tenant_id}/inventory/assets/groups/{group_field_id}/values

GET /rest/tenants/{tenant_id}/inventory/assets/groups/{group_field_id}/values HTTP/1.1
Host: api.snyk.io
Authorization: YOUR_API_KEY
Accept: */*

{
  "data": [
    {
      "attributes": {
        "value": "text"
      },
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "meta": {
        "count": 1,
        "issues": {
          "critical": 1,
          "high": 1,
          "low": 1,
          "medium": 1,
          "total": 1
        },
        "labels": [
          "text"
        ],
        "last_seen_at": "2026-03-30T19:49:44.485Z",
        "risk_score": 1,
        "tags": [
          {
            "key": "text",
            "value": "text"
          }
        ],
        "updated_at": "2026-03-30T19:49:44.485Z"
      },
      "type": "group_values"
    }
  ],
  "links": {
    "self": "https://example.com"
  }
}

Get available filter fields (Early Access)

get

Returns a list of valid field names that can be used for filtering assets using RSQL. Each field includes its name, data type, and which asset types it applies to.

Required permissions

View Tenant Details (tenant.read)

Authorizations

AuthorizationstringRequired

API key value must be prefixed with "Token ".

Path parameters

tenant_idstring · uuidRequired

The unique identifier of the tenant

Query parameters

versionstringOptional

The requested API version

Example: 2024-10-15Pattern: ^\d{4}-\d{2}-\d{2}$

asset_typesstringOptional

Comma-separated list of asset types to filter the available filter fields

Example: container_images

limitinteger · min: 10 · max: 100Optional

Number of results to return

Default: 10

starting_afterstringOptional

Cursor for fetching the next page of results

ending_beforestringOptional

Cursor for fetching the previous page of results

Responses

200

List of available filter fields

application/vnd.api+json

400

Bad Request: A parameter provided as a part of the request was invalid.

application/vnd.api+json

401

Unauthorized: the request requires an authentication token.

application/vnd.api+json

403

Forbidden: the request requires an authentication token with more or different permissions.

application/vnd.api+json

500

Internal Server Error: An error was encountered while attempting to process the request.

application/vnd.api+json

get

/tenants/{tenant_id}/inventory/assets/filters

GET /rest/tenants/{tenant_id}/inventory/assets/filters HTTP/1.1
Host: api.snyk.io
Authorization: YOUR_API_KEY
Accept: */*

{
  "data": [
    {
      "attributes": {
        "asset_types": [
          "container_images"
        ],
        "name": "text",
        "type": "string"
      },
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "relationships": {
        "values": {
          "links": {
            "related": "../folder"
          }
        }
      },
      "type": "filter_fields"
    }
  ],
  "links": {
    "self": "https://example.com"
  }
}

Get filter value suggestions (autocomplete) (Early Access)

get

Returns a list of distinct values for a specific filter field. Useful for building autocomplete functionality in filter UIs.

Use the UUID from the filter fields list endpoint to identify which field to query.

For object filter values, both the keys and values are returned.

Required permissions

View Tenant Details (tenant.read)

Authorizations

AuthorizationstringRequired

API key value must be prefixed with "Token ".

Path parameters

tenant_idstring · uuidRequired

The unique identifier of the tenant

filter_idstring · uuidRequired

The UUID of the filter field to get values for (from the filter fields list endpoint)

Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6

Query parameters

versionstringOptional

The requested API version

Example: 2024-10-15Pattern: ^\d{4}-\d{2}-\d{2}$

qstring · max: 100Optional

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 filter the value for the specific key of the object filter values.

Example: prod

limitinteger · min: 10 · max: 100Optional

Number of results to return

Default: 10

starting_afterstringOptional

Cursor for fetching the next page of results

ending_beforestringOptional

Cursor for fetching the previous page of results

keys_onlybooleanOptional

Return only the keys of the object filter values

keystringOptional

Return only the value for a specific key of the object filter values

Responses

200

List of filter values

application/vnd.api+json

400

Bad Request: A parameter provided as a part of the request was invalid.

application/vnd.api+json

401

Unauthorized: the request requires an authentication token.

application/vnd.api+json

403

Forbidden: the request requires an authentication token with more or different permissions.

application/vnd.api+json

404

Not Found: The resource being operated on could not be found.

application/vnd.api+json

500

Internal Server Error: An error was encountered while attempting to process the request.

application/vnd.api+json

get

/tenants/{tenant_id}/inventory/assets/filters/{filter_id}/values

GET /rest/tenants/{tenant_id}/inventory/assets/filters/{filter_id}/values HTTP/1.1
Host: api.snyk.io
Authorization: YOUR_API_KEY
Accept: */*

{
  "data": [
    {
      "attributes": {
        "key": "text",
        "value": "text"
      },
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "type": "filter_values"
    }
  ],
  "links": {
    "self": "https://example.com"
  }
}

Bulk update asset attributes - Org scope (Early Access)

patch

Partially updates multiple assets within an org context. Maximum of 100 assets can be updated per request. The operation is transactional - all updates succeed or all fail.

Required permissions

Edit Organization (org.edit)

Authorizations

AuthorizationstringRequired

API key value must be prefixed with "Token ".

Path parameters

org_idstring · uuidRequired

The unique identifier of the organization

Query parameters

versionstringOptional

The requested API version

Example: 2024-10-15Pattern: ^\d{4}-\d{2}-\d{2}$

Body

Responses

204

Assets updated successfully

400

Bad Request: A parameter provided as a part of the request was invalid.

application/vnd.api+json

401

Unauthorized: the request requires an authentication token.

application/vnd.api+json

403

Forbidden: the request requires an authentication token with more or different permissions.

application/vnd.api+json

404

Not Found: The resource being operated on could not be found.

application/vnd.api+json

500

Internal Server Error: An error was encountered while attempting to process the request.

application/vnd.api+json

patch

/orgs/{org_id}/inventory/assets

PATCH /rest/orgs/{org_id}/inventory/assets HTTP/1.1
Host: api.snyk.io
Authorization: YOUR_API_KEY
Content-Type: application/vnd.api+json
Accept: */*
Content-Length: 261

{
  "data": [
    {
      "attributes": {
        "class": {
          "display_name": "A",
          "locked": true,
          "rank": 1
        },
        "labels": {
          "add": [
            "text"
          ],
          "remove": [
            "text"
          ]
        },
        "tags": {
          "add": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "remove": [
            "text"
          ]
        }
      },
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "type": "container_images"
    }
  ]
}

No content

List or search all assets (synchronous) - Org scope (Early Access)

get

Retrieves a polymorphic list of all asset types for a given organization. The group and tenant are resolved from the org_id.

Required permissions

View Organization (org.read)

Authorizations

AuthorizationstringRequired

API key value must be prefixed with "Token ".

Path parameters

org_idstring · uuidRequired

The unique identifier of the organization

Query parameters

versionstringOptional

The requested API version

Example: 2024-10-15Pattern: ^\d{4}-\d{2}-\d{2}$

filterstringOptional

RSQL filter expression for filtering results.

Supported operators:

== (equal), != (not equal)
< or =lt= (less than), > or =gt= (greater than)
<= or =le= (less than or equal), >= or =ge= (greater than or equal)
=in=(val1,val2) (IN list), =out=(val1,val2) (NOT IN list)
; or and (logical AND), , or or (logical OR) - word operators are case-insensitive

Wildcard pattern matching: Use * (asterisk) for flexible string matching with == and != operators:

*value* - Contains (e.g., registry==*docker* matches "docker.io")
value* - Starts with (e.g., registry==docker* matches "docker.io")
*value - Ends with (e.g., name==*nginx matches "library/nginx")
!=*value* - Does not contain (e.g., class!=*test*)

Note: Special SQL characters (%, _) are automatically escaped for security.

Filtering for empty values: Use empty quotes ('' or "") with == or != to filter by empty fields:

registry=='' - Matches assets where registry is empty
registry!='' - Matches assets where registry has a value

Multi-field substring search: Use the special q field to search across multiple fields simultaneously using case-insensitive substring matching:

q==<search_term> - Searches across all searchable string fields (labels, tags, registry, repository, name, config_digest, manifest_digest, index_digest, image_tag)
Only supports the == operator (no wildcards needed - automatically searches for substring matches)
Uses case-insensitive pattern matching (PostgreSQL ILIKE)
Does not support linguistic features like stemming or ranking
Special characters are automatically escaped for security
Can be combined with other filters: q==nginx;type==container_images

Supported fields:

Common fields (apply to all asset types):

q (string) - Multi-field substring search (see above)
id (UUID) - Asset ID
type (string) - Type of asset. Allowed values: container_images
class (string) - Class of asset (e.g., A, B)
created_at (timestamp) - Asset creation timestamp (ISO 8601 format)
updated_at (timestamp) - Asset last update timestamp (ISO 8601 format)
labels (string array) - Asset labels
tags (object) - Asset tags. Requires a sub-field (e.g., tags.env==production)

Container image fields (apply when type is container_images):

registry (string) - Container image registry (e.g., docker.io)
repository (string) - Container image repository path
name (string) - Container image name
config_digest (string) - Image config digest
manifest_digest (string) - Distribution manifest digest
index_digest (string) - Distribution index digest
image_tag (string) - Image tag from discovery source
image_labels (object) - OCI image config labels. Requires a sub-field (e.g., image_labels.vendor==nginx)

Examples:

q==nginx - Multi-field substring search for "nginx"
q==docker.io;type==container_images - Search "docker.io" substring in container images only
type==container_images - Exact match on asset type
registry==*docker* - Registry contains "docker" (wildcard)
created_at>2024-01-01 or created_at=gt=2024-01-01 - Date comparison
class==A;created_at=ge=2024-01-01 - AND combination
labels=in=(production,staging) - Labels IN list
tags.env==production - Tag sub-field filter
image_labels.vendor==nginx - Image label sub-field filter
registry=='docker.io' - Quoted value (equivalent to registry==docker.io)
registry=='' - Assets where registry is empty
registry!='' - Assets where registry has a value

Example: type==container_images;created_at>2024-01-01

sortstringOptional

Comma-separated sort fields. Prefix with - for descending order.

Example: -created_at

limitinteger · min: 10 · max: 100Optional

Number of results to return per page

Default: 10

starting_afterstringOptional

Cursor for fetching the next page of results

ending_beforestringOptional

Cursor for fetching the previous page of results

meta_countstring · enumOptional

Example: withPossible values:

Responses

200

Successful response with a polymorphic list of assets

application/vnd.api+json

400

Bad Request: A parameter provided as a part of the request was invalid.

application/vnd.api+json

401

Unauthorized: the request requires an authentication token.

application/vnd.api+json

403

Forbidden: the request requires an authentication token with more or different permissions.

application/vnd.api+json

500

Internal Server Error: An error was encountered while attempting to process the request.

application/vnd.api+json

get

/orgs/{org_id}/inventory/assets

GET /rest/orgs/{org_id}/inventory/assets HTTP/1.1
Host: api.snyk.io
Authorization: YOUR_API_KEY
Accept: */*

{
  "data": [
    {
      "attributes": {
        "class": {
          "display_name": "A",
          "locked": false,
          "rank": 1
        },
        "created_at": "2026-03-30T19:49:44.485Z",
        "issues": {
          "critical": 1,
          "high": 1,
          "low": 1,
          "medium": 1
        },
        "labels": [
          "text"
        ],
        "last_scan": "2026-03-30T19:49:44.485Z",
        "last_seen_at": "2026-03-30T19:49:44.485Z",
        "risk_score": 1,
        "scan_engines": [
          {
            "issues": {
              "critical": 1,
              "high": 1,
              "low": 1,
              "medium": 1
            },
            "last_seen": "2026-03-30T19:49:44.485Z",
            "link": "https://example.com",
            "name": "text",
            "type": "sca"
          }
        ],
        "tags": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "teams": [
          "text"
        ],
        "test_surfaces": [
          "text"
        ],
        "updated_at": "2026-03-30T19:49:44.485Z",
        "architecture": "386",
        "author": "text",
        "built_at": "2026-03-30T19:49:44.485Z",
        "config": {
          "args_escaped": true,
          "cmd": [
            "text"
          ],
          "entry_point": [
            "text"
          ],
          "env": [
            "text"
          ],
          "exposed_ports": [
            "text"
          ],
          "labels": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "stop_signal": "text",
          "user": "text",
          "volumes": [
            "text"
          ],
          "working_dir": "text"
        },
        "config_digest": "text",
        "distribution_digests": [
          {
            "index_digest": "text",
            "manifest_digest": "text"
          }
        ],
        "history": [
          {
            "author": "text",
            "comment": "text",
            "created_at": "2026-03-30T19:49:44.485Z",
            "created_by": "text",
            "empty_layer": true
          }
        ],
        "image_tags": [
          "text"
        ],
        "inferred_base_images": [
          "text"
        ],
        "os": "aix",
        "os_features": [
          "text"
        ],
        "os_version": "text",
        "registry": "text",
        "repository": "text",
        "root_fs": {
          "diff_ids": [
            "text"
          ],
          "type": "text"
        },
        "size_bytes": 1,
        "total_image_tags": 1,
        "variant": "text"
      },
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "links": {
        "self": "https://example.com"
      },
      "relationships": {
        "projects": {
          "links": {
            "related": "text"
          }
        },
        "targets": {
          "links": {
            "related": "text"
          }
        }
      },
      "type": "container_images"
    }
  ],
  "links": {
    "first": "https://example.com",
    "next": "https://example.com",
    "prev": "https://example.com",
    "self": "https://example.com"
  },
  "meta": {
    "count": 1
  }
}

Update asset attributes - Org scope (Early Access)

patch

Partially updates an asset's attributes within an org context. Supports updating class, labels (add/remove), and tags (add/remove).

Required permissions

Edit Organization (org.edit)

Authorizations

AuthorizationstringRequired

API key value must be prefixed with "Token ".

Path parameters

org_idstring · uuidRequired

The unique identifier of the organization

asset_idstring · uuidRequired

The unique identifier of the asset

Query parameters

versionstringOptional

The requested API version

Example: 2024-10-15Pattern: ^\d{4}-\d{2}-\d{2}$

Body

Responses

200

Asset updated successfully

application/vnd.api+json

400

Bad Request: A parameter provided as a part of the request was invalid.

application/vnd.api+json

401

Unauthorized: the request requires an authentication token.

application/vnd.api+json

403

Forbidden: the request requires an authentication token with more or different permissions.

application/vnd.api+json

404

Not Found: The resource being operated on could not be found.

application/vnd.api+json

500

Internal Server Error: An error was encountered while attempting to process the request.

application/vnd.api+json

patch

/orgs/{org_id}/inventory/assets/{asset_id}

PATCH /rest/orgs/{org_id}/inventory/assets/{asset_id} HTTP/1.1
Host: api.snyk.io
Authorization: YOUR_API_KEY
Content-Type: application/vnd.api+json
Accept: */*
Content-Length: 259

{
  "data": {
    "attributes": {
      "class": {
        "display_name": "A",
        "locked": true,
        "rank": 1
      },
      "labels": {
        "add": [
          "text"
        ],
        "remove": [
          "text"
        ]
      },
      "tags": {
        "add": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "remove": [
          "text"
        ]
      }
    },
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "type": "container_images"
  }
}

{
  "data": {
    "attributes": {
      "class": {
        "display_name": "A",
        "locked": false,
        "rank": 1
      },
      "created_at": "2026-03-30T19:49:44.485Z",
      "issues": {
        "critical": 1,
        "high": 1,
        "low": 1,
        "medium": 1
      },
      "labels": [
        "text"
      ],
      "last_scan": "2026-03-30T19:49:44.485Z",
      "last_seen_at": "2026-03-30T19:49:44.485Z",
      "risk_score": 1,
      "scan_engines": [
        {
          "issues": {
            "critical": 1,
            "high": 1,
            "low": 1,
            "medium": 1
          },
          "last_seen": "2026-03-30T19:49:44.485Z",
          "link": "https://example.com",
          "name": "text",
          "type": "sca"
        }
      ],
      "tags": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "teams": [
        "text"
      ],
      "test_surfaces": [
        "text"
      ],
      "updated_at": "2026-03-30T19:49:44.485Z",
      "architecture": "386",
      "author": "text",
      "built_at": "2026-03-30T19:49:44.485Z",
      "config": {
        "args_escaped": true,
        "cmd": [
          "text"
        ],
        "entry_point": [
          "text"
        ],
        "env": [
          "text"
        ],
        "exposed_ports": [
          "text"
        ],
        "labels": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "stop_signal": "text",
        "user": "text",
        "volumes": [
          "text"
        ],
        "working_dir": "text"
      },
      "config_digest": "text",
      "distribution_digests": [
        {
          "index_digest": "text",
          "manifest_digest": "text"
        }
      ],
      "history": [
        {
          "author": "text",
          "comment": "text",
          "created_at": "2026-03-30T19:49:44.485Z",
          "created_by": "text",
          "empty_layer": true
        }
      ],
      "image_tags": [
        "text"
      ],
      "inferred_base_images": [
        "text"
      ],
      "os": "aix",
      "os_features": [
        "text"
      ],
      "os_version": "text",
      "registry": "text",
      "repository": "text",
      "root_fs": {
        "diff_ids": [
          "text"
        ],
        "type": "text"
      },
      "size_bytes": 1,
      "total_image_tags": 1,
      "variant": "text"
    },
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "links": {
      "self": "https://example.com"
    },
    "relationships": {
      "projects": {
        "links": {
          "related": "text"
        }
      },
      "targets": {
        "links": {
          "related": "text"
        }
      }
    },
    "type": "container_images"
  },
  "jsonapi": {
    "version": "1.0"
  },
  "links": {
    "self": "https://example.com"
  }
}

Get a single asset by ID - Org scope (Early Access)

get

Retrieves a single asset by its unique identifier within an org context.

Required permissions

View Organization (org.read)

Authorizations

AuthorizationstringRequired

API key value must be prefixed with "Token ".

Path parameters

org_idstring · uuidRequired

The unique identifier of the organization

asset_idstring · uuidRequired

The unique identifier of the asset

Query parameters

versionstringOptional

The requested API version

Example: 2024-10-15Pattern: ^\d{4}-\d{2}-\d{2}$

Responses

200

Asset retrieved successfully

application/vnd.api+json

400

Bad Request: A parameter provided as a part of the request was invalid.

application/vnd.api+json

401

Unauthorized: the request requires an authentication token.

application/vnd.api+json

403

Forbidden: the request requires an authentication token with more or different permissions.

application/vnd.api+json

404

Not Found: The resource being operated on could not be found.

application/vnd.api+json

500

Internal Server Error: An error was encountered while attempting to process the request.

application/vnd.api+json

get

/orgs/{org_id}/inventory/assets/{asset_id}

GET /rest/orgs/{org_id}/inventory/assets/{asset_id} HTTP/1.1
Host: api.snyk.io
Authorization: YOUR_API_KEY
Accept: */*

{
  "data": {
    "attributes": {
      "class": {
        "display_name": "A",
        "locked": false,
        "rank": 1
      },
      "created_at": "2026-03-30T19:49:44.485Z",
      "issues": {
        "critical": 1,
        "high": 1,
        "low": 1,
        "medium": 1
      },
      "labels": [
        "text"
      ],
      "last_scan": "2026-03-30T19:49:44.485Z",
      "last_seen_at": "2026-03-30T19:49:44.485Z",
      "risk_score": 1,
      "scan_engines": [
        {
          "issues": {
            "critical": 1,
            "high": 1,
            "low": 1,
            "medium": 1
          },
          "last_seen": "2026-03-30T19:49:44.485Z",
          "link": "https://example.com",
          "name": "text",
          "type": "sca"
        }
      ],
      "tags": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "teams": [
        "text"
      ],
      "test_surfaces": [
        "text"
      ],
      "updated_at": "2026-03-30T19:49:44.485Z",
      "architecture": "386",
      "author": "text",
      "built_at": "2026-03-30T19:49:44.485Z",
      "config": {
        "args_escaped": true,
        "cmd": [
          "text"
        ],
        "entry_point": [
          "text"
        ],
        "env": [
          "text"
        ],
        "exposed_ports": [
          "text"
        ],
        "labels": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "stop_signal": "text",
        "user": "text",
        "volumes": [
          "text"
        ],
        "working_dir": "text"
      },
      "config_digest": "text",
      "distribution_digests": [
        {
          "index_digest": "text",
          "manifest_digest": "text"
        }
      ],
      "history": [
        {
          "author": "text",
          "comment": "text",
          "created_at": "2026-03-30T19:49:44.485Z",
          "created_by": "text",
          "empty_layer": true
        }
      ],
      "image_tags": [
        "text"
      ],
      "inferred_base_images": [
        "text"
      ],
      "os": "aix",
      "os_features": [
        "text"
      ],
      "os_version": "text",
      "registry": "text",
      "repository": "text",
      "root_fs": {
        "diff_ids": [
          "text"
        ],
        "type": "text"
      },
      "size_bytes": 1,
      "total_image_tags": 1,
      "variant": "text"
    },
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "links": {
      "self": "https://example.com"
    },
    "relationships": {
      "projects": {
        "links": {
          "related": "text"
        }
      },
      "targets": {
        "links": {
          "related": "text"
        }
      }
    },
    "type": "container_images"
  },
  "links": {
    "self": "https://example.com"
  }
}

List targets for an asset (org scope) (Early Access)

get

Retrieves a paginated list of Snyk targets linked to this asset with full attributes. Returns the id, type, and attributes of each related target. Scoped to the specified organization.

Required permissions

View Organization (org.read)

Authorizations

AuthorizationstringRequired

API key value must be prefixed with "Token ".

Path parameters

org_idstring · uuidRequired

The unique identifier of the organization

asset_idstring · uuidRequired

The unique identifier of the asset

Query parameters

versionstringOptional

The requested API version

Example: 2024-10-15Pattern: ^\d{4}-\d{2}-\d{2}$

starting_afterstringOptional

Cursor for fetching the next page of results

ending_beforestringOptional

Cursor for fetching the previous page of results

limitinteger · min: 10 · max: 100Optional

Maximum number of results to return per page

Default: 10

Responses

200

Successfully retrieved linked targets

application/vnd.api+json

400

Bad Request: A parameter provided as a part of the request was invalid.

application/vnd.api+json

401

Unauthorized: the request requires an authentication token.

application/vnd.api+json

403

Forbidden: the request requires an authentication token with more or different permissions.

application/vnd.api+json

404

Not Found: The resource being operated on could not be found.

application/vnd.api+json

500

Internal Server Error: An error was encountered while attempting to process the request.

application/vnd.api+json

get

/orgs/{org_id}/inventory/assets/{asset_id}/relationships/targets

GET /rest/orgs/{org_id}/inventory/assets/{asset_id}/relationships/targets HTTP/1.1
Host: api.snyk.io
Authorization: YOUR_API_KEY
Accept: */*

{
  "data": [
    {
      "attributes": {
        "imported_at": "2026-03-30T19:49:44.485Z",
        "integration_id": "123e4567-e89b-12d3-a456-426614174000",
        "target_file": "text",
        "target_origin": "text",
        "target_ref": "text"
      },
      "id": "66666666-7777-8888-9999-000000000000",
      "type": "target"
    }
  ],
  "jsonapi": {
    "version": "1.0"
  },
  "links": {
    "related": "https://example.com",
    "self": "https://example.com",
    "first": "https://example.com",
    "next": "https://example.com",
    "prev": "https://example.com"
  }
}

List projects for an asset (org scope) (Early Access)

get

Retrieves a paginated list of Snyk projects linked to this asset with full attributes. Returns the id, type, and attributes of each related project. Scoped to the specified organization.

Required permissions

View Organization (org.read)

Authorizations

AuthorizationstringRequired

API key value must be prefixed with "Token ".

Path parameters

org_idstring · uuidRequired

The unique identifier of the organization

asset_idstring · uuidRequired

The unique identifier of the asset

Query parameters

versionstringOptional

The requested API version

Example: 2024-10-15Pattern: ^\d{4}-\d{2}-\d{2}$

starting_afterstringOptional

Cursor for fetching the next page of results

ending_beforestringOptional

Cursor for fetching the previous page of results

limitinteger · min: 10 · max: 100Optional

Maximum number of results to return per page

Default: 10

canonicalstring · enumOptional

Filter projects by canonical status.

with: Returns all projects (canonical attribute is populated).
only: Returns only canonical projects (those used for vulnerability counts).
none: Returns only non-canonical projects. When omitted, returns all projects without canonical filtering.

Possible values:

target_idstring · uuidOptional

Filter projects by target ID. When provided, returns only projects that belong to the specified target. When omitted, returns projects from all targets.

Responses

200

Successfully retrieved linked projects

application/vnd.api+json

400

Bad Request: A parameter provided as a part of the request was invalid.

application/vnd.api+json

401

Unauthorized: the request requires an authentication token.

application/vnd.api+json

403

Forbidden: the request requires an authentication token with more or different permissions.

application/vnd.api+json

404

Not Found: The resource being operated on could not be found.

application/vnd.api+json

500

Internal Server Error: An error was encountered while attempting to process the request.

application/vnd.api+json

get

/orgs/{org_id}/inventory/assets/{asset_id}/relationships/projects

GET /rest/orgs/{org_id}/inventory/assets/{asset_id}/relationships/projects HTTP/1.1
Host: api.snyk.io
Authorization: YOUR_API_KEY
Accept: */*

{
  "data": [
    {
      "attributes": {
        "base_image_remediation": {
          "base_image": {
            "issues_by_severity": {
              "critical": 1,
              "high": 1,
              "low": 1,
              "medium": 1
            },
            "name": "text",
            "repo": "text",
            "tag": "text",
            "total_issues": 1
          },
          "base_image_name": "text",
          "base_image_outdated": true,
          "code": "text",
          "distro_alert": "text",
          "proposed_base_images": {
            "alternative_upgrade": [
              {
                "issues_by_severity": {
                  "critical": 1,
                  "high": 1,
                  "low": 1,
                  "medium": 1
                },
                "name": "text",
                "repo": "text",
                "tag": "text",
                "total_issues": 1
              }
            ],
            "major_upgrade": [
              {
                "issues_by_severity": {
                  "critical": 1,
                  "high": 1,
                  "low": 1,
                  "medium": 1
                },
                "name": "text",
                "repo": "text",
                "tag": "text",
                "total_issues": 1
              }
            ],
            "minor_upgrade": [
              {
                "issues_by_severity": {
                  "critical": 1,
                  "high": 1,
                  "low": 1,
                  "medium": 1
                },
                "name": "text",
                "repo": "text",
                "tag": "text",
                "total_issues": 1
              }
            ]
          }
        },
        "is_canonical": true,
        "issues": {
          "critical": 1,
          "high": 1,
          "low": 1,
          "medium": 1
        },
        "monitor_created_at": "2026-03-30T19:49:44.485Z",
        "monitor_id": "123e4567-e89b-12d3-a456-426614174000",
        "org_id": "123e4567-e89b-12d3-a456-426614174000",
        "project_type": "rubygems",
        "risk_score": 1,
        "snapshot_created_at": "2026-03-30T19:49:44.485Z",
        "snapshot_id": "123e4567-e89b-12d3-a456-426614174000",
        "target_file": "text",
        "target_id": "123e4567-e89b-12d3-a456-426614174000",
        "target_origin": "text",
        "target_ref": "text"
      },
      "id": "11111111-2222-3333-4444-555555555555",
      "type": "project"
    }
  ],
  "jsonapi": {
    "version": "1.0"
  },
  "links": {
    "related": "https://example.com",
    "self": "https://example.com",
    "first": "https://example.com",
    "next": "https://example.com",
    "prev": "https://example.com"
  }
}

Create an asset search (asynchronous) - Org scope (Early Access)

post

Initiates an asynchronous search for assets within an org context.

Required permissions

View Organization (org.read)

Authorizations

AuthorizationstringRequired

API key value must be prefixed with "Token ".

Path parameters

org_idstring · uuidRequired

The unique identifier of the organization

Query parameters

versionstringOptional

The requested API version

Example: 2024-10-15Pattern: ^\d{4}-\d{2}-\d{2}$

Body

Responses

302

Found - Redirects to search results endpoint

application/vnd.api+json

400

Bad Request: A parameter provided as a part of the request was invalid.

application/vnd.api+json

500

Internal Server Error: An error was encountered while attempting to process the request.

application/vnd.api+json

post

/orgs/{org_id}/inventory/assets/searches

POST /rest/orgs/{org_id}/inventory/assets/searches HTTP/1.1
Host: api.snyk.io
Authorization: YOUR_API_KEY
Content-Type: application/vnd.api+json
Accept: */*
Content-Length: 151

{
  "data": {
    "attributes": {
      "filter": "type==container_images;created_at>2024-01-01",
      "limit": 10,
      "meta_count": "with",
      "sort": "-created_at"
    },
    "type": "searches"
  }
}

{
  "jsonapi": {
    "version": "text"
  }
}

Retrieve asset search results (asynchronous) - Org scope (Early Access)

get

Gets paginated results for a previously initiated asset search within an org context.

Required permissions

View Organization (org.read)

Authorizations

AuthorizationstringRequired

API key value must be prefixed with "Token ".

Path parameters

org_idstring · uuidRequired

The unique identifier of the organization

search_idstring · uuidRequired

The unique identifier of the search operation

Query parameters

versionstringOptional

The requested API version

Example: 2024-10-15Pattern: ^\d{4}-\d{2}-\d{2}$

sortstringOptional

Sort order for results (e.g., -created_at for descending)

limitinteger · min: 10 · max: 100Optional

Maximum number of results to return

Default: 10

starting_afterstringOptional

Cursor for forward pagination

ending_beforestringOptional

Cursor for backward pagination

Responses

200

Search results retrieved successfully

application/vnd.api+json

404

Not Found: The resource being operated on could not be found.

application/vnd.api+json

500

Internal Server Error: An error was encountered while attempting to process the request.

application/vnd.api+json

get

/orgs/{org_id}/inventory/assets/searches/{search_id}/results

GET /rest/orgs/{org_id}/inventory/assets/searches/{search_id}/results HTTP/1.1
Host: api.snyk.io
Authorization: YOUR_API_KEY
Accept: */*

{
  "data": [
    {
      "attributes": {
        "class": {
          "display_name": "A",
          "locked": false,
          "rank": 1
        },
        "created_at": "2026-03-30T19:49:44.485Z",
        "issues": {
          "critical": 1,
          "high": 1,
          "low": 1,
          "medium": 1
        },
        "labels": [
          "text"
        ],
        "last_scan": "2026-03-30T19:49:44.485Z",
        "last_seen_at": "2026-03-30T19:49:44.485Z",
        "risk_score": 1,
        "scan_engines": [
          {
            "issues": {
              "critical": 1,
              "high": 1,
              "low": 1,
              "medium": 1
            },
            "last_seen": "2026-03-30T19:49:44.485Z",
            "link": "https://example.com",
            "name": "text",
            "type": "sca"
          }
        ],
        "tags": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "teams": [
          "text"
        ],
        "test_surfaces": [
          "text"
        ],
        "updated_at": "2026-03-30T19:49:44.485Z",
        "architecture": "386",
        "author": "text",
        "built_at": "2026-03-30T19:49:44.485Z",
        "config": {
          "args_escaped": true,
          "cmd": [
            "text"
          ],
          "entry_point": [
            "text"
          ],
          "env": [
            "text"
          ],
          "exposed_ports": [
            "text"
          ],
          "labels": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "stop_signal": "text",
          "user": "text",
          "volumes": [
            "text"
          ],
          "working_dir": "text"
        },
        "config_digest": "text",
        "distribution_digests": [
          {
            "index_digest": "text",
            "manifest_digest": "text"
          }
        ],
        "history": [
          {
            "author": "text",
            "comment": "text",
            "created_at": "2026-03-30T19:49:44.485Z",
            "created_by": "text",
            "empty_layer": true
          }
        ],
        "image_tags": [
          "text"
        ],
        "inferred_base_images": [
          "text"
        ],
        "os": "aix",
        "os_features": [
          "text"
        ],
        "os_version": "text",
        "registry": "text",
        "repository": "text",
        "root_fs": {
          "diff_ids": [
            "text"
          ],
          "type": "text"
        },
        "size_bytes": 1,
        "total_image_tags": 1,
        "variant": "text"
      },
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "links": {
        "self": "https://example.com"
      },
      "relationships": {
        "projects": {
          "links": {
            "related": "text"
          }
        },
        "targets": {
          "links": {
            "related": "text"
          }
        }
      },
      "type": "container_images"
    }
  ],
  "links": {
    "first": "https://example.com",
    "next": "https://example.com",
    "prev": "https://example.com",
    "self": "https://example.com"
  },
  "meta": {
    "count": 1
  }
}

Get available group fields - Org scope (Early Access)

get

Returns a list of valid group field names that can be used for grouping assets within an org context.

Required permissions

View Organization (org.read)

Authorizations

AuthorizationstringRequired

API key value must be prefixed with "Token ".

Path parameters

org_idstring · uuidRequired

The unique identifier of the organization

Query parameters

versionstringOptional

The requested API version

Example: 2024-10-15Pattern: ^\d{4}-\d{2}-\d{2}$

asset_typesstringOptional

Comma-separated list of asset types to filter group fields

limitinteger · min: 10 · max: 100Optional

Maximum number of results to return

Default: 10

starting_afterstringOptional

Cursor for forward pagination

ending_beforestringOptional

Cursor for backward pagination

Responses

200

List of available group fields

application/vnd.api+json

400

Bad Request: A parameter provided as a part of the request was invalid.

application/vnd.api+json

401

Unauthorized: the request requires an authentication token.

application/vnd.api+json

403

Forbidden: the request requires an authentication token with more or different permissions.

application/vnd.api+json

500

Internal Server Error: An error was encountered while attempting to process the request.

application/vnd.api+json

get

/orgs/{org_id}/inventory/assets/groups

GET /rest/orgs/{org_id}/inventory/assets/groups HTTP/1.1
Host: api.snyk.io
Authorization: YOUR_API_KEY
Accept: */*

{
  "data": [
    {
      "attributes": {
        "asset_types": [
          "text"
        ],
        "name": "text"
      },
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "relationships": {
        "values": {
          "links": {
            "related": "../folder"
          }
        }
      },
      "type": "group_fields"
    }
  ],
  "links": {
    "self": "https://example.com"
  }
}

Get group value aggregation - Org scope (Early Access)

get

Returns aggregated values for a specific group field id, showing the count of assets for each distinct value.

Use the UUID from the group fields list endpoint to identify which field to query.

Required permissions

View Organization (org.read)

Authorizations

AuthorizationstringRequired

API key value must be prefixed with "Token ".

Path parameters

org_idstring · uuidRequired

The unique identifier of the organization

group_field_idstring · uuidRequired

The UUID of the group field to get values for (from the group fields list endpoint)

Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6

Query parameters

versionstringOptional

The requested API version

Example: 2024-10-15Pattern: ^\d{4}-\d{2}-\d{2}$

asset_typesstringOptional

Comma-separated list of asset types to filter the aggregation

Example: container_images

filterstringOptional

RSQL filter expression for filtering results.

Supported operators:

== (equal), != (not equal)
< or =lt= (less than), > or =gt= (greater than)
<= or =le= (less than or equal), >= or =ge= (greater than or equal)
=in=(val1,val2) (IN list), =out=(val1,val2) (NOT IN list)
; or and (logical AND), , or or (logical OR) - word operators are case-insensitive

Wildcard pattern matching: Use * (asterisk) for flexible string matching with == and != operators:

*value* - Contains (e.g., registry==*docker* matches "docker.io")
value* - Starts with (e.g., registry==docker* matches "docker.io")
*value - Ends with (e.g., name==*nginx matches "library/nginx")
!=*value* - Does not contain (e.g., class!=*test*)

Note: Special SQL characters (%, _) are automatically escaped for security.

Filtering for empty values: Use empty quotes ('' or "") with == or != to filter by empty fields:

registry=='' - Matches assets where registry is empty
registry!='' - Matches assets where registry has a value

Multi-field substring search: Use the special q field to search across multiple fields simultaneously using case-insensitive substring matching:

q==<search_term> - Searches across all searchable string fields (labels, tags, registry, repository, name, config_digest, manifest_digest, index_digest, image_tag)
Only supports the == operator (no wildcards needed - automatically searches for substring matches)
Uses case-insensitive pattern matching (PostgreSQL ILIKE)
Does not support linguistic features like stemming or ranking
Special characters are automatically escaped for security
Can be combined with other filters: q==nginx;type==container_images

Supported fields:

Common fields (apply to all asset types):

q (string) - Multi-field substring search (see above)
id (UUID) - Asset ID
type (string) - Type of asset. Allowed values: container_images
class (string) - Class of asset (e.g., A, B)
created_at (timestamp) - Asset creation timestamp (ISO 8601 format)
updated_at (timestamp) - Asset last update timestamp (ISO 8601 format)
labels (string array) - Asset labels
tags (object) - Asset tags. Requires a sub-field (e.g., tags.env==production)

Container image fields (apply when type is container_images):

registry (string) - Container image registry (e.g., docker.io)
repository (string) - Container image repository path
name (string) - Container image name
config_digest (string) - Image config digest
manifest_digest (string) - Distribution manifest digest
index_digest (string) - Distribution index digest
image_tag (string) - Image tag from discovery source
image_labels (object) - OCI image config labels. Requires a sub-field (e.g., image_labels.vendor==nginx)

Examples:

q==nginx - Multi-field substring search for "nginx"
q==docker.io;type==container_images - Search "docker.io" substring in container images only
type==container_images - Exact match on asset type
registry==*docker* - Registry contains "docker" (wildcard)
created_at>2024-01-01 or created_at=gt=2024-01-01 - Date comparison
class==A;created_at=ge=2024-01-01 - AND combination
labels=in=(production,staging) - Labels IN list
tags.env==production - Tag sub-field filter
image_labels.vendor==nginx - Image label sub-field filter
registry=='docker.io' - Quoted value (equivalent to registry==docker.io)
registry=='' - Assets where registry is empty
registry!='' - Assets where registry has a value

Example: type==container_images;created_at>2024-01-01

sortstringOptional

Available sort fields:

value - Sort by the group value string (alphabetical)
count - Sort by the number of assets in each group
last_seen_at - Sort by the aggregated last_seen_at timestamp
updated_at - Sort by the aggregated updated_at timestamp
risk_score - Sort by the aggregated risk score
issues - Sort by issue severity (critical → high → medium → low)

Example: -count

limitinteger · min: 10 · max: 100Optional

Maximum number of group values to return

Default: 10

starting_afterstringOptional

Cursor for forward pagination

ending_beforestringOptional

Cursor for backward pagination

Responses

200

List of group values with aggregated metadata

application/vnd.api+json

400

Bad Request: A parameter provided as a part of the request was invalid.

application/vnd.api+json

401

Unauthorized: the request requires an authentication token.

application/vnd.api+json

403

Forbidden: the request requires an authentication token with more or different permissions.

application/vnd.api+json

404

Not Found: The resource being operated on could not be found.

application/vnd.api+json

500

Internal Server Error: An error was encountered while attempting to process the request.

application/vnd.api+json

get

/orgs/{org_id}/inventory/assets/groups/{group_field_id}/values

GET /rest/orgs/{org_id}/inventory/assets/groups/{group_field_id}/values HTTP/1.1
Host: api.snyk.io
Authorization: YOUR_API_KEY
Accept: */*

{
  "data": [
    {
      "attributes": {
        "value": "text"
      },
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "meta": {
        "count": 1,
        "issues": {
          "critical": 1,
          "high": 1,
          "low": 1,
          "medium": 1,
          "total": 1
        },
        "labels": [
          "text"
        ],
        "last_seen_at": "2026-03-30T19:49:44.485Z",
        "risk_score": 1,
        "tags": [
          {
            "key": "text",
            "value": "text"
          }
        ],
        "updated_at": "2026-03-30T19:49:44.485Z"
      },
      "type": "group_values"
    }
  ],
  "links": {
    "self": "https://example.com"
  }
}

Get available filter fields - Org scope (Early Access)

get

Returns a list of valid field names that can be used for filtering assets using RSQL. Each field includes its name, data type, and which asset types it applies to.

Required permissions

View Organization (org.read)

Authorizations

AuthorizationstringRequired

API key value must be prefixed with "Token ".

Path parameters

org_idstring · uuidRequired

The unique identifier of the organization

Query parameters

versionstringOptional

The requested API version

Example: 2024-10-15Pattern: ^\d{4}-\d{2}-\d{2}$

asset_typesstringOptional

Comma-separated list of asset types to filter the available filter fields

Example: container_images

limitinteger · min: 10 · max: 100Optional

Number of results to return

Default: 10

starting_afterstringOptional

Cursor for fetching the next page of results

ending_beforestringOptional

Cursor for fetching the previous page of results

Responses

200

List of available filter fields

application/vnd.api+json

400

Bad Request: A parameter provided as a part of the request was invalid.

application/vnd.api+json

401

Unauthorized: the request requires an authentication token.

application/vnd.api+json

403

Forbidden: the request requires an authentication token with more or different permissions.

application/vnd.api+json

500

Internal Server Error: An error was encountered while attempting to process the request.

application/vnd.api+json

get

/orgs/{org_id}/inventory/assets/filters

GET /rest/orgs/{org_id}/inventory/assets/filters HTTP/1.1
Host: api.snyk.io
Authorization: YOUR_API_KEY
Accept: */*

{
  "data": [
    {
      "attributes": {
        "asset_types": [
          "container_images"
        ],
        "name": "text",
        "type": "string"
      },
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "relationships": {
        "values": {
          "links": {
            "related": "../folder"
          }
        }
      },
      "type": "filter_fields"
    }
  ],
  "links": {
    "self": "https://example.com"
  }
}

Get filter value suggestions (autocomplete) - Org scope (Early Access)

get

Returns a list of distinct values for a specific filter field. Useful for building autocomplete functionality in filter UIs.

Use the UUID from the filter fields list endpoint to identify which field to query.

For object filter values, both the keys and values are returned.

Required permissions

View Organization (org.read)

Authorizations

AuthorizationstringRequired

API key value must be prefixed with "Token ".

Path parameters

org_idstring · uuidRequired

The unique identifier of the organization

filter_idstring · uuidRequired

The UUID of the filter field to get values for (from the filter fields list endpoint)

Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6

Query parameters

versionstringOptional

The requested API version

Example: 2024-10-15Pattern: ^\d{4}-\d{2}-\d{2}$

qstring · max: 100Optional

Example: prod

limitinteger · min: 10 · max: 100Optional

Number of results to return

Default: 10

starting_afterstringOptional

Cursor for fetching the next page of results

ending_beforestringOptional

Cursor for fetching the previous page of results

keys_onlybooleanOptional

Return only the keys of the object filter values

keystringOptional

Return only the value for a specific key of the object filter values

Responses

200

List of filter values

application/vnd.api+json

400

Bad Request: A parameter provided as a part of the request was invalid.

application/vnd.api+json

401

Unauthorized: the request requires an authentication token.

application/vnd.api+json

403

Forbidden: the request requires an authentication token with more or different permissions.

application/vnd.api+json

404

Not Found: The resource being operated on could not be found.

application/vnd.api+json

500

Internal Server Error: An error was encountered while attempting to process the request.

application/vnd.api+json

get

/orgs/{org_id}/inventory/assets/filters/{filter_id}/values

GET /rest/orgs/{org_id}/inventory/assets/filters/{filter_id}/values HTTP/1.1
Host: api.snyk.io
Authorization: YOUR_API_KEY
Accept: */*

{
  "data": [
    {
      "attributes": {
        "key": "text",
        "value": "text"
      },
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "type": "filter_values"
    }
  ],
  "links": {
    "self": "https://example.com"
  }
}

Bulk update asset attributes - Group scope (Early Access)

patch

Partially updates multiple assets within a group context. Maximum of 100 assets can be updated per request. The operation is transactional - all updates succeed or all fail.

Required permissions

Edit Group Details (group.edit)

Authorizations

AuthorizationstringRequired

API key value must be prefixed with "Token ".

Path parameters

group_idstring · uuidRequired

The unique identifier of the group

Query parameters

versionstringOptional

The requested API version

Example: 2024-10-15Pattern: ^\d{4}-\d{2}-\d{2}$

Body

Responses

204

Assets updated successfully

400

Bad Request: A parameter provided as a part of the request was invalid.

application/vnd.api+json

401

Unauthorized: the request requires an authentication token.

application/vnd.api+json

403

Forbidden: the request requires an authentication token with more or different permissions.

application/vnd.api+json

404

Not Found: The resource being operated on could not be found.

application/vnd.api+json

500

Internal Server Error: An error was encountered while attempting to process the request.

application/vnd.api+json

patch

/groups/{group_id}/inventory/assets

PATCH /rest/groups/{group_id}/inventory/assets HTTP/1.1
Host: api.snyk.io
Authorization: YOUR_API_KEY
Content-Type: application/vnd.api+json
Accept: */*
Content-Length: 261

{
  "data": [
    {
      "attributes": {
        "class": {
          "display_name": "A",
          "locked": true,
          "rank": 1
        },
        "labels": {
          "add": [
            "text"
          ],
          "remove": [
            "text"
          ]
        },
        "tags": {
          "add": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "remove": [
            "text"
          ]
        }
      },
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "type": "container_images"
    }
  ]
}

No content

List or search all assets (synchronous) - Group scope (Early Access)

get

Retrieves a polymorphic list of all asset types for a given group. The tenant is resolved from the group_id.

Required permissions

View Groups (group.read)

Authorizations

AuthorizationstringRequired

API key value must be prefixed with "Token ".

Path parameters

group_idstring · uuidRequired

The unique identifier of the group

Query parameters

versionstringOptional

The requested API version

Example: 2024-10-15Pattern: ^\d{4}-\d{2}-\d{2}$

filterstringOptional

RSQL filter expression for filtering results.

Supported operators:

== (equal), != (not equal)
< or =lt= (less than), > or =gt= (greater than)
<= or =le= (less than or equal), >= or =ge= (greater than or equal)
=in=(val1,val2) (IN list), =out=(val1,val2) (NOT IN list)
; or and (logical AND), , or or (logical OR) - word operators are case-insensitive

Wildcard pattern matching: Use * (asterisk) for flexible string matching with == and != operators:

*value* - Contains (e.g., registry==*docker* matches "docker.io")
value* - Starts with (e.g., registry==docker* matches "docker.io")
*value - Ends with (e.g., name==*nginx matches "library/nginx")
!=*value* - Does not contain (e.g., class!=*test*)

Note: Special SQL characters (%, _) are automatically escaped for security.

Filtering for empty values: Use empty quotes ('' or "") with == or != to filter by empty fields:

registry=='' - Matches assets where registry is empty
registry!='' - Matches assets where registry has a value

Multi-field substring search: Use the special q field to search across multiple fields simultaneously using case-insensitive substring matching:

q==<search_term> - Searches across all searchable string fields (labels, tags, registry, repository, name, config_digest, manifest_digest, index_digest, image_tag)
Only supports the == operator (no wildcards needed - automatically searches for substring matches)
Uses case-insensitive pattern matching (PostgreSQL ILIKE)
Does not support linguistic features like stemming or ranking
Special characters are automatically escaped for security
Can be combined with other filters: q==nginx;type==container_images

Supported fields:

Common fields (apply to all asset types):

q (string) - Multi-field substring search (see above)
id (UUID) - Asset ID
type (string) - Type of asset. Allowed values: container_images
class (string) - Class of asset (e.g., A, B)
created_at (timestamp) - Asset creation timestamp (ISO 8601 format)
updated_at (timestamp) - Asset last update timestamp (ISO 8601 format)
labels (string array) - Asset labels
tags (object) - Asset tags. Requires a sub-field (e.g., tags.env==production)

Container image fields (apply when type is container_images):

registry (string) - Container image registry (e.g., docker.io)
repository (string) - Container image repository path
name (string) - Container image name
config_digest (string) - Image config digest
manifest_digest (string) - Distribution manifest digest
index_digest (string) - Distribution index digest
image_tag (string) - Image tag from discovery source
image_labels (object) - OCI image config labels. Requires a sub-field (e.g., image_labels.vendor==nginx)

Examples:

q==nginx - Multi-field substring search for "nginx"
q==docker.io;type==container_images - Search "docker.io" substring in container images only
type==container_images - Exact match on asset type
registry==*docker* - Registry contains "docker" (wildcard)
created_at>2024-01-01 or created_at=gt=2024-01-01 - Date comparison
class==A;created_at=ge=2024-01-01 - AND combination
labels=in=(production,staging) - Labels IN list
tags.env==production - Tag sub-field filter
image_labels.vendor==nginx - Image label sub-field filter
registry=='docker.io' - Quoted value (equivalent to registry==docker.io)
registry=='' - Assets where registry is empty
registry!='' - Assets where registry has a value

Example: type==container_images;created_at>2024-01-01

sortstringOptional

Comma-separated sort fields. Prefix with - for descending order.

Example: -created_at

limitinteger · min: 10 · max: 100Optional

Number of results to return per page

Default: 10

starting_afterstringOptional

Cursor for fetching the next page of results

ending_beforestringOptional

Cursor for fetching the previous page of results

meta_countstring · enumOptional

Example: withPossible values:

Responses

200

Successful response with a polymorphic list of assets

application/vnd.api+json

400

Bad Request: A parameter provided as a part of the request was invalid.

application/vnd.api+json

401

Unauthorized: the request requires an authentication token.

application/vnd.api+json

403

Forbidden: the request requires an authentication token with more or different permissions.

application/vnd.api+json

500

Internal Server Error: An error was encountered while attempting to process the request.

application/vnd.api+json

get

/groups/{group_id}/inventory/assets

GET /rest/groups/{group_id}/inventory/assets HTTP/1.1
Host: api.snyk.io
Authorization: YOUR_API_KEY
Accept: */*

{
  "data": [
    {
      "attributes": {
        "class": {
          "display_name": "A",
          "locked": false,
          "rank": 1
        },
        "created_at": "2026-03-30T19:49:44.485Z",
        "issues": {
          "critical": 1,
          "high": 1,
          "low": 1,
          "medium": 1
        },
        "labels": [
          "text"
        ],
        "last_scan": "2026-03-30T19:49:44.485Z",
        "last_seen_at": "2026-03-30T19:49:44.485Z",
        "risk_score": 1,
        "scan_engines": [
          {
            "issues": {
              "critical": 1,
              "high": 1,
              "low": 1,
              "medium": 1
            },
            "last_seen": "2026-03-30T19:49:44.485Z",
            "link": "https://example.com",
            "name": "text",
            "type": "sca"
          }
        ],
        "tags": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "teams": [
          "text"
        ],
        "test_surfaces": [
          "text"
        ],
        "updated_at": "2026-03-30T19:49:44.485Z",
        "architecture": "386",
        "author": "text",
        "built_at": "2026-03-30T19:49:44.485Z",
        "config": {
          "args_escaped": true,
          "cmd": [
            "text"
          ],
          "entry_point": [
            "text"
          ],
          "env": [
            "text"
          ],
          "exposed_ports": [
            "text"
          ],
          "labels": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "stop_signal": "text",
          "user": "text",
          "volumes": [
            "text"
          ],
          "working_dir": "text"
        },
        "config_digest": "text",
        "distribution_digests": [
          {
            "index_digest": "text",
            "manifest_digest": "text"
          }
        ],
        "history": [
          {
            "author": "text",
            "comment": "text",
            "created_at": "2026-03-30T19:49:44.485Z",
            "created_by": "text",
            "empty_layer": true
          }
        ],
        "image_tags": [
          "text"
        ],
        "inferred_base_images": [
          "text"
        ],
        "os": "aix",
        "os_features": [
          "text"
        ],
        "os_version": "text",
        "registry": "text",
        "repository": "text",
        "root_fs": {
          "diff_ids": [
            "text"
          ],
          "type": "text"
        },
        "size_bytes": 1,
        "total_image_tags": 1,
        "variant": "text"
      },
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "links": {
        "self": "https://example.com"
      },
      "relationships": {
        "projects": {
          "links": {
            "related": "text"
          }
        },
        "targets": {
          "links": {
            "related": "text"
          }
        }
      },
      "type": "container_images"
    }
  ],
  "links": {
    "first": "https://example.com",
    "next": "https://example.com",
    "prev": "https://example.com",
    "self": "https://example.com"
  },
  "meta": {
    "count": 1
  }
}

Update asset attributes - Group scope (Early Access)

patch

Partially updates an asset's attributes within a group context. Supports updating class, labels (add/remove), and tags (add/remove).

Required permissions

Edit Group Details (group.edit)

Authorizations

AuthorizationstringRequired

API key value must be prefixed with "Token ".

Path parameters

group_idstring · uuidRequired

The unique identifier of the group

asset_idstring · uuidRequired

The unique identifier of the asset

Query parameters

versionstringOptional

The requested API version

Example: 2024-10-15Pattern: ^\d{4}-\d{2}-\d{2}$

Body

Responses

200

Asset updated successfully

application/vnd.api+json

400

Bad Request: A parameter provided as a part of the request was invalid.

application/vnd.api+json

401

Unauthorized: the request requires an authentication token.

application/vnd.api+json

403

Forbidden: the request requires an authentication token with more or different permissions.

application/vnd.api+json

404

Not Found: The resource being operated on could not be found.

application/vnd.api+json

500

Internal Server Error: An error was encountered while attempting to process the request.

application/vnd.api+json

patch

/groups/{group_id}/inventory/assets/{asset_id}

PATCH /rest/groups/{group_id}/inventory/assets/{asset_id} HTTP/1.1
Host: api.snyk.io
Authorization: YOUR_API_KEY
Content-Type: application/vnd.api+json
Accept: */*
Content-Length: 259

{
  "data": {
    "attributes": {
      "class": {
        "display_name": "A",
        "locked": true,
        "rank": 1
      },
      "labels": {
        "add": [
          "text"
        ],
        "remove": [
          "text"
        ]
      },
      "tags": {
        "add": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "remove": [
          "text"
        ]
      }
    },
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "type": "container_images"
  }
}

{
  "data": {
    "attributes": {
      "class": {
        "display_name": "A",
        "locked": false,
        "rank": 1
      },
      "created_at": "2026-03-30T19:49:44.485Z",
      "issues": {
        "critical": 1,
        "high": 1,
        "low": 1,
        "medium": 1
      },
      "labels": [
        "text"
      ],
      "last_scan": "2026-03-30T19:49:44.485Z",
      "last_seen_at": "2026-03-30T19:49:44.485Z",
      "risk_score": 1,
      "scan_engines": [
        {
          "issues": {
            "critical": 1,
            "high": 1,
            "low": 1,
            "medium": 1
          },
          "last_seen": "2026-03-30T19:49:44.485Z",
          "link": "https://example.com",
          "name": "text",
          "type": "sca"
        }
      ],
      "tags": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "teams": [
        "text"
      ],
      "test_surfaces": [
        "text"
      ],
      "updated_at": "2026-03-30T19:49:44.485Z",
      "architecture": "386",
      "author": "text",
      "built_at": "2026-03-30T19:49:44.485Z",
      "config": {
        "args_escaped": true,
        "cmd": [
          "text"
        ],
        "entry_point": [
          "text"
        ],
        "env": [
          "text"
        ],
        "exposed_ports": [
          "text"
        ],
        "labels": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "stop_signal": "text",
        "user": "text",
        "volumes": [
          "text"
        ],
        "working_dir": "text"
      },
      "config_digest": "text",
      "distribution_digests": [
        {
          "index_digest": "text",
          "manifest_digest": "text"
        }
      ],
      "history": [
        {
          "author": "text",
          "comment": "text",
          "created_at": "2026-03-30T19:49:44.485Z",
          "created_by": "text",
          "empty_layer": true
        }
      ],
      "image_tags": [
        "text"
      ],
      "inferred_base_images": [
        "text"
      ],
      "os": "aix",
      "os_features": [
        "text"
      ],
      "os_version": "text",
      "registry": "text",
      "repository": "text",
      "root_fs": {
        "diff_ids": [
          "text"
        ],
        "type": "text"
      },
      "size_bytes": 1,
      "total_image_tags": 1,
      "variant": "text"
    },
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "links": {
      "self": "https://example.com"
    },
    "relationships": {
      "projects": {
        "links": {
          "related": "text"
        }
      },
      "targets": {
        "links": {
          "related": "text"
        }
      }
    },
    "type": "container_images"
  },
  "jsonapi": {
    "version": "1.0"
  },
  "links": {
    "self": "https://example.com"
  }
}

Get a single asset by ID - Group scope (Early Access)

get

Retrieves a single asset by its unique identifier within a group context.

Required permissions

View Groups (group.read)

Authorizations

AuthorizationstringRequired

API key value must be prefixed with "Token ".

Path parameters

group_idstring · uuidRequired

The unique identifier of the group

asset_idstring · uuidRequired

The unique identifier of the asset

Query parameters

versionstringOptional

The requested API version

Example: 2024-10-15Pattern: ^\d{4}-\d{2}-\d{2}$

Responses

200

Asset retrieved successfully

application/vnd.api+json

400

Bad Request: A parameter provided as a part of the request was invalid.

application/vnd.api+json

401

Unauthorized: the request requires an authentication token.

application/vnd.api+json

403

Forbidden: the request requires an authentication token with more or different permissions.

application/vnd.api+json

404

Not Found: The resource being operated on could not be found.

application/vnd.api+json

500

Internal Server Error: An error was encountered while attempting to process the request.

application/vnd.api+json

get

/groups/{group_id}/inventory/assets/{asset_id}

GET /rest/groups/{group_id}/inventory/assets/{asset_id} HTTP/1.1
Host: api.snyk.io
Authorization: YOUR_API_KEY
Accept: */*

{
  "data": {
    "attributes": {
      "class": {
        "display_name": "A",
        "locked": false,
        "rank": 1
      },
      "created_at": "2026-03-30T19:49:44.485Z",
      "issues": {
        "critical": 1,
        "high": 1,
        "low": 1,
        "medium": 1
      },
      "labels": [
        "text"
      ],
      "last_scan": "2026-03-30T19:49:44.485Z",
      "last_seen_at": "2026-03-30T19:49:44.485Z",
      "risk_score": 1,
      "scan_engines": [
        {
          "issues": {
            "critical": 1,
            "high": 1,
            "low": 1,
            "medium": 1
          },
          "last_seen": "2026-03-30T19:49:44.485Z",
          "link": "https://example.com",
          "name": "text",
          "type": "sca"
        }
      ],
      "tags": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "teams": [
        "text"
      ],
      "test_surfaces": [
        "text"
      ],
      "updated_at": "2026-03-30T19:49:44.485Z",
      "architecture": "386",
      "author": "text",
      "built_at": "2026-03-30T19:49:44.485Z",
      "config": {
        "args_escaped": true,
        "cmd": [
          "text"
        ],
        "entry_point": [
          "text"
        ],
        "env": [
          "text"
        ],
        "exposed_ports": [
          "text"
        ],
        "labels": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "stop_signal": "text",
        "user": "text",
        "volumes": [
          "text"
        ],
        "working_dir": "text"
      },
      "config_digest": "text",
      "distribution_digests": [
        {
          "index_digest": "text",
          "manifest_digest": "text"
        }
      ],
      "history": [
        {
          "author": "text",
          "comment": "text",
          "created_at": "2026-03-30T19:49:44.485Z",
          "created_by": "text",
          "empty_layer": true
        }
      ],
      "image_tags": [
        "text"
      ],
      "inferred_base_images": [
        "text"
      ],
      "os": "aix",
      "os_features": [
        "text"
      ],
      "os_version": "text",
      "registry": "text",
      "repository": "text",
      "root_fs": {
        "diff_ids": [
          "text"
        ],
        "type": "text"
      },
      "size_bytes": 1,
      "total_image_tags": 1,
      "variant": "text"
    },
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "links": {
      "self": "https://example.com"
    },
    "relationships": {
      "projects": {
        "links": {
          "related": "text"
        }
      },
      "targets": {
        "links": {
          "related": "text"
        }
      }
    },
    "type": "container_images"
  },
  "links": {
    "self": "https://example.com"
  }
}

List targets for an asset (group scope) (Early Access)

get

Retrieves a paginated list of Snyk targets linked to this asset with full attributes. Returns the id, type, and attributes of each related target. Scoped to the specified group.

Required permissions

View Groups (group.read)

Authorizations

AuthorizationstringRequired

API key value must be prefixed with "Token ".

Path parameters

group_idstring · uuidRequired

The unique identifier of the group

asset_idstring · uuidRequired

The unique identifier of the asset

Query parameters

versionstringOptional

The requested API version

Example: 2024-10-15Pattern: ^\d{4}-\d{2}-\d{2}$

starting_afterstringOptional

Cursor for fetching the next page of results

ending_beforestringOptional

Cursor for fetching the previous page of results

limitinteger · min: 10 · max: 100Optional

Maximum number of results to return per page

Default: 10

Responses

200

Successfully retrieved linked targets

application/vnd.api+json

400

Bad Request: A parameter provided as a part of the request was invalid.

application/vnd.api+json

401

Unauthorized: the request requires an authentication token.

application/vnd.api+json

403

Forbidden: the request requires an authentication token with more or different permissions.

application/vnd.api+json

404

Not Found: The resource being operated on could not be found.

application/vnd.api+json

500

Internal Server Error: An error was encountered while attempting to process the request.

application/vnd.api+json

get

/groups/{group_id}/inventory/assets/{asset_id}/relationships/targets

GET /rest/groups/{group_id}/inventory/assets/{asset_id}/relationships/targets HTTP/1.1
Host: api.snyk.io
Authorization: YOUR_API_KEY
Accept: */*

{
  "data": [
    {
      "attributes": {
        "imported_at": "2026-03-30T19:49:44.485Z",
        "integration_id": "123e4567-e89b-12d3-a456-426614174000",
        "target_file": "text",
        "target_origin": "text",
        "target_ref": "text"
      },
      "id": "66666666-7777-8888-9999-000000000000",
      "type": "target"
    }
  ],
  "jsonapi": {
    "version": "1.0"
  },
  "links": {
    "related": "https://example.com",
    "self": "https://example.com",
    "first": "https://example.com",
    "next": "https://example.com",
    "prev": "https://example.com"
  }
}

List projects for an asset (group scope) (Early Access)

get

Retrieves a paginated list of Snyk projects linked to this asset with full attributes. Returns the id, type, and attributes of each related project. Scoped to the specified group.

Required permissions

View Groups (group.read)

Authorizations

AuthorizationstringRequired

API key value must be prefixed with "Token ".

Path parameters

group_idstring · uuidRequired

The unique identifier of the group

asset_idstring · uuidRequired

The unique identifier of the asset

Query parameters

versionstringOptional

The requested API version

Example: 2024-10-15Pattern: ^\d{4}-\d{2}-\d{2}$

starting_afterstringOptional

Cursor for fetching the next page of results

ending_beforestringOptional

Cursor for fetching the previous page of results

limitinteger · min: 10 · max: 100Optional

Maximum number of results to return per page

Default: 10

canonicalstring · enumOptional

Filter projects by canonical status.

with: Returns all projects (canonical attribute is populated).
only: Returns only canonical projects (those used for vulnerability counts).
none: Returns only non-canonical projects. When omitted, returns all projects without canonical filtering.

Possible values:

target_idstring · uuidOptional

Filter projects by target ID. When provided, returns only projects that belong to the specified target. When omitted, returns projects from all targets.

Responses

200

Successfully retrieved linked projects

application/vnd.api+json

400

Bad Request: A parameter provided as a part of the request was invalid.

application/vnd.api+json

401

Unauthorized: the request requires an authentication token.

application/vnd.api+json

403

Forbidden: the request requires an authentication token with more or different permissions.

application/vnd.api+json

404

Not Found: The resource being operated on could not be found.

application/vnd.api+json

500

Internal Server Error: An error was encountered while attempting to process the request.

application/vnd.api+json

get

/groups/{group_id}/inventory/assets/{asset_id}/relationships/projects

GET /rest/groups/{group_id}/inventory/assets/{asset_id}/relationships/projects HTTP/1.1
Host: api.snyk.io
Authorization: YOUR_API_KEY
Accept: */*

{
  "data": [
    {
      "attributes": {
        "base_image_remediation": {
          "base_image": {
            "issues_by_severity": {
              "critical": 1,
              "high": 1,
              "low": 1,
              "medium": 1
            },
            "name": "text",
            "repo": "text",
            "tag": "text",
            "total_issues": 1
          },
          "base_image_name": "text",
          "base_image_outdated": true,
          "code": "text",
          "distro_alert": "text",
          "proposed_base_images": {
            "alternative_upgrade": [
              {
                "issues_by_severity": {
                  "critical": 1,
                  "high": 1,
                  "low": 1,
                  "medium": 1
                },
                "name": "text",
                "repo": "text",
                "tag": "text",
                "total_issues": 1
              }
            ],
            "major_upgrade": [
              {
                "issues_by_severity": {
                  "critical": 1,
                  "high": 1,
                  "low": 1,
                  "medium": 1
                },
                "name": "text",
                "repo": "text",
                "tag": "text",
                "total_issues": 1
              }
            ],
            "minor_upgrade": [
              {
                "issues_by_severity": {
                  "critical": 1,
                  "high": 1,
                  "low": 1,
                  "medium": 1
                },
                "name": "text",
                "repo": "text",
                "tag": "text",
                "total_issues": 1
              }
            ]
          }
        },
        "is_canonical": true,
        "issues": {
          "critical": 1,
          "high": 1,
          "low": 1,
          "medium": 1
        },
        "monitor_created_at": "2026-03-30T19:49:44.485Z",
        "monitor_id": "123e4567-e89b-12d3-a456-426614174000",
        "org_id": "123e4567-e89b-12d3-a456-426614174000",
        "project_type": "rubygems",
        "risk_score": 1,
        "snapshot_created_at": "2026-03-30T19:49:44.485Z",
        "snapshot_id": "123e4567-e89b-12d3-a456-426614174000",
        "target_file": "text",
        "target_id": "123e4567-e89b-12d3-a456-426614174000",
        "target_origin": "text",
        "target_ref": "text"
      },
      "id": "11111111-2222-3333-4444-555555555555",
      "type": "project"
    }
  ],
  "jsonapi": {
    "version": "1.0"
  },
  "links": {
    "related": "https://example.com",
    "self": "https://example.com",
    "first": "https://example.com",
    "next": "https://example.com",
    "prev": "https://example.com"
  }
}

Create an asset search (asynchronous) - Group scope (Early Access)

post

Initiates an asynchronous search for assets within a group context.

Required permissions

View Groups (group.read)

Authorizations

AuthorizationstringRequired

API key value must be prefixed with "Token ".

Path parameters

group_idstring · uuidRequired

The unique identifier of the group

Query parameters

versionstringOptional

The requested API version

Example: 2024-10-15Pattern: ^\d{4}-\d{2}-\d{2}$

Body

Responses

302

Found - Redirects to search results endpoint

application/vnd.api+json

400

Bad Request: A parameter provided as a part of the request was invalid.

application/vnd.api+json

500

Internal Server Error: An error was encountered while attempting to process the request.

application/vnd.api+json

post

/groups/{group_id}/inventory/assets/searches

POST /rest/groups/{group_id}/inventory/assets/searches HTTP/1.1
Host: api.snyk.io
Authorization: YOUR_API_KEY
Content-Type: application/vnd.api+json
Accept: */*
Content-Length: 151

{
  "data": {
    "attributes": {
      "filter": "type==container_images;created_at>2024-01-01",
      "limit": 10,
      "meta_count": "with",
      "sort": "-created_at"
    },
    "type": "searches"
  }
}

{
  "jsonapi": {
    "version": "text"
  }
}

Retrieve asset search results (asynchronous) - Group scope (Early Access)

get

Gets paginated results for a previously initiated asset search within a group context.

Required permissions

View Groups (group.read)

Authorizations

AuthorizationstringRequired

API key value must be prefixed with "Token ".

Path parameters

group_idstring · uuidRequired

The unique identifier of the group

search_idstring · uuidRequired

The unique identifier of the search operation

Query parameters

versionstringOptional

The requested API version

Example: 2024-10-15Pattern: ^\d{4}-\d{2}-\d{2}$

sortstringOptional

Sort order for results (e.g., -created_at for descending)

limitinteger · min: 10 · max: 100Optional

Maximum number of results to return

Default: 10

starting_afterstringOptional

Cursor for forward pagination

ending_beforestringOptional

Cursor for backward pagination

Responses

200

Search results retrieved successfully

application/vnd.api+json

404

Not Found: The resource being operated on could not be found.

application/vnd.api+json

500

Internal Server Error: An error was encountered while attempting to process the request.

application/vnd.api+json

get

/groups/{group_id}/inventory/assets/searches/{search_id}/results

GET /rest/groups/{group_id}/inventory/assets/searches/{search_id}/results HTTP/1.1
Host: api.snyk.io
Authorization: YOUR_API_KEY
Accept: */*

{
  "data": [
    {
      "attributes": {
        "class": {
          "display_name": "A",
          "locked": false,
          "rank": 1
        },
        "created_at": "2026-03-30T19:49:44.485Z",
        "issues": {
          "critical": 1,
          "high": 1,
          "low": 1,
          "medium": 1
        },
        "labels": [
          "text"
        ],
        "last_scan": "2026-03-30T19:49:44.485Z",
        "last_seen_at": "2026-03-30T19:49:44.485Z",
        "risk_score": 1,
        "scan_engines": [
          {
            "issues": {
              "critical": 1,
              "high": 1,
              "low": 1,
              "medium": 1
            },
            "last_seen": "2026-03-30T19:49:44.485Z",
            "link": "https://example.com",
            "name": "text",
            "type": "sca"
          }
        ],
        "tags": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "teams": [
          "text"
        ],
        "test_surfaces": [
          "text"
        ],
        "updated_at": "2026-03-30T19:49:44.485Z",
        "architecture": "386",
        "author": "text",
        "built_at": "2026-03-30T19:49:44.485Z",
        "config": {
          "args_escaped": true,
          "cmd": [
            "text"
          ],
          "entry_point": [
            "text"
          ],
          "env": [
            "text"
          ],
          "exposed_ports": [
            "text"
          ],
          "labels": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "stop_signal": "text",
          "user": "text",
          "volumes": [
            "text"
          ],
          "working_dir": "text"
        },
        "config_digest": "text",
        "distribution_digests": [
          {
            "index_digest": "text",
            "manifest_digest": "text"
          }
        ],
        "history": [
          {
            "author": "text",
            "comment": "text",
            "created_at": "2026-03-30T19:49:44.485Z",
            "created_by": "text",
            "empty_layer": true
          }
        ],
        "image_tags": [
          "text"
        ],
        "inferred_base_images": [
          "text"
        ],
        "os": "aix",
        "os_features": [
          "text"
        ],
        "os_version": "text",
        "registry": "text",
        "repository": "text",
        "root_fs": {
          "diff_ids": [
            "text"
          ],
          "type": "text"
        },
        "size_bytes": 1,
        "total_image_tags": 1,
        "variant": "text"
      },
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "links": {
        "self": "https://example.com"
      },
      "relationships": {
        "projects": {
          "links": {
            "related": "text"
          }
        },
        "targets": {
          "links": {
            "related": "text"
          }
        }
      },
      "type": "container_images"
    }
  ],
  "links": {
    "first": "https://example.com",
    "next": "https://example.com",
    "prev": "https://example.com",
    "self": "https://example.com"
  },
  "meta": {
    "count": 1
  }
}

Get available group fields - Group scope (Early Access)

get

Returns a list of valid group field names that can be used for grouping assets within a group context.

Required permissions

View Groups (group.read)

Authorizations

AuthorizationstringRequired

API key value must be prefixed with "Token ".

Path parameters

group_idstring · uuidRequired

The unique identifier of the group

Query parameters

versionstringOptional

The requested API version

Example: 2024-10-15Pattern: ^\d{4}-\d{2}-\d{2}$

asset_typesstringOptional

Comma-separated list of asset types to filter group fields

limitinteger · min: 10 · max: 100Optional

Maximum number of results to return

Default: 10

starting_afterstringOptional

Cursor for forward pagination

ending_beforestringOptional

Cursor for backward pagination

Responses

200

List of available group fields

application/vnd.api+json

400

Bad Request: A parameter provided as a part of the request was invalid.

application/vnd.api+json

401

Unauthorized: the request requires an authentication token.

application/vnd.api+json

403

Forbidden: the request requires an authentication token with more or different permissions.

application/vnd.api+json

500

Internal Server Error: An error was encountered while attempting to process the request.

application/vnd.api+json

get

/groups/{group_id}/inventory/assets/groups

GET /rest/groups/{group_id}/inventory/assets/groups HTTP/1.1
Host: api.snyk.io
Authorization: YOUR_API_KEY
Accept: */*

{
  "data": [
    {
      "attributes": {
        "asset_types": [
          "text"
        ],
        "name": "text"
      },
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "relationships": {
        "values": {
          "links": {
            "related": "../folder"
          }
        }
      },
      "type": "group_fields"
    }
  ],
  "links": {
    "self": "https://example.com"
  }
}

Get group value aggregation - Group scope (Early Access)

get

Returns aggregated values for a specific group field id, showing the count of assets for each distinct value.

Use the UUID from the group fields list endpoint to identify which field to query.

Required permissions

View Groups (group.read)

Authorizations

AuthorizationstringRequired

API key value must be prefixed with "Token ".

Path parameters

group_idstring · uuidRequired

The unique identifier of the group

group_field_idstring · uuidRequired

The UUID of the group field to get values for (from the group fields list endpoint)

Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6

Query parameters

versionstringOptional

The requested API version

Example: 2024-10-15Pattern: ^\d{4}-\d{2}-\d{2}$

asset_typesstringOptional

Comma-separated list of asset types to filter the aggregation

Example: container_images

filterstringOptional

RSQL filter expression for filtering results.

Supported operators:

== (equal), != (not equal)
< or =lt= (less than), > or =gt= (greater than)
<= or =le= (less than or equal), >= or =ge= (greater than or equal)
=in=(val1,val2) (IN list), =out=(val1,val2) (NOT IN list)
; or and (logical AND), , or or (logical OR) - word operators are case-insensitive

Wildcard pattern matching: Use * (asterisk) for flexible string matching with == and != operators:

*value* - Contains (e.g., registry==*docker* matches "docker.io")
value* - Starts with (e.g., registry==docker* matches "docker.io")
*value - Ends with (e.g., name==*nginx matches "library/nginx")
!=*value* - Does not contain (e.g., class!=*test*)

Note: Special SQL characters (%, _) are automatically escaped for security.

Filtering for empty values: Use empty quotes ('' or "") with == or != to filter by empty fields:

registry=='' - Matches assets where registry is empty
registry!='' - Matches assets where registry has a value

Multi-field substring search: Use the special q field to search across multiple fields simultaneously using case-insensitive substring matching:

q==<search_term> - Searches across all searchable string fields (labels, tags, registry, repository, name, config_digest, manifest_digest, index_digest, image_tag)
Only supports the == operator (no wildcards needed - automatically searches for substring matches)
Uses case-insensitive pattern matching (PostgreSQL ILIKE)
Does not support linguistic features like stemming or ranking
Special characters are automatically escaped for security
Can be combined with other filters: q==nginx;type==container_images

Supported fields:

Common fields (apply to all asset types):

q (string) - Multi-field substring search (see above)
id (UUID) - Asset ID
type (string) - Type of asset. Allowed values: container_images
class (string) - Class of asset (e.g., A, B)
created_at (timestamp) - Asset creation timestamp (ISO 8601 format)
updated_at (timestamp) - Asset last update timestamp (ISO 8601 format)
labels (string array) - Asset labels
tags (object) - Asset tags. Requires a sub-field (e.g., tags.env==production)

Container image fields (apply when type is container_images):

registry (string) - Container image registry (e.g., docker.io)
repository (string) - Container image repository path
name (string) - Container image name
config_digest (string) - Image config digest
manifest_digest (string) - Distribution manifest digest
index_digest (string) - Distribution index digest
image_tag (string) - Image tag from discovery source
image_labels (object) - OCI image config labels. Requires a sub-field (e.g., image_labels.vendor==nginx)

Examples:

q==nginx - Multi-field substring search for "nginx"
q==docker.io;type==container_images - Search "docker.io" substring in container images only
type==container_images - Exact match on asset type
registry==*docker* - Registry contains "docker" (wildcard)
created_at>2024-01-01 or created_at=gt=2024-01-01 - Date comparison
class==A;created_at=ge=2024-01-01 - AND combination
labels=in=(production,staging) - Labels IN list
tags.env==production - Tag sub-field filter
image_labels.vendor==nginx - Image label sub-field filter
registry=='docker.io' - Quoted value (equivalent to registry==docker.io)
registry=='' - Assets where registry is empty
registry!='' - Assets where registry has a value

Example: type==container_images;created_at>2024-01-01

sortstringOptional

Available sort fields:

value - Sort by the group value string (alphabetical)
count - Sort by the number of assets in each group
last_seen_at - Sort by the aggregated last_seen_at timestamp
updated_at - Sort by the aggregated updated_at timestamp
risk_score - Sort by the aggregated risk score
issues - Sort by issue severity (critical → high → medium → low)

Example: -count

limitinteger · min: 10 · max: 100Optional

Maximum number of group values to return

Default: 10

starting_afterstringOptional

Cursor for forward pagination

ending_beforestringOptional

Cursor for backward pagination

Responses

200

List of group values with aggregated metadata

application/vnd.api+json

400

Bad Request: A parameter provided as a part of the request was invalid.

application/vnd.api+json

401

Unauthorized: the request requires an authentication token.

application/vnd.api+json

403

Forbidden: the request requires an authentication token with more or different permissions.

application/vnd.api+json

404

Not Found: The resource being operated on could not be found.

application/vnd.api+json

500

Internal Server Error: An error was encountered while attempting to process the request.

application/vnd.api+json

get

/groups/{group_id}/inventory/assets/groups/{group_field_id}/values

GET /rest/groups/{group_id}/inventory/assets/groups/{group_field_id}/values HTTP/1.1
Host: api.snyk.io
Authorization: YOUR_API_KEY
Accept: */*

{
  "data": [
    {
      "attributes": {
        "value": "text"
      },
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "meta": {
        "count": 1,
        "issues": {
          "critical": 1,
          "high": 1,
          "low": 1,
          "medium": 1,
          "total": 1
        },
        "labels": [
          "text"
        ],
        "last_seen_at": "2026-03-30T19:49:44.485Z",
        "risk_score": 1,
        "tags": [
          {
            "key": "text",
            "value": "text"
          }
        ],
        "updated_at": "2026-03-30T19:49:44.485Z"
      },
      "type": "group_values"
    }
  ],
  "links": {
    "self": "https://example.com"
  }
}

Get available filter fields - Group scope (Early Access)

get

Returns a list of valid field names that can be used for filtering assets using RSQL. Each field includes its name, data type, and which asset types it applies to.

Required permissions

View Groups (group.read)

Authorizations

AuthorizationstringRequired

API key value must be prefixed with "Token ".

Path parameters

group_idstring · uuidRequired

The unique identifier of the group

Query parameters

versionstringOptional

The requested API version

Example: 2024-10-15Pattern: ^\d{4}-\d{2}-\d{2}$

asset_typesstringOptional

Comma-separated list of asset types to filter the available filter fields

Example: container_images

limitinteger · min: 10 · max: 100Optional

Number of results to return

Default: 10

starting_afterstringOptional

Cursor for fetching the next page of results

ending_beforestringOptional

Cursor for fetching the previous page of results

Responses

200

List of available filter fields

application/vnd.api+json

400

Bad Request: A parameter provided as a part of the request was invalid.

application/vnd.api+json

401

Unauthorized: the request requires an authentication token.

application/vnd.api+json

403

Forbidden: the request requires an authentication token with more or different permissions.

application/vnd.api+json

500

Internal Server Error: An error was encountered while attempting to process the request.

application/vnd.api+json

get

/groups/{group_id}/inventory/assets/filters

GET /rest/groups/{group_id}/inventory/assets/filters HTTP/1.1
Host: api.snyk.io
Authorization: YOUR_API_KEY
Accept: */*

{
  "data": [
    {
      "attributes": {
        "asset_types": [
          "container_images"
        ],
        "name": "text",
        "type": "string"
      },
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "relationships": {
        "values": {
          "links": {
            "related": "../folder"
          }
        }
      },
      "type": "filter_fields"
    }
  ],
  "links": {
    "self": "https://example.com"
  }
}

Get filter value suggestions (autocomplete) - Group scope (Early Access)

get

Returns a list of distinct values for a specific filter field. Useful for building autocomplete functionality in filter UIs.

Use the UUID from the filter fields list endpoint to identify which field to query.

For object filter values, both the keys and values are returned.

Required permissions

View Groups (group.read)

Authorizations

AuthorizationstringRequired

API key value must be prefixed with "Token ".

Path parameters

group_idstring · uuidRequired

The unique identifier of the group

filter_idstring · uuidRequired

The UUID of the filter field to get values for (from the filter fields list endpoint)

Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6

Query parameters

versionstringOptional

The requested API version

Example: 2024-10-15Pattern: ^\d{4}-\d{2}-\d{2}$

qstring · max: 100Optional

Example: prod

limitinteger · min: 10 · max: 100Optional

Number of results to return

Default: 10

starting_afterstringOptional

Cursor for fetching the next page of results

ending_beforestringOptional

Cursor for fetching the previous page of results

keys_onlybooleanOptional

Return only the keys of the object filter values

keystringOptional

Return only the value for a specific key of the object filter values

Responses

200

List of filter values

application/vnd.api+json

400

Bad Request: A parameter provided as a part of the request was invalid.

application/vnd.api+json

401

Unauthorized: the request requires an authentication token.

application/vnd.api+json

403

Forbidden: the request requires an authentication token with more or different permissions.

application/vnd.api+json

404

Not Found: The resource being operated on could not be found.

application/vnd.api+json

500

Internal Server Error: An error was encountered while attempting to process the request.

application/vnd.api+json

get

/groups/{group_id}/inventory/assets/filters/{filter_id}/values

GET /rest/groups/{group_id}/inventory/assets/filters/{filter_id}/values HTTP/1.1
Host: api.snyk.io
Authorization: YOUR_API_KEY
Accept: */*

{
  "data": [
    {
      "attributes": {
        "key": "text",
        "value": "text"
      },
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "type": "filter_values"
    }
  ],
  "links": {
    "self": "https://example.com"
  }
}

PreviousIntegrations (v1)NextInvites

Last updated 14 days ago

Was this helpful?

hashtagBulk update asset attributes (Early Access)

Required permissions

hashtagList or search all assets (synchronous) (Early Access)

Required permissions

hashtagUpdate asset attributes (Early Access)

Required permissions

hashtagGet a single asset by ID (Early Access)

Required permissions

hashtagList targets for an asset (Early Access)

Required permissions

hashtagList projects for an asset (Early Access)

Required permissions

hashtagCreate an asset search (asynchronous) (Early Access)

Required permissions

hashtagRetrieve asset search results (asynchronous) (Early Access)

Required permissions

hashtagGet available group fields (Early Access)

Required permissions

hashtagGet group value aggregation (Early Access)

Required permissions

hashtagGet available filter fields (Early Access)

Required permissions

hashtagGet filter value suggestions (autocomplete) (Early Access)

Required permissions

hashtagBulk update asset attributes - Org scope (Early Access)

Required permissions

hashtagList or search all assets (synchronous) - Org scope (Early Access)

Required permissions

hashtagUpdate asset attributes - Org scope (Early Access)

Required permissions

hashtagGet a single asset by ID - Org scope (Early Access)

Required permissions

hashtagList targets for an asset (org scope) (Early Access)

Required permissions

hashtagList projects for an asset (org scope) (Early Access)

Required permissions

hashtagCreate an asset search (asynchronous) - Org scope (Early Access)

Required permissions

hashtagRetrieve asset search results (asynchronous) - Org scope (Early Access)

Required permissions

hashtagGet available group fields - Org scope (Early Access)

Required permissions

hashtagGet group value aggregation - Org scope (Early Access)

Required permissions

hashtagGet available filter fields - Org scope (Early Access)

Required permissions

hashtagGet filter value suggestions (autocomplete) - Org scope (Early Access)

Required permissions

hashtagBulk update asset attributes - Group scope (Early Access)

Required permissions

hashtagList or search all assets (synchronous) - Group scope (Early Access)

Required permissions

hashtagUpdate asset attributes - Group scope (Early Access)

Required permissions

hashtagGet a single asset by ID - Group scope (Early Access)

Required permissions

hashtagList targets for an asset (group scope) (Early Access)

Required permissions

hashtagList projects for an asset (group scope) (Early Access)

Required permissions

hashtagCreate an asset search (asynchronous) - Group scope (Early Access)

Required permissions

hashtagRetrieve asset search results (asynchronous) - Group scope (Early Access)

Required permissions

hashtagGet available group fields - Group scope (Early Access)

Required permissions

hashtagGet group value aggregation - Group scope (Early Access)

Required permissions

hashtagGet available filter fields - Group scope (Early Access)

Required permissions

hashtagGet filter value suggestions (autocomplete) - Group scope (Early Access)

Required permissions

Bulk update asset attributes (Early Access)

List or search all assets (synchronous) (Early Access)

Update asset attributes (Early Access)

Get a single asset by ID (Early Access)

List targets for an asset (Early Access)

List projects for an asset (Early Access)

Create an asset search (asynchronous) (Early Access)

Retrieve asset search results (asynchronous) (Early Access)

Get available group fields (Early Access)

Get group value aggregation (Early Access)

Get available filter fields (Early Access)

Get filter value suggestions (autocomplete) (Early Access)

Bulk update asset attributes - Org scope (Early Access)

List or search all assets (synchronous) - Org scope (Early Access)

Update asset attributes - Org scope (Early Access)

Get a single asset by ID - Org scope (Early Access)

List targets for an asset (org scope) (Early Access)

List projects for an asset (org scope) (Early Access)

Create an asset search (asynchronous) - Org scope (Early Access)

Retrieve asset search results (asynchronous) - Org scope (Early Access)

Get available group fields - Org scope (Early Access)

Get group value aggregation - Org scope (Early Access)

Get available filter fields - Org scope (Early Access)

Get filter value suggestions (autocomplete) - Org scope (Early Access)

Bulk update asset attributes - Group scope (Early Access)

List or search all assets (synchronous) - Group scope (Early Access)

Update asset attributes - Group scope (Early Access)

Get a single asset by ID - Group scope (Early Access)

List targets for an asset (group scope) (Early Access)

List projects for an asset (group scope) (Early Access)

Create an asset search (asynchronous) - Group scope (Early Access)

Retrieve asset search results (asynchronous) - Group scope (Early Access)

Get available group fields - Group scope (Early Access)

Get group value aggregation - Group scope (Early Access)

Get available filter fields - Group scope (Early Access)

Get filter value suggestions (autocomplete) - Group scope (Early Access)