Changelog
2025-11-05
GET - /orgs/{org_id}/packages/{purl}/issues - Updated
/orgs/{org_id}/packages/{purl}/issues - Updatedfor the
queryrequest parameterlimit, the type/format was changed fromnumber/to `integer`/for the
queryrequest parameteroffset, the type/format was changed fromnumber/to `integer`/for the
queryrequest parameterlimit, the max was set to1000.00for the
queryrequest parameterlimit, the min was set to1.00for the
queryrequest parameteroffset, the min was set to0.00api operation id
fetchIssuesPerPurlremoved and replaced withgetIssuesPerPurladded the optional property
meta/matchto the response with the200status
POST - /orgs/{org_id}/packages/issues - Updated
/orgs/{org_id}/packages/issues - Updatedadded the optional property
meta/packagesto the response with the200status
2025-09-28 - Updated 2025-11-13
POST - /orgs/{org_id}/export - Updated
/orgs/{org_id}/export - Updatedadded the new optional request property
data/attributes/filters/empty_project_tags
POST - /groups/{group_id}/export - Updated
/groups/{group_id}/export - Updatedadded the new optional request property
data/attributes/filters/empty_project_tags
2025-09-28 - Updated 2025-11-13
GET - /orgs/{org_id}/issues - Updated
/orgs/{org_id}/issues - Updatedadded the optional property
data/items/attributes/coordinates/items/created_atto the response with the200statusadded the optional property
data/items/attributes/coordinates/items/last_introduced_atto the response with the200statusadded the optional property
data/items/attributes/coordinates/items/last_resolved_atto the response with the200statusadded the optional property
data/items/attributes/coordinates/items/last_resolved_detailsto the response with the200statusadded the optional property
data/items/attributes/coordinates/items/stateto the response with the200statusadded the optional property
data/items/attributes/coordinates/items/updated_atto the response with the200status
GET - /orgs/{org_id}/issues/{issue_id} - Updated
/orgs/{org_id}/issues/{issue_id} - Updatedadded the optional property
data/attributes/coordinates/items/created_atto the response with the200statusadded the optional property
data/attributes/coordinates/items/last_introduced_atto the response with the200statusadded the optional property
data/attributes/coordinates/items/last_resolved_atto the response with the200statusadded the optional property
data/attributes/coordinates/items/last_resolved_detailsto the response with the200statusadded the optional property
data/attributes/coordinates/items/stateto the response with the200statusadded the optional property
data/attributes/coordinates/items/updated_atto the response with the200status
GET - /groups/{group_id}/issues - Updated
/groups/{group_id}/issues - Updatedadded the optional property
data/items/attributes/coordinates/items/created_atto the response with the200statusadded the optional property
data/items/attributes/coordinates/items/last_introduced_atto the response with the200statusadded the optional property
data/items/attributes/coordinates/items/last_resolved_atto the response with the200statusadded the optional property
data/items/attributes/coordinates/items/last_resolved_detailsto the response with the200statusadded the optional property
data/items/attributes/coordinates/items/stateto the response with the200statusadded the optional property
data/items/attributes/coordinates/items/updated_atto the response with the200status
GET - /groups/{group_id}/issues/{issue_id} - Updated
/groups/{group_id}/issues/{issue_id} - Updatedadded the optional property
data/attributes/coordinates/items/created_atto the response with the200statusadded the optional property
data/attributes/coordinates/items/last_introduced_atto the response with the200statusadded the optional property
data/attributes/coordinates/items/last_resolved_atto the response with the200statusadded the optional property
data/attributes/coordinates/items/last_resolved_detailsto the response with the200statusadded the optional property
data/attributes/coordinates/items/stateto the response with the200statusadded the optional property
data/attributes/coordinates/items/updated_atto the response with the200status
2025-09-28 - Updated 2025-10-22
POST - /orgs/{org_id}/export - Updated
/orgs/{org_id}/export - Updatedadded the new optional request property
data/attributes/url_expiration_seconds
POST - /groups/{group_id}/export - Updated
/groups/{group_id}/export - Updatedadded the new optional request property
data/attributes/url_expiration_seconds
Changelog
2025-09-28 - Updated 2025-10-14
GET - /orgs/{org_id}/issues - Updated
the
data/items/attributes/coordinates/items/representations/items/oneOf[subschema #3]/cloud_resource/resource/nameresponse propertys maxLength was unset from256for the response status200`
GET - /orgs/{org_id}/issues/{issue_id} - Updated
the
data/attributes/coordinates/items/representations/items/oneOf[subschema #3]/cloud_resource/resource/nameresponse propertys maxLength was unset from256for the response status200`
GET - /groups/{group_id}/issues - Updated
the
data/items/attributes/coordinates/items/representations/items/oneOf[subschema #3]/cloud_resource/resource/nameresponse propertys maxLength was unset from256for the response status200`
GET - /groups/{group_id}/issues/{issue_id} - Updated
the
data/attributes/coordinates/items/representations/items/oneOf[subschema #3]/cloud_resource/resource/nameresponse propertys maxLength was unset from256for the response status200`
2025-09-28
POST - /orgs/{org_id}/policies - Updated
added the new optional request property
data/attributes/source
2024-10-15 - Updated 2025-09-29
POST - /orgs/{org_id}/export - Updated
added the new optional request property
data/attributes/filters/product_nameadded the new optional request property
data/attributes/filters/project_tagsadded the new optional request property
data/attributes/filters/project_type
POST - /groups/{group_id}/export - Updated
added the new optional request property
data/attributes/filters/product_nameadded the new optional request property
data/attributes/filters/project_tagsadded the new optional request property
data/attributes/filters/project_type
Changelog
2024-10-15 - Updated 2025-09-08
POST - /orgs/{org_id}/policies - Updated
removed the
cancelledenum value from thedata/attributes/reviewresponse property for the response status201
GET - /orgs/{org_id}/policies - Updated
removed the
cancelledenum value from thedata/items/attributes/reviewresponse property for the response status200
PATCH - /orgs/{org_id}/policies/{policy_id} - Updated
removed the enum value
cancelledof the request propertydata/attributes/reviewremoved the
cancelledenum value from thedata/attributes/reviewresponse property for the response status200
GET - /orgs/{org_id}/policies/{policy_id} - Updated
removed the
cancelledenum value from thedata/attributes/reviewresponse property for the response status200
2024-10-15 - Updated 2025-08-15
GET - /orgs/{org_id}/policies - Updated
added the new enum value
ignore-typeto thequeryrequest parameterorder_byadded the new enum value
requested-byto thequeryrequest parameterorder_by
2024-10-15 - Updated 2025-08-14
PATCH - /orgs/{org_id}/policies/{policy_id} - Updated
added the new
cancelledenum value to the request propertydata/attributes/review
2024-10-15 - Updated 2025-08-06
POST - /orgs/{org_id}/export - Updated
removed the request property
data/attributes/destination
POST - /groups/{group_id}/export - Updated
removed the request property
data/attributes/destination
2024-10-15 - Updated 2025-07-07
POST - /orgs/{org_id}/service_accounts - Updated
added the new
access_tokenenum value to thedata/attributes/auth_typeresponse property for the response status201added the new optional request property
data/attributes/access_token_expires_atadded the new
access_tokenenum value to the request propertydata/attributes/auth_typeadded the optional property
data/attributes/access_tokento the response with the201statusadded the optional property
data/attributes/access_token_expires_atto the response with the201statusadded the optional property
data/attributes/created_atto the response with the201status
GET - /orgs/{org_id}/service_accounts - Updated
added the new
access_tokenenum value to thedata/items/attributes/auth_typeresponse property for the response status200added the optional property
data/items/attributes/access_tokento the response with the200statusadded the optional property
data/items/attributes/access_token_expires_atto the response with the200statusadded the optional property
data/items/attributes/created_atto the response with the200status
PATCH - /orgs/{org_id}/service_accounts/{serviceaccount_id} - Updated
added the new
access_tokenenum value to thedata/attributes/auth_typeresponse property for the response status200added the optional property
data/attributes/access_tokento the response with the200statusadded the optional property
data/attributes/access_token_expires_atto the response with the200statusadded the optional property
data/attributes/created_atto the response with the200status
GET - /orgs/{org_id}/service_accounts/{serviceaccount_id} - Updated
added the new
access_tokenenum value to thedata/attributes/auth_typeresponse property for the response status200added the optional property
data/attributes/access_tokento the response with the200statusadded the optional property
data/attributes/access_token_expires_atto the response with the200statusadded the optional property
data/attributes/created_atto the response with the200status
POST - /orgs/{org_id}/service_accounts/{serviceaccount_id}/secrets - Updated
added the new
access_tokenenum value to thedata/attributes/auth_typeresponse property for the response status200added the optional property
data/attributes/access_tokento the response with the200statusadded the optional property
data/attributes/access_token_expires_atto the response with the200statusadded the optional property
data/attributes/created_atto the response with the200status
GET - /orgs/{org_id}/packages/{purl}/issues - Updated
added
#/components/schemas/ResourcePathRepresentation, #/components/schemas/PackageRepresentationto thedata/items/attributes/coordinates/items/representations/items/response propertyanyOflist for the response status200
POST - /orgs/{org_id}/packages/issues - Updated
added
#/components/schemas/ResourcePathRepresentation, #/components/schemas/PackageRepresentationto thedata/items/attributes/coordinates/items/representations/items/response propertyanyOflist for the response status200
POST - /groups/{group_id}/service_accounts - Updated
added the new
access_tokenenum value to thedata/attributes/auth_typeresponse property for the response status201added the new optional request property
data/attributes/access_token_expires_atadded the new
access_tokenenum value to the request propertydata/attributes/auth_typeadded the optional property
data/attributes/access_tokento the response with the201statusadded the optional property
data/attributes/access_token_expires_atto the response with the201statusadded the optional property
data/attributes/created_atto the response with the201status
GET - /groups/{group_id}/service_accounts - Updated
added the new
access_tokenenum value to thedata/items/attributes/auth_typeresponse property for the response status200added the optional property
data/items/attributes/access_tokento the response with the200statusadded the optional property
data/items/attributes/access_token_expires_atto the response with the200statusadded the optional property
data/items/attributes/created_atto the response with the200statusadded the optional property
metato the response with the200status
PATCH - /groups/{group_id}/service_accounts/{serviceaccount_id} - Updated
added the new
access_tokenenum value to thedata/attributes/auth_typeresponse property for the response status200added the optional property
data/attributes/access_tokento the response with the200statusadded the optional property
data/attributes/access_token_expires_atto the response with the200statusadded the optional property
data/attributes/created_atto the response with the200status
GET - /groups/{group_id}/service_accounts/{serviceaccount_id} - Updated
added the new
access_tokenenum value to thedata/attributes/auth_typeresponse property for the response status200added the optional property
data/attributes/access_tokento the response with the200statusadded the optional property
data/attributes/access_token_expires_atto the response with the200statusadded the optional property
data/attributes/created_atto the response with the200status
POST - /groups/{group_id}/service_accounts/{serviceaccount_id}/secrets - Updated
added the new
access_tokenenum value to thedata/attributes/auth_typeresponse property for the response status200added the optional property
data/attributes/access_tokento the response with the200statusadded the optional property
data/attributes/access_token_expires_atto the response with the200statusadded the optional property
data/attributes/created_atto the response with the200status
Changelog
2024-10-15 - Updated 2025-06-12
GET - /tenants - Added
Get a list of all Tenants which the calling user is a member of
PATCH - /tenants/{tenant_id} - Added
Update the details of a tenant
Required permissions
Edit Tenant Details (tenant.edit)
GET - /tenants/{tenant_id} - Added
Get the full details of a Tenant.
Required permissions
View Tenant Details (tenant.read)
POST - /tenants/{tenant_id}/brokers/installs/{install_id}/deployments/{deployment_id}/connections/{connection_id}/bulk_migration - Added
Performs bulk migration for integrations from legacy to universal broker
Required permissions
View Tenant Details (tenant.read)
GET - /tenants/{tenant_id}/brokers/installs/{install_id}/deployments/{deployment_id}/connections/{connection_id}/bulk_migration - Added
Lists organization IDs associated with a connection type to be bulk migrated to universal broker
Required permissions
View Tenant Details (tenant.read)
GET - /orgs/{org_id} - Updated
added the new optional
queryrequest parameterexpandadded the optional property
data/relationshipsto the response with the200status
GET - /orgs/{org_id}/projects - Updated
added the optional property
data/items/attributes/settings/auto_dependency_upgrade/is_inheritedto the response with the200status
PATCH - /orgs/{org_id}/projects/{project_id} - Updated
added the optional property
data/attributes/settings/auto_dependency_upgrade/is_inheritedto the response with the200status
GET - /orgs/{org_id}/projects/{project_id} - Updated
added the optional property
data/attributes/settings/auto_dependency_upgrade/is_inheritedto the response with the200status
GET - /orgs/{org_id}/packages/{purl}/issues - Updated
removed
#/components/schemas/ResourcePathRepresentation, #/components/schemas/PackageRepresentationfrom thedata/items/attributes/coordinates/items/representations/items/response propertyanyOflist for the response status200
POST - /orgs/{org_id}/packages/issues - Updated
removed
#/components/schemas/ResourcePathRepresentation, #/components/schemas/PackageRepresentationfrom thedata/items/attributes/coordinates/items/representations/items/response propertyanyOflist for the response status200
2024-10-15 - Updated 2025-06-04
GET - /groups/{group_id}/assets/{asset_id} - Added
Get an Asset by its ID
Required permissions
View Groups (group.read)
GET - /groups/{group_id}/assets/{asset_id}/relationships/projects - Added
List asset projects with pagination
Required permissions
View Groups (group.read)
GET - /groups/{group_id}/assets/{asset_id}/relationships/assets - Added
List related assets with pagination
Required permissions
View Groups (group.read)
POST - /groups/{group_id}/assets/search - Added
List Assets with filters
Required permissions
View Groups (group.read)
2024-10-15 - Updated 2025-05-27
GET - /orgs/{org_id} - Updated
the response property
databecame optional for the status200the response property
jsonapibecame optional for the status200the response property
linksbecame optional for the status200removed the optional property
links/firstfrom the response with the200statusremoved the optional property
links/lastfrom the response with the200statusremoved the optional property
links/nextfrom the response with the200statusremoved the optional property
links/prevfrom the response with the200statusremoved the optional property
links/relatedfrom the response with the200statusadded the non-success response with the status
409added the optional property
data/attributes/created_atto the response with the200statusadded the optional property
data/attributes/updated_atto the response with the200statusthe response property
data/attributesbecame required for the status200the
data/typeresponses property pattern^[a-z][a-z0-9](_[a-z][a-z0-9])*$was added for the status200`
2024-10-15 - Updated 2025-05-20
GET - /orgs/{org_id}/projects - Updated
added the optional property
data/items/attributes/settings/pull_requests/is_enabledto the response with the200status
PATCH - /orgs/{org_id}/projects/{project_id} - Updated
added the optional property
data/attributes/settings/pull_requests/is_enabledto the response with the200status
GET - /orgs/{org_id}/projects/{project_id} - Updated
added the optional property
data/attributes/settings/pull_requests/is_enabledto the response with the200status
2024-10-15 - Updated 2025-05-15
GET - /orgs/{org_id}/policies - Updated
added the new optional
queryrequest parameterorder_byadded the new optional
queryrequest parameterorder_direction
2024-10-15 - Updated 2025-05-08
GET - /orgs/{org_id}/packages/{purl}/issues - Updated
added
#/components/schemas/ResourcePathRepresentation, #/components/schemas/PackageRepresentationto thedata/items/attributes/coordinates/items/representations/items/response propertyanyOflist for the response status200
POST - /orgs/{org_id}/packages/issues - Updated
added
#/components/schemas/ResourcePathRepresentation, #/components/schemas/PackageRepresentationto thedata/items/attributes/coordinates/items/representations/items/response propertyanyOflist for the response status200
2024-10-15 - Updated 2025-04-28
GET - /orgs/{org_id}/packages/{purl}/issues - Updated
removed
#/components/schemas/ResourcePathRepresentation, #/components/schemas/PackageRepresentationfrom thedata/items/attributes/coordinates/items/representations/items/response propertyanyOflist for the response status200
POST - /orgs/{org_id}/packages/issues - Updated
removed
#/components/schemas/ResourcePathRepresentation, #/components/schemas/PackageRepresentationfrom thedata/items/attributes/coordinates/items/representations/items/response propertyanyOflist for the response status200
GET - /orgs/{org_id}/issues - Updated
added the optional property
data/items/attributes/coordinates/items/representations/items/oneOf[subschema #4]/sourceLocation/commit_idto the response with the200statusadded the optional property
data/items/attributes/key_assetto the response with the200status
GET - /orgs/{org_id}/issues/{issue_id} - Updated
added the optional property
data/attributes/coordinates/items/representations/items/oneOf[subschema #4]/sourceLocation/commit_idto the response with the200statusadded the optional property
data/attributes/key_assetto the response with the200status
GET - /groups/{group_id}/issues - Updated
added the optional property
data/items/attributes/coordinates/items/representations/items/oneOf[subschema #4]/sourceLocation/commit_idto the response with the200statusadded the optional property
data/items/attributes/key_assetto the response with the200status
GET - /groups/{group_id}/issues/{issue_id} - Updated
added the optional property
data/attributes/coordinates/items/representations/items/oneOf[subschema #4]/sourceLocation/commit_idto the response with the200statusadded the optional property
data/attributes/key_assetto the response with the200status
2024-10-15 - Updated 2025-04-25
POST - /tenants/{tenant_id}/brokers/installs/{install_id}/deployments - Added
Creates a new Broker Deployment for an installation
GET - /tenants/{tenant_id}/brokers/installs/{install_id}/deployments - Added
List Broker deployments for a given install ID
PATCH - /tenants/{tenant_id}/brokers/installs/{install_id}/deployments/{deployment_id} - Added
Updates a Broker deployment for a given install ID
DELETE - /tenants/{tenant_id}/brokers/installs/{install_id}/deployments/{deployment_id} - Added
Delete a Broker deployment for a given install ID
POST - /tenants/{tenant_id}/brokers/installs/{install_id}/deployments/{deployment_id}/credentials - Added
Creates a new Deployment credential
GET - /tenants/{tenant_id}/brokers/installs/{install_id}/deployments/{deployment_id}/credentials - Added
List Deployment credentials for a given deployment ID
PATCH - /tenants/{tenant_id}/brokers/installs/{install_id}/deployments/{deployment_id}/credentials/{credential_id} - Added
Updates a Deployment credential for an deployment
GET - /tenants/{tenant_id}/brokers/installs/{install_id}/deployments/{deployment_id}/credentials/{credential_id} - Added
Get all Deployment credential data for an deployment
DELETE - /tenants/{tenant_id}/brokers/installs/{install_id}/deployments/{deployment_id}/credentials/{credential_id} - Added
Deletes an existing Deployment credential for an deployment
POST - /tenants/{tenant_id}/brokers/installs/{install_id}/deployments/{deployment_id}/contexts - Added
Creates a new Broker Context
GET - /tenants/{tenant_id}/brokers/installs/{install_id}/deployments/{deployment_id}/contexts - Added
List Deployment contexts for a given deployment ID
POST - /tenants/{tenant_id}/brokers/installs/{install_id}/deployments/{deployment_id}/connections - Added
Creates a new Broker connection for an deployment
GET - /tenants/{tenant_id}/brokers/installs/{install_id}/deployments/{deployment_id}/connections - Added
List all Broker connections for a given deployment
DELETE - /tenants/{tenant_id}/brokers/installs/{install_id}/deployments/{deployment_id}/connections - Added
Deletes all existing Broker connections for an deployment
PATCH - /tenants/{tenant_id}/brokers/installs/{install_id}/deployments/{deployment_id}/connections/{connection_id} - Added
Updates a Broker connection for an deployment
GET - /tenants/{tenant_id}/brokers/installs/{install_id}/deployments/{deployment_id}/connections/{connection_id} - Added
Get all Broker connection data for an deployment
DELETE - /tenants/{tenant_id}/brokers/installs/{install_id}/deployments/{deployment_id}/connections/{connection_id} - Added
Deletes an existing Broker connection for an deployment
PATCH - /tenants/{tenant_id}/brokers/installs/{install_id}/contexts/{context_id} - Added
Updates a Broker Context for an deployment
GET - /tenants/{tenant_id}/brokers/installs/{install_id}/contexts/{context_id} - Added
List Broker context for a given broker context ID
DELETE - /tenants/{tenant_id}/brokers/installs/{install_id}/contexts/{context_id} - Added
Deletes an existing broker context
DELETE - /tenants/{tenant_id}/brokers/installs/{install_id}/contexts/{context_id}/integrations/{integration_id} - Added
Deletes an existing Broker context association for an integration
PATCH - /tenants/{tenant_id}/brokers/installs/{install_id}/contexts/{context_id}/integration - Added
Updates an integration to be associated with a Broker context
GET - /tenants/{tenant_id}/brokers/installs/{install_id}/connections/{connection_id}/contexts - Added
List Broker contexts for a given broker connection ID
GET - /tenants/{tenant_id}/brokers/deployments - Added
List Broker deployments for the tenant
DELETE - /tenants/{tenant_id}/brokers/connections/{connection_id}/orgs/{org_id}/integrations/{integration_id} - Added
Deletes an existing Broker connection for an deployment
POST - /tenants/{tenant_id}/brokers/connections/{connection_id}/orgs/{org_id}/integration - Added
Configures integrations to use the Broker connection for an deployment
GET - /tenants/{tenant_id}/brokers/connections/{connection_id}/integrations - Added
Get all integrations using the Broker connection
POST - /orgs/{org_id}/policies - Updated
the
data/attributes/action/data/reasonrequest propertys maxLength was set to10000`the
data/attributes/namerequest propertys maxLength was set to255`
PATCH - /orgs/{org_id}/policies/{policy_id} - Updated
the
data/attributes/action/data/reasonrequest propertys maxLength was set to10000`the
data/attributes/namerequest propertys maxLength was set to255`
GET - /orgs/{org_id}/brokers/connections - Added
List all Broker connections integrated with a given org
2024-10-15 - Updated 2025-04-22
GET - /orgs/{org_id}/policies - Updated
added the new optional
queryrequest parametersearch
2024-10-15 - Updated 2025-04-02
POST - /orgs/{org_id}/policies - Updated
added the new optional request property
data/meta
2024-10-15 - Updated 2025-04-01
POST - /orgs/{org_id}/memberships - Updated
the request property
databecame requiredthe request property
data/relationshipsbecame requiredthe request property
data/relationships/org/databecame requiredthe request property
data/relationships/org/data/idbecame requiredthe request property
data/relationships/org/data/typebecame requiredthe request property
data/relationships/role/databecame requiredthe request property
data/relationships/role/data/idbecame requiredthe request property
data/relationships/role/data/typebecame requiredthe request property
data/relationships/user/databecame requiredthe request property
data/relationships/user/data/idbecame requiredthe request property
data/relationships/user/data/typebecame requiredthe request property
data/typebecame required
2024-10-15 - Updated 2025-03-19
PATCH - /orgs/{org_id}/memberships/{membership_id} - Updated
the request property
databecame required
Changelog
2024-10-15 - Updated 2025-03-04
GET - /orgs/{org_id}/packages/{purl}/issues - Updated
added
#/components/schemas/ResourcePathRepresentation, #/components/schemas/PackageRepresentationto thedata/items/attributes/coordinates/items/representations/items/response propertyanyOflist for the response status200
POST - /orgs/{org_id}/packages/issues - Updated
added
#/components/schemas/ResourcePathRepresentation, #/components/schemas/PackageRepresentationto thedata/items/attributes/coordinates/items/representations/items/response propertyanyOflist for the response status200
2024-10-15 - Updated 2025-02-11
GET - /orgs/{org_id}/packages/{purl}/issues - Updated
removed
#/components/schemas/ResourcePathRepresentation, #/components/schemas/PackageRepresentationfrom thedata/items/attributes/coordinates/items/representations/items/response propertyanyOflist for the response status200
POST - /orgs/{org_id}/packages/issues - Updated
removed
#/components/schemas/ResourcePathRepresentation, #/components/schemas/PackageRepresentationfrom thedata/items/attributes/coordinates/items/representations/items/response propertyanyOflist for the response status200
2024-10-15 - Updated 2025-02-04
POST - /orgs/{org_id}/policies - Added
Create a new org-level policy.
Org level Policy APIs Access Notice: Access to our Org level Policy APIs is currently restricted via "snykCodeConsistentIgnores" feature flag and will result in a 403 Forbidden error without the flag enabled. Please contact your account representative for eligibility requirements.
GET - /orgs/{org_id}/policies - Added
Get all policies for the requested organisation.
Org level Policy APIs Access Notice: Access to our Org level Policy APIs is currently restricted via "snykCodeConsistentIgnores" feature flag and will result in a 403 Forbidden error without the flag enabled. Please contact your account representative for eligibility requirements.
PATCH - /orgs/{org_id}/policies/{policy_id} - Added
Update the org-level policy.
Org level Policy APIs Access Notice: Access to our Org level Policy APIs is currently restricted via "snykCodeConsistentIgnores" feature flag and will result in a 403 Forbidden error without the flag enabled. Please contact your account representative for eligibility requirements.
GET - /orgs/{org_id}/policies/{policy_id} - Added
Get a specific org-level policy based on its ID.
Org level Policy APIs Access Notice: Access to our Org level Policy APIs is currently restricted via "snykCodeConsistentIgnores" feature flag and will result in a 403 Forbidden error without the flag enabled. Please contact your account representative for eligibility requirements.
DELETE - /orgs/{org_id}/policies/{policy_id} - Added
Delete an existing org-level policy.
Org level Policy APIs Access Notice: Access to our Org level Policy APIs is currently restricted via "snykCodeConsistentIgnores" feature flag and will result in a 403 Forbidden error without the flag enabled. Please contact your account representative for eligibility requirements.
2024-10-15 - Updated 2025-01-22
GET - /orgs/{org_id}/packages/{purl}/issues - Updated
added
#/components/schemas/ResourcePathRepresentation, #/components/schemas/PackageRepresentationto thedata/items/attributes/coordinates/items/representations/items/response propertyanyOflist for the response status200
POST - /orgs/{org_id}/packages/issues - Updated
added
#/components/schemas/ResourcePathRepresentation, #/components/schemas/PackageRepresentationto thedata/items/attributes/coordinates/items/representations/items/response propertyanyOflist for the response status200
2024-10-15 - Updated 2025-01-13
GET - /orgs/{org_id}/issues - Updated
added the optional property
data/items/attributes/exploit_detailsto the response with the200statusadded the optional property
data/items/attributes/severitiesto the response with the200status
GET - /orgs/{org_id}/issues/{issue_id} - Updated
added the optional property
data/attributes/exploit_detailsto the response with the200statusadded the optional property
data/attributes/severitiesto the response with the200status
GET - /groups/{group_id}/issues - Updated
added the optional property
data/items/attributes/exploit_detailsto the response with the200statusadded the optional property
data/items/attributes/severitiesto the response with the200status
GET - /groups/{group_id}/issues/{issue_id} - Updated
added the optional property
data/attributes/exploit_detailsto the response with the200statusadded the optional property
data/attributes/severitiesto the response with the200status
2024-10-15 - Updated 2025-01-07
GET - /orgs/{org_id}/issues - Updated
added
loaded_packagediscriminator mapping keys to thedata/items/attributes/risk/factors/items/response property for the response status200added
#/components/schemas/LoadedPackageRiskFactorto thedata/items/attributes/risk/factors/items/response propertyoneOflist for the response status200
GET - /orgs/{org_id}/issues/{issue_id} - Updated
added
loaded_packagediscriminator mapping keys to thedata/attributes/risk/factors/items/response property for the response status200added
#/components/schemas/LoadedPackageRiskFactorto thedata/attributes/risk/factors/items/response propertyoneOflist for the response status200
GET - /groups/{group_id}/issues - Updated
added
loaded_packagediscriminator mapping keys to thedata/items/attributes/risk/factors/items/response property for the response status200added
#/components/schemas/LoadedPackageRiskFactorto thedata/items/attributes/risk/factors/items/response propertyoneOflist for the response status200
GET - /groups/{group_id}/issues/{issue_id} - Updated
added
loaded_packagediscriminator mapping keys to thedata/attributes/risk/factors/items/response property for the response status200added
#/components/schemas/LoadedPackageRiskFactorto thedata/attributes/risk/factors/items/response propertyoneOflist for the response status200
2024-10-15 - Updated 2024-12-09
GET - /orgs/{org_id} - Updated
the response property
databecame optional for the status200the response property
jsonapibecame optional for the status200the response property
linksbecame optional for the status200removed the optional property
links/firstfrom the response with the200statusremoved the optional property
links/lastfrom the response with the200statusremoved the optional property
links/nextfrom the response with the200statusremoved the optional property
links/prevfrom the response with the200statusremoved the optional property
links/relatedfrom the response with the200statusadded the non-success response with the status
409added the optional property
data/attributes/created_atto the response with the200statusadded the optional property
data/attributes/updated_atto the response with the200statusthe response property
data/attributesbecame required for the status200the
data/typeresponses property pattern^[a-z][a-z0-9](_[a-z][a-z0-9])*$was added for the status200`
2024-10-15 - Updated 2024-11-28
GET - /orgs/{org_id}/projects/{project_id}/sbom - Updated
added the new optional
queryrequest parameterexclude
2024-10-15 - Updated 2024-11-06
GET - /orgs/{org_id}/packages/{purl}/issues - Updated
removed
#/components/schemas/ResourcePathRepresentation, #/components/schemas/PackageRepresentationfrom thedata/items/attributes/coordinates/items/representations/items/response propertyanyOflist for the response status200
POST - /orgs/{org_id}/packages/issues - Updated
removed
#/components/schemas/ResourcePathRepresentation, #/components/schemas/PackageRepresentationfrom thedata/items/attributes/coordinates/items/representations/items/response propertyanyOflist for the response status200
2024-10-15 - Updated 2024-10-31
GET - /orgs/{org_id}/packages/{purl}/issues - Updated
added
#/components/schemas/ResourcePathRepresentation, #/components/schemas/PackageRepresentationto thedata/items/attributes/coordinates/items/representations/items/response propertyanyOflist for the response status200
POST - /orgs/{org_id}/packages/issues - Updated
added
#/components/schemas/ResourcePathRepresentation, #/components/schemas/PackageRepresentationto thedata/items/attributes/coordinates/items/representations/items/response propertyanyOflist for the response status200
2024-10-15 - Updated 2024-10-30
GET - /orgs/{org_id}/issues - Updated
added the new
functionenum value to thedata/items/attributes/coordinates/items/reachabilityresponse property for the response status200added the new
no-infoenum value to thedata/items/attributes/coordinates/items/reachabilityresponse property for the response status200added the new
not-applicableenum value to thedata/items/attributes/coordinates/items/reachabilityresponse property for the response status200added the new
packageenum value to thedata/items/attributes/coordinates/items/reachabilityresponse property for the response status200
GET - /orgs/{org_id}/issues/{issue_id} - Updated
added the new
functionenum value to thedata/attributes/coordinates/items/reachabilityresponse property for the response status200added the new
no-infoenum value to thedata/attributes/coordinates/items/reachabilityresponse property for the response status200added the new
not-applicableenum value to thedata/attributes/coordinates/items/reachabilityresponse property for the response status200added the new
packageenum value to thedata/attributes/coordinates/items/reachabilityresponse property for the response status200
GET - /groups/{group_id}/issues - Updated
added the new
functionenum value to thedata/items/attributes/coordinates/items/reachabilityresponse property for the response status200added the new
no-infoenum value to thedata/items/attributes/coordinates/items/reachabilityresponse property for the response status200added the new
not-applicableenum value to thedata/items/attributes/coordinates/items/reachabilityresponse property for the response status200added the new
packageenum value to thedata/items/attributes/coordinates/items/reachabilityresponse property for the response status200
GET - /groups/{group_id}/issues/{issue_id} - Updated
added the new
functionenum value to thedata/attributes/coordinates/items/reachabilityresponse property for the response status200added the new
no-infoenum value to thedata/attributes/coordinates/items/reachabilityresponse property for the response status200added the new
not-applicableenum value to thedata/attributes/coordinates/items/reachabilityresponse property for the response status200added the new
packageenum value to thedata/attributes/coordinates/items/reachabilityresponse property for the response status200
2024-10-15
Simplified API Versioning
Going forward, Snyk will expose one API specification per version-date, rather than one for each stability. New versions of the Snyk API will only be published when necessitated by breaking changes. For newer versions, you should only specify the date for beta versions, i.e 2024-10-15 rather than 2024-10-15~beta. It's important to note that existing versions won't be affected by these changes; this new approach only applies to upcoming new versions.
2024-08-25 - Updated 2024-10-10
GET - /self - Updated
added
#/components/schemas/User20240422, #/components/schemas/ServiceAccount20240422to thedata/attributesresponse propertyanyOflist for the response status200removed
#/components/schemas/ServiceAccountfrom thedata/attributesresponse propertyanyOflist for the response status200
GET - /orgs/{org_id}/projects - Updated
added
#/components/schemas/ProjectRelationshipsTarget20230215to thedata/items/relationships/targetresponse propertyoneOflist for the response status200removed
#/components/schemas/ProjectRelationshipsTargetfrom thedata/items/relationships/targetresponse propertyoneOflist for the response status200
PATCH - /orgs/{org_id}/projects/{project_id} - Updated
added
#/components/schemas/ProjectRelationshipsTarget20230215to thedata/relationships/targetresponse propertyoneOflist for the response status200removed
#/components/schemas/ProjectRelationshipsTargetfrom thedata/relationships/targetresponse propertyoneOflist for the response status200
GET - /orgs/{org_id}/projects/{project_id} - Updated
added
#/components/schemas/ProjectRelationshipsTarget20230215to thedata/relationships/targetresponse propertyoneOflist for the response status200removed
#/components/schemas/ProjectRelationshipsTargetfrom thedata/relationships/targetresponse propertyoneOflist for the response status200
GET - /orgs/{org_id}/packages/{purl}/issues - Updated
removed the optional property
data/items/attributes/coordinates/items/representationfrom the response with the200statusremoved the optional property
data/items/attributes/keyfrom the response with the200statusremoved the optional property
data/items/attributes/slots/exploitfrom the response with the200statusadded the optional property
data/items/attributes/severities/items/typeto the response with the200statusadded the optional property
data/items/attributes/severities/items/versionto the response with the200statusadded the optional property
data/items/attributes/slots/exploit_detailsto the response with the200statusadded the required property
data/items/attributes/coordinates/items/representationsto the response with the200status
POST - /orgs/{org_id}/packages/issues - Updated
removed the optional property
data/items/attributes/slots/exploitfrom the response with the200statusadded the optional property
data/items/attributes/severities/items/typeto the response with the200statusadded the optional property
data/items/attributes/severities/items/versionto the response with the200statusadded the optional property
data/items/attributes/slots/exploit_detailsto the response with the200status
GET - /orgs/{org_id}/invites - Updated
the
data/items/attributes/roleresponses property type/format changed fromstring/uuidtostring/`` for status200`removed the
org_invitationenum value from thedata/items/typeresponse property for the response status200
2024-08-25 - Updated 2024-09-11
POST - /orgs/{org_id}/apps - Updated
added the new required request property
nameadded the new required request property
redirect_urisadded the new required request property
scopesremoved the request property
dataadded the new optional request property
access_token_ttl_secondsadded the new optional request property
context
GET - /orgs/{org_id}/apps - Updated
the
data/items/attributes/redirect_urisresponse propertys minItems was decreased from1to0for the response status200`the response property
data/items/attributes/client_idbecame required for the status200the response property
data/items/attributes/redirect_urisbecame required for the status200
PATCH - /orgs/{org_id}/apps/{client_id} - Updated
the
data/attributes/redirect_urisresponse propertys minItems was decreased from1to0for the response status200`removed the request property
dataadded the new optional request property
access_token_ttl_secondsadded the new optional request property
nameadded the new optional request property
redirect_uristhe response property
data/attributes/client_idbecame required for the status200the response property
data/attributes/redirect_urisbecame required for the status200
GET - /orgs/{org_id}/apps/{client_id} - Updated
the
data/attributes/redirect_urisresponse propertys minItems was decreased from1to0for the response status200`the response property
data/attributes/client_idbecame required for the status200the response property
data/attributes/redirect_urisbecame required for the status200
2024-08-25 - Updated 2024-09-03
POST - /groups/{group_id}/memberships - Updated
the response property
data/relationships/groupbecame required for the status201the response property
data/relationships/group/data/attributesbecame required for the status201the response property
data/relationships/group/data/attributes/namebecame required for the status201the response property
data/relationships/group/data/idbecame required for the status201the response property
data/relationships/rolebecame required for the status201the response property
data/relationships/role/data/attributesbecame required for the status201the response property
data/relationships/role/data/attributes/namebecame required for the status201the response property
data/relationships/role/data/idbecame required for the status201the response property
data/relationships/userbecame required for the status201the response property
data/relationships/user/data/attributesbecame required for the status201the response property
data/relationships/user/data/attributes/emailbecame required for the status201the response property
data/relationships/user/data/attributes/namebecame required for the status201the response property
data/relationships/user/data/attributes/usernamebecame required for the status201the response property
data/relationships/user/data/idbecame required for the status201
GET - /groups/{group_id}/memberships - Updated
the response property
data/items/relationships/groupbecame required for the status200the response property
data/items/relationships/group/data/attributesbecame required for the status200the response property
data/items/relationships/group/data/attributes/namebecame required for the status200the response property
data/items/relationships/group/data/idbecame required for the status200the response property
data/items/relationships/rolebecame required for the status200the response property
data/items/relationships/role/data/attributesbecame required for the status200the response property
data/items/relationships/role/data/attributes/namebecame required for the status200the response property
data/items/relationships/role/data/idbecame required for the status200the response property
data/items/relationships/userbecame required for the status200the response property
data/items/relationships/user/data/attributesbecame required for the status200the response property
data/items/relationships/user/data/attributes/emailbecame required for the status200the response property
data/items/relationships/user/data/attributes/namebecame required for the status200the response property
data/items/relationships/user/data/attributes/usernamebecame required for the status200the response property
data/items/relationships/user/data/idbecame required for the status200
2024-08-25 - Updated 2024-08-30
POST - /orgs/{org_id}/memberships - Updated
the response property
data/relationships/orgbecame required for the status201the response property
data/relationships/org/data/attributesbecame required for the status201the response property
data/relationships/org/data/attributes/namebecame required for the status201the response property
data/relationships/org/data/idbecame required for the status201the response property
data/relationships/rolebecame required for the status201the response property
data/relationships/role/data/attributesbecame required for the status201the response property
data/relationships/role/data/attributes/namebecame required for the status201the response property
data/relationships/role/data/idbecame required for the status201the response property
data/relationships/userbecame required for the status201the response property
data/relationships/user/data/attributesbecame required for the status201the response property
data/relationships/user/data/attributes/emailbecame required for the status201the response property
data/relationships/user/data/attributes/namebecame required for the status201the response property
data/relationships/user/data/attributes/usernamebecame required for the status201the response property
data/relationships/user/data/idbecame required for the status201
GET - /orgs/{org_id}/memberships - Updated
the response property
data/items/relationships/orgbecame required for the status200the response property
data/items/relationships/org/data/attributesbecame required for the status200the response property
data/items/relationships/org/data/attributes/namebecame required for the status200the response property
data/items/relationships/org/data/idbecame required for the status200the response property
data/items/relationships/rolebecame required for the status200the response property
data/items/relationships/role/data/attributesbecame required for the status200the response property
data/items/relationships/role/data/attributes/namebecame required for the status200the response property
data/items/relationships/role/data/idbecame required for the status200the response property
data/items/relationships/userbecame required for the status200the response property
data/items/relationships/user/data/attributesbecame required for the status200the response property
data/items/relationships/user/data/attributes/emailbecame required for the status200the response property
data/items/relationships/user/data/attributes/namebecame required for the status200the response property
data/items/relationships/user/data/attributes/usernamebecame required for the status200the response property
data/items/relationships/user/data/idbecame required for the status200
2024-08-25
POST - /orgs/{org_id}/memberships - Added
Create a org membership for a user with role
GET - /orgs/{org_id}/memberships - Added
Returns all memberships of the org
PATCH - /orgs/{org_id}/memberships/{membership_id} - Added
Update a org membership for a user with role
DELETE - /orgs/{org_id}/memberships/{membership_id} - Added
Remove a user`s membership of the group.
GET - /groups/{group_id}/org_memberships - Added
Get list of org memberships of a group user
POST - /groups/{group_id}/memberships - Added
Create a group membership for a user with role
GET - /groups/{group_id}/memberships - Added
Returns all memberships of the group
PATCH - /groups/{group_id}/memberships/{membership_id} - Added
Update a role from a group membership
DELETE - /groups/{group_id}/memberships/{membership_id} - Added
Deletes a membership from a group
2024-08-22
GET - /orgs/{org_id}/projects/{project_id}/sbom - Updated
removed the required property
bomFormatfrom the response with the200statusremoved the required property
componentsfrom the response with the200statusremoved the required property
dependenciesfrom the response with the200statusremoved the required property
dependenciesfrom the response with the200statusremoved the required property
metadatafrom the response with the200statusremoved the required property
metadatafrom the response with the200statusremoved the required property
specVersionfrom the response with the200statusremoved the required property
versionfrom the response with the200statusremoved the optional property
componentsfrom the response with the200statusadded the new enum value
cyclonedx1.5+jsonto thequeryrequest parameterformatadded the new enum value
cyclonedx1.5+xmlto thequeryrequest parameterformatadded the new enum value
cyclonedx1.6+jsonto thequeryrequest parameterformatadded the new enum value
cyclonedx1.6+xmlto thequeryrequest parameterformat
2024-08-15
GET - /orgs/{org_id}/audit_logs/search - Updated
for the
queryrequest parametersize, default value100.00was added
GET - /groups/{group_id}/audit_logs/search - Updated
for the
queryrequest parametersize, default value100.00was added
2024-06-21 - Updated 2024-06-27
POST - /orgs/{org_id}/collections - Updated
the
data/attributes/nameresponse property's maxLength was unset from255for the response status201the
data/attributes/nameresponse property's minLength was decreased from1to0for the response status201the
data/attributes/nameresponse's property pattern^([a-zA-Z0-9 _\-\/:.])+$was removed for the status201
GET - /orgs/{org_id}/collections - Updated
the
data/items/attributes/nameresponse property's maxLength was unset from255for the response status200the
data/items/attributes/nameresponse property's minLength was decreased from1to0for the response status200the
data/items/attributes/nameresponse's property pattern^([a-zA-Z0-9 _\-\/:.])+$was removed for the status200
PATCH - /orgs/{org_id}/collections/{collection_id} - Updated
the
data/attributes/nameresponse property's maxLength was unset from255for the response status200the
data/attributes/nameresponse property's minLength was decreased from1to0for the response status200the
data/attributes/nameresponse's property pattern^([a-zA-Z0-9 _\-\/:.])+$was removed for the status200
GET - /orgs/{org_id}/collections/{collection_id} - Updated
the
data/attributes/nameresponse property's maxLength was unset from255for the response status200the
data/attributes/nameresponse property's minLength was decreased from1to0for the response status200the
data/attributes/nameresponse's property pattern^([a-zA-Z0-9 _\-\/:.])+$was removed for the status200
2024-06-21 - Updated 2024-06-25
PATCH - /orgs/{org_id} - Updated
request property
data/typewas restricted to a list of enum valuesthe request property
data/attributesbecame requiredthe request property
data/idbecame requiredthe request property
data/typebecame requiredadded the new
orgenum value to thedata/typeresponse property for the response status200added the new
orgenum value to the request propertydata/typeremoved the pattern
^[a-z][a-z0-9]*(_[a-z][a-z0-9]*)*$from the request propertydata/typethe
data/typeresponse's property pattern^[a-z][a-z0-9]*(_[a-z][a-z0-9]*)*$was removed for the status200
2024-06-21
POST - /orgs/{org_id}/invites - Updated
removed the request property
data/relationships
2024-06-18
POST - /groups/{group_id}/settings/pull_request_template - Updated
removed the request property
data/attributes/branch_nameremoved the optional property
data/attributes/branch_namefrom the response with the201status
GET - /groups/{group_id}/settings/pull_request_template - Updated
removed the optional property
data/attributes/branch_namefrom the response with the200status
2024-06-06
GET - /orgs/{org_id}/projects - Updated
removed the optional property
data/items/attributes/settings/auto_dependency_upgrade/is_inheritedfrom the response with the200status
PATCH - /orgs/{org_id}/projects/{project_id} - Updated
removed the optional property
data/attributes/settings/auto_dependency_upgrade/is_inheritedfrom the response with the200status
GET - /orgs/{org_id}/projects/{project_id} - Updated
removed the optional property
data/attributes/settings/auto_dependency_upgrade/is_inheritedfrom the response with the200status
2024-05-23
DELETE - /self/apps/installs/{install_id} - Updated
api operation id
deleteUserAppInstallByIDremoved and replaced withdeleteUserAppInstallById
DELETE - /orgs/{org_id}/apps/installs/{install_id} - Updated
api operation id
deleteAppOrgInstallByIDremoved and replaced withdeleteAppOrgInstallById
DELETE - /groups/{group_id}/apps/installs/{install_id} - Updated
api operation id
deleteGroupAppInstallByIDremoved and replaced withdeleteGroupAppInstallById
2024-05-08
POST - /groups/{group_id}/settings/pull_request_template - Added
Configures a group level pull request template that will be used on any org or project within that group
GET - /groups/{group_id}/settings/pull_request_template - Added
Get your groups pull request template
DELETE - /groups/{group_id}/settings/pull_request_template - Added
Delete your groups pull request template. This means Snyk pull requests will start to use the default template for this group.
2024-04-29
GET - /orgs/{org_id}/audit_logs/search - Updated
deleted the
queryrequest parametereventdeleted the
queryrequest parameterexclude_eventadded the new optional
queryrequest parametereventsadded the new optional
queryrequest parameterexclude_events
GET - /groups/{group_id}/audit_logs/search - Updated
deleted the
queryrequest parametereventdeleted the
queryrequest parameterexclude_eventadded the new optional
queryrequest parametereventsadded the new optional
queryrequest parameterexclude_events
2024-04-22
GET - /self - Added
Retrieves information about the the user making the request.
GET - /orgs/{org_id}/projects - Updated
added
#/components/schemas/Relationship, #/components/schemas/ProjectRelationshipsTargetto thedata/items/relationships/targetresponse propertyoneOflist for the response status200
PATCH - /orgs/{org_id}/projects/{project_id} - Updated
added
#/components/schemas/Relationship, #/components/schemas/ProjectRelationshipsTargetto thedata/relationships/targetresponse propertyoneOflist for the response status200
GET - /orgs/{org_id}/projects/{project_id} - Updated
added
#/components/schemas/Relationship, #/components/schemas/ProjectRelationshipsTargetto thedata/relationships/targetresponse propertyoneOflist for the response status200
2024-02-28
GET - /orgs - Updated
for the
queryrequest parametername, the maxLength was set to100for the
queryrequest parameterslug, the maxLength was set to100added the pattern
^[\w.-]+$to thequeryrequest parameterslugadded the optional property
data/items/attributes/access_requests_enabledto the response with the200status
PATCH - /orgs/{org_id} - Updated
added the optional property
data/attributes/access_requests_enabledto the response with the200status
GET - /orgs/{org_id} - Updated
added the optional property
data/attributes/access_requests_enabledto the response with the200status
GET - /groups/{group_id}/orgs - Added
Get a paginated list of all the organizations belonging to the group. By default, this endpoint returns the organizations in alphabetical order of their name.
2024-02-21
GET - /orgs/{org_id}/targets - Added
Get a list of an organization`s targets.
GET - /orgs/{org_id}/targets/{target_id} - Added
Get a specified target for an organization.
DELETE - /orgs/{org_id}/targets/{target_id} - Added
Delete the specified target.
GET - /orgs/{org_id}/projects - Updated
removed
#/components/schemas/Relationship, #/components/schemas/ProjectRelationshipsTargetfrom thedata/items/relationships/targetresponse propertyoneOflist for the response status200
PATCH - /orgs/{org_id}/projects/{project_id} - Updated
removed
#/components/schemas/Relationship, #/components/schemas/ProjectRelationshipsTargetfrom thedata/relationships/targetresponse propertyoneOflist for the response status200
GET - /orgs/{org_id}/projects/{project_id} - Updated
removed
#/components/schemas/Relationship, #/components/schemas/ProjectRelationshipsTargetfrom thedata/relationships/targetresponse propertyoneOflist for the response status200
2024-01-23
GET - /orgs/{org_id}/issues - Added
Get a list of an organization`s issues.
GET - /orgs/{org_id}/issues/{issue_id} - Added
Get an issue
GET - /groups/{group_id}/issues - Added
Get a list of a group`s issues.
GET - /groups/{group_id}/issues/{issue_id} - Added
Get an issue
2024-01-04
POST - /custom_base_images - Updated
removed
#/components/schemas/VersioningSchemaDateTypefrom thedata/attributes/versioning_schemarequest propertyoneOflistremoved
#/components/schemas/VersioningSchemaDateTypefrom thedata/attributes/versioning_schemaresponse propertyoneOflist for the response status201
PATCH - /custom_base_images/{custombaseimage_id} - Updated
removed
#/components/schemas/VersioningSchemaDateTypefrom thedata/attributes/versioning_schemarequest propertyoneOflistremoved
#/components/schemas/VersioningSchemaDateTypefrom thedata/attributes/versioning_schemaresponse propertyoneOflist for the response status200
GET - /custom_base_images/{custombaseimage_id} - Updated
removed
#/components/schemas/VersioningSchemaDateTypefrom thedata/attributes/versioning_schemaresponse propertyoneOflist for the response status200
2023-11-06
DELETE - /orgs/{org_id}/projects/{project_id} - Added
Delete one project in the organization by project ID.
2023-11-03
GET - /self/apps/{app_id}/sessions - Added
Get a list of active OAuth sessions for the app.
DELETE - /self/apps/{app_id}/sessions/{session_id} - Added
Revoke an active user app session.
GET - /self/apps/installs - Added
Get a list of apps installed for an user.
DELETE - /self/apps/installs/{install_id} - Added
Revoke access for an app by install ID.
POST - /orgs/{org_id}/apps - Updated
added the new required request property
dataremoved the request property
access_token_ttl_secondsremoved the request property
contextremoved the request property
nameremoved the request property
redirect_urisremoved the request property
scopes
GET - /orgs/{org_id}/apps - Updated
the response property
data/items/attributes/client_idbecame optional for the status200the response property
data/items/attributes/redirect_urisbecame optional for the status200
PATCH - /orgs/{org_id}/apps/{client_id} - Updated
added the new required request property
datathe response property
data/attributes/client_idbecame optional for the status200the response property
data/attributes/redirect_urisbecame optional for the status200removed the request property
access_token_ttl_secondsremoved the request property
nameremoved the request property
redirect_uris
GET - /orgs/{org_id}/apps/{client_id} - Updated
the response property
data/attributes/client_idbecame optional for the status200the response property
data/attributes/redirect_urisbecame optional for the status200
POST - /orgs/{org_id}/apps/installs - Added
Install a Snyk Apps to this organization, the Snyk App must use unattended authentication eg client credentials.
GET - /orgs/{org_id}/apps/installs - Added
Get a list of apps installed for an organization.
DELETE - /orgs/{org_id}/apps/installs/{install_id} - Added
Revoke app authorization for an Snyk Organization with install ID.
POST - /orgs/{org_id}/apps/installs/{install_id}/secrets - Added
Manage client secret for non-interactive Snyk App installations.
POST - /orgs/{org_id}/apps/creations - Added
Create a new Snyk App for an organization.
GET - /orgs/{org_id}/apps/creations - Added
Get a list of apps created by an organization.
PATCH - /orgs/{org_id}/apps/creations/{app_id} - Added
Update app creation attributes with App ID.
GET - /orgs/{org_id}/apps/creations/{app_id} - Added
Get a Snyk App by its App ID.
DELETE - /orgs/{org_id}/apps/creations/{app_id} - Added
Delete an app by its App ID.
POST - /orgs/{org_id}/apps/creations/{app_id}/secrets - Added
Manage client secret for the Snyk App.
POST - /groups/{group_id}/apps/installs - Added
Install a Snyk Apps to this group, the Snyk App must use unattended authentication eg client credentials.
GET - /groups/{group_id}/apps/installs - Added
Get a list of apps installed for a group.
DELETE - /groups/{group_id}/apps/installs/{install_id} - Added
Revoke app authorization for an Snyk Group with install ID.
POST - /groups/{group_id}/apps/installs/{install_id}/secrets - Added
Manage client secret for non-interactive Snyk App installations.
2023-11-02
GET - /orgs/{org_id}/container_images - Added
List instances of container image
GET - /orgs/{org_id}/container_images/{image_id} - Added
Get instance of container image
GET - /orgs/{org_id}/container_images/{image_id}/relationships/image_target_refs - Added
List instances of image target references for a container image
2023-09-13
GET - /orgs/{org_id}/projects - Updated
added
#/components/schemas/Relationship, #/components/schemas/ProjectRelationshipsTargetto thedata/items/relationships/targetresponse propertyoneOflist for the response status200
PATCH - /orgs/{org_id}/projects/{project_id} - Updated
added
#/components/schemas/Relationship, #/components/schemas/ProjectRelationshipsTargetto thedata/relationships/targetresponse propertyoneOflist for the response status200
GET - /orgs/{org_id}/projects/{project_id} - Updated
added
#/components/schemas/Relationship, #/components/schemas/ProjectRelationshipsTargetto thedata/relationships/targetresponse propertyoneOflist for the response status200
2023-09-12
GET - /orgs/{org_id}/projects - Updated
removed
#/components/schemas/Relationship, #/components/schemas/ProjectRelationshipsTargetfrom thedata/items/relationships/targetresponse propertyoneOflist for the response status200
PATCH - /orgs/{org_id}/projects/{project_id} - Updated
removed
#/components/schemas/Relationship, #/components/schemas/ProjectRelationshipsTargetfrom thedata/relationships/targetresponse propertyoneOflist for the response status200
GET - /orgs/{org_id}/projects/{project_id} - Updated
removed
#/components/schemas/Relationship, #/components/schemas/ProjectRelationshipsTargetfrom thedata/relationships/targetresponse propertyoneOflist for the response status200
POST - /orgs/{org_id}/collections - Added
Create a collection
GET - /orgs/{org_id}/collections - Added
Return a list of organization`s collections with issues counts and projects count.
PATCH - /orgs/{org_id}/collections/{collection_id} - Added
Edit a collection
GET - /orgs/{org_id}/collections/{collection_id} - Added
Get a collection
DELETE - /orgs/{org_id}/collections/{collection_id} - Added
Delete a collection
POST - /orgs/{org_id}/collections/{collection_id}/relationships/projects - Added
Add projects to a collection by specifying an array of project ids
GET - /orgs/{org_id}/collections/{collection_id}/relationships/projects - Added
Return a list of organization`s projects that are from the specified collection.
DELETE - /orgs/{org_id}/collections/{collection_id}/relationships/projects - Added
Remove projects from a collection by specifying an array of project ids
2023-09-11
PATCH - /orgs/{org_id}/settings/sast - Added
Enable/Disable the Snyk Code settings for an org
GET - /orgs/{org_id}/audit_logs/search - Added
Search audit logs for an Organization. Supported event types:
api.access
org.app_bot.create
org.app.create
org.app.delete
org.app.edit
org.cloud_config.settings.edit
org.collection.create
org.collection.delete
org.collection.edit
org.create
org.delete
org.edit
org.ignore_policy.edit
org.integration.create
org.integration.delete
org.integration.edit
org.integration.settings.edit
org.language_settings.edit
org.notification_settings.edit
org.org_source.create
org.org_source.delete
org.org_source.edit
org.policy.edit
org.project_filter.create
org.project_filter.delete
org.project.add
org.project.attributes.edit
org.project.delete
org.project.edit
org.project.fix_pr.auto_open
org.project.fix_pr.manual_open
org.project.ignore.create
org.project.ignore.delete
org.project.ignore.edit
org.project.monitor
org.project.pr_check.edit
org.project.remove
org.project.settings.delete
org.project.settings.edit
org.project.stop_monitor
org.project.tag.add
org.project.tag.remove
org.project.test
org.request_access_settings.edit
org.sast_settings.edit
org.service_account.create
org.service_account.delete
org.service_account.edit
org.settings.feature_flag.edit
org.target.create
org.target.delete
org.user.add
org.user.invite
org.user.invite.accept
org.user.invite.revoke
org.user.invite_link.accept
org.user.invite_link.create
org.user.invite_link.revoke
org.user.leave
org.user.provision.accept
org.user.provision.create
org.user.provision.delete
org.user.remove
org.user.role.create
org.user.role.delete
org.user.role.details.edit
org.user.role.edit
org.user.role.permissions.edit
org.webhook.add
org.webhook.delete
user.org.notification_settings.edit
GET - /groups/{group_id}/audit_logs/search - Added
Search audit logs for a Group. Some Organization level events are supported as well as the following Group level events:
api.access
group.cloud_config.settings.edit
group.create
group.delete
group.edit
group.notification_settings.edit
group.org.add
group.org.remove
group.policy.create
group.policy.delete
group.policy.edit
group.request_access_settings.edit
group.role.create
group.role.delete
group.role.edit
group.service_account.create
group.service_account.delete
group.service_account.edit
group.settings.edit
group.settings.feature_flag.edit
group.sso.add
group.sso.auth0_connection.create
group.sso.auth0_connection.edit
group.sso.create
group.sso.delete
group.sso.edit
group.sso.membership.sync
group.sso.remove
group.tag.create
group.tag.delete
group.user.add
group.user.remove
group.user.role.edit
2023-09-07
POST - /orgs/{org_id}/service_accounts - Added
Create a service account for an organization. The service account can be used to access the Snyk API.
GET - /orgs/{org_id}/service_accounts - Added
Get all service accounts for an organization.
PATCH - /orgs/{org_id}/service_accounts/{serviceaccount_id} - Added
Update the name of an organization-level service account by its ID.
GET - /orgs/{org_id}/service_accounts/{serviceaccount_id} - Added
Get an organization-level service account by its ID.
DELETE - /orgs/{org_id}/service_accounts/{serviceaccount_id} - Added
Delete a service account in an organization.
POST - /orgs/{org_id}/service_accounts/{serviceaccount_id}/secrets - Added
Manage the client secret of an organization service account by the service account ID.
POST - /groups/{group_id}/service_accounts - Added
Create a service account for a group. The service account can be used to access the Snyk API.
GET - /groups/{group_id}/service_accounts - Added
Get all service accounts for a group.
PATCH - /groups/{group_id}/service_accounts/{serviceaccount_id} - Added
Update the name of a group`s service account by its ID.
GET - /groups/{group_id}/service_accounts/{serviceaccount_id} - Added
Get a group-level service account by its ID.
DELETE - /groups/{group_id}/service_accounts/{serviceaccount_id} - Added
Permanently delete a group-level service account by its ID.
POST - /groups/{group_id}/service_accounts/{serviceaccount_id}/secrets - Added
Manage the client secret of a group service account by the service account ID.
2023-08-28
GET - /orgs/{org_id}/projects - Updated
added the new optional
queryrequest parameternames_start_withadded the new optional
queryrequest parametertarget_fileadded the new optional
queryrequest parametertarget_referenceadded the new optional
queryrequest parametertarget_runtime
PATCH - /orgs/{org_id}/projects/{project_id} - Updated
deleted the
queryrequest parameteruser_id
2023-08-21
POST - /orgs/{org_id}/packages/issues - Updated
added the optional property
metato the response with the200status
POST - /custom_base_images - Added
In order to create a custom base image, you first need to import your base images into Snyk. You can do this through the CLI, UI, or API.
This endpoint marks an image as a custom base image. This means that the image will get added to the pool of images from which Snyk can recommend base image upgrades.
Note, after the first image in a repository gets added, a versioning schema cannot be passed in this endpoint. To update the versioning schema, the PATCH endpoint must be used.
GET - /custom_base_images - Added
Get a list of custom base images with support for ordering and filtering. Either the org_id or group_id parameters must be set to authorize successfully.
PATCH - /custom_base_images/{custombaseimage_id} - Added
Updates a custom base image`s attributes
GET - /custom_base_images/{custombaseimage_id} - Added
Get a custom base image
DELETE - /custom_base_images/{custombaseimage_id} - Added
Delete a custom base image resource. (the related container project is unaffected)
2023-06-22
GET - /orgs/{org_id}/settings/sast - Added
Retrieves the SAST settings for an org
2023-05-29
GET - /orgs - Added
Get a paginated list of organizations you have access to.
PATCH - /orgs/{org_id} - Added
Update the details of an organization
GET - /orgs/{org_id} - Added
Get the full details of an organization.
2023-04-28
POST - /orgs/{org_id}/invites - Updated
added the new required request property
datathe
data/attributes/roleresponses property type/format changed fromstring/`` tostring/uuidfor status201`removed the request property
emailremoved the request property
roleadded the new
org_invitationenum value to thedata/typeresponse property for the response status201
GET - /orgs/{org_id}/invites - Updated
the
data/items/attributes/roleresponses property type/format changed fromstring/`` tostring/uuidfor status200`added the new
org_invitationenum value to thedata/items/typeresponse property for the response status200
2023-04-17
POST - /orgs/{org_id}/packages/issues - Added
This endpoint is not available to all customers. If you are interested please contact support. Query issues for a batch of packages identified by Package URL (purl). Only direct vulnerabilities are returned, transitive vulnerabilities (from dependencies) are not returned because they can vary depending on context.
2023-03-20
GET - /orgs/{org_id}/projects/{project_id}/sbom - Added
This endpoint lets you retrieve the SBOM document of a software project. It supports the following formats:
CycloneDX version 1.4 in JSON (set
formattocyclonedx1.4+json).CycloneDX version 1.4 in XML (set
formattocyclonedx1.4+xml).SPDX version 2.3 in JSON (set
formattospdx2.3+json).
By default it will respond with an empty JSON:API response.
2023-02-15
GET - /orgs/{org_id}/projects - Added
List all Projects for an Org.
PATCH - /orgs/{org_id}/projects/{project_id} - Added
Updates one project of the organization by project ID.
GET - /orgs/{org_id}/projects/{project_id} - Added
Get one project of the organization by project ID.
2022-12-14
POST - /orgs/{org_id}/slack_app/{bot_id} - Added
Create new Slack notification default settings for a given tenant.
GET - /orgs/{org_id}/slack_app/{bot_id} - Added
Get Slack integration default notification settings for the provided tenant ID and bot ID.
DELETE - /orgs/{org_id}/slack_app/{bot_id} - Added
Remove the given Slack App integration
GET - /orgs/{org_id}/slack_app/{bot_id}/projects - Added
Slack notification settings overrides for projects. These settings overrides the default settings configured for the tenant.
POST - /orgs/{org_id}/slack_app/{bot_id}/projects/{project_id} - Added
Create Slack settings override for a project.
PATCH - /orgs/{org_id}/slack_app/{bot_id}/projects/{project_id} - Added
Update Slack notification settings for a project.
DELETE - /orgs/{org_id}/slack_app/{bot_id}/projects/{project_id} - Added
Remove Slack settings override for a project.
2022-11-14
GET - /orgs/{org_id}/invites - Added
List pending user invitations to an organization.
DELETE - /orgs/{org_id}/invites/{invite_id} - Added
Cancel a pending user invitations to an organization.
2022-11-07
GET - /orgs/{org_id}/slack_app/{tenant_id}/channels - Added
Requires the Snyk Slack App to be set up for this org, will retrieve a list of channels the Snyk Slack App can access. Note that it is currently only possible to page forwards through this collection, no prev links will be generated and the ending_before parameter will not function.
GET - /orgs/{org_id}/slack_app/{tenant_id}/channels/{channel_id} - Added
Requires the Snyk Slack App to be set up for this org. It will return the Slack channel name for the provided Slack channel ID.
2022-09-15
GET - /orgs/{org_id}/packages/{purl}/issues - Added
Query issues for a specific package version identified by Package URL (purl). Snyk returns only direct vulnerabilities. Transitive vulnerabilities (from dependencies) are not returned because they can vary depending on context.
2022-06-01
POST - /orgs/{org_id}/invites - Added
Invite a user to an organization with a role.
2022-03-11
GET - /self/apps - Added
Get a list of apps that can act on your behalf.
DELETE - /self/apps/{app_id} - Added
Revoke access for an app by app id
POST - /orgs/{org_id}/apps - Added
Create a new app for an organization. Deprecated, use /orgs/{org_id}/apps/creations instead.
GET - /orgs/{org_id}/apps - Added
Get a list of apps created by an organization. Deprecated, use /orgs/{org_id}/apps/creations instead.
PATCH - /orgs/{org_id}/apps/{client_id} - Added
Update app attributes. Deprecated, use /orgs/{org_id}/apps/creations/{app_id} instead.
GET - /orgs/{org_id}/apps/{client_id} - Added
Get an App by client id. Deprecated, use /orgs/{org_id}/apps/creations/{app_id} instead.
DELETE - /orgs/{org_id}/apps/{client_id} - Added
Delete an app by app id. Deprecated, use /orgs/{org_id}/apps/creations/{app_id} instead.
POST - /orgs/{org_id}/apps/{client_id}/secrets - Added
Manage client secrets for an app. Deprecated, use /orgs/{org_id}/apps/creations/{app_id}/secrets instead.
GET - /orgs/{org_id}/app_bots - Added
Get a list of app bots authorized to an organization. Deprecated, use /orgs/{org_id}/apps/installs instead.
DELETE - /orgs/{org_id}/app_bots/{bot_id} - Added
Revoke app bot authorization. Deprecated, use /orgs/{org_id}/apps/installs/{install_id} instead.
2021-12-09
PATCH - /orgs/{org_id}/settings/iac - Added
Update the Infrastructure as Code Settings for an org.
GET - /orgs/{org_id}/settings/iac - Added
Get the Infrastructure as Code Settings for an org.
PATCH - /groups/{group_id}/settings/iac - Added
Update the Infrastructure as Code Settings for a group.
GET - /groups/{group_id}/settings/iac - Added
Get the Infrastructure as Code Settings for a group.
Last updated
Was this helpful?

