Snyk REST API - SBOMs

{"components":{"examples":{"CloudListIssuesResponse":{"summary":"An example of a list issue response for a Cloud issue.","value":{"data":[{"attributes":{"classes":[{"id":"data","source":"snyk-cloud","type":"rule-category"},{"id":"CIS-AWS_v1.3.0_2.1.2","source":"CIS-AWS_v1.3.0","type":"compliance"},{"id":"CIS-AWS_v1.4.0_2.1.2","source":"CIS-AWS_v1.4.0","type":"compliance"},{"id":"HIPAA_§164.306(a)","source":"HIPAA_v2013","type":"compliance"},{"id":"HIPAA_§164.312(a)(2)(iv)","source":"HIPAA_v2013","type":"compliance"},{"id":"HIPAA_v2013_164.312(e)(2)(ii)","source":"HIPAA_v2013","type":"compliance"}],"coordinates":[{"remedies":[{"description":"1. Go to the AWS console\n2. Navigate to the S3 service page\n3. ...","type":"manual"},{"description":"1. Find the corresponding AWS::S3::Bucket resource\n2. ...","type":"cloudformation"},{"description":"1. Find the corresponding aws_s3_bucket resource\n2. ...","type":"terraform"},{"description":"Buckets should not ...","type":"rule_result_message"}],"representations":[{"cloud_resource":{"environment":{"id":"b50f2832-a901-565e-9e06-e4e59e8582b6","name":"Staging","native_id":"721018433921","type":"aws"},"resource":{"id":"b50f2832-a901-565e-9e06-e4e59e8582b7","input_type":"cloud_scan","location":"us-east-1","name":"policy-test-remediation","native_id":"arn:aws:s3:::policy-test-remediation","platform":"aws","resource_type":"aws_s3_bucket","tags":{"Stage":"Prod"},"type":"cloud"}}}]}],"created_at":"2022-09-27T20:09:05Z","description":"To protect data in transit, an S3 bucket policy should deny all HTTP requests to its objects and allow only HTTPS requests. HTTPS uses Transport Layer Security (TLS) to encrypt data, which preserves integrity and prevents tampering.","effective_severity_level":"medium","ignored":false,"key":"b50f2832-a901-565e-9e06-e4e59e8582b6","problems":[{"id":"SNYK-CC-00181","source":"snyk-cloud","type":"rule"}],"resolution":{"details":"rule_passed","resolved_at":"2022-09-28T20:09:05Z","type":"fixed"},"status":"resolved","title":"S3 bucket policies should only allow requests that use HTTPS","tool":"snyk://cloud","type":"cloud","updated_at":"2022-09-28T20:09:05Z"},"id":"d8db944b-d25a-477d-9c26-a63befad8ada","relationships":{"organization":{"data":{"id":"81e93f62-135f-48bc-84d0-47f16822313f","type":"organization"}},"scan_item":{"data":{"id":"24c8e771-ab3b-4e85-ac4f-f73950ba4acf","type":"environment"}}},"type":"issue"}],"jsonapi":{"version":"1.0"}}},"CodeListIssuesResponse20240123":{"summary":"An example of a list issue response for a Code issue.","value":{"data":[{"attributes":{"created_at":"2022-09-27T20:09:05Z","effective_severity_level":"low","ignored":false,"key":"24018479-6bb1-4196-a41b-e54c7c5dcc82:1c6ddc45.7f41fd64.a214ef38.72ad650e.f0ecbaa5.18c3080a.b570850e.89112ac5.1a6d2cd5.71413d6f.a924ef28.71cdd50e.d0e1bea5.52c3a80a.1a0c4319.a9127ac5:1","status":"resolved","title":"Insecure hash function used","type":"code","updated_at":"2022-09-27T20:09:05Z"},"id":"d5b640e5-d88c-4c17-9bf0-93597b7a1ce2","relationships":{"organization":{"data":{"id":"a3952187-0d8e-45d8-9aa2-036642857b5b","type":"organization"}},"scan_item":{"data":{"id":"a3952187-0d8e-45d8-9aa2-036642857b5c","type":"project"}}},"type":"issue"}],"jsonapi":{"version":"1.0"}}},"GetBrokerSettingsResponseEmpty":{"summary":"No integrations configured","value":{"data":{"integrations":[]},"jsonapi":{"version":"1.0"},"links":{"self":"/orgs/82b3efbb-4b32-4f96-8005-9444eceacec8/settings/opensource/Dotnet/broker?version=2024-10-15"}}},"GetBrokerSettingsResponseWithIntegrations":{"summary":"Broker settings with some integrations configured","value":{"data":{"integrations":[{"created_at":"2026-04-15T10:00:00.000Z","id":"019d7722-72c3-7ae4-bb4e-40deea1820c0","integration_type":"artifactory","urls":["https://artifactory.internal-domain.com/artifactory/api/nuget/v3/nuget-group/index.json"]},{"created_at":"2026-04-16T10:00:00.000Z","id":"019d7722-90bd-7bc0-9666-775eee165cf0","integration_type":"nexus-private-repo","urls":["https://nexus.internal-domain.com/repository/nuget-hosted/index.json","https://nexus.internal-domain.com/repository/nuget-proxy/index.json"]}]},"jsonapi":{"version":"1.0"},"links":{"self":"/orgs/db2557c3-ecb8-4d45-8e1e-894ae89a92a6/settings/opensource/Dotnet/broker?version=2024-10-15"}}},"IaCListIssuesResponse20240123":{"summary":"An example of a list issue response for an Infrastructure as Code issue.","value":{"data":[{"attributes":{"created_at":"2022-09-27T20:09:05Z","effective_severity_level":"low","ignored":false,"key":"ff35a5c4d1cb4a1fd29c38b70f8ab89d1efea9d75aabf3a202d94f4776714b6191e2747cded23ba6cd7a47017a505a5d2c0823b69106ee2be0c11a18aa44b8a4","status":"resolved","title":"Container is running with writable root filesystem","type":"cloud","updated_at":"2022-09-27T20:09:05Z"},"id":"d5b640e5-d88c-4c17-9bf0-93597b7a1ce2","relationships":{"organization":{"data":{"id":"a3952187-0d8e-45d8-9aa2-036642857b5b","type":"organization"}},"scan_item":{"data":{"id":"a3952187-0d8e-45d8-9aa2-036642857b5c","type":"project"}}},"type":"issue"}],"jsonapi":{"version":"1.0"}}},"OpenSourceListIssuesResponse20240123":{"summary":"An example of a list issue response for an Open Source issue.","value":{"data":[{"attributes":{"created_at":"2022-09-27T20:09:05Z","effective_severity_level":"medium","ignored":false,"key":"npm:hoek:20180212:hoek:2.16.3","status":"resolved","title":"Hoek - Prototype Pollution","type":"package_vulnerability","updated_at":"2022-09-27T20:09:05Z"},"id":"d5b640e5-d88c-4c17-9bf0-93597b7a1ce2","relationships":{"organization":{"data":{"id":"a3952187-0d8e-45d8-9aa2-036642857b5b","type":"organization"}},"scan_item":{"data":{"id":"a3952187-0d8e-45d8-9aa2-036642857b5c","type":"project"}}},"type":"issue"}],"jsonapi":{"version":"1.0"}}},"PostBrokerSettingsRequestAddIntegration":{"summary":"Add an integration","value":{"data":{"integrations":[{"integration_type":"artifactory","urls":["https://artifactory.internal-domain.com/artifactory/api/nuget/v3/team-nuget/index.json"]}]}}},"PostBrokerSettingsRequestEditIntegrations":{"summary":"Edit multiple integrations at once","value":{"data":{"integrations":[{"integration_type":"artifactory","urls":["https://artifactory.internal-domain.com/artifactory/api/nuget/v3/sandbox-nuget/index.json","https://artifactory.internal-domain.com/artifactory/api/nuget/v3/production-nuget/index.json"]},{"integration_type":"nexus-private-repo","urls":[]}]}}},"PostBrokerSettingsRequestRemoveIntegration":{"summary":"Remove an integration by setting empty urls","value":{"data":{"integrations":[{"integration_type":"nexus-private-repo","urls":[]}]}}},"PostBrokerSettingsResponse":{"summary":"Response after updating broker settings","value":{"data":{"integrations":[{"created_at":"2024-01-15T10:00:00.000Z","id":"019d7722-d843-7b9f-a1dd-bd5c0bac373d","integration_type":"artifactory","urls":["https://artifactory.internal-domain.com/artifactory/api/nuget/v3/team-nuget/index.json"]}]},"jsonapi":{"version":"1.0"},"links":{"self":"/orgs/4f4fbf18-b2cd-4bf3-9b7e-323b8be249ea/settings/opensource/Dotnet/broker?version=2024-10-15"}}}},"headers":{"DeprecationHeader":{"description":"A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","example":"2021-07-01T00:00:00Z","schema":{"format":"date-time","type":"string"}},"DeprecationHeader__0":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","example":"2021-07-01T00:00:00Z","schema":{"format":"date-time","type":"string"}},"Location":{"schema":{"type":"string"}},"LocationHeader":{"description":"A header providing a URL for the location of a resource\n","example":"https://example.com/resource/4","schema":{"format":"url","type":"string"}},"RequestIdResponseHeader":{"description":"A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","schema":{"format":"uuid","type":"string"}},"RequestIdResponseHeader__0":{"description":"A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","schema":{"format":"uuid","type":"string"}},"RetryAfter":{"description":"Retry after seconds","example":45,"schema":{"type":"integer"}},"SunsetHeader":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","type":"string"}},"SunsetHeader__0":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","type":"string"}},"VersionRequestedResponseHeader":{"description":"A header containing the version of the endpoint requested by the caller.","example":"2026-03-25","schema":{"$ref":"#/components/schemas/QueryVersion"}},"VersionRequestedResponseHeader__0":{"description":"The version of the endpoint requested by the caller.","example":"2021-06-04","schema":{"description":"Requested API version","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"VersionServedResponseHeader":{"description":"A header containing the version of the endpoint that was served by the API.","example":"2026-03-25","schema":{"$ref":"#/components/schemas/ActualVersion"}},"VersionServedResponseHeader__0":{"description":"The version of the endpoint that was served by the API.","example":"2021-06-04","schema":{"description":"Resolved API version","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"VersionStageResponseHeader":{"description":"A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"VersionStageResponseHeader__0":{"description":"The version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}}},"parameters":{"Accept":{"in":"header","name":"Accept","schema":{"type":"string"}},"AggregateGroupValues":{"description":"Per-field aggregate function override for meta fields.\nAll fields default to `last` when not specified.\n`max`/`min` compute the SQL MAX/MIN across all assets in the group (scalar fields only).\n`first`/`last` returns the value from the single asset with the earliest/latest\nupdated_at in the group (all field types).\n`sum` computes the total across all assets (numeric fields, issues, labels, tags).\n","explode":true,"in":"query","name":"aggregate","schema":{"properties":{"built_at":{"default":"last","enum":["max","min","first","last"],"type":"string"},"issues":{"default":"last","enum":["first","last","sum"],"type":"string"},"labels":{"default":"last","enum":["first","last","sum"],"type":"string"},"last_seen_at":{"default":"last","enum":["max","min","first","last"],"type":"string"},"risk_score":{"default":"last","enum":["max","min","first","last","sum"],"type":"string"},"tags":{"default":"last","enum":["first","last","sum"],"type":"string"},"updated_at":{"default":"last","enum":["max","min","first","last"],"type":"string"}},"type":"object"},"style":"deepObject"},"AiBomIdParam":{"description":"The ai_bom id","in":"path","name":"ai_bom_id","required":true,"schema":{"format":"uuid","type":"string"}},"ApiVersion":{"description":"The requested version of the endpoint to process the request","example":"2025-11-05","in":"query","name":"version","required":true,"schema":{"default":"2025-11-05","description":"Requested API version","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"AppId":{"description":"App ID","in":"path","name":"app_id","required":true,"schema":{"$ref":"#/components/schemas/Uuid"}},"AssetId":{"description":"Unique identifier for the Asset","in":"path","name":"asset_id","required":true,"schema":{"format":"uuid","type":"string"}},"AssetTypeFilter":{"description":"Filter by asset type","in":"query","name":"type","schema":{"enum":["repository","package","image"],"type":"string"}},"AssignableByMe":{"description":"When true, only return roles that the current user can assign to others in the tenant.","in":"query","name":"assignable_by_me","schema":{"$ref":"#/components/schemas/AssignableByMe"}},"BotId":{"description":"Bot ID","in":"path","name":"bot_id","required":true,"schema":{"$ref":"#/components/schemas/Uuid"}},"Cascade":{"description":"indicates whether to delete the child org memberships of the group membership.","in":"query","name":"cascade","schema":{"type":"boolean"}},"ChannelId":{"description":"Slack Channel ID","in":"path","name":"channel_id","required":true,"schema":{"format":"uri","type":"string"}},"ChannelLimit":{"description":"Number of results to return per page","example":100,"in":"query","name":"limit","schema":{"default":1000,"format":"int32","maximum":1000,"minimum":10,"multipleOf":10,"type":"integer"}},"ClientId":{"description":"Client ID","in":"path","name":"client_id","required":true,"schema":{"$ref":"#/components/schemas/Uuid"}},"CollectionId":{"description":"Unique identifier for a collection","in":"path","name":"collection_id","required":true,"schema":{"format":"uuid","type":"string"}},"CompletionInterval":{"description":"Filter by date interval in ISO 8601 format (e.g. 2024-01-01/2024-02-01)","in":"query","name":"completion_interval","schema":{"$ref":"#/components/schemas/DateInterval"}},"ConnectionId":{"description":"Connection ID","in":"path","name":"connection_id","required":true,"schema":{"format":"uuid","type":"string"}},"ConnectionTypeFilter":{"description":"Filter the response by Users that match the provided connection type","in":"query","name":"connection_type","schema":{"type":"string"}},"ContentSource":{"description":"The source of educational resources","in":"query","name":"content_source","schema":{"enum":["source-preview","cache"],"type":"string"}},"ContextId":{"description":"Context ID","in":"path","name":"context_id","required":true,"schema":{"format":"uuid","type":"string"}},"CreatedAfter":{"description":"Return environments created after this date","example":"2022-05-06T12:25:15-04:00","in":"query","name":"created_after","schema":{"format":"date-time","type":"string"}},"CreatedBefore":{"description":"Return environments created before this date","example":"2022-05-06T12:25:15-04:00","in":"query","name":"created_before","schema":{"format":"date-time","type":"string"}},"CredentialId":{"description":"Credential ID","in":"path","name":"credential_id","required":true,"schema":{"format":"uuid","type":"string"}},"Cursor":{"description":"The ID for the next page of results.","in":"query","name":"cursor","schema":{"type":"string"}},"Custom":{"description":"Whether role is custom or not.","in":"query","name":"custom","schema":{"$ref":"#/components/schemas/Custom"}},"CustomBaseImageId":{"description":"Unique identifier for custom base image","in":"path","name":"custombaseimage_id","required":true,"schema":{"format":"uuid","type":"string"}},"Cves":{"description":"Filter by CVE rules","in":"query","name":"cves","schema":{"$ref":"#/components/schemas/Cves"}},"Cwes":{"description":"Filter by CWE rules","in":"query","name":"cwes","schema":{"$ref":"#/components/schemas/Cwes"}},"DeploymentId":{"description":"Deployment ID","in":"path","name":"deployment_id","required":true,"schema":{"format":"uuid","type":"string"}},"Ecosystem":{"description":"The package ecosystem","in":"path","name":"ecosystem","required":true,"schema":{"enum":["npm","pypi","maven","nuget","golang"],"example":"npm","type":"string"}},"EffectiveSeverityLevel":{"description":"One or more effective severity levels to filter issues.","explode":false,"in":"query","name":"effective_severity_level","schema":{"items":{"enum":["info","low","medium","high","critical"],"type":"string"},"type":"array"},"style":"form"},"EmailFilter":{"description":"Filter the response by Users that match the provided email","in":"query","name":"email","schema":{"type":"string"}},"Emails":{"description":"Filter by user email addresses","example":["[email protected]","[email protected]"],"explode":false,"in":"query","name":"emails","schema":{"$ref":"#/components/schemas/Emails"},"style":"form"},"EndingBefore":{"description":"Return the page of results immediately before this cursor","example":"v1.eyJpZCI6IjExMDAifQo=","in":"query","name":"ending_before","schema":{"type":"string"}},"EndingBeforeCursor":{"description":"Return records before the record identified by this cursor","example":"v1.MTIzNDU2Nzg5MHxhYmNkZWY=","in":"query","name":"ending_before","schema":{"type":"string"}},"EndingBeforeCursor__0":{"description":"Return records before the record identified by cursor position ending_before","in":"query","name":"ending_before","schema":{"type":"string"}},"EnvironmentId":{"description":"Unique identifier for an environment","example":"052781a7-17f6-494d-0000-25c8b509abcd","in":"path","name":"environment_id","required":true,"schema":{"format":"uuid","type":"string"}},"EnvironmentIdQuery":{"description":"Filter resources by environment ID (multi-value, comma-separated)","example":"052781a7-17f6-494d-0000-25c8b509abcd","explode":false,"in":"query","name":"environment_id","schema":{"format":"uuid","type":"string"},"style":"form"},"Events":{"description":"Filter logs by event types, cannot be used in conjunction with exclude_events parameter.","in":"query","name":"events","schema":{"items":{"type":"string"},"type":"array"}},"Exclude":{"description":"An array of features to be excluded from the generated SBOM.","in":"query","name":"exclude","schema":{"items":{"enum":["licenses"],"type":"string"},"type":"array"}},"ExcludeEvents":{"description":"Exclude event types from results, cannot be used in conjunctions with events parameter.","in":"query","name":"exclude_events","schema":{"items":{"type":"string"},"type":"array"}},"ExpandPermissions":{"description":"option to show all permission types","in":"query","name":"expand_permissions","schema":{"default":false,"type":"boolean"}},"ForceUpdate":{"description":"flag to force the update of a role, required if users are assigned to the role","in":"query","name":"force","schema":{"$ref":"#/components/schemas/ForceUpdate"}},"Format":{"description":"The desired SBOM format of the response.","in":"query","name":"format","schema":{"enum":["cyclonedx1.6+json","cyclonedx1.6+xml","cyclonedx1.5+json","cyclonedx1.5+xml","cyclonedx1.4+json","cyclonedx1.4+xml","spdx2.3+json"],"example":"cyclonedx1.6+json","type":"string"}},"From":{"description":"The start date (inclusive) of the audit logs search. If not specified, the start of yesterday is used. Dates should be formatted as RFC3339, e.g. 2024-01-02T16:30:00Z.\n","in":"query","name":"from","schema":{"format":"date-time","type":"string"}},"GoModuleLevel":{"description":"When true, consolidate Go package-level dependencies into module-level components in the SBOM. Only applies to gomodules graphs; default is false.","in":"query","name":"go_module_level","schema":{"default":false,"type":"boolean"}},"GroupId":{"description":"The ID of the Group.","example":"0d3728ec-eebf-484d-9907-ba238019f10b","in":"path","name":"group_id","required":true,"schema":{"format":"uuid","type":"string"}},"HasUsersAssigned":{"description":"returns current memberships of the role in the meta relationships section","in":"query","name":"has_users_assigned","schema":{"default":false,"type":"boolean"}},"Id":{"description":"Filter resources by resource UUID (multi-value, comma-separated)","example":"4a662442-7445-55c3-adcc-cbbbdd99999","explode":false,"in":"query","name":"id","schema":{"type":"string"},"style":"form"},"IdInQuery":{"description":"Filter environments by environment ID (multi-value, comma-separated)","example":"052781a7-17f6-494d-0000-25c8b509abcd","in":"query","name":"id","schema":{"format":"uuid","type":"string"}},"Ignored":{"description":"Whether an issue is ignored or not.","in":"query","name":"ignored","schema":{"type":"boolean"},"style":"form"},"ImageId20231102":{"description":"Image ID","in":"path","name":"image_id","required":true,"schema":{"example":"sha256:2bd864580926b790a22c8b96fd74496fe87b3c59c0774fe144bab2788e78e676","format":"uri","pattern":"^sha256(:|%3A)[a-f0-9]{64}$","type":"string"}},"ImageIds":{"description":"A comma-separated list of Image IDs","example":["sha256:b26f21f90920dba8401e30b89ad803587f81cce9bd1f92750f963556da2f930f","sha256:28984a62eb713aa5fff922ba06e8689f20e4b2f07de30f3d753b868389c0904f"],"explode":false,"in":"query","name":"image_ids","schema":{"items":{"format":"uri","pattern":"^sha256(:|%3A)[a-f0-9]{64}$","type":"string"},"maxItems":100,"type":"array"},"style":"form"},"IncludeGroupMembershipCount":{"description":"indicates whether the count of group memberships is included","in":"query","name":"include_group_membership_count","schema":{"type":"boolean"}},"IncludeInRecommendations":{"description":"Whether this image should be recommended as a base image upgrade","in":"query","name":"include_in_recommendations","schema":{"type":"boolean"}},"InstallId":{"description":"Install ID","in":"path","name":"install_id","required":true,"schema":{"format":"uuid","type":"string"}},"IntegrationId":{"description":"Integration ID","in":"path","name":"integration_id","required":true,"schema":{"format":"uuid","type":"string"}},"JobId":{"description":"Job ID","in":"path","name":"job_id","required":true,"schema":{"format":"uuid","type":"string"}},"JobIdParam":{"description":"The job id","in":"path","name":"job_id","required":true,"schema":{"format":"uuid","type":"string"}},"Kind":{"description":"Filter resources by kind (multi-value, comma-separated): cloud","example":"cloud","explode":false,"in":"query","name":"kind","schema":{"$ref":"#/components/schemas/ResourceKind"},"style":"form"},"KindInQuery":{"description":"Filter environments by kind (multi-value, comma-separated): aws","example":"aws","in":"query","name":"kind","schema":{"$ref":"#/components/schemas/EnvironmentKind"}},"Limit":{"description":"Number of results to return per page","example":10,"in":"query","name":"limit","schema":{"default":10,"format":"int32","maximum":100,"minimum":10,"multipleOf":10,"type":"integer"}},"Limit__0":{"description":"Number of records to return","in":"query","name":"limit","schema":{"default":10,"maximum":100,"minimum":10,"type":"number"}},"Location":{"description":"Filter resources by location (multi-value, comma-separated) (AWS region)","example":"us-west-2","explode":false,"in":"query","name":"location","schema":{"type":"string"},"style":"form"},"MembershipId":{"description":"Unique identifier of the tenant membership.","in":"path","name":"membership_id","required":true,"schema":{"$ref":"#/components/schemas/TenantMembershipId"}},"MetaCount":{"description":"Provide summary count in the response meta object when requested.\nWhen `with` is provided, the count will be included in the response meta object.\nWhen `only` is provided, the count will be included in the response meta object and no data will be returned.\n","example":"with","in":"query","name":"meta_count","schema":{"enum":["with","only"],"type":"string"}},"MetaFieldsGroupValues":{"description":"Meta fields to include in the response. Multiple fields can be specified.\n\nAvailable fields:\n  - `count` - Number of assets with this value\n  - `last_seen_at` - Aggregated last_seen_at timestamp (default aggregation: last)\n  - `updated_at` - Aggregated updated_at timestamp (default aggregation: last)\n  - `risk_score` - Aggregated risk score from discovery sources (default aggregation: last)\n  - `issues` - Aggregated issue counts (critical, high, medium, low, total) (default aggregation: last)\n  - `labels` - Labels across assets (default aggregation: last)\n  - `tags` - Tags across assets (default aggregation: last)\n  - `built_at` - Aggregated container image build timestamp (default aggregation: last)\n  - `all` - Include all available meta fields\n\nAll fields default to the `last` aggregation function, which returns the value\nfrom the asset with the most recent updated_at in the group. Use the `aggregate`\nparameter to override the aggregation function per field.\n\nIf not specified, the meta object is not included in the response.\n\nNote: Requesting meta fields may impact response time as aggregations\nrequire additional computation.\n","example":["count","risk_score","issues","labels"],"explode":false,"in":"query","name":"meta_fields","schema":{"items":{"enum":["count","last_seen_at","updated_at","risk_score","issues","labels","tags","built_at","all"],"type":"string"},"type":"array"},"style":"form"},"Name":{"description":"Filter resources by name (multi-value, comma-separated)","example":"example-bucket","explode":false,"in":"query","name":"name","schema":{"type":"string"},"style":"form"},"NameFilter":{"description":"Filter the response by Users that match the provided name","in":"query","name":"name","schema":{"type":"string"}},"NameInQuery":{"description":"Filter environments by name (multi-value, comma-separated)","example":"Demo AWS Environment","in":"query","name":"name","schema":{"$ref":"#/components/schemas/EnvironmentName"}},"Names":{"description":"The container registry names","example":["gcr.io/snyk/redis:5"],"explode":false,"in":"query","name":"names","schema":{"items":{"$ref":"#/components/schemas/ImageName"},"maxItems":1,"type":"array"},"style":"form"},"NativeId":{"description":"Filter resources by native ID (multi-value, comma-separated) (AWS ARN)","example":"arn:aws:s3:::example-bucket","explode":false,"in":"query","name":"native_id","schema":{"type":"string"},"style":"form"},"OrderBy":{"description":"The column name to sort on","in":"query","name":"order_by","schema":{"enum":["created","expires","ignore-type","requested-by"],"type":"string"}},"OrderDirection":{"description":"Sorting direction ASC/DESC","in":"query","name":"order_direction","schema":{"enum":["asc","desc"],"type":"string"}},"OrgId":{"description":"The ID of the organization.","example":"0d3728ec-eebf-484d-9907-ba238019f10b","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}},"OrgIdFilter":{"description":"The IDs of the org to filter by","explode":false,"in":"query","name":"org_id","schema":{"items":{"format":"uuid","type":"string"},"type":"array"},"style":"form"},"OrgIdParam":{"description":"Org ID","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}},"OrgId__0":{"description":"Org ID","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}},"OrgMembershipId":{"description":"The id of the org membership","in":"path","name":"membership_id","required":true,"schema":{"format":"uuid","type":"string"}},"OrgName":{"description":"The Name of the org","in":"query","name":"org_name","schema":{"description":"Organization name","example":"Org name","type":"string"}},"PackageName":{"description":"Package name (URL encoded if needed)","in":"path","name":"package_name","required":true,"schema":{"example":"express","type":"string"}},"PackageUrl":{"description":"A URI-encoded Package URL (purl). Supported purl types are apk, cargo, cocoapods, composer, conan, deb, gem, generic, golang, hex, maven, npm, nuget, pub, pypi, rpm, and swift. A version for the package is also required. Maven packages support an optional checksum qualifier to request checksum validation. When provided, the response will include checksum validation metadata indicating whether the package and checksum match records in Snyk's database. Checksum format: `algorithm:hex_value` (lowercase), for example `sha1:ad9503c3e994a4f611a4892f2e67ac82df727086`. Only one checksum is supported per request. Supported algorithms: md5, sha1, sha256, sha512.","example":"pkg:maven/com.fasterxml.woodstox/[email protected]?checksum=sha1:ad9503c3e994a4f611a4892f2e67ac82df727086","in":"path","name":"purl","required":true,"schema":{"type":"string"}},"PackageVersion":{"description":"Package version (URL encoded if needed). Accepts semantic versioning formats (e.g., 1.2.3, v1.2.3).\nNote: Golang commit hashes are NOT supported.\n","in":"path","name":"package_version","required":true,"schema":{"example":"4.19.2","type":"string"}},"PathGroupId":{"description":"Unique identifier for group","in":"path","name":"group_id","required":true,"schema":{"example":"b667f176-df52-4b0a-9954-117af6b05ab7","format":"uuid","type":"string"}},"PathIssueId20240123":{"description":"Issue ID","in":"path","name":"issue_id","required":true,"schema":{"example":"4a18d42f-0706-4ad0-b127-24078731fbed","format":"uuid","type":"string"}},"PathOrgId":{"description":"Unique identifier for org","in":"path","name":"org_id","required":true,"schema":{"example":"b667f176-df52-4b0a-9954-117af6b05ab7","format":"uuid","type":"string"}},"PersonalAccessTokenId":{"description":"The personal access token id","in":"path","name":"personal_access_token_id","required":true,"schema":{"example":"01HSBP9DKDK39KWZQV84PSPRHY","format":"ulid","type":"string"}},"Platform":{"description":"Filter resources by platform (multi-value, comma-separated): aws","example":"aws","explode":false,"in":"query","name":"platform","schema":{"type":"string"},"style":"form"},"PolicyId":{"description":"Policy ID","in":"path","name":"policy_id","required":true,"schema":{"format":"uuid","type":"string"}},"ProjectId":{"description":"Filter logs by project ID.","example":"0d3728ec-eebf-484d-9907-ba238019f10b","in":"query","name":"project_id","schema":{"format":"uuid","type":"string"}},"ProjectSortParam":{"description":"Sort field with optional direction prefix. Prefix with `-` for descending order.\n\n**Supported fields:**\n- `snapshot_created_at` - Snapshot creation timestamp\n- `issues` - Issue counts by severity (critical, high, medium, low)\n\nWhen omitted, results are ordered by `snapshot_created_at` ascending.\n","example":"-snapshot_created_at","in":"query","name":"sort","schema":{"enum":["snapshot_created_at","-snapshot_created_at","issues","-issues"],"type":"string"}},"QueryExpand":{"description":"Expand the response with additional fields. When set to `count`, the response will include a `meta` object containing a `total_count` field with the total number of organizations in the group, ignoring any filters applied to the original query.","in":"query","name":"expand","schema":{"enum":["count"],"example":"count","type":"string"}},"QueryNameFilter":{"description":"Only return organizations whose name contains this value. Case insensitive.","in":"query","name":"name","schema":{"type":"string"}},"QuerySlugFilter":{"description":"Only return organizations whose slug exactly matches this value. Case sensitive.","in":"query","name":"slug","schema":{"type":"string"}},"Removed":{"description":"Filter resources by whether they have been removed or not.","example":true,"explode":false,"in":"query","name":"removed","schema":{"type":"boolean"},"style":"form"},"Repository":{"description":"The image repository","in":"query","name":"repository","schema":{"type":"string"}},"RepositoryUrlQuery":{"description":"Optional repository URL filter — restricts results to the canonical document containing this URL","in":"query","name":"url","schema":{"type":"string"}},"ResourceId":{"description":"Filter resources by resource ID (multi-value, comma-separated)","example":"example-bucket","explode":false,"in":"query","name":"resource_id","schema":{"type":"string"},"style":"form"},"ResourceType":{"description":"Filter resources by resource type (multi-value, comma-separated)","example":"aws_s3_bucket","explode":false,"in":"query","name":"resource_type","schema":{"type":"string"},"style":"form"},"Review":{"description":"Policy rule review state e.g. approved","explode":false,"in":"query","name":"review","schema":{"items":{"$ref":"#/com

# --- truncated at 32 KB (1789 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/snyk/refs/heads/main/openapi/snyk-rest-openapi.json