Snyk API

Snyk API

API version: REST

Auth

ApiKey Authorization in header | Bearer bearer

Base URL

https://api.snyk.io/rest

Setup

1. Set Authorization header with your Bearer token
2. GET /custom_base_images -- verify access
3. POST /custom_base_images -- create first custom_base_images

Endpoints

250 endpoints across 7 groups. See references/api-spec.lap for full details.

custom_base_images

groups

learn

openapi

orgs

self

tenants

Common Questions

Match user requests to endpoints in references/api-spec.lap. Key patterns:

• "List all custom_base_images?" -> GET /custom_base_images
• "Create a custom_base_image?" -> POST /custom_base_images
• "Delete a custom_base_image?" -> DELETE /custom_base_images/{custombaseimage_id}
• "Get custom_base_image details?" -> GET /custom_base_images/{custombaseimage_id}
• "Partially update a custom_base_image?" -> PATCH /custom_base_images/{custombaseimage_id}
• "List all groups?" -> GET /groups
• "Get group details?" -> GET /groups/{group_id}
• "List all installs?" -> GET /groups/{group_id}/apps/installs
• "Create a install?" -> POST /groups/{group_id}/apps/installs
• "Delete a install?" -> DELETE /groups/{group_id}/apps/installs/{install_id}
• "Create a secret?" -> POST /groups/{group_id}/apps/installs/{install_id}/secrets
• "Create a search?" -> POST /groups/{group_id}/assets/search
• "Get asset details?" -> GET /groups/{group_id}/assets/{asset_id}
• "Partially update a asset?" -> PATCH /groups/{group_id}/assets/{asset_id}
• "List all assets?" -> GET /groups/{group_id}/assets/{asset_id}/relationships/assets
• "List all projects?" -> GET /groups/{group_id}/assets/{asset_id}/relationships/projects
• "List all search?" -> GET /groups/{group_id}/audit_logs/search
• "Create a export?" -> POST /groups/{group_id}/export
• "Get export details?" -> GET /groups/{group_id}/export/{export_id}
• "List all assets?" -> GET /groups/{group_id}/inventory/assets
• "List all filters?" -> GET /groups/{group_id}/inventory/assets/filters
• "Search values?" -> GET /groups/{group_id}/inventory/assets/filters/{filter_id}/values
• "List all groups?" -> GET /groups/{group_id}/inventory/assets/groups
• "List all values?" -> GET /groups/{group_id}/inventory/assets/groups/{group_field}/values
• "Create a searche?" -> POST /groups/{group_id}/inventory/assets/searches
• "List all results?" -> GET /groups/{group_id}/inventory/assets/searches/{search_id}/results
• "Get asset details?" -> GET /groups/{group_id}/inventory/assets/{asset_id}
• "Partially update a asset?" -> PATCH /groups/{group_id}/inventory/assets/{asset_id}
• "List all projects?" -> GET /groups/{group_id}/inventory/assets/{asset_id}/relationships/projects
• "List all targets?" -> GET /groups/{group_id}/inventory/assets/{asset_id}/relationships/targets
• "List all issues?" -> GET /groups/{group_id}/issues
• "Get issue details?" -> GET /groups/{group_id}/issues/{issue_id}
• "Get export details?" -> GET /groups/{group_id}/jobs/export/{export_id}
• "List all memberships?" -> GET /groups/{group_id}/memberships
• "Create a membership?" -> POST /groups/{group_id}/memberships
• "Delete a membership?" -> DELETE /groups/{group_id}/memberships/{membership_id}
• "Partially update a membership?" -> PATCH /groups/{group_id}/memberships/{membership_id}
• "List all org_memberships?" -> GET /groups/{group_id}/org_memberships
• "List all orgs?" -> GET /groups/{group_id}/orgs
• "List all policies?" -> GET /groups/{group_id}/policies
• "Create a policy?" -> POST /groups/{group_id}/policies
• "Delete a policy?" -> DELETE /groups/{group_id}/policies/{policy_id}
• "Partially update a policy?" -> PATCH /groups/{group_id}/policies/{policy_id}
• "List all service_accounts?" -> GET /groups/{group_id}/service_accounts
• "Create a service_account?" -> POST /groups/{group_id}/service_accounts
• "Delete a service_account?" -> DELETE /groups/{group_id}/service_accounts/{serviceaccount_id}
• "Get service_account details?" -> GET /groups/{group_id}/service_accounts/{serviceaccount_id}
• "Partially update a service_account?" -> PATCH /groups/{group_id}/service_accounts/{serviceaccount_id}
• "Create a secret?" -> POST /groups/{group_id}/service_accounts/{serviceaccount_id}/secrets
• "List all iac?" -> GET /groups/{group_id}/settings/iac
• "List all pull_request_template?" -> GET /groups/{group_id}/settings/pull_request_template
• "Create a pull_request_template?" -> POST /groups/{group_id}/settings/pull_request_template
• "List all sso_connections?" -> GET /groups/{group_id}/sso_connections
• "List all users?" -> GET /groups/{group_id}/sso_connections/{sso_id}/users
• "Delete a user?" -> DELETE /groups/{group_id}/sso_connections/{sso_id}/users/{user_id}
• "Partially update a user?" -> PATCH /groups/{group_id}/users/{id}
• "List all catalog?" -> GET /learn/catalog
• "List all openapi?" -> GET /openapi
• "Get openapi details?" -> GET /openapi/{version}
• "List all orgs?" -> GET /orgs
• "Get org details?" -> GET /orgs/{org_id}
• "Partially update a org?" -> PATCH /orgs/{org_id}
• "Get ai_bom_job details?" -> GET /orgs/{org_id}/ai_bom_jobs/{job_id}
• "Create a ai_bom?" -> POST /orgs/{org_id}/ai_boms
• "Create a upload?" -> POST /orgs/{org_id}/ai_boms/upload
• "Get ai_bom details?" -> GET /orgs/{org_id}/ai_boms/{ai_bom_id}
• "List all app_bots?" -> GET /orgs/{org_id}/app_bots
• "Delete a app_bot?" -> DELETE /orgs/{org_id}/app_bots/{bot_id}
• "List all apps?" -> GET /orgs/{org_id}/apps
• "Create a app?" -> POST /orgs/{org_id}/apps
• "List all creations?" -> GET /orgs/{org_id}/apps/creations
• "Create a creation?" -> POST /orgs/{org_id}/apps/creations
• "Delete a creation?" -> DELETE /orgs/{org_id}/apps/creations/{app_id}
• "Get creation details?" -> GET /orgs/{org_id}/apps/creations/{app_id}
• "Partially update a creation?" -> PATCH /orgs/{org_id}/apps/creations/{app_id}
• "Create a secret?" -> POST /orgs/{org_id}/apps/creations/{app_id}/secrets
• "List all installs?" -> GET /orgs/{org_id}/apps/installs
• "Create a install?" -> POST /orgs/{org_id}/apps/installs
• "Delete a install?" -> DELETE /orgs/{org_id}/apps/installs/{install_id}
• "Create a secret?" -> POST /orgs/{org_id}/apps/installs/{install_id}/secrets
• "Delete a app?" -> DELETE /orgs/{org_id}/apps/{client_id}
• "Get app details?" -> GET /orgs/{org_id}/apps/{client_id}
• "Partially update a app?" -> PATCH /orgs/{org_id}/apps/{client_id}
• "Create a secret?" -> POST /orgs/{org_id}/apps/{client_id}/secrets
• "List all search?" -> GET /orgs/{org_id}/audit_logs/search
• "List all connections?" -> GET /orgs/{org_id}/brokers/connections
• "List all environments?" -> GET /orgs/{org_id}/cloud/environments
• "Create a environment?" -> POST /orgs/{org_id}/cloud/environments
• "Delete a environment?" -> DELETE /orgs/{org_id}/cloud/environments/{environment_id}
• "Partially update a environment?" -> PATCH /orgs/{org_id}/cloud/environments/{environment_id}
• "Create a permission?" -> POST /orgs/{org_id}/cloud/permissions
• "List all resources?" -> GET /orgs/{org_id}/cloud/resources
• "List all scans?" -> GET /orgs/{org_id}/cloud/scans
• "Create a scan?" -> POST /orgs/{org_id}/cloud/scans
• "Get scan details?" -> GET /orgs/{org_id}/cloud/scans/{scan_id}
• "List all collections?" -> GET /orgs/{org_id}/collections
• "Create a collection?" -> POST /orgs/{org_id}/collections
• "Delete a collection?" -> DELETE /orgs/{org_id}/collections/{collection_id}
• "Get collection details?" -> GET /orgs/{org_id}/collections/{collection_id}
• "Partially update a collection?" -> PATCH /orgs/{org_id}/collections/{collection_id}
• "List all projects?" -> GET /orgs/{org_id}/collections/{collection_id}/relationships/projects
• "Create a project?" -> POST /orgs/{org_id}/collections/{collection_id}/relationships/projects
• "List all container_images?" -> GET /orgs/{org_id}/container_images
• "Get container_image details?" -> GET /orgs/{org_id}/container_images/{image_id}
• "List all image_target_refs?" -> GET /orgs/{org_id}/container_images/{image_id}/relationships/image_target_refs
• "Create a dry_run?" -> POST /orgs/{org_id}/container_import/{integration_id}/policy/dry_run
• "Get dry_run details?" -> GET /orgs/{org_id}/container_import/{integration_id}/policy/dry_run/{job_id}
• "Get package details?" -> GET /orgs/{org_id}/ecosystems/{ecosystem}/packages/{package_name}
• "Get version details?" -> GET /orgs/{org_id}/ecosystems/{ecosystem}/packages/{package_name}/versions/{package_version}
• "Create a export?" -> POST /orgs/{org_id}/export
• "Get export details?" -> GET /orgs/{org_id}/export/{export_id}
• "List all assets?" -> GET /orgs/{org_id}/inventory/assets
• "List all filters?" -> GET /orgs/{org_id}/inventory/assets/filters
• "Search values?" -> GET /orgs/{org_id}/inventory/assets/filters/{filter_id}/values
• "List all groups?" -> GET /orgs/{org_id}/inventory/assets/groups
• "List all values?" -> GET /orgs/{org_id}/inventory/assets/groups/{group_field}/values
• "Create a searche?" -> POST /orgs/{org_id}/inventory/assets/searches
• "List all results?" -> GET /orgs/{org_id}/inventory/assets/searches/{search_id}/results
• "Get asset details?" -> GET /orgs/{org_id}/inventory/assets/{asset_id}
• "Partially update a asset?" -> PATCH /orgs/{org_id}/inventory/assets/{asset_id}
• "List all projects?" -> GET /orgs/{org_id}/inventory/assets/{asset_id}/relationships/projects
• "List all targets?" -> GET /orgs/{org_id}/inventory/assets/{asset_id}/relationships/targets
• "List all invites?" -> GET /orgs/{org_id}/invites
• "Create a invite?" -> POST /orgs/{org_id}/invites
• "Delete a invite?" -> DELETE /orgs/{org_id}/invites/{invite_id}
• "List all issues?" -> GET /orgs/{org_id}/issues
• "Get issue details?" -> GET /orgs/{org_id}/issues/{issue_id}
• "Get export details?" -> GET /orgs/{org_id}/jobs/export/{export_id}
• "List all assignments?" -> GET /orgs/{org_id}/learn/assignments
• "Create a assignment?" -> POST /orgs/{org_id}/learn/assignments
• "Create a bulk_delete?" -> POST /orgs/{org_id}/learn/assignments/bulk_delete
• "List all catalog?" -> GET /orgs/{org_id}/learn/progress/catalog
• "List all users?" -> GET /orgs/{org_id}/learn/progress/users
• "List all memberships?" -> GET /orgs/{org_id}/memberships
• "Create a membership?" -> POST /orgs/{org_id}/memberships
• "Delete a membership?" -> DELETE /orgs/{org_id}/memberships/{membership_id}
• "Partially update a membership?" -> PATCH /orgs/{org_id}/memberships/{membership_id}
• "Create a issue?" -> POST /orgs/{org_id}/packages/issues
• "List all issues?" -> GET /orgs/{org_id}/packages/{purl}/issues
• "Search policies?" -> GET /orgs/{org_id}/policies
• "Create a policy?" -> POST /orgs/{org_id}/policies
• "Delete a policy?" -> DELETE /orgs/{org_id}/policies/{policy_id}
• "Get policy details?" -> GET /orgs/{org_id}/policies/{policy_id}
• "Partially update a policy?" -> PATCH /orgs/{org_id}/policies/{policy_id}
• "List all events?" -> GET /orgs/{org_id}/policies/{policy_id}/events
• "List all projects?" -> GET /orgs/{org_id}/projects
• "Delete a project?" -> DELETE /orgs/{org_id}/projects/{project_id}
• "Get project details?" -> GET /orgs/{org_id}/projects/{project_id}
• "Partially update a project?" -> PATCH /orgs/{org_id}/projects/{project_id}
• "List all sbom?" -> GET /orgs/{org_id}/projects/{project_id}/sbom
• "Create a sbom_test?" -> POST /orgs/{org_id}/sbom_tests
• "Get sbom_test details?" -> GET /orgs/{org_id}/sbom_tests/{job_id}
• "List all results?" -> GET /orgs/{org_id}/sbom_tests/{job_id}/results
• "List all service_accounts?" -> GET /orgs/{org_id}/service_accounts
• "Create a service_account?" -> POST /orgs/{org_id}/service_accounts
• "Delete a service_account?" -> DELETE /orgs/{org_id}/service_accounts/{serviceaccount_id}
• "Get service_account details?" -> GET /orgs/{org_id}/service_accounts/{serviceaccount_id}
• "Partially update a service_account?" -> PATCH /orgs/{org_id}/service_accounts/{serviceaccount_id}
• "Create a secret?" -> POST /orgs/{org_id}/service_accounts/{serviceaccount_id}/secrets
• "List all iac?" -> GET /orgs/{org_id}/settings/iac
• "List all opensource?" -> GET /orgs/{org_id}/settings/opensource
• "List all sast?" -> GET /orgs/{org_id}/settings/sast
• "Delete a slack_app?" -> DELETE /orgs/{org_id}/slack_app/{bot_id}
• "Get slack_app details?" -> GET /orgs/{org_id}/slack_app/{bot_id}
• "List all projects?" -> GET /orgs/{org_id}/slack_app/{bot_id}/projects
• "Delete a project?" -> DELETE /orgs/{org_id}/slack_app/{bot_id}/projects/{project_id}
• "Partially update a project?" -> PATCH /orgs/{org_id}/slack_app/{bot_id}/projects/{project_id}
• "List all channels?" -> GET /orgs/{org_id}/slack_app/{tenant_id}/channels
• "Get channel details?" -> GET /orgs/{org_id}/slack_app/{tenant_id}/channels/{channel_id}
• "List all targets?" -> GET /orgs/{org_id}/targets
• "Delete a target?" -> DELETE /orgs/{org_id}/targets/{target_id}
• "Get target details?" -> GET /orgs/{org_id}/targets/{target_id}
• "Get test_job details?" -> GET /orgs/{org_id}/test_jobs/{job_id}
• "Create a test?" -> POST /orgs/{org_id}/tests
• "Get test details?" -> GET /orgs/{org_id}/tests/{test_id}
• "List all findings?" -> GET /orgs/{org_id}/tests/{test_id}/findings
• "Get user details?" -> GET /orgs/{org_id}/users/{id}
• "List all self?" -> GET /self
• "List all access_requests?" -> GET /self/access_requests
• "List all apps?" -> GET /self/apps
• "List all installs?" -> GET /self/apps/installs
• "Delete a install?" -> DELETE /self/apps/installs/{install_id}
• "Delete a app?" -> DELETE /self/apps/{app_id}
• "List all sessions?" -> GET /self/apps/{app_id}/sessions
• "Delete a session?" -> DELETE /self/apps/{app_id}/sessions/{session_id}
• "List all personal_access_tokens?" -> GET /self/personal_access_tokens
• "Delete a personal_access_token?" -> DELETE /self/personal_access_tokens/{personal_access_token_id}
• "List all tenants?" -> GET /tenants
• "Get tenant details?" -> GET /tenants/{tenant_id}
• "Partially update a tenant?" -> PATCH /tenants/{tenant_id}
• "List all integrations?" -> GET /tenants/{tenant_id}/brokers/connections/{connection_id}/integrations
• "Create a integration?" -> POST /tenants/{tenant_id}/brokers/connections/{connection_id}/orgs/{org_id}/integration
• "Delete a integration?" -> DELETE /tenants/{tenant_id}/brokers/connections/{connection_id}/orgs/{org_id}/integrations/{integration_id}
• "List all deployments?" -> GET /tenants/{tenant_id}/brokers/deployments
• "List all contexts?" -> GET /tenants/{tenant_id}/brokers/installs/{install_id}/connections/{connection_id}/contexts
• "Delete a context?" -> DELETE /tenants/{tenant_id}/brokers/installs/{install_id}/contexts/{context_id}
• "Get context details?" -> GET /tenants/{tenant_id}/brokers/installs/{install_id}/contexts/{context_id}
• "Partially update a context?" -> PATCH /tenants/{tenant_id}/brokers/installs/{install_id}/contexts/{context_id}

…(truncated)