Can I use Snyk as a CLI?

Yes. KosmoKrator exposes a Snyk CLI through kosmo integrations:call and the provider shortcut command. Commands can return JSON for scripts, CI, and coding agents.

Can I expose Snyk through MCP?

Yes. The KosmoKrator MCP gateway can expose selected Snyk tools to clients such as Claude Code, Cursor, Codex, and other MCP-compatible tools.

Where are Snyk credentials stored?

Snyk credentials are configured in KosmoKrator's local integration settings and reused by CLI, Lua, and MCP gateway surfaces.

Can I deny write access for Snyk MCP tools?

Yes. Start the gateway with --write=deny for read-only clients, or use ask/allow only for trusted workspaces.

data

Snyk Lua API for KosmoKrator Agents

Agent-facing Lua documentation and function reference for the Snyk KosmoKrator integration.

Lua Namespace

Agents call this integration through app.integrations.snyk.*. Use lua_read_doc("integrations.snyk") inside KosmoKrator to discover the same reference at runtime.

Call Lua from the Headless CLI

Use kosmo integrations:lua when a shell script, CI job, cron job, or another coding CLI should run a deterministic Snyk workflow without starting an interactive agent session.

Inline Lua call

kosmo integrations:lua --eval 'dump(app.integrations.snyk.get_custom_base_image_collection({}))' --json

Read Lua docs headlessly

kosmo integrations:lua --eval 'print(docs.read("snyk"))' --json
kosmo integrations:lua --eval 'print(docs.read("snyk.get_custom_base_image_collection"))' --json

Workflow file

Put repeatable logic in a Lua file, then execute it with JSON output for the calling process.

workflow.lua

local snyk = app.integrations.snyk
local result = snyk.get_custom_base_image_collection({})

dump(result)

Run the workflow

kosmo integrations:lua workflow.lua --json
kosmo integrations:lua workflow.lua --force --json

Namespace note. integrations:lua exposes app.integrations.snyk, app.mcp.*, docs.*, json.*, and regex.*. Use app.integrations.snyk.default.* or app.integrations.snyk.work.* when you configured named credential accounts.

MCP-only Lua

If the script only needs configured MCP servers and does not need Snyk, use the narrower mcp:lua command.

MCP Lua command

# Use mcp:lua for MCP-only scripts; use integrations:lua for this integration namespace.
kosmo mcp:lua --eval 'dump(mcp.servers())' --json

Agent-Facing Lua Docs

This is the rendered version of the full Lua documentation exposed to agents when they inspect the integration namespace.

Snyk Lua Docs

Snyk tools are exposed under app.integrations.snyk. This package is generated from Snyk’s official REST OpenAPI specification and exposes all 277 operations found in that spec.

Configure api_token, optionally url for the Snyk region, and optionally version. The default URL is https://api.snyk.io/rest; the default version is 2024-10-15.

Pass path, query, and header parameters as top-level snake_case arguments. Pass JSON request bodies under body. The service injects the configured version query parameter when a tool call does not provide one.

local groups = app.integrations.snyk.snyk_list_groups({ limit = 25 })
local group = app.integrations.snyk.snyk_get_group({ group_id = 'group-id' })

Coverage Notes

The manifest snyk-openapi-manifest.json records source URL, operation IDs, methods, paths, tool slugs, and classes. The Snyk REST API uses JSON:API content negotiation and token authentication.

Representative Tools

snyk_get_custom_base_images - GET /custom_base_images
snyk_create_custom_base_image - POST /custom_base_images
snyk_delete_custom_base_image - DELETE /custom_base_images/{custombaseimage_id}
snyk_get_custom_base_image - GET /custom_base_images/{custombaseimage_id}
snyk_update_custom_base_image - PATCH /custom_base_images/{custombaseimage_id}
snyk_list_groups - GET /groups
snyk_get_group - GET /groups/{group_id}
snyk_get_app_installs_for_group - GET /groups/{group_id}/apps/installs
snyk_create_group_app_install - POST /groups/{group_id}/apps/installs
snyk_delete_group_app_install_by_id - DELETE /groups/{group_id}/apps/installs/{install_id}
snyk_update_group_app_install_secret - POST /groups/{group_id}/apps/installs/{install_id}/secrets
snyk_delete_aliases_in_group - DELETE /groups/{group_id}/assets/repository/aliases
snyk_list_repository_aliases_in_group - GET /groups/{group_id}/assets/repository/aliases
snyk_create_alias_in_group - POST /groups/{group_id}/assets/repository/aliases
snyk_list_assets - POST /groups/{group_id}/assets/search
snyk_get_asset - GET /groups/{group_id}/assets/{asset_id}
snyk_update_asset - PATCH /groups/{group_id}/assets/{asset_id}
snyk_list_related_assets - GET /groups/{group_id}/assets/{asset_id}/relationships/assets
snyk_list_asset_projects - GET /groups/{group_id}/assets/{asset_id}/relationships/projects
snyk_list_group_audit_logs - GET /groups/{group_id}/audit_logs/search

Raw agent markdown

# Snyk Lua Docs

Snyk tools are exposed under `app.integrations.snyk`. This package is generated from Snyk's official REST OpenAPI specification and exposes all 277 operations found in that spec.

Configure `api_token`, optionally `url` for the Snyk region, and optionally `version`. The default URL is `https://api.snyk.io/rest`; the default version is `2024-10-15`.

Pass path, query, and header parameters as top-level snake_case arguments. Pass JSON request bodies under `body`. The service injects the configured `version` query parameter when a tool call does not provide one.

```lua
local groups = app.integrations.snyk.snyk_list_groups({ limit = 25 })
local group = app.integrations.snyk.snyk_get_group({ group_id = 'group-id' })
```

## Coverage Notes

The manifest `snyk-openapi-manifest.json` records source URL, operation IDs, methods, paths, tool slugs, and classes. The Snyk REST API uses JSON:API content negotiation and token authentication.

## Representative Tools

- `snyk_get_custom_base_images` - GET `/custom_base_images`
- `snyk_create_custom_base_image` - POST `/custom_base_images`
- `snyk_delete_custom_base_image` - DELETE `/custom_base_images/{custombaseimage_id}`
- `snyk_get_custom_base_image` - GET `/custom_base_images/{custombaseimage_id}`
- `snyk_update_custom_base_image` - PATCH `/custom_base_images/{custombaseimage_id}`
- `snyk_list_groups` - GET `/groups`
- `snyk_get_group` - GET `/groups/{group_id}`
- `snyk_get_app_installs_for_group` - GET `/groups/{group_id}/apps/installs`
- `snyk_create_group_app_install` - POST `/groups/{group_id}/apps/installs`
- `snyk_delete_group_app_install_by_id` - DELETE `/groups/{group_id}/apps/installs/{install_id}`
- `snyk_update_group_app_install_secret` - POST `/groups/{group_id}/apps/installs/{install_id}/secrets`
- `snyk_delete_aliases_in_group` - DELETE `/groups/{group_id}/assets/repository/aliases`
- `snyk_list_repository_aliases_in_group` - GET `/groups/{group_id}/assets/repository/aliases`
- `snyk_create_alias_in_group` - POST `/groups/{group_id}/assets/repository/aliases`
- `snyk_list_assets` - POST `/groups/{group_id}/assets/search`
- `snyk_get_asset` - GET `/groups/{group_id}/assets/{asset_id}`
- `snyk_update_asset` - PATCH `/groups/{group_id}/assets/{asset_id}`
- `snyk_list_related_assets` - GET `/groups/{group_id}/assets/{asset_id}/relationships/assets`
- `snyk_list_asset_projects` - GET `/groups/{group_id}/assets/{asset_id}/relationships/projects`
- `snyk_list_group_audit_logs` - GET `/groups/{group_id}/audit_logs/search`

Metadata-derived Lua example

local result = app.integrations.snyk.get_custom_base_image_collection({})
print(result)

Functions

get_custom_base_image_collection Read

Get a custom base image collection Official Snyk endpoint: GET /custom_base_images 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 auth...

Lua path: app.integrations.snyk.get_custom_base_image_collection
Full name: snyk.snyk_get_custom_base_images

Parameter	Type	Required	Description
No parameters.

create_custom_base_image_from_existing_container_project Write

Create a Custom Base Image from an existing container project Official Snyk endpoint: POST /custom_base_images In order to create a custom base image, you first need to import your base images into Snyk. You can do th...

Lua path: app.integrations.snyk.create_custom_base_image_from_existing_container_project
Full name: snyk.snyk_create_custom_base_image

Parameter	Type	Required	Description
No parameters.

delete_custom_base_image Write

Delete a custom base image Official Snyk endpoint: DELETE /custom_base_images/{custombaseimage_id} Delete a custom base image resource. (the related container project is unaffected)

Lua path: app.integrations.snyk.delete_custom_base_image
Full name: snyk.snyk_delete_custom_base_image

Parameter	Type	Required	Description
No parameters.

get_custom_base_image Read

Get a custom base image Official Snyk endpoint: GET /custom_base_images/{custombaseimage_id} Get a custom base image

Lua path: app.integrations.snyk.get_custom_base_image
Full name: snyk.snyk_get_custom_base_image

Parameter	Type	Required	Description
No parameters.

update_custom_base_image Write

Update a custom base image Official Snyk endpoint: PATCH /custom_base_images/{custombaseimage_id} Updates a custom base image's attributes

Lua path: app.integrations.snyk.update_custom_base_image
Full name: snyk.snyk_update_custom_base_image

Parameter	Type	Required	Description
No parameters.

get_all_groups_early_access Read

Get all groups (Early Access) Official Snyk endpoint: GET /groups Returns a list of groups which a user is a member of

Lua path: app.integrations.snyk.get_all_groups_early_access
Full name: snyk.snyk_list_groups

Parameter	Type	Required	Description
No parameters.

get_group_early_access Read

Get Group (Early Access) Official Snyk endpoint: GET /groups/{group_id} Get a group #### Required permissions - `View Groups (group.read)`

Lua path: app.integrations.snyk.get_group_early_access
Full name: snyk.snyk_get_group

Parameter	Type	Required	Description
No parameters.

get_list_apps_installed_group Read

Get a list of Snyk Apps installed for a Group Official Snyk endpoint: GET /groups/{group_id}/apps/installs Get a list of Snyk Apps installed for a Group #### Required permissions - `View Apps (group.app.read)`

Lua path: app.integrations.snyk.get_list_apps_installed_group
Full name: snyk.snyk_get_app_installs_for_group

Parameter	Type	Required	Description
No parameters.

install_app_group Write

Install a Snyk App for a Group Official Snyk endpoint: POST /groups/{group_id}/apps/installs Install a Snyk App to this group, the Snyk App must use unattended authentication e.g. client credentials #### Required perm...

Lua path: app.integrations.snyk.install_app_group
Full name: snyk.snyk_create_group_app_install

Parameter	Type	Required	Description
No parameters.

revoke_app_authorization_group_with_install_id Write

Revoke app authorization for a Snyk group with install ID Official Snyk endpoint: DELETE /groups/{group_id}/apps/installs/{install_id} Revoke app authorization for a Snyk group with install ID #### Required permission...

Lua path: app.integrations.snyk.revoke_app_authorization_group_with_install_id
Full name: snyk.snyk_delete_group_app_install_by_id

Parameter	Type	Required	Description
No parameters.

manage_client_secret_non_interactive_app_installations Write

Manage client secret for non-interactive Snyk App installations Official Snyk endpoint: POST /groups/{group_id}/apps/installs/{install_id}/secrets Manage client secret for non-interactive Snyk App installations #### R...

Lua path: app.integrations.snyk.manage_client_secret_non_interactive_app_installations
Full name: snyk.snyk_update_group_app_install_secret

Parameter	Type	Required	Description
No parameters.

bulk_remove_aliases_from_repository_assets_group_early_access Write

Bulk remove aliases from repository assets in group (Early Access) Official Snyk endpoint: DELETE /groups/{group_id}/assets/repository/aliases Detach one or more aliased URLs from their canonical repository assets wit...

Lua path: app.integrations.snyk.bulk_remove_aliases_from_repository_assets_group_early_access
Full name: snyk.snyk_delete_aliases_in_group

Parameter	Type	Required	Description
No parameters.

list_repository_aliases_group_early_access Read

List repository aliases in group (Early Access) Official Snyk endpoint: GET /groups/{group_id}/assets/repository/aliases Returns a paginated list of alias URL entries for repository assets within a group. Use the opti...

Lua path: app.integrations.snyk.list_repository_aliases_group_early_access
Full name: snyk.snyk_list_repository_aliases_in_group

Parameter	Type	Required	Description
No parameters.

add_alias_repository_asset_group_early_access Write

Add alias for a repository asset in group (Early Access) Official Snyk endpoint: POST /groups/{group_id}/assets/repository/aliases Link one or more alternate repository URLs to a canonical repository asset within a gr...

Lua path: app.integrations.snyk.add_alias_repository_asset_group_early_access
Full name: snyk.snyk_create_alias_in_group

Parameter	Type	Required	Description
No parameters.

list_assets_with_filters_early_access Write

List Assets with filters (Early Access) Official Snyk endpoint: POST /groups/{group_id}/assets/search List Assets with filters #### Required permissions - `View Groups (group.read)`

Lua path: app.integrations.snyk.list_assets_with_filters_early_access
Full name: snyk.snyk_list_assets

Parameter	Type	Required	Description
No parameters.

get_asset_by_its_id_early_access Read

Get an Asset by its ID (Early Access) Official Snyk endpoint: GET /groups/{group_id}/assets/{asset_id} Get an Asset by its ID #### Required permissions - `View Groups (group.read)`

Lua path: app.integrations.snyk.get_asset_by_its_id_early_access
Full name: snyk.snyk_get_asset

Parameter	Type	Required	Description
No parameters.

update_asset_attributes_early_access Write

Update asset attributes (Early Access) Official Snyk endpoint: PATCH /groups/{group_id}/assets/{asset_id} The endpoint allows for partial updates to an asset's attributes. #### Required permissions - `Edit Group Detai...

Lua path: app.integrations.snyk.update_asset_attributes_early_access
Full name: snyk.snyk_update_asset

Parameter	Type	Required	Description
No parameters.

list_related_assets_with_pagination_early_access Read

List related assets with pagination (Early Access) Official Snyk endpoint: GET /groups/{group_id}/assets/{asset_id}/relationships/assets List related assets with pagination #### Required permissions - `View Groups (gr...

Lua path: app.integrations.snyk.list_related_assets_with_pagination_early_access
Full name: snyk.snyk_list_related_assets

Parameter	Type	Required	Description
No parameters.

list_asset_projects_with_pagination_early_access Read

List asset projects with pagination (Early Access) Official Snyk endpoint: GET /groups/{group_id}/assets/{asset_id}/relationships/projects List asset projects with pagination #### Required permissions - `View Groups (...

Lua path: app.integrations.snyk.list_asset_projects_with_pagination_early_access
Full name: snyk.snyk_list_asset_projects

Parameter	Type	Required	Description
No parameters.

search_group_audit_logs Read

Search Group audit logs. Official Snyk endpoint: GET /groups/{group_id}/audit_logs/search Search audit logs for a Group. "api.access" events are omitted from results unless explicitly requested using the events parame...

Lua path: app.integrations.snyk.search_group_audit_logs
Full name: snyk.snyk_list_group_audit_logs

Parameter	Type	Required	Description
No parameters.

start_export Write

Start an export Official Snyk endpoint: POST /groups/{group_id}/export Create and start an export for a group #### Required permissions - `View reports (group.report.read)`

Lua path: app.integrations.snyk.start_export
Full name: snyk.snyk_create_group_export

Parameter	Type	Required	Description
No parameters.

get_export_results Read

Get export results Official Snyk endpoint: GET /groups/{group_id}/export/{export_id} Get an export results #### Required permissions - `View reports (group.report.read)`

Lua path: app.integrations.snyk.get_export_results
Full name: snyk.snyk_get_group_export

Parameter	Type	Required	Description
No parameters.

list_or_search_all_assets_synchronous_group_scope_early_access Read

List or search all assets (synchronous) - Group scope (Early Access) Official Snyk endpoint: GET /groups/{group_id}/inventory/assets Retrieves a polymorphic list of all asset types for a given group. The tenant is res...

Lua path: app.integrations.snyk.list_or_search_all_assets_synchronous_group_scope_early_access
Full name: snyk.snyk_list_assets_group

Parameter	Type	Required	Description
No parameters.

bulk_update_asset_attributes_group_scope_early_access Write

Bulk update asset attributes - Group scope (Early Access) Official Snyk endpoint: PATCH /groups/{group_id}/inventory/assets Partially updates multiple assets within a group context. Maximum of 100 assets can be update...

Lua path: app.integrations.snyk.bulk_update_asset_attributes_group_scope_early_access
Full name: snyk.snyk_update_assets_bulk_group

Parameter	Type	Required	Description
No parameters.

get_available_filter_fields_group_scope_early_access Read

Get available filter fields - Group scope (Early Access) Official Snyk endpoint: GET /groups/{group_id}/inventory/assets/filters Returns a list of valid field names that can be used for filtering assets using RSQL. Ea...

Lua path: app.integrations.snyk.get_available_filter_fields_group_scope_early_access
Full name: snyk.snyk_get_filter_fields_group

Parameter	Type	Required	Description
No parameters.

get_filter_value_suggestions_autocomplete_group_scope_early_access Read

Get filter value suggestions (autocomplete) - Group scope (Early Access) Official Snyk endpoint: GET /groups/{group_id}/inventory/assets/filters/{filter_id}/values Returns a list of distinct values for a specific filt...

Lua path: app.integrations.snyk.get_filter_value_suggestions_autocomplete_group_scope_early_access
Full name: snyk.snyk_get_filter_values_group

Parameter	Type	Required	Description
No parameters.

get_available_group_fields_group_scope_early_access Read

Get available group fields - Group scope (Early Access) Official Snyk endpoint: GET /groups/{group_id}/inventory/assets/groups Returns a list of valid group field names that can be used for grouping assets within a gr...

Lua path: app.integrations.snyk.get_available_group_fields_group_scope_early_access
Full name: snyk.snyk_get_group_fields_group

Parameter	Type	Required	Description
No parameters.

get_group_value_aggregation_group_scope_early_access Read

Get group value aggregation - Group scope (Early Access) Official Snyk endpoint: GET /groups/{group_id}/inventory/assets/groups/{group_field_id}/values Returns aggregated values for a specific group field id, showing ...

Lua path: app.integrations.snyk.get_group_value_aggregation_group_scope_early_access
Full name: snyk.snyk_get_group_values_group

Parameter	Type	Required	Description
No parameters.

create_asset_search_asynchronous_group_scope_early_access Write

Create an asset search (asynchronous) - Group scope (Early Access) Official Snyk endpoint: POST /groups/{group_id}/inventory/assets/searches Initiates an asynchronous search for assets within a group context. #### Req...

Lua path: app.integrations.snyk.create_asset_search_asynchronous_group_scope_early_access
Full name: snyk.snyk_create_asset_search_group

Parameter	Type	Required	Description
No parameters.

retrieve_asset_search_results_asynchronous_group_scope_early_access Read

Retrieve asset search results (asynchronous) - Group scope (Early Access) Official Snyk endpoint: GET /groups/{group_id}/inventory/assets/searches/{search_id}/results Gets paginated results for a previously initiated ...

Lua path: app.integrations.snyk.retrieve_asset_search_results_asynchronous_group_scope_early_access
Full name: snyk.snyk_get_asset_search_results_group

Parameter	Type	Required	Description
No parameters.

get_single_asset_by_id_group_scope_early_access Read

Get a single asset by ID - Group scope (Early Access) Official Snyk endpoint: GET /groups/{group_id}/inventory/assets/{asset_id} Retrieves a single asset by its unique identifier within a group context. #### Required ...

Lua path: app.integrations.snyk.get_single_asset_by_id_group_scope_early_access
Full name: snyk.snyk_get_asset_group

Parameter	Type	Required	Description
No parameters.

update_asset_attributes_group_scope_early_access Write

Update asset attributes - Group scope (Early Access) Official Snyk endpoint: PATCH /groups/{group_id}/inventory/assets/{asset_id} Partially updates an asset's attributes within a group context. Supports updating class...

Lua path: app.integrations.snyk.update_asset_attributes_group_scope_early_access
Full name: snyk.snyk_update_asset_group

Parameter	Type	Required	Description
No parameters.

list_projects_asset_group_scope_early_access Read

List projects for an asset (group scope) (Early Access) Official Snyk endpoint: GET /groups/{group_id}/inventory/assets/{asset_id}/relationships/projects Retrieves a paginated list of Snyk projects linked to this asse...

Lua path: app.integrations.snyk.list_projects_asset_group_scope_early_access
Full name: snyk.snyk_list_asset_projects_group

Parameter	Type	Required	Description
No parameters.

list_targets_asset_group_scope_early_access Read

List targets for an asset (group scope) (Early Access) Official Snyk endpoint: GET /groups/{group_id}/inventory/assets/{asset_id}/relationships/targets Retrieves a paginated list of Snyk targets linked to this asset w...

Lua path: app.integrations.snyk.list_targets_asset_group_scope_early_access
Full name: snyk.snyk_list_asset_targets_group

Parameter	Type	Required	Description
No parameters.

get_issues_by_group_id Read

Get issues by group ID Official Snyk endpoint: GET /groups/{group_id}/issues Get a list of a group's issues. #### Required permissions - `View Issues (group.issues.read)`

Lua path: app.integrations.snyk.get_issues_by_group_id
Full name: snyk.snyk_list_group_issues

Parameter	Type	Required	Description
No parameters.

get_issue Read

Get an issue Official Snyk endpoint: GET /groups/{group_id}/issues/{issue_id} Get an issue #### Required permissions - `View Issues (group.issues.read)`

Lua path: app.integrations.snyk.get_issue
Full name: snyk.snyk_get_group_issue_by_issue_id

Parameter	Type	Required	Description
No parameters.

get_export_status Read

Get export status Official Snyk endpoint: GET /groups/{group_id}/jobs/export/{export_id} Get an export job status #### Required permissions - `View reports (group.report.read)`

Lua path: app.integrations.snyk.get_export_status
Full name: snyk.snyk_get_group_export_job_status

Parameter	Type	Required	Description
No parameters.

get_all_memberships_group Read

Get all memberships of the group Official Snyk endpoint: GET /groups/{group_id}/memberships Returns all memberships of the group #### Required permissions - `View Group Memberships (group.membership.read)`

Lua path: app.integrations.snyk.get_all_memberships_group
Full name: snyk.snyk_list_group_memberships

Parameter	Type	Required	Description
No parameters.

create_group_membership_user_with_role Write

Create a group membership for a user with role Official Snyk endpoint: POST /groups/{group_id}/memberships Create a group membership for a user with role #### Required permissions - `Add Group Memberships (group.membe...

Lua path: app.integrations.snyk.create_group_membership_user_with_role
Full name: snyk.snyk_create_group_membership

Parameter	Type	Required	Description
No parameters.

delete_membership_from_group Write

Delete a membership from a group Official Snyk endpoint: DELETE /groups/{group_id}/memberships/{membership_id} Deletes a membership from a group #### Required permissions - `Delete Group Memberships (group.membership....

Lua path: app.integrations.snyk.delete_membership_from_group
Full name: snyk.snyk_delete_group_membership

Parameter	Type	Required	Description
No parameters.

update_role_from_group_membership Write

Update a role from a group membership Official Snyk endpoint: PATCH /groups/{group_id}/memberships/{membership_id} Update a role from a group membership #### Required permissions - `Edit Group Memberships (group.membe...

Lua path: app.integrations.snyk.update_role_from_group_membership
Full name: snyk.snyk_update_group_user_membership

Parameter	Type	Required	Description
No parameters.

get_list_org_memberships_group_user Read

Get list of org memberships of a group user Official Snyk endpoint: GET /groups/{group_id}/org_memberships Get list of org memberships of a group user #### Required permissions - `View Group Memberships (group.members...

Lua path: app.integrations.snyk.get_list_org_memberships_group_user
Full name: snyk.snyk_list_group_user_org_memberships

Parameter	Type	Required	Description
No parameters.

list_all_organizations_group Read

List all organizations in group Official Snyk endpoint: GET /groups/{group_id}/orgs Get a paginated list of all the organizations belonging to the group. By default, this endpoint returns the organizations in alphabet...

Lua path: app.integrations.snyk.list_all_organizations_group
Full name: snyk.snyk_list_orgs_in_group

Parameter	Type	Required	Description
No parameters.

get_group_level_policies_early_access Read

Get group level policies (Early Access) Official Snyk endpoint: GET /groups/{group_id}/policies Get all policies for the requested group *Group level Policy APIs Access Notice:* Access to our Group level Policy APIs i...

Lua path: app.integrations.snyk.get_group_level_policies_early_access
Full name: snyk.snyk_list_group_policies

Parameter	Type	Required	Description
No parameters.

create_new_group_level_policy_early_access Write

Create a new group level policy (Early Access) Official Snyk endpoint: POST /groups/{group_id}/policies Create one new group level policy. *Group level Policy APIs Access Notice:* Access to our Group level Policy APIs...

Lua path: app.integrations.snyk.create_new_group_level_policy_early_access
Full name: snyk.snyk_create_group_policy

Parameter	Type	Required	Description
No parameters.

delete_group_level_policy_early_access Write

Delete an group-level policy (Early Access) Official Snyk endpoint: DELETE /groups/{group_id}/policies/{policy_id} Delete an existing group-level policy. *Group level Policy APIs Access Notice:* Access to our Group le...

Lua path: app.integrations.snyk.delete_group_level_policy_early_access
Full name: snyk.snyk_delete_group_policy

Parameter	Type	Required	Description
No parameters.

update_group_level_policy_early_access Write

Update a group-level policy (Early Access) Official Snyk endpoint: PATCH /groups/{group_id}/policies/{policy_id} Update the group-level policy. *Group level Policy APIs Access Notice:* Access to our Group level Policy...

Lua path: app.integrations.snyk.update_group_level_policy_early_access
Full name: snyk.snyk_update_group_policy

Parameter	Type	Required	Description
No parameters.

get_list_group_service_accounts Read

Get a list of group service accounts. Official Snyk endpoint: GET /groups/{group_id}/service_accounts Get all service accounts for a group. #### Required permissions - `View service accounts (group.service_account.read)`

Lua path: app.integrations.snyk.get_list_group_service_accounts
Full name: snyk.snyk_get_many_group_service_account

Parameter	Type	Required	Description
No parameters.

create_service_account_group Write

Create a service account for a group. Official Snyk endpoint: POST /groups/{group_id}/service_accounts Create a service account for a group. The service account can be used to access the Snyk API. #### Required permis...

Lua path: app.integrations.snyk.create_service_account_group
Full name: snyk.snyk_create_group_service_account

Parameter	Type	Required	Description
No parameters.

delete_group_service_account Write

Delete a group service account. Official Snyk endpoint: DELETE /groups/{group_id}/service_accounts/{serviceaccount_id} Permanently delete a group-level service account by its ID. #### Required permissions - `Delete se...

Lua path: app.integrations.snyk.delete_group_service_account
Full name: snyk.snyk_delete_one_group_service_account

Parameter	Type	Required	Description
No parameters.

get_group_service_account Read

Get a group service account. Official Snyk endpoint: GET /groups/{group_id}/service_accounts/{serviceaccount_id} Get a group-level service account by its ID. #### Required permissions - `View service accounts (group.s...

Lua path: app.integrations.snyk.get_group_service_account
Full name: snyk.snyk_get_one_group_service_account

Parameter	Type	Required	Description
No parameters.

update_group_service_account Write

Update a group service account. Official Snyk endpoint: PATCH /groups/{group_id}/service_accounts/{serviceaccount_id} Update the name of a group's service account by its ID. #### Required permissions - `Edit service a...

Lua path: app.integrations.snyk.update_group_service_account
Full name: snyk.snyk_update_group_service_account

Parameter	Type	Required	Description
No parameters.

manage_group_service_account_client_secret Write

Manage a group service account's client secret. Official Snyk endpoint: POST /groups/{group_id}/service_accounts/{serviceaccount_id}/secrets Manage the client secret of a group service account by the service account I...

Lua path: app.integrations.snyk.manage_group_service_account_client_secret
Full name: snyk.snyk_update_service_account_secret

Parameter	Type	Required	Description
No parameters.

get_infrastructure_as_code_settings_group Read

Get the Infrastructure as Code Settings for a group Official Snyk endpoint: GET /groups/{group_id}/settings/iac Get the Infrastructure as Code Settings for a group. #### Required permissions - `View IaC settings (grou...

Lua path: app.integrations.snyk.get_infrastructure_as_code_settings_group
Full name: snyk.snyk_get_iac_settings_for_group

Parameter	Type	Required	Description
No parameters.

update_infrastructure_as_code_settings_group Write

Update the Infrastructure as Code Settings for a group Official Snyk endpoint: PATCH /groups/{group_id}/settings/iac Update the Infrastructure as Code Settings for a group. #### Required permissions - `Edit IaC settin...

Lua path: app.integrations.snyk.update_infrastructure_as_code_settings_group
Full name: snyk.snyk_update_iac_settings_for_group

Parameter	Type	Required	Description
No parameters.

delete_opensource_broker_setting_group Write

Delete opensource broker setting for group Official Snyk endpoint: DELETE /groups/{group_id}/settings/opensource/broker Deletes the opensource broker setting for the group by uninstalling the Snyk App #### Required pe...

Lua path: app.integrations.snyk.delete_opensource_broker_setting_group
Full name: snyk.snyk_delete_opensource_broker_setting_for_group

Parameter	Type	Required	Description
No parameters.

get_opensource_broker_setting_group Read

Get opensource broker setting for group Official Snyk endpoint: GET /groups/{group_id}/settings/opensource/broker Returns whether the opensource broker setting is enabled for the group #### Required permissions - `Vie...

Lua path: app.integrations.snyk.get_opensource_broker_setting_group
Full name: snyk.snyk_get_opensource_broker_setting_for_group

Parameter	Type	Required	Description
No parameters.

enable_opensource_broker_group Write

Enable opensource broker for group Official Snyk endpoint: POST /groups/{group_id}/settings/opensource/broker Enables the opensource broker setting for a group by installing the Snyk App #### Required permissions - `I...

Lua path: app.integrations.snyk.enable_opensource_broker_group
Full name: snyk.snyk_enable_opensource_broker_for_group

Parameter	Type	Required	Description
No parameters.

delete_pull_request_template_group Write

Delete pull request template for group Official Snyk endpoint: DELETE /groups/{group_id}/settings/pull_request_template Delete your groups pull request template. This means Snyk pull requests will start to use the def...

Lua path: app.integrations.snyk.delete_pull_request_template_group
Full name: snyk.snyk_delete_pull_request_template

Parameter	Type	Required	Description
No parameters.

get_pull_request_template_group Read

Get pull request template for group Official Snyk endpoint: GET /groups/{group_id}/settings/pull_request_template Get your groups pull request template #### Required permissions - `View Group settings (group.settings....

Lua path: app.integrations.snyk.get_pull_request_template_group
Full name: snyk.snyk_get_pull_request_template

Parameter	Type	Required	Description
No parameters.

create_or_update_pull_request_template_group Write

Create or update pull request template for group Official Snyk endpoint: POST /groups/{group_id}/settings/pull_request_template Configures a group level pull request template that will be used on any org or project wi...

Lua path: app.integrations.snyk.create_or_update_pull_request_template_group
Full name: snyk.snyk_create_or_update_pull_request_template

Parameter	Type	Required	Description
No parameters.

get_all_sso_connections_group_early_access Read

Get all SSO connections for a group (Early Access) Official Snyk endpoint: GET /groups/{group_id}/sso_connections Returns a list of SSO connections for a group #### Required permissions - `View SSO settings (group.sso...

Lua path: app.integrations.snyk.get_all_sso_connections_group_early_access
Full name: snyk.snyk_list_group_sso_connections

Parameter	Type	Required	Description
No parameters.

get_all_users_using_given_sso_connection_early_access Read

Get all users using a given SSO connection (Early Access) Official Snyk endpoint: GET /groups/{group_id}/sso_connections/{sso_id}/users Returns a list of users for a SSO connection #### Required permissions - `View SS...

Lua path: app.integrations.snyk.get_all_users_using_given_sso_connection_early_access
Full name: snyk.snyk_list_group_sso_connection_users

Parameter	Type	Required	Description
No parameters.

delete_user_from_group_sso_connection_early_access Write

Delete a user from a Group SSO connection (Early Access) Official Snyk endpoint: DELETE /groups/{group_id}/sso_connections/{sso_id}/users/{user_id} Deletes a user from a Group SSO connection #### Required permissions ...

Lua path: app.integrations.snyk.delete_user_from_group_sso_connection_early_access
Full name: snyk.snyk_delete_user

Parameter	Type	Required	Description
No parameters.

update_user_role_group_early_access Write

Update a user's role in a group (Early Access) Official Snyk endpoint: PATCH /groups/{group_id}/users/{id} Update a user's membership of the group. To remove a user's membership, provide 'null' as the membership param...

Lua path: app.integrations.snyk.update_user_role_group_early_access
Full name: snyk.snyk_update_user

Parameter	Type	Required	Description
No parameters.

list_learn_resources_early_access Read

List Snyk Learn's resources (Early Access) Official Snyk endpoint: GET /learn/catalog List Snyk Learn's catalog resources

Lua path: app.integrations.snyk.list_learn_resources_early_access
Full name: snyk.snyk_list_learn_catalog

Parameter	Type	Required	Description
No parameters.

listapiversions Read

listAPIVersions Official Snyk endpoint: GET /openapi List available versions of OpenAPI specification

Lua path: app.integrations.snyk.listapiversions
Full name: snyk.snyk_list_apiversions

Parameter	Type	Required	Description
No parameters.

getapiversion Read

getAPIVersion Official Snyk endpoint: GET /openapi/{version} Get OpenAPI specification effective at version.

Lua path: app.integrations.snyk.getapiversion
Full name: snyk.snyk_get_apiversion

Parameter	Type	Required	Description
No parameters.

list_accessible_organizations Read

List accessible organizations Official Snyk endpoint: GET /orgs Get a paginated list of organizations you have access to.

Lua path: app.integrations.snyk.list_accessible_organizations
Full name: snyk.snyk_list_orgs

Parameter	Type	Required	Description
No parameters.

get_organization Read

Get organization Official Snyk endpoint: GET /orgs/{org_id} Get the full details of an organization. #### Required permissions - `View Organization (org.read)`

Lua path: app.integrations.snyk.get_organization
Full name: snyk.snyk_get_org

Parameter	Type	Required	Description
No parameters.

update_organization Write

Update organization Official Snyk endpoint: PATCH /orgs/{org_id} Update the details of an organization #### Required permissions - `Edit Organization (org.edit)`

Lua path: app.integrations.snyk.update_organization
Full name: snyk.snyk_update_org

Parameter	Type	Required	Description
No parameters.

get_ai_bom_job_status_early_access Read

Get an AI-BOM job status (Early Access) Official Snyk endpoint: GET /orgs/{org_id}/ai_bom_jobs/{job_id} Returns the status of an AI-BOM job. The job status is returned in the response body. If the job is completed the...

Lua path: app.integrations.snyk.get_ai_bom_job_status_early_access
Full name: snyk.snyk_get_ai_bom_job

Parameter	Type	Required	Description
No parameters.

create_new_ai_bom_early_access Write

Create a new AI-BOM (Early Access) Official Snyk endpoint: POST /orgs/{org_id}/ai_boms Triggers the creation of a new AI-BOM. The AI-BOM will be created in a background job. Users should query the background job statu...

Lua path: app.integrations.snyk.create_new_ai_bom_early_access
Full name: snyk.snyk_create_ai_bom

Parameter	Type	Required	Description
No parameters.

create_and_upload_ai_bom_early_access Write

Create and upload an AI-BOM (Early Access) Official Snyk endpoint: POST /orgs/{org_id}/ai_boms/upload Creates an AI-BOM from a file bundle and persists it to the database. Unlike the standard createAiBom endpoint, thi...

Lua path: app.integrations.snyk.create_and_upload_ai_bom_early_access
Full name: snyk.snyk_create_and_upload_ai_bom

Parameter	Type	Required	Description
No parameters.

get_ai_bom_early_access Read

Get an AI-BOM. (Early Access) Official Snyk endpoint: GET /orgs/{org_id}/ai_boms/{ai_bom_id} Get a AI-BOM once it's job has finished #### Required permissions - `View Organization (org.read)`

Lua path: app.integrations.snyk.get_ai_bom_early_access
Full name: snyk.snyk_get_ai_bom

Parameter	Type	Required	Description
No parameters.

get_list_app_bots_authorized_organization Read

Get a list of app bots authorized to an organization. Official Snyk endpoint: GET /orgs/{org_id}/app_bots Get a list of app bots authorized to an organization. Deprecated, use /orgs/{org_id}/apps/installs instead. ###...

Lua path: app.integrations.snyk.get_list_app_bots_authorized_organization
Full name: snyk.snyk_get_app_bots

Parameter	Type	Required	Description
No parameters.

revoke_app_bot_authorization Write

Revoke app bot authorization Official Snyk endpoint: DELETE /orgs/{org_id}/app_bots/{bot_id} Revoke app bot authorization. Deprecated, use /orgs/{org_id}/apps/installs/{install_id} instead. #### Required permissions -...

Lua path: app.integrations.snyk.revoke_app_bot_authorization
Full name: snyk.snyk_delete_app_bot

Parameter	Type	Required	Description
No parameters.

get_list_apps_created_by_organization Read

Get a list of Snyk Apps created by an Organization Official Snyk endpoint: GET /orgs/{org_id}/apps Get a list of Snyk Apps created by an Organization Deprecated, use /orgs/{org_id}/apps/creations instead. #### Require...

Lua path: app.integrations.snyk.get_list_apps_created_by_organization
Full name: snyk.snyk_get_apps

Parameter	Type	Required	Description
No parameters.

create_new_app_organization Write

Create a new app for an organization. Official Snyk endpoint: POST /orgs/{org_id}/apps Create a new app for an organization. Deprecated, use /orgs/{org_id}/apps/creations instead. #### Required permissions - `Create A...

Lua path: app.integrations.snyk.create_new_app_organization
Full name: snyk.snyk_create_app

Parameter	Type	Required	Description
No parameters.

get_list_apps_created_by_organization Read

Get a list of Snyk Apps created by an Organization Official Snyk endpoint: GET /orgs/{org_id}/apps/creations Get a list of Snyk Apps created by an Organization #### Required permissions - `View Apps (org.app.read)`

Lua path: app.integrations.snyk.get_list_apps_created_by_organization
Full name: snyk.snyk_get_org_apps

Parameter	Type	Required	Description
No parameters.

create_new_app_organization Write

Create a new Snyk App for an organization Official Snyk endpoint: POST /orgs/{org_id}/apps/creations Create a new Snyk App for an organization #### Required permissions - `Create Apps (org.app.create)`

Lua path: app.integrations.snyk.create_new_app_organization
Full name: snyk.snyk_create_org_app

Parameter	Type	Required	Description
No parameters.

delete_app_by_app_id Write

Delete a Snyk App by app ID Official Snyk endpoint: DELETE /orgs/{org_id}/apps/creations/{app_id} Delete a Snyk App by app ID #### Required permissions - `Delete Apps (org.app.delete)`

Lua path: app.integrations.snyk.delete_app_by_app_id
Full name: snyk.snyk_delete_app_by_id

Parameter	Type	Required	Description
No parameters.

get_app_by_app_id Read

Get a Snyk App by app ID Official Snyk endpoint: GET /orgs/{org_id}/apps/creations/{app_id} Get a Snyk App by app ID #### Required permissions - `View Apps (org.app.read)`

Lua path: app.integrations.snyk.get_app_by_app_id
Full name: snyk.snyk_get_app_by_id

Parameter	Type	Required	Description
No parameters.

update_app_creation_attributes_such_as_name_redirect_uris_and_access_token_time_live_using_app_id Write

Update app creation attributes such as name, redirect URIs, and access token time to live using the App ID Official Snyk endpoint: PATCH /orgs/{org_id}/apps/creations/{app_id} Update app creation attributes with App I...

Lua path: app.integrations.snyk.update_app_creation_attributes_such_as_name_redirect_uris_and_access_token_time_live_using_app_id
Full name: snyk.snyk_update_app_creation_by_id

Parameter	Type	Required	Description
No parameters.

manage_client_secret_app Write

Manage client secret for a Snyk App Official Snyk endpoint: POST /orgs/{org_id}/apps/creations/{app_id}/secrets Manage client secret for a Snyk App #### Required permissions - `Edit Apps (org.app.edit)`

Lua path: app.integrations.snyk.manage_client_secret_app
Full name: snyk.snyk_manage_app_creation_secret

Parameter	Type	Required	Description
No parameters.

get_list_apps_installed_organization Read

Get a list of Snyk Apps installed for an Organization Official Snyk endpoint: GET /orgs/{org_id}/apps/installs Get a list of Snyk Apps installed for an Organization #### Required permissions - `View Apps (org.app.read)`

Lua path: app.integrations.snyk.get_list_apps_installed_organization
Full name: snyk.snyk_get_app_installs_for_org

Parameter	Type	Required	Description
No parameters.

install_app_organization Write

Install a Snyk App for an Organization Official Snyk endpoint: POST /orgs/{org_id}/apps/installs Install a Snyk App to this organization, the Snyk App must use unattended authentication e.g. client credentials #### Re...

Lua path: app.integrations.snyk.install_app_organization
Full name: snyk.snyk_create_org_app_install

Parameter	Type	Required	Description
No parameters.

revoke_app_authorization_organization_with_install_id Write

Revoke app authorization for a Snyk organization with install ID Official Snyk endpoint: DELETE /orgs/{org_id}/apps/installs/{install_id} Revoke app authorization for a Snyk organization with install ID #### Required ...

Lua path: app.integrations.snyk.revoke_app_authorization_organization_with_install_id
Full name: snyk.snyk_delete_app_org_install_by_id

Parameter	Type	Required	Description
No parameters.

manage_client_secret_non_interactive_app_installations Write

Manage client secret for non-interactive Snyk App installations Official Snyk endpoint: POST /orgs/{org_id}/apps/installs/{install_id}/secrets Manage client secret for non-interactive Snyk App installations #### Requi...

Lua path: app.integrations.snyk.manage_client_secret_non_interactive_app_installations
Full name: snyk.snyk_update_org_app_install_secret

Parameter	Type	Required	Description
No parameters.

delete_app Write

Delete an app Official Snyk endpoint: DELETE /orgs/{org_id}/apps/{client_id} Delete an app by app id. Deprecated, use /orgs/{org_id}/apps/creations/{app_id} instead. #### Required permissions - `Delete Apps (org.app.d...

Lua path: app.integrations.snyk.delete_app
Full name: snyk.snyk_delete_app

Parameter	Type	Required	Description
No parameters.

get_app_by_client_id Read

Get an app by client id Official Snyk endpoint: GET /orgs/{org_id}/apps/{client_id} Get an App by client id. Deprecated, use /orgs/{org_id}/apps/creations/{app_id} instead. #### Required permissions - `View Apps (org....

Lua path: app.integrations.snyk.get_app_by_client_id
Full name: snyk.snyk_get_app

Parameter	Type	Required	Description
No parameters.

update_app_attributes_that_are_name_redirect_uris_and_access_token_time_live Write

Update app attributes that are name, redirect URIs, and access token time to live Official Snyk endpoint: PATCH /orgs/{org_id}/apps/{client_id} Update app attributes. Deprecated, use /orgs/{org_id}/apps/creations/{app...

Lua path: app.integrations.snyk.update_app_attributes_that_are_name_redirect_uris_and_access_token_time_live
Full name: snyk.snyk_update_app

Parameter	Type	Required	Description
No parameters.

manage_client_secrets_app Write

Manage client secrets for an app. Official Snyk endpoint: POST /orgs/{org_id}/apps/{client_id}/secrets Manage client secrets for an app. Deprecated, use /orgs/{org_id}/apps/creations/{app_id}/secrets instead. #### Req...

Lua path: app.integrations.snyk.manage_client_secrets_app
Full name: snyk.snyk_manage_secrets

Parameter	Type	Required	Description
No parameters.

bulk_remove_aliases_from_repository_assets_org_early_access Write

Bulk remove aliases from repository assets in org (Early Access) Official Snyk endpoint: DELETE /orgs/{org_id}/assets/repository/aliases Detach one or more aliased URLs from their canonical repository assets within an...

Lua path: app.integrations.snyk.bulk_remove_aliases_from_repository_assets_org_early_access
Full name: snyk.snyk_delete_aliases_in_org

Parameter	Type	Required	Description
No parameters.

list_repository_aliases_org_early_access Read

List repository aliases in org (Early Access) Official Snyk endpoint: GET /orgs/{org_id}/assets/repository/aliases Returns a paginated list of alias URL entries for repository assets within an organisation. Use the op...

Lua path: app.integrations.snyk.list_repository_aliases_org_early_access
Full name: snyk.snyk_list_repository_aliases_in_org

Parameter	Type	Required	Description
No parameters.

add_alias_repository_asset_org_early_access Write

Add alias for a repository asset in org (Early Access) Official Snyk endpoint: POST /orgs/{org_id}/assets/repository/aliases Link one or more alternate repository URLs to a canonical repository asset within an organis...

Lua path: app.integrations.snyk.add_alias_repository_asset_org_early_access
Full name: snyk.snyk_create_alias_in_org

Parameter	Type	Required	Description
No parameters.

search_organization_audit_logs Read

Search Organization audit logs. Official Snyk endpoint: GET /orgs/{org_id}/audit_logs/search Search audit logs for an Organization. "api.access" events are omitted from results unless explicitly requested using the ev...

Lua path: app.integrations.snyk.search_organization_audit_logs
Full name: snyk.snyk_list_org_audit_logs

Parameter	Type	Required	Description
No parameters.

list_broker_connections_given_organization Read

List Broker connections for a given organization Official Snyk endpoint: GET /orgs/{org_id}/brokers/connections List all Broker connections integrated with a given org #### Required permissions - `View Organization (o...

Lua path: app.integrations.snyk.list_broker_connections_given_organization
Full name: snyk.snyk_list_broker_connections_for_org

Parameter	Type	Required	Description
No parameters.

list_environments_early_access Read

List Environments (Early Access) Official Snyk endpoint: GET /orgs/{org_id}/cloud/environments List environments for an organization #### Required permissions - `View environments (org.cloud_environments.read)`

Lua path: app.integrations.snyk.list_environments_early_access
Full name: snyk.snyk_list_environments

Parameter	Type	Required	Description
No parameters.

create_new_environment_early_access Write

Create New Environment (Early Access) Official Snyk endpoint: POST /orgs/{org_id}/cloud/environments Create a new environment and run a scan #### Required permissions - `Create environments (org.cloud_environments.cre...

Lua path: app.integrations.snyk.create_new_environment_early_access
Full name: snyk.snyk_create_environment

Parameter	Type	Required	Description
No parameters.

delete_environment_early_access Write

Delete Environment (Early Access) Official Snyk endpoint: DELETE /orgs/{org_id}/cloud/environments/{environment_id} Delete an environment #### Required permissions - `Delete environments (org.cloud_environments.delete)`

Lua path: app.integrations.snyk.delete_environment_early_access
Full name: snyk.snyk_delete_environment

Parameter	Type	Required	Description
No parameters.

update_environment_early_access Write

Update Environment (Early Access) Official Snyk endpoint: PATCH /orgs/{org_id}/cloud/environments/{environment_id} Update an environment #### Required permissions - `Update environments (org.cloud_environments.edit)`

Lua path: app.integrations.snyk.update_environment_early_access
Full name: snyk.snyk_update_environment

Parameter	Type	Required	Description
No parameters.

generate_cloud_provider_permissions_early_access Write

Generate Cloud Provider Permissions (Early Access) Official Snyk endpoint: POST /orgs/{org_id}/cloud/permissions Generate IAC template for Snyk to access your cloud resources #### Required permissions - `Create enviro...

Lua path: app.integrations.snyk.generate_cloud_provider_permissions_early_access
Full name: snyk.snyk_get_permissions

Parameter	Type	Required	Description
No parameters.

list_resources_early_access Read

List Resources (Early Access) Official Snyk endpoint: GET /orgs/{org_id}/cloud/resources List resources for an organization #### Required permissions - `View resources (org.cloud_resources.read)`

Lua path: app.integrations.snyk.list_resources_early_access
Full name: snyk.snyk_list_resources

Parameter	Type	Required	Description
No parameters.

list_scans_early_access Read

List Scans (Early Access) Official Snyk endpoint: GET /orgs/{org_id}/cloud/scans List scans for an organization #### Required permissions - `View scans (org.cloud_scans.read)`

Lua path: app.integrations.snyk.list_scans_early_access
Full name: snyk.snyk_list_scan

Parameter	Type	Required	Description
No parameters.

create_scan_early_access Write

Create Scan (Early Access) Official Snyk endpoint: POST /orgs/{org_id}/cloud/scans Create and trigger a new scan for an environment #### Required permissions - `Create scans (org.cloud_scans.create)`

Lua path: app.integrations.snyk.create_scan_early_access
Full name: snyk.snyk_create_scan

Parameter	Type	Required	Description
No parameters.

get_scan_early_access Read

Get scan (Early Access) Official Snyk endpoint: GET /orgs/{org_id}/cloud/scans/{scan_id} Get a single scan for an organization #### Required permissions - `View scans (org.cloud_scans.read)`

Lua path: app.integrations.snyk.get_scan_early_access
Full name: snyk.snyk_get_scan

Parameter	Type	Required	Description
No parameters.

get_collections Read

Get collections Official Snyk endpoint: GET /orgs/{org_id}/collections Return a list of organization's collections with issues counts and projects count. #### Required permissions - `View Collections (org.collection.r...

Lua path: app.integrations.snyk.get_collections
Full name: snyk.snyk_get_collections

Parameter	Type	Required	Description
No parameters.

create_collection Write

Create a collection Official Snyk endpoint: POST /orgs/{org_id}/collections Create a collection #### Required permissions - `Create Collections (org.collection.create)`

Lua path: app.integrations.snyk.create_collection
Full name: snyk.snyk_create_collection

Parameter	Type	Required	Description
No parameters.

delete_collection Write

Delete a collection Official Snyk endpoint: DELETE /orgs/{org_id}/collections/{collection_id} Delete a collection #### Required permissions - `Delete Collections (org.collection.delete)`

Lua path: app.integrations.snyk.delete_collection
Full name: snyk.snyk_delete_collection

Parameter	Type	Required	Description
No parameters.

get_collection Read

Get a collection Official Snyk endpoint: GET /orgs/{org_id}/collections/{collection_id} Get a collection #### Required permissions - `View Collections (org.collection.read)`

Lua path: app.integrations.snyk.get_collection
Full name: snyk.snyk_get_collection

Parameter	Type	Required	Description
No parameters.

edit_collection Write

Edit a collection Official Snyk endpoint: PATCH /orgs/{org_id}/collections/{collection_id} Edit a collection #### Required permissions - `Edit Collections (org.collection.edit)`

Lua path: app.integrations.snyk.edit_collection
Full name: snyk.snyk_update_collection

Parameter	Type	Required	Description
No parameters.

remove_projects_from_collection Write

Remove projects from a collection Official Snyk endpoint: DELETE /orgs/{org_id}/collections/{collection_id}/relationships/projects Remove projects from a collection by specifying an array of project ids #### Required ...

Lua path: app.integrations.snyk.remove_projects_from_collection
Full name: snyk.snyk_delete_projects_collection

Parameter	Type	Required	Description
No parameters.

get_projects_from_specified_collection Read

Get projects from the specified collection Official Snyk endpoint: GET /orgs/{org_id}/collections/{collection_id}/relationships/projects Return a list of organization's projects that are from the specified collection....

Lua path: app.integrations.snyk.get_projects_from_specified_collection
Full name: snyk.snyk_get_projects_of_collection

Parameter	Type	Required	Description
No parameters.

add_projects_collection Write

Add projects to a collection Official Snyk endpoint: POST /orgs/{org_id}/collections/{collection_id}/relationships/projects Add projects to a collection by specifying an array of project ids #### Required permissions ...

Lua path: app.integrations.snyk.add_projects_collection
Full name: snyk.snyk_update_collection_with_projects

Parameter	Type	Required	Description
No parameters.

list_instances_container_image Read

List instances of container image Official Snyk endpoint: GET /orgs/{org_id}/container_images List instances of container image #### Required permissions - `View container images (org.container_image.read)`

Lua path: app.integrations.snyk.list_instances_container_image
Full name: snyk.snyk_list_container_image

Parameter	Type	Required	Description
No parameters.

get_instance_container_image Read

Get instance of container image Official Snyk endpoint: GET /orgs/{org_id}/container_images/{image_id} Get instance of container image #### Required permissions - `View container images (org.container_image.read)`

Lua path: app.integrations.snyk.get_instance_container_image
Full name: snyk.snyk_get_container_image

Parameter	Type	Required	Description
No parameters.

list_instances_image_target_references_container_image Read

List instances of image target references for a container image Official Snyk endpoint: GET /orgs/{org_id}/container_images/{image_id}/relationships/image_target_refs List instances of image target references for a co...

Lua path: app.integrations.snyk.list_instances_image_target_references_container_image
Full name: snyk.snyk_list_image_target_refs

Parameter	Type	Required	Description
No parameters.

delete_container_registry_import_policy Write

Delete a container registry import policy Official Snyk endpoint: DELETE /orgs/{org_id}/container_import/{integration_id}/policy Delete a container registry import policy #### Required permissions - `Edit integrations...

Lua path: app.integrations.snyk.delete_container_registry_import_policy
Full name: snyk.snyk_delete_container_registry_import_policy

Parameter	Type	Required	Description
No parameters.

get_container_registry_import_policy Read

Get a container registry import policy Official Snyk endpoint: GET /orgs/{org_id}/container_import/{integration_id}/policy Get a container registry import policy #### Required permissions - `View integrations (org.int...

Lua path: app.integrations.snyk.get_container_registry_import_policy
Full name: snyk.snyk_get_container_registry_import_policy

Parameter	Type	Required	Description
No parameters.

update_container_registry_import_policy Write

Update a container registry import policy Official Snyk endpoint: PATCH /orgs/{org_id}/container_import/{integration_id}/policy Update a container registry import policy #### Required permissions - `Edit integrations ...

Lua path: app.integrations.snyk.update_container_registry_import_policy
Full name: snyk.snyk_update_container_registry_import_policy

Parameter	Type	Required	Description
No parameters.

create_container_registry_import_policy Write

Create a container registry import policy Official Snyk endpoint: POST /orgs/{org_id}/container_import/{integration_id}/policy Create a container registry import policy #### Required permissions - `Edit integrations (...

Lua path: app.integrations.snyk.create_container_registry_import_policy
Full name: snyk.snyk_create_container_registry_import_policy

Parameter	Type	Required	Description
No parameters.

create_dry_run_job_container_registry_import_policy Write

Create a dry run job for a container registry import policy Official Snyk endpoint: POST /orgs/{org_id}/container_import/{integration_id}/policy/dry_run Creates an asynchronous dry run job to test a container registry...

Lua path: app.integrations.snyk.create_dry_run_job_container_registry_import_policy
Full name: snyk.snyk_create_container_registry_import_policy_dry_run

Parameter	Type	Required	Description
No parameters.

get_dry_run_job Read

Get a dry run job Official Snyk endpoint: GET /orgs/{org_id}/container_import/{integration_id}/policy/dry_run/{job_id} Retrieves the status and results of a dry run job #### Required permissions - `Edit integrations (...

Lua path: app.integrations.snyk.get_dry_run_job
Full name: snyk.snyk_get_dry_run_job

Parameter	Type	Required	Description
No parameters.

get_package_early_access Read

Get a package (Early Access) Official Snyk endpoint: GET /orgs/{org_id}/ecosystems/{ecosystem}/packages/{package_name} Get package metadata for a specific package from an ecosystem. **Important:** The security section...

Lua path: app.integrations.snyk.get_package_early_access
Full name: snyk.snyk_get_package

Parameter	Type	Required	Description
No parameters.

get_package_version_early_access Read

Get a package version (Early Access) Official Snyk endpoint: GET /orgs/{org_id}/ecosystems/{ecosystem}/packages/{package_name}/versions/{package_version} Get package version metadata for a specific version of a packag...

Lua path: app.integrations.snyk.get_package_version_early_access
Full name: snyk.snyk_get_package_version

Parameter	Type	Required	Description
No parameters.

start_export Write

Start an export Official Snyk endpoint: POST /orgs/{org_id}/export Create and start an export for an org #### Required permissions - `View Organization reports (org.report.read)`

Lua path: app.integrations.snyk.start_export
Full name: snyk.snyk_create_export

Parameter	Type	Required	Description
No parameters.

get_export_results Read

Get export results Official Snyk endpoint: GET /orgs/{org_id}/export/{export_id} Get an export results #### Required permissions - `View Organization reports (org.report.read)`

Lua path: app.integrations.snyk.get_export_results
Full name: snyk.snyk_get_export

Parameter	Type	Required	Description
No parameters.

list_all_integrations_organization_early_access Read

List all integrations for an organization (Early Access) Official Snyk endpoint: GET /orgs/{org_id}/integrations Get all integrations for an organization with cursor-based pagination #### Required permissions - `View ...

Lua path: app.integrations.snyk.list_all_integrations_organization_early_access
Full name: snyk.snyk_list_integrations

Parameter	Type	Required	Description
No parameters.

create_integration_organization_early_access Write

Create an integration for an organization (Early Access) Official Snyk endpoint: POST /orgs/{org_id}/integrations Create a new integration with specified credentials and profile name #### Required permissions - `Edit ...

Lua path: app.integrations.snyk.create_integration_organization_early_access
Full name: snyk.snyk_create_integration

Parameter	Type	Required	Description
No parameters.

delete_integration_early_access Write

Delete an integration (Early Access) Official Snyk endpoint: DELETE /orgs/{org_id}/integrations/{integration_id} Permanently delete a container registry integration from an organization. Brokered integrations must hav...

Lua path: app.integrations.snyk.delete_integration_early_access
Full name: snyk.snyk_delete_integration

Parameter	Type	Required	Description
No parameters.

get_specific_integration_early_access Read

Get a specific integration (Early Access) Official Snyk endpoint: GET /orgs/{org_id}/integrations/{integration_id} Retrieve details for a single integration by its ID #### Required permissions - `View integrations (or...

Lua path: app.integrations.snyk.get_specific_integration_early_access
Full name: snyk.snyk_get_integration

Parameter	Type	Required	Description
No parameters.

update_existing_integration_early_access Write

Update an existing integration (Early Access) Official Snyk endpoint: PATCH /orgs/{org_id}/integrations/{integration_id} Update attributes of an integration. Supports partial updates - only provided fields will be mod...

Lua path: app.integrations.snyk.update_existing_integration_early_access
Full name: snyk.snyk_update_integration

Parameter	Type	Required	Description
No parameters.

get_integration_settings_early_access Read

Get integration settings (Early Access) Official Snyk endpoint: GET /orgs/{org_id}/integrations/{integration_id}/settings Get the settings for a specific integration. #### Required permissions - `View integrations (or...

Lua path: app.integrations.snyk.get_integration_settings_early_access
Full name: snyk.snyk_get_integration_settings

Parameter	Type	Required	Description
No parameters.

update_integration_settings_early_access Write

Update integration settings (Early Access) Official Snyk endpoint: PATCH /orgs/{org_id}/integrations/{integration_id}/settings Update the settings for a specific integration. Supports partial updates. **Updateable fie...

Lua path: app.integrations.snyk.update_integration_settings_early_access
Full name: snyk.snyk_update_integration_settings

Parameter	Type	Required	Description
No parameters.

list_or_search_all_assets_synchronous_org_scope_early_access Read

List or search all assets (synchronous) - Org scope (Early Access) Official Snyk endpoint: GET /orgs/{org_id}/inventory/assets Retrieves a polymorphic list of all asset types for a given organization. The group and te...

Lua path: app.integrations.snyk.list_or_search_all_assets_synchronous_org_scope_early_access
Full name: snyk.snyk_list_assets_org

Parameter	Type	Required	Description
No parameters.

bulk_update_asset_attributes_org_scope_early_access Write

Bulk update asset attributes - Org scope (Early Access) Official Snyk endpoint: PATCH /orgs/{org_id}/inventory/assets Partially updates multiple assets within an org context. Maximum of 100 assets can be updated per r...

Lua path: app.integrations.snyk.bulk_update_asset_attributes_org_scope_early_access
Full name: snyk.snyk_update_assets_bulk_org

Parameter	Type	Required	Description
No parameters.

get_available_filter_fields_org_scope_early_access Read

Get available filter fields - Org scope (Early Access) Official Snyk endpoint: GET /orgs/{org_id}/inventory/assets/filters Returns a list of valid field names that can be used for filtering assets using RSQL. Each fie...

Lua path: app.integrations.snyk.get_available_filter_fields_org_scope_early_access
Full name: snyk.snyk_get_filter_fields_org

Parameter	Type	Required	Description
No parameters.

get_filter_value_suggestions_autocomplete_org_scope_early_access Read

Get filter value suggestions (autocomplete) - Org scope (Early Access) Official Snyk endpoint: GET /orgs/{org_id}/inventory/assets/filters/{filter_id}/values Returns a list of distinct values for a specific filter fie...

Lua path: app.integrations.snyk.get_filter_value_suggestions_autocomplete_org_scope_early_access
Full name: snyk.snyk_get_filter_values_org

Parameter	Type	Required	Description
No parameters.

get_available_group_fields_org_scope_early_access Read

Get available group fields - Org scope (Early Access) Official Snyk endpoint: GET /orgs/{org_id}/inventory/assets/groups Returns a list of valid group field names that can be used for grouping assets within an org con...

Lua path: app.integrations.snyk.get_available_group_fields_org_scope_early_access
Full name: snyk.snyk_get_group_fields_org

Parameter	Type	Required	Description
No parameters.

get_group_value_aggregation_org_scope_early_access Read

Get group value aggregation - Org scope (Early Access) Official Snyk endpoint: GET /orgs/{org_id}/inventory/assets/groups/{group_field_id}/values Returns aggregated values for a specific group field id, showing the co...

Lua path: app.integrations.snyk.get_group_value_aggregation_org_scope_early_access
Full name: snyk.snyk_get_group_values_org

Parameter	Type	Required	Description
No parameters.

create_asset_search_asynchronous_org_scope_early_access Write

Create an asset search (asynchronous) - Org scope (Early Access) Official Snyk endpoint: POST /orgs/{org_id}/inventory/assets/searches Initiates an asynchronous search for assets within an org context. #### Required p...

Lua path: app.integrations.snyk.create_asset_search_asynchronous_org_scope_early_access
Full name: snyk.snyk_create_asset_search_org

Parameter	Type	Required	Description
No parameters.

retrieve_asset_search_results_asynchronous_org_scope_early_access Read

Retrieve asset search results (asynchronous) - Org scope (Early Access) Official Snyk endpoint: GET /orgs/{org_id}/inventory/assets/searches/{search_id}/results Gets paginated results for a previously initiated asset ...

Lua path: app.integrations.snyk.retrieve_asset_search_results_asynchronous_org_scope_early_access
Full name: snyk.snyk_get_asset_search_results_org

Parameter	Type	Required	Description
No parameters.

get_single_asset_by_id_org_scope_early_access Read

Get a single asset by ID - Org scope (Early Access) Official Snyk endpoint: GET /orgs/{org_id}/inventory/assets/{asset_id} Retrieves a single asset by its unique identifier within an org context. #### Required permiss...

Lua path: app.integrations.snyk.get_single_asset_by_id_org_scope_early_access
Full name: snyk.snyk_get_asset_org

Parameter	Type	Required	Description
No parameters.

update_asset_attributes_org_scope_early_access Write

Update asset attributes - Org scope (Early Access) Official Snyk endpoint: PATCH /orgs/{org_id}/inventory/assets/{asset_id} Partially updates an asset's attributes within an org context. Supports updating class, label...

Lua path: app.integrations.snyk.update_asset_attributes_org_scope_early_access
Full name: snyk.snyk_update_asset_org

Parameter	Type	Required	Description
No parameters.

list_projects_asset_org_scope_early_access Read

List projects for an asset (org scope) (Early Access) Official Snyk endpoint: GET /orgs/{org_id}/inventory/assets/{asset_id}/relationships/projects Retrieves a paginated list of Snyk projects linked to this asset with...

Lua path: app.integrations.snyk.list_projects_asset_org_scope_early_access
Full name: snyk.snyk_list_asset_projects_org

Parameter	Type	Required	Description
No parameters.

list_targets_asset_org_scope_early_access Read

List targets for an asset (org scope) (Early Access) Official Snyk endpoint: GET /orgs/{org_id}/inventory/assets/{asset_id}/relationships/targets Retrieves a paginated list of Snyk targets linked to this asset with fu...

Lua path: app.integrations.snyk.list_targets_asset_org_scope_early_access
Full name: snyk.snyk_list_asset_targets_org

Parameter	Type	Required	Description
No parameters.

list_pending_user_invitations_organization Read

List pending user invitations to an organization. Official Snyk endpoint: GET /orgs/{org_id}/invites List pending user invitations to an organization. #### Required permissions - `View Organization (org.read)` - `View...

Lua path: app.integrations.snyk.list_pending_user_invitations_organization
Full name: snyk.snyk_list_org_invitation

Parameter	Type	Required	Description
No parameters.

invite_user_organization Write

Invite a user to an organization Official Snyk endpoint: POST /orgs/{org_id}/invites Invite a user to an organization with a role. #### Required permissions - `Invite users (org.user.invite)`

Lua path: app.integrations.snyk.invite_user_organization
Full name: snyk.snyk_create_org_invitation

Parameter	Type	Required	Description
No parameters.

cancel_pending_user_invitations_organization Write

Cancel a pending user invitations to an organization. Official Snyk endpoint: DELETE /orgs/{org_id}/invites/{invite_id} Cancel a pending user invitations to an organization. #### Required permissions - `Invite users (...

Lua path: app.integrations.snyk.cancel_pending_user_invitations_organization
Full name: snyk.snyk_delete_org_invitation

Parameter	Type	Required	Description
No parameters.

get_issues_by_org_id Read

Get issues by org ID Official Snyk endpoint: GET /orgs/{org_id}/issues Get a list of an organization's issues. #### Required permissions - `View Organization (org.read)` - `View Projects (org.project.read)` - `View Pr...

Lua path: app.integrations.snyk.get_issues_by_org_id
Full name: snyk.snyk_list_org_issues

Parameter	Type	Required	Description
No parameters.

get_issue Read

Get an issue Official Snyk endpoint: GET /orgs/{org_id}/issues/{issue_id} Get an issue #### Required permissions - `View Organization (org.read)` - `View Projects (org.project.read)` - `View Project history (org.proje...

Lua path: app.integrations.snyk.get_issue
Full name: snyk.snyk_get_org_issue_by_issue_id

Parameter	Type	Required	Description
No parameters.

get_export_status Read

Get export status Official Snyk endpoint: GET /orgs/{org_id}/jobs/export/{export_id} Get an export job status #### Required permissions - `View Organization reports (org.report.read)`

Lua path: app.integrations.snyk.get_export_status
Full name: snyk.snyk_get_export_job_status

Parameter	Type	Required	Description
No parameters.

bulk_deletion_assignments_organization_early_access Write

Bulk deletion of assignments in an organization (Early Access) Official Snyk endpoint: DELETE /orgs/{org_id}/learn/assignments Allows an admin to delete multiple assignments within their organization. **Note**: Assign...

Lua path: app.integrations.snyk.bulk_deletion_assignments_organization_early_access
Full name: snyk.snyk_delete_org_assignments

Parameter	Type	Required	Description
No parameters.

retrieve_list_assignments_organization_early_access Read

Retrieve a list of assignments for an organization (Early Access) Official Snyk endpoint: GET /orgs/{org_id}/learn/assignments Allows an admin to obtain a comprehensive list of all assignments within their organizatio...

Lua path: app.integrations.snyk.retrieve_list_assignments_organization_early_access
Full name: snyk.snyk_list_org_assignments

Parameter	Type	Required	Description
No parameters.

update_due_date_assignments_organization_early_access Write

Update due date for assignments in an organization. (Early Access) Official Snyk endpoint: PATCH /orgs/{org_id}/learn/assignments Allows an admin to update the due date for existing assignments within their organizati...

Lua path: app.integrations.snyk.update_due_date_assignments_organization_early_access
Full name: snyk.snyk_update_org_assignments

Parameter	Type	Required	Description
No parameters.

bulk_creation_assignments_users_organization_early_access Write

Bulk creation of assignments for users in an organization. (Early Access) Official Snyk endpoint: POST /orgs/{org_id}/learn/assignments Allows an admin to create assignments in bulk for all or a subset of users within...

Lua path: app.integrations.snyk.bulk_creation_assignments_users_organization_early_access
Full name: snyk.snyk_create_org_assignments

Parameter	Type	Required	Description
No parameters.

bulk_deletion_assignments_organization_early_access Write

Bulk deletion of assignments in an organization (Early Access) Official Snyk endpoint: POST /orgs/{org_id}/learn/assignments/bulk_delete Allows an admin to delete multiple assignments within their organization. **Note...

Lua path: app.integrations.snyk.bulk_deletion_assignments_organization_early_access
Full name: snyk.snyk_delete_org_assignments_bulk

Parameter	Type	Required	Description
No parameters.

get_collective_learning_progress_early_access Read

Get collective learning progress (Early Access) Official Snyk endpoint: GET /orgs/{org_id}/learn/progress/catalog Retrieves aggregated counts of users' lesson or learning path statuses (completed, in progress, todo) a...

Lua path: app.integrations.snyk.get_collective_learning_progress_early_access
Full name: snyk.snyk_get_catalog_progress

Parameter	Type	Required	Description
No parameters.

get_individual_user_learning_progress_early_access Read

Get individual user learning progress (Early Access) Official Snyk endpoint: GET /orgs/{org_id}/learn/progress/users Retrieves detailed learning progress status per user, including completion dates and history for eac...

Lua path: app.integrations.snyk.get_individual_user_learning_progress_early_access
Full name: snyk.snyk_get_users_progress

Parameter	Type	Required	Description
No parameters.

get_all_memberships_org Read

Get all memberships of the org Official Snyk endpoint: GET /orgs/{org_id}/memberships Returns all memberships of the org #### Required permissions - `View Organization Memberships (org.membership.read)`

Lua path: app.integrations.snyk.get_all_memberships_org
Full name: snyk.snyk_list_org_memberships

Parameter	Type	Required	Description
No parameters.

create_org_membership_user_with_role Write

Create a org membership for a user with role Official Snyk endpoint: POST /orgs/{org_id}/memberships Create a org membership for a user with role #### Required permissions - `Add Organization Memberships (org.membersh...

Lua path: app.integrations.snyk.create_org_membership_user_with_role
Full name: snyk.snyk_create_org_membership

Parameter	Type	Required	Description
No parameters.

remove_user_org_membership Write

Remove user's org membership Official Snyk endpoint: DELETE /orgs/{org_id}/memberships/{membership_id} Remove a user's membership of the group. #### Required permissions - `Delete Organization Memberships (org.members...

Lua path: app.integrations.snyk.remove_user_org_membership
Full name: snyk.snyk_delete_org_membership

Parameter	Type	Required	Description
No parameters.

update_org_membership_user_with_role Write

Update a org membership for a user with role Official Snyk endpoint: PATCH /orgs/{org_id}/memberships/{membership_id} Update a org membership for a user with role #### Required permissions - `Edit Organization Members...

Lua path: app.integrations.snyk.update_org_membership_user_with_role
Full name: snyk.snyk_update_org_membership

Parameter	Type	Required	Description
No parameters.

list_issues_given_set_packages_currently_not_available_all_customers Write

List issues for a given set of packages (Currently not available to all customers) Official Snyk endpoint: POST /orgs/{org_id}/packages/issues This endpoint is currently restricted and is not available to all customer...

Lua path: app.integrations.snyk.list_issues_given_set_packages_currently_not_available_all_customers
Full name: snyk.snyk_list_issues_for_many_purls

Parameter	Type	Required	Description
No parameters.

list_issues_package Read

List issues for a package Official Snyk endpoint: GET /orgs/{org_id}/packages/{purl}/issues Query issues for a specific package version identified by Package URL (purl). Snyk returns only direct vulnerabilities. Trans...

Lua path: app.integrations.snyk.list_issues_package
Full name: snyk.snyk_get_issues_per_purl

Parameter	Type	Required	Description
No parameters.

get_org_level_policies Read

Get org-level policies Official Snyk endpoint: GET /orgs/{org_id}/policies Get all policies for the requested organisation. *Org level Policy APIs Access Notice:* Org level Policy APIs are only available for use with ...

Lua path: app.integrations.snyk.get_org_level_policies
Full name: snyk.snyk_get_org_policies

Parameter	Type	Required	Description
No parameters.

create_new_org_level_policy Write

Create a new org-level policy Official Snyk endpoint: POST /orgs/{org_id}/policies Create a new org-level policy. *Org level Policy APIs Access Notice:* Org level Policy APIs are only available for use with Code Consi...

Lua path: app.integrations.snyk.create_new_org_level_policy
Full name: snyk.snyk_create_org_policy

Parameter	Type	Required	Description
No parameters.

delete_org_level_policy Write

Delete an org-level policy Official Snyk endpoint: DELETE /orgs/{org_id}/policies/{policy_id} Delete an existing org-level policy. *Org level Policy APIs Access Notice:* Org level Policy APIs are only available for us...

Lua path: app.integrations.snyk.delete_org_level_policy
Full name: snyk.snyk_delete_org_policy

Parameter	Type	Required	Description
No parameters.

get_org_level_policy Read

Get an org-level policy Official Snyk endpoint: GET /orgs/{org_id}/policies/{policy_id} Get a specific org-level policy based on its ID. *Org level Policy APIs Access Notice:* Org level Policy APIs are only available ...

Lua path: app.integrations.snyk.get_org_level_policy
Full name: snyk.snyk_get_org_policy

Parameter	Type	Required	Description
No parameters.

update_org_level_policy Write

Update an org-level policy Official Snyk endpoint: PATCH /orgs/{org_id}/policies/{policy_id} Update the org-level policy. *Org level Policy APIs Access Notice:* Org level Policy APIs are only available for use with Co...

Lua path: app.integrations.snyk.update_org_level_policy
Full name: snyk.snyk_update_org_policy

Parameter	Type	Required	Description
No parameters.

list_org_policy_events_early_access Read

List org policy events (Early Access) Official Snyk endpoint: GET /orgs/{org_id}/policies/{policy_id}/events Retrieve the event history for the given policy. *Org level Policy APIs Access Notice:* Access to our Org le...

Lua path: app.integrations.snyk.list_org_policy_events_early_access
Full name: snyk.snyk_get_org_policy_events

Parameter	Type	Required	Description
No parameters.

list_all_projects_org_with_given_org_id Read

List all Projects for an Org with the given Org ID. Official Snyk endpoint: GET /orgs/{org_id}/projects List all Projects for an Org. #### Required permissions - `View Projects (org.project.read)`

Lua path: app.integrations.snyk.list_all_projects_org_with_given_org_id
Full name: snyk.snyk_list_org_projects

Parameter	Type	Required	Description
No parameters.

delete_project_by_project_id Write

Delete project by project ID. Official Snyk endpoint: DELETE /orgs/{org_id}/projects/{project_id} Delete one project in the organization by project ID. #### Required permissions - `View Organization (org.read)` - `Vie...

Lua path: app.integrations.snyk.delete_project_by_project_id
Full name: snyk.snyk_delete_org_project

Parameter	Type	Required	Description
No parameters.

get_project_by_project_id Read

Get project by project ID. Official Snyk endpoint: GET /orgs/{org_id}/projects/{project_id} Get one project of the organization by project ID. #### Required permissions - `View Projects (org.project.read)`

Lua path: app.integrations.snyk.get_project_by_project_id
Full name: snyk.snyk_get_org_project

Parameter	Type	Required	Description
No parameters.

updates_project_by_project_id Write

Updates project by project ID. Official Snyk endpoint: PATCH /orgs/{org_id}/projects/{project_id} Updates one project of the organization by project ID. #### Required permissions - `View Organization (org.read)` - `Vi...

Lua path: app.integrations.snyk.updates_project_by_project_id
Full name: snyk.snyk_update_org_project

Parameter	Type	Required	Description
No parameters.

get_project_sbom_document Read

Get a project's SBOM document Official Snyk endpoint: GET /orgs/{org_id}/projects/{project_id}/sbom This endpoint lets you retrieve the SBOM document of a software project. It supports the following formats: * Cyclone...

Lua path: app.integrations.snyk.get_project_sbom_document
Full name: snyk.snyk_get_sbom

Parameter	Type	Required	Description
No parameters.

create_sbom_test_run_early_access Write

Create an SBOM test run (Early Access) Official Snyk endpoint: POST /orgs/{org_id}/sbom_tests Create an SBOM test run by supplying an SBOM document. The components contained in the given document will get analyzed for...

Lua path: app.integrations.snyk.create_sbom_test_run_early_access
Full name: snyk.snyk_create_sbom_test_run

Parameter	Type	Required	Description
No parameters.

gets_sbom_test_run_status_early_access Read

Gets an SBOM test run status (Early Access) Official Snyk endpoint: GET /orgs/{org_id}/sbom_tests/{job_id} Get an SBOM test run status #### Required permissions - `Test Projects (org.project.test)`

Lua path: app.integrations.snyk.gets_sbom_test_run_status_early_access
Full name: snyk.snyk_get_sbom_test_status

Parameter	Type	Required	Description
No parameters.

gets_sbom_test_run_result_early_access Read

Gets an SBOM test run result (Early Access) Official Snyk endpoint: GET /orgs/{org_id}/sbom_tests/{job_id}/results Get an SBOM test run result #### Required permissions - `Test Projects (org.project.test)`

Lua path: app.integrations.snyk.gets_sbom_test_run_result_early_access
Full name: snyk.snyk_get_sbom_test_result

Parameter	Type	Required	Description
No parameters.

get_list_organization_service_accounts Read

Get a list of organization service accounts. Official Snyk endpoint: GET /orgs/{org_id}/service_accounts Get all service accounts for an organization. #### Required permissions - `View service accounts (org.service_ac...

Lua path: app.integrations.snyk.get_list_organization_service_accounts
Full name: snyk.snyk_get_many_org_service_accounts

Parameter	Type	Required	Description
No parameters.

create_service_account_organization Write

Create a service account for an organization. Official Snyk endpoint: POST /orgs/{org_id}/service_accounts Create a service account for an organization. The service account can be used to access the Snyk API. #### Req...

Lua path: app.integrations.snyk.create_service_account_organization
Full name: snyk.snyk_create_org_service_account

Parameter	Type	Required	Description
No parameters.

delete_service_account_organization Write

Delete a service account in an organization. Official Snyk endpoint: DELETE /orgs/{org_id}/service_accounts/{serviceaccount_id} Delete a service account in an organization. #### Required permissions - `Remove service ...

Lua path: app.integrations.snyk.delete_service_account_organization
Full name: snyk.snyk_delete_service_account

Parameter	Type	Required	Description
No parameters.

get_organization_service_account Read

Get an organization service account. Official Snyk endpoint: GET /orgs/{org_id}/service_accounts/{serviceaccount_id} Get an organization-level service account by its ID. #### Required permissions - `View service accou...

Lua path: app.integrations.snyk.get_organization_service_account
Full name: snyk.snyk_get_one_org_service_account

Parameter	Type	Required	Description
No parameters.

update_organization_service_account Write

Update an organization service account. Official Snyk endpoint: PATCH /orgs/{org_id}/service_accounts/{serviceaccount_id} Update the name of an organization-level service account by its ID. #### Required permissions -...

Lua path: app.integrations.snyk.update_organization_service_account
Full name: snyk.snyk_update_org_service_account

Parameter	Type	Required	Description
No parameters.

manage_organization_service_account_client_secret Write

Manage an organization service account's client secret. Official Snyk endpoint: POST /orgs/{org_id}/service_accounts/{serviceaccount_id}/secrets Manage the client secret of an organization service account by the servi...

Lua path: app.integrations.snyk.manage_organization_service_account_client_secret
Full name: snyk.snyk_update_org_service_account_secret

Parameter	Type	Required	Description
No parameters.

get_infrastructure_as_code_settings_org Read

Get the Infrastructure as Code Settings for an org. Official Snyk endpoint: GET /orgs/{org_id}/settings/iac Get the Infrastructure as Code Settings for an org. #### Required permissions - `View Organization (org.read)`

Lua path: app.integrations.snyk.get_infrastructure_as_code_settings_org
Full name: snyk.snyk_get_iac_settings_for_org

Parameter	Type	Required	Description
No parameters.

update_infrastructure_as_code_settings_org Write

Update the Infrastructure as Code Settings for an org Official Snyk endpoint: PATCH /orgs/{org_id}/settings/iac Update the Infrastructure as Code Settings for an org. #### Required permissions - `Edit Organization (or...

Lua path: app.integrations.snyk.update_infrastructure_as_code_settings_org
Full name: snyk.snyk_update_iac_settings_for_org

Parameter	Type	Required	Description
No parameters.

get_language_settings_organization_early_access Read

Get language settings for an organization (Early Access) Official Snyk endpoint: GET /orgs/{org_id}/settings/open_source/languages Retrieves the language settings for a specific organization. #### Required permissions...

Lua path: app.integrations.snyk.get_language_settings_organization_early_access
Full name: snyk.snyk_get_org_languages_settings

Parameter	Type	Required	Description
No parameters.

update_language_settings_organization_early_access Write

Update language settings for an organization (Early Access) Official Snyk endpoint: PATCH /orgs/{org_id}/settings/open_source/languages/{language} Updates one or more language settings for a specific organization. ###...

Lua path: app.integrations.snyk.update_language_settings_organization_early_access
Full name: snyk.snyk_update_org_languages_settings

Parameter	Type	Required	Description
No parameters.

get_open_source_settings_org_early_access Read

Get the Open Source Settings for an Org. (Early Access) Official Snyk endpoint: GET /orgs/{org_id}/settings/opensource Returns settings for your Org which may also be controlled at the Group level. #### Required permi...

Lua path: app.integrations.snyk.get_open_source_settings_org_early_access
Full name: snyk.snyk_get_open_source_settings_for_org

Parameter	Type	Required	Description
No parameters.

delete_opensource_broker_setting_organization Write

Delete opensource broker setting for organization Official Snyk endpoint: DELETE /orgs/{org_id}/settings/opensource/broker Deletes the opensource broker setting for the organization by uninstalling the Snyk App #### R...

Lua path: app.integrations.snyk.delete_opensource_broker_setting_organization
Full name: snyk.snyk_delete_opensource_broker_setting_for_org

Parameter	Type	Required	Description
No parameters.

get_opensource_broker_setting_organization Read

Get opensource broker setting for organization Official Snyk endpoint: GET /orgs/{org_id}/settings/opensource/broker Returns whether the opensource broker setting is enabled for the organization #### Required permissi...

Lua path: app.integrations.snyk.get_opensource_broker_setting_organization
Full name: snyk.snyk_get_opensource_broker_setting

Parameter	Type	Required	Description
No parameters.

enable_opensource_broker_organization Write

Enable opensource broker for organization Official Snyk endpoint: POST /orgs/{org_id}/settings/opensource/broker Enables the opensource broker setting for an organization by installing the Snyk App #### Required permi...

Lua path: app.integrations.snyk.enable_opensource_broker_organization
Full name: snyk.snyk_enable_opensource_broker_for_org

Parameter	Type	Required	Description
No parameters.

get_opensource_broker_settings_ecosystem_organization Read

Get opensource broker settings of ecosystem for organization Official Snyk endpoint: GET /orgs/{org_id}/settings/opensource/{ecosystem}/broker Retrieves all Broker settings of a specific Open Source Ecosystem for an O...

Lua path: app.integrations.snyk.get_opensource_broker_settings_ecosystem_organization
Full name: snyk.snyk_get_opensource_broker_ecosystem_settings_for_org

Parameter	Type	Required	Description
No parameters.

update_opensource_broker_settings_ecosystem_organization Write

Update opensource broker settings of ecosystem for organization Official Snyk endpoint: PATCH /orgs/{org_id}/settings/opensource/{ecosystem}/broker Updates all Broker settings of a specific Open Source Ecosystem for a...

Lua path: app.integrations.snyk.update_opensource_broker_settings_ecosystem_organization
Full name: snyk.snyk_update_opensource_broker_ecosystem_settings_for_org

Parameter	Type	Required	Description
No parameters.

retrieves_sast_settings_org Read

Retrieves the SAST settings for an org Official Snyk endpoint: GET /orgs/{org_id}/settings/sast Retrieves the SAST settings for an org #### Required permissions - `View Organization (org.read)`

Lua path: app.integrations.snyk.retrieves_sast_settings_org
Full name: snyk.snyk_get_sast_settings

Parameter	Type	Required	Description
No parameters.

enable_disable_code_settings_org Write

Enable/Disable the Snyk Code settings for an org Official Snyk endpoint: PATCH /orgs/{org_id}/settings/sast Enable/Disable the Snyk Code settings for an org #### Required permissions - `View Organization (org.read)` -...

Lua path: app.integrations.snyk.enable_disable_code_settings_org
Full name: snyk.snyk_update_org_sast_settings

Parameter	Type	Required	Description
No parameters.

remove_given_slack_app_integration Write

Remove the given Slack App integration Official Snyk endpoint: DELETE /orgs/{org_id}/slack_app/{bot_id} Remove the given Slack App integration #### Required permissions - `Install Apps (org.app.install)`

Lua path: app.integrations.snyk.remove_given_slack_app_integration
Full name: snyk.snyk_delete_slack_default_notification_settings

Parameter	Type	Required	Description
No parameters.

get_slack_integration_default_notification_settings Read

Get Slack integration default notification settings. Official Snyk endpoint: GET /orgs/{org_id}/slack_app/{bot_id} Get Slack integration default notification settings for the provided tenant ID and bot ID. #### Requir...

Lua path: app.integrations.snyk.get_slack_integration_default_notification_settings
Full name: snyk.snyk_get_slack_default_notification_settings

Parameter	Type	Required	Description
No parameters.

create_new_slack_notification_default_settings Write

Create new Slack notification default settings. Official Snyk endpoint: POST /orgs/{org_id}/slack_app/{bot_id} Create new Slack notification default settings for a given tenant. #### Required permissions - `Install Ap...

Lua path: app.integrations.snyk.create_new_slack_notification_default_settings
Full name: snyk.snyk_create_slack_default_notification_settings

Parameter	Type	Required	Description
No parameters.

slack_notification_settings_overrides_projects Read

Slack notification settings overrides for projects Official Snyk endpoint: GET /orgs/{org_id}/slack_app/{bot_id}/projects Slack notification settings overrides for projects. These settings overrides the default settin...

Lua path: app.integrations.snyk.slack_notification_settings_overrides_projects
Full name: snyk.snyk_get_slack_project_notification_settings_collection

Parameter	Type	Required	Description
No parameters.

remove_slack_settings_override_project Write

Remove Slack settings override for a project. Official Snyk endpoint: DELETE /orgs/{org_id}/slack_app/{bot_id}/projects/{project_id} Remove Slack settings override for a project. #### Required permissions - `Install A...

Lua path: app.integrations.snyk.remove_slack_settings_override_project
Full name: snyk.snyk_delete_slack_project_notification_settings

Parameter	Type	Required	Description
No parameters.

update_slack_notification_settings_project Write

Update Slack notification settings for a project. Official Snyk endpoint: PATCH /orgs/{org_id}/slack_app/{bot_id}/projects/{project_id} Update Slack notification settings for a project. #### Required permissions - `In...

Lua path: app.integrations.snyk.update_slack_notification_settings_project
Full name: snyk.snyk_update_slack_project_notification_settings

Parameter	Type	Required	Description
No parameters.

create_new_slack_settings_override_given_project Write

Create a new Slack settings override for a given project. Official Snyk endpoint: POST /orgs/{org_id}/slack_app/{bot_id}/projects/{project_id} Create Slack settings override for a project. #### Required permissions - ...

Lua path: app.integrations.snyk.create_new_slack_settings_override_given_project
Full name: snyk.snyk_create_slack_project_notification_settings

Parameter	Type	Required	Description
No parameters.

get_list_slack_channels Read

Get a list of Slack channels Official Snyk endpoint: GET /orgs/{org_id}/slack_app/{tenant_id}/channels Requires the Snyk Slack App to be set up for this org, will retrieve a list of channels the Snyk Slack App can acc...

Lua path: app.integrations.snyk.get_list_slack_channels
Full name: snyk.snyk_list_channels

Parameter	Type	Required	Description
No parameters.

get_slack_channel_name_by_slack_channel_id Read

Get Slack Channel name by Slack Channel ID. Official Snyk endpoint: GET /orgs/{org_id}/slack_app/{tenant_id}/channels/{channel_id} Requires the Snyk Slack App to be set up for this org. It will return the Slack channe...

Lua path: app.integrations.snyk.get_slack_channel_name_by_slack_channel_id
Full name: snyk.snyk_get_channel_name_by_id

Parameter	Type	Required	Description
No parameters.

get_targets_by_org_id Read

Get targets by org ID Official Snyk endpoint: GET /orgs/{org_id}/targets Get a list of an organization's targets. #### Required permissions - `View Projects (org.project.read)`

Lua path: app.integrations.snyk.get_targets_by_org_id
Full name: snyk.snyk_get_orgs_targets

Parameter	Type	Required	Description
No parameters.

delete_target_by_target_id Write

Delete target by target ID Official Snyk endpoint: DELETE /orgs/{org_id}/targets/{target_id} Delete the specified target. #### Required permissions - `Remove Projects (org.project.delete)`

Lua path: app.integrations.snyk.delete_target_by_target_id
Full name: snyk.snyk_delete_orgs_target

Parameter	Type	Required	Description
No parameters.

get_target_by_target_id Read

Get target by target ID Official Snyk endpoint: GET /orgs/{org_id}/targets/{target_id} Get a specified target for an organization. #### Required permissions - `View Projects (org.project.read)`

Lua path: app.integrations.snyk.get_target_by_target_id
Full name: snyk.snyk_get_orgs_target

Parameter	Type	Required	Description
No parameters.

get_test_job_early_access Read

Get a test job. (Early Access) Official Snyk endpoint: GET /orgs/{org_id}/test_jobs/{job_id} Get a test job. The Test API is Asynchronous, and Tests begun through the API are assigned a Job ID which references the in-...

Lua path: app.integrations.snyk.get_test_job_early_access
Full name: snyk.snyk_get_job

Parameter	Type	Required	Description
No parameters.

create_new_test_early_access Write

Create a new test. (Early Access) Official Snyk endpoint: POST /orgs/{org_id}/tests Create a new test. Provide the items to be tested by Snyk as well as any configuration parameters for the test to be run. Currently, ...

Lua path: app.integrations.snyk.create_new_test_early_access
Full name: snyk.snyk_create_test

Parameter	Type	Required	Description
No parameters.

get_test_early_access Read

Get a test. (Early Access) Official Snyk endpoint: GET /orgs/{org_id}/tests/{test_id} Get a test. A Test returned through this endpoint is intended to be a completed Test with results. The data returned through this e...

Lua path: app.integrations.snyk.get_test_early_access
Full name: snyk.snyk_get_test

Parameter	Type	Required	Description
No parameters.

list_findings_test_early_access Read

List findings for a test. (Early Access) Official Snyk endpoint: GET /orgs/{org_id}/tests/{test_id}/findings List findings for a test. Test Findings are scanner-agnostic representations of vulnerabilities and organiza...

Lua path: app.integrations.snyk.list_findings_test_early_access
Full name: snyk.snyk_list_findings

Parameter	Type	Required	Description
No parameters.

get_user_by_id_early_access Read

Get user by ID (Early Access) Official Snyk endpoint: GET /orgs/{org_id}/users/{id} Get a summary of user. Note that Service Accounts are not returned by this endpoint. Please use the Service Accounts endpoints. #### ...

Lua path: app.integrations.snyk.get_user_by_id_early_access
Full name: snyk.snyk_get_user

Parameter	Type	Required	Description
No parameters.

my_user_details Read

My User Details Official Snyk endpoint: GET /self Retrieves information about the the user making the request.

Lua path: app.integrations.snyk.my_user_details
Full name: snyk.snyk_get_self

Parameter	Type	Required	Description
No parameters.

get_access_requests_early_access Read

Get access requests (Early Access) Official Snyk endpoint: GET /self/access_requests Get a list of user's access requests

Lua path: app.integrations.snyk.get_access_requests_early_access
Full name: snyk.snyk_get_access_requests

Parameter	Type	Required	Description
No parameters.

get_list_apps_that_can_act_your_behalf Read

Get a list of Snyk Apps that can act on your behalf Official Snyk endpoint: GET /self/apps Get a list of Snyk Apps that can act on your behalf

Lua path: app.integrations.snyk.get_list_apps_that_can_act_your_behalf
Full name: snyk.snyk_get_user_installed_apps

Parameter	Type	Required	Description
No parameters.

get_list_apps_installed_user Read

Get a list of Snyk Apps installed for a user Official Snyk endpoint: GET /self/apps/installs Get a list of Snyk Apps installed for a user

Lua path: app.integrations.snyk.get_list_apps_installed_user
Full name: snyk.snyk_get_app_installs_for_user

Parameter	Type	Required	Description
No parameters.

revoke_app_by_install_id Write

Revoke a Snyk App by install ID Official Snyk endpoint: DELETE /self/apps/installs/{install_id} Revoke a Snyk App by install ID

Lua path: app.integrations.snyk.revoke_app_by_install_id
Full name: snyk.snyk_delete_user_app_install_by_id

Parameter	Type	Required	Description
No parameters.

revoke_app_by_app_id Write

Revoke a Snyk App by app ID Official Snyk endpoint: DELETE /self/apps/{app_id} Revoke access for an app by app id

Lua path: app.integrations.snyk.revoke_app_by_app_id
Full name: snyk.snyk_revoke_user_installed_app

Parameter	Type	Required	Description
No parameters.

get_list_active_oauth_sessions_by_app_id Read

Get a list of active OAuth sessions by app ID Official Snyk endpoint: GET /self/apps/{app_id}/sessions Get a list of active OAuth sessions by app ID

Lua path: app.integrations.snyk.get_list_active_oauth_sessions_by_app_id
Full name: snyk.snyk_get_user_app_sessions

Parameter	Type	Required	Description
No parameters.

revoke_app_session_active_user Write

Revoke the Snyk App session of an active user Official Snyk endpoint: DELETE /self/apps/{app_id}/sessions/{session_id} Revoke the Snyk App session of an active user

Lua path: app.integrations.snyk.revoke_app_session_active_user
Full name: snyk.snyk_revoke_user_app_session

Parameter	Type	Required	Description
No parameters.

list_personal_access_tokens Read

List personal access tokens Official Snyk endpoint: GET /self/personal_access_tokens List personal access tokens

Lua path: app.integrations.snyk.list_personal_access_tokens
Full name: snyk.snyk_list_personal_access_token

Parameter	Type	Required	Description
No parameters.

deletes_personal_access_token Write

Deletes a personal access token Official Snyk endpoint: DELETE /self/personal_access_tokens/{personal_access_token_id} Delete a personal access token

Lua path: app.integrations.snyk.deletes_personal_access_token
Full name: snyk.snyk_delete_personal_access_token

Parameter	Type	Required	Description
No parameters.

get_list_all_accessible_tenants Read

Get a list of all accessible Tenants Official Snyk endpoint: GET /tenants Get a list of all Tenants which the calling user is a member of

Lua path: app.integrations.snyk.get_list_all_accessible_tenants
Full name: snyk.snyk_list_tenants

Parameter	Type	Required	Description
No parameters.

get_single_tenant_by_id Read

Get a single Tenant by ID Official Snyk endpoint: GET /tenants/{tenant_id} Get the full details of a Tenant. #### Required permissions - `View Tenant Details (tenant.read)`

Lua path: app.integrations.snyk.get_single_tenant_by_id
Full name: snyk.snyk_get_tenant

Parameter	Type	Required	Description
No parameters.

update_tenant Write

Update tenant Official Snyk endpoint: PATCH /tenants/{tenant_id} Update the details of a tenant #### Required permissions - `Edit Tenant Details (tenant.edit)`

Lua path: app.integrations.snyk.update_tenant
Full name: snyk.snyk_update_tenant

Parameter	Type	Required	Description
No parameters.

get_integrations_using_current_broker_connection Read

Get Integrations using the current Broker connection Official Snyk endpoint: GET /tenants/{tenant_id}/brokers/connections/{connection_id}/integrations Get all integrations using the Broker connection #### Required per...

Lua path: app.integrations.snyk.get_integrations_using_current_broker_connection
Full name: snyk.snyk_get_broker_connection_integrations

Parameter	Type	Required	Description
No parameters.

creates_broker_connection_integration_configuration Write

Creates Broker connection Integration Configuration Official Snyk endpoint: POST /tenants/{tenant_id}/brokers/connections/{connection_id}/orgs/{org_id}/integration Configures integrations to use the Broker connection ...

Lua path: app.integrations.snyk.creates_broker_connection_integration_configuration
Full name: snyk.snyk_create_broker_connection_integration

Parameter	Type	Required	Description
No parameters.

deletes_integration_broker_connection Write

Deletes an Integration for a Broker connection Official Snyk endpoint: DELETE /tenants/{tenant_id}/brokers/connections/{connection_id}/orgs/{org_id}/integrations/{integration_id} Deletes an existing Broker connection ...

Lua path: app.integrations.snyk.deletes_integration_broker_connection
Full name: snyk.snyk_delete_broker_connection_integration

Parameter	Type	Required	Description
No parameters.

list_broker_deployments_tenant Read

List Broker deployments for tenant Official Snyk endpoint: GET /tenants/{tenant_id}/brokers/deployments List Broker deployments for the tenant #### Required permissions - `View Tenant Details (tenant.read)`

Lua path: app.integrations.snyk.list_broker_deployments_tenant
Full name: snyk.snyk_list_broker_deployments_for_tenant

Parameter	Type	Required	Description
No parameters.

list_connection_contexts Read

List Connection contexts Official Snyk endpoint: GET /tenants/{tenant_id}/brokers/installs/{install_id}/connections/{connection_id}/contexts List Broker contexts for a given broker connection ID #### Required permissi...

Lua path: app.integrations.snyk.list_connection_contexts
Full name: snyk.snyk_list_connection_contexts

Parameter	Type	Required	Description
No parameters.

deletes_broker_context Write

Deletes broker context Official Snyk endpoint: DELETE /tenants/{tenant_id}/brokers/installs/{install_id}/contexts/{context_id} Deletes an existing broker context #### Required permissions - `View Tenant Details (tenan...

Lua path: app.integrations.snyk.deletes_broker_context
Full name: snyk.snyk_delete_broker_context

Parameter	Type	Required	Description
No parameters.

list_connection_context Read

List Connection context Official Snyk endpoint: GET /tenants/{tenant_id}/brokers/installs/{install_id}/contexts/{context_id} List Broker context for a given broker context ID #### Required permissions - `View Tenant D...

Lua path: app.integrations.snyk.list_connection_context
Full name: snyk.snyk_get_connection_context

Parameter	Type	Required	Description
No parameters.

updates_broker_context Write

Updates Broker Context Official Snyk endpoint: PATCH /tenants/{tenant_id}/brokers/installs/{install_id}/contexts/{context_id} Updates a Broker Context for an deployment #### Required permissions - `View Tenant Details...

Lua path: app.integrations.snyk.updates_broker_context
Full name: snyk.snyk_update_broker_context

Parameter	Type	Required	Description
No parameters.

updates_integration_be_associated_with_broker_context Write

Updates an integration to be associated with a Broker context Official Snyk endpoint: PATCH /tenants/{tenant_id}/brokers/installs/{install_id}/contexts/{context_id}/integration Updates an integration to be associated ...

Lua path: app.integrations.snyk.updates_integration_be_associated_with_broker_context
Full name: snyk.snyk_update_broker_context_integration

Parameter	Type	Required	Description
No parameters.

deletes_broker_context_association_with_integration Write

Deletes the Broker context association with an Integration Official Snyk endpoint: DELETE /tenants/{tenant_id}/brokers/installs/{install_id}/contexts/{context_id}/integrations/{integration_id} Deletes an existing Brok...

Lua path: app.integrations.snyk.deletes_broker_context_association_with_integration
Full name: snyk.snyk_delete_broker_context_integration

Parameter	Type	Required	Description
No parameters.

list_broker_deployments Read

List Broker deployments Official Snyk endpoint: GET /tenants/{tenant_id}/brokers/installs/{install_id}/deployments List Broker deployments for a given install ID #### Required permissions - `View Tenant Details (tenan...

Lua path: app.integrations.snyk.list_broker_deployments
Full name: snyk.snyk_list_broker_deployments

Parameter	Type	Required	Description
No parameters.

creates_broker_deployment Write

Creates Broker Deployment Official Snyk endpoint: POST /tenants/{tenant_id}/brokers/installs/{install_id}/deployments Creates a new Broker Deployment for an installation #### Required permissions - `View Tenant Detail...

Lua path: app.integrations.snyk.creates_broker_deployment
Full name: snyk.snyk_create_broker_deployment

Parameter	Type	Required	Description
No parameters.

deletes_broker_deployment Write

Deletes Broker deployment Official Snyk endpoint: DELETE /tenants/{tenant_id}/brokers/installs/{install_id}/deployments/{deployment_id} Delete a Broker deployment for a given install ID #### Required permissions - `Vi...

Lua path: app.integrations.snyk.deletes_broker_deployment
Full name: snyk.snyk_delete_broker_deployment

Parameter	Type	Required	Description
No parameters.

updates_broker_deployment Write

Updates Broker deployment Official Snyk endpoint: PATCH /tenants/{tenant_id}/brokers/installs/{install_id}/deployments/{deployment_id} Updates a Broker deployment for a given install ID #### Required permissions - `Vi...

Lua path: app.integrations.snyk.updates_broker_deployment
Full name: snyk.snyk_update_broker_deployment

Parameter	Type	Required	Description
No parameters.

deletes_broker_connections Write

Deletes Broker connections Official Snyk endpoint: DELETE /tenants/{tenant_id}/brokers/installs/{install_id}/deployments/{deployment_id}/connections Deletes all existing Broker connections for an deployment #### Requi...

Lua path: app.integrations.snyk.deletes_broker_connections
Full name: snyk.snyk_delete_broker_connections

Parameter	Type	Required	Description
No parameters.

list_broker_connections Read

List Broker connections Official Snyk endpoint: GET /tenants/{tenant_id}/brokers/installs/{install_id}/deployments/{deployment_id}/connections List all Broker connections for a given deployment #### Required permissio...

Lua path: app.integrations.snyk.list_broker_connections
Full name: snyk.snyk_list_broker_connections

Parameter	Type	Required	Description
No parameters.

creates_broker_connection Write

Creates Broker connection Official Snyk endpoint: POST /tenants/{tenant_id}/brokers/installs/{install_id}/deployments/{deployment_id}/connections Creates a new Broker connection for an deployment #### Required permiss...

Lua path: app.integrations.snyk.creates_broker_connection
Full name: snyk.snyk_create_broker_connection

Parameter	Type	Required	Description
No parameters.

deletes_broker_connection Write

Deletes Broker connection Official Snyk endpoint: DELETE /tenants/{tenant_id}/brokers/installs/{install_id}/deployments/{deployment_id}/connections/{connection_id} Deletes an existing Broker connection for an deployme...

Lua path: app.integrations.snyk.deletes_broker_connection
Full name: snyk.snyk_delete_broker_connection

Parameter	Type	Required	Description
No parameters.

get_broker_connection Read

Get Broker connection Official Snyk endpoint: GET /tenants/{tenant_id}/brokers/installs/{install_id}/deployments/{deployment_id}/connections/{connection_id} Get all Broker connection data for an deployment #### Requir...

Lua path: app.integrations.snyk.get_broker_connection
Full name: snyk.snyk_get_broker_connection

Parameter	Type	Required	Description
No parameters.

updates_broker_connection Write

Updates Broker connection Official Snyk endpoint: PATCH /tenants/{tenant_id}/brokers/installs/{install_id}/deployments/{deployment_id}/connections/{connection_id} Updates a Broker connection for an deployment #### Req...

Lua path: app.integrations.snyk.updates_broker_connection
Full name: snyk.snyk_update_broker_connection

Parameter	Type	Required	Description
No parameters.

list_organizations_bulk_migration Read

List organizations for bulk migration Official Snyk endpoint: GET /tenants/{tenant_id}/brokers/installs/{install_id}/deployments/{deployment_id}/connections/{connection_id}/bulk_migration Lists organization IDs associ...

Lua path: app.integrations.snyk.list_organizations_bulk_migration
Full name: snyk.snyk_list_broker_orgs_for_bulk_migration

Parameter	Type	Required	Description
No parameters.

performs_bulk_migration_integrations_universal_broker Write

Performs bulk migration integrations to universal broker Official Snyk endpoint: POST /tenants/{tenant_id}/brokers/installs/{install_id}/deployments/{deployment_id}/connections/{connection_id}/bulk_migration Performs ...

Lua path: app.integrations.snyk.performs_bulk_migration_integrations_universal_broker
Full name: snyk.snyk_create_broker_orgs_for_bulk_migration

Parameter	Type	Required	Description
No parameters.

list_deployment_contexts Read

List Deployment contexts Official Snyk endpoint: GET /tenants/{tenant_id}/brokers/installs/{install_id}/deployments/{deployment_id}/contexts List Deployment contexts for a given deployment ID #### Required permissions...

Lua path: app.integrations.snyk.list_deployment_contexts
Full name: snyk.snyk_list_deployment_contexts

Parameter	Type	Required	Description
No parameters.

create_broker_context Write

Create broker Context Official Snyk endpoint: POST /tenants/{tenant_id}/brokers/installs/{install_id}/deployments/{deployment_id}/contexts Creates a new Broker Context #### Required permissions - `View Tenant Details ...

Lua path: app.integrations.snyk.create_broker_context
Full name: snyk.snyk_create_broker_context

Parameter	Type	Required	Description
No parameters.

list_deployment_credentials Read

List Deployment credentials Official Snyk endpoint: GET /tenants/{tenant_id}/brokers/installs/{install_id}/deployments/{deployment_id}/credentials List Deployment credentials for a given deployment ID #### Required pe...

Lua path: app.integrations.snyk.list_deployment_credentials
Full name: snyk.snyk_list_deployment_credentials

Parameter	Type	Required	Description
No parameters.

create_deployment_credential Write

Create deployment credential Official Snyk endpoint: POST /tenants/{tenant_id}/brokers/installs/{install_id}/deployments/{deployment_id}/credentials Creates a new Deployment credential #### Required permissions - `Vie...

Lua path: app.integrations.snyk.create_deployment_credential
Full name: snyk.snyk_create_deployment_credential

Parameter	Type	Required	Description
No parameters.

deletes_deployment_credential Write

Deletes Deployment credential Official Snyk endpoint: DELETE /tenants/{tenant_id}/brokers/installs/{install_id}/deployments/{deployment_id}/credentials/{credential_id} Deletes an existing Deployment credential for an ...

Lua path: app.integrations.snyk.deletes_deployment_credential
Full name: snyk.snyk_delete_deployment_credential

Parameter	Type	Required	Description
No parameters.

get_deployment_credential Read

Get Deployment credential Official Snyk endpoint: GET /tenants/{tenant_id}/brokers/installs/{install_id}/deployments/{deployment_id}/credentials/{credential_id} Get all Deployment credential data for an deployment ###...

Lua path: app.integrations.snyk.get_deployment_credential
Full name: snyk.snyk_get_deployment_credential

Parameter	Type	Required	Description
No parameters.

updates_deployment_credential Write

Updates Deployment credential Official Snyk endpoint: PATCH /tenants/{tenant_id}/brokers/installs/{install_id}/deployments/{deployment_id}/credentials/{credential_id} Updates a Deployment credential for an deployment ...

Lua path: app.integrations.snyk.updates_deployment_credential
Full name: snyk.snyk_update_deployment_credential

Parameter	Type	Required	Description
No parameters.

list_or_search_all_assets_synchronous_early_access Read

List or search all assets (synchronous) (Early Access) Official Snyk endpoint: GET /tenants/{tenant_id}/inventory/assets Retrieves a polymorphic list of all asset types for a given tenant. The response includes differ...

Lua path: app.integrations.snyk.list_or_search_all_assets_synchronous_early_access
Full name: snyk.snyk_list_assets_tenant

Parameter	Type	Required	Description
No parameters.

bulk_update_asset_attributes_early_access Write

Bulk update asset attributes (Early Access) Official Snyk endpoint: PATCH /tenants/{tenant_id}/inventory/assets Partially updates multiple assets in a single request. Maximum of 100 assets can be updated per request. ...

Lua path: app.integrations.snyk.bulk_update_asset_attributes_early_access
Full name: snyk.snyk_update_assets_bulk_tenant

Parameter	Type	Required	Description
No parameters.

get_available_filter_fields_early_access Read

Get available filter fields (Early Access) Official Snyk endpoint: GET /tenants/{tenant_id}/inventory/assets/filters Returns a list of valid field names that can be used for filtering assets using RSQL. Each field inc...

Lua path: app.integrations.snyk.get_available_filter_fields_early_access
Full name: snyk.snyk_get_filter_fields_tenant

Parameter	Type	Required	Description
No parameters.

get_filter_value_suggestions_autocomplete_early_access Read

Get filter value suggestions (autocomplete) (Early Access) Official Snyk endpoint: GET /tenants/{tenant_id}/inventory/assets/filters/{filter_id}/values Returns a list of distinct values for a specific filter field. Us...

Lua path: app.integrations.snyk.get_filter_value_suggestions_autocomplete_early_access
Full name: snyk.snyk_get_filter_values_tenant

Parameter	Type	Required	Description
No parameters.

get_available_group_fields_early_access Read

Get available group fields (Early Access) Official Snyk endpoint: GET /tenants/{tenant_id}/inventory/assets/groups Returns a list of valid group field names that can be used for grouping assets. Each field includes it...

Lua path: app.integrations.snyk.get_available_group_fields_early_access
Full name: snyk.snyk_get_group_fields_tenant

Parameter	Type	Required	Description
No parameters.

get_group_value_aggregation_early_access Read

Get group value aggregation (Early Access) Official Snyk endpoint: GET /tenants/{tenant_id}/inventory/assets/groups/{group_field_id}/values Returns aggregated values for a specific group field id, showing the count of...

Lua path: app.integrations.snyk.get_group_value_aggregation_early_access
Full name: snyk.snyk_get_group_values_tenant

Parameter	Type	Required	Description
No parameters.

create_asset_search_asynchronous_early_access Write

Create an asset search (asynchronous) (Early Access) Official Snyk endpoint: POST /tenants/{tenant_id}/inventory/assets/searches Initiates an asynchronous search for assets and returns a redirect to the search results...

Lua path: app.integrations.snyk.create_asset_search_asynchronous_early_access
Full name: snyk.snyk_create_asset_search_tenant

Parameter	Type	Required	Description
No parameters.

retrieve_asset_search_results_asynchronous_early_access Read

Retrieve asset search results (asynchronous) (Early Access) Official Snyk endpoint: GET /tenants/{tenant_id}/inventory/assets/searches/{search_id}/results Gets paginated results for a previously initiated asset search...

Lua path: app.integrations.snyk.retrieve_asset_search_results_asynchronous_early_access
Full name: snyk.snyk_get_asset_search_results_tenant

Parameter	Type	Required	Description
No parameters.

get_single_asset_by_id_early_access Read

Get a single asset by ID (Early Access) Official Snyk endpoint: GET /tenants/{tenant_id}/inventory/assets/{asset_id} Retrieves a single asset by its unique identifier. The response includes the asset's details in JSON...

Lua path: app.integrations.snyk.get_single_asset_by_id_early_access
Full name: snyk.snyk_get_asset_tenant

Parameter	Type	Required	Description
No parameters.

update_asset_attributes_early_access Write

Update asset attributes (Early Access) Official Snyk endpoint: PATCH /tenants/{tenant_id}/inventory/assets/{asset_id} Partially updates an asset's attributes. Supports updating class, labels (add/remove), and tags (ad...

Lua path: app.integrations.snyk.update_asset_attributes_early_access
Full name: snyk.snyk_update_asset_tenant

Parameter	Type	Required	Description
No parameters.

list_projects_asset_early_access Read

List projects for an asset (Early Access) Official Snyk endpoint: GET /tenants/{tenant_id}/inventory/assets/{asset_id}/relationships/projects Retrieves a paginated list of Snyk projects linked to this asset with full ...

Lua path: app.integrations.snyk.list_projects_asset_early_access
Full name: snyk.snyk_list_asset_projects_tenant

Parameter	Type	Required	Description
No parameters.

list_targets_asset_early_access Read

List targets for an asset (Early Access) Official Snyk endpoint: GET /tenants/{tenant_id}/inventory/assets/{asset_id}/relationships/targets Retrieves a paginated list of Snyk targets linked to this asset with full att...

Lua path: app.integrations.snyk.list_targets_asset_early_access
Full name: snyk.snyk_list_asset_targets_tenant

Parameter	Type	Required	Description
No parameters.

get_all_memberships_tenant_early_access Read

Get all memberships of the tenant (Early Access) Official Snyk endpoint: GET /tenants/{tenant_id}/memberships Returns all memberships of the tenant #### Required permissions - `View Tenant Memberships (tenant.membersh...

Lua path: app.integrations.snyk.get_all_memberships_tenant_early_access
Full name: snyk.snyk_get_tenant_memberships

Parameter	Type	Required	Description
No parameters.

delete_individual_tenant_membership_single_user_early_access Write

Delete an individual tenant membership for a single user. (Early Access) Official Snyk endpoint: DELETE /tenants/{tenant_id}/memberships/{membership_id} Delete an individual tenant membership for a single user. #### R...

Lua path: app.integrations.snyk.delete_individual_tenant_membership_single_user_early_access
Full name: snyk.snyk_delete_tenant_membership

Parameter	Type	Required	Description
No parameters.

update_tenant_membership_early_access Write

Update tenant membership (Early Access) Official Snyk endpoint: PATCH /tenants/{tenant_id}/memberships/{membership_id} Update the tenant membership with the new role #### Required permissions - `View Tenant Details (t...

Lua path: app.integrations.snyk.update_tenant_membership_early_access
Full name: snyk.snyk_update_tenant_membership

Parameter	Type	Required	Description
No parameters.

list_all_available_roles_given_tenant_early_access Read

List all available roles for a given tenant (Early Access) Official Snyk endpoint: GET /tenants/{tenant_id}/roles List all available roles for a given tenant. #### Required permissions - `View Tenant Roles (tenant.rol...

Lua path: app.integrations.snyk.list_all_available_roles_given_tenant_early_access
Full name: snyk.snyk_list_tenant_roles

Parameter	Type	Required	Description
No parameters.

create_custom_tenant_role_given_tenant_early_access Write

Create a custom tenant role for a given tenant (Early Access) Official Snyk endpoint: POST /tenants/{tenant_id}/roles Create a custom tenant role for a given tenant. #### Required permissions - `View Tenant Roles (ten...

Lua path: app.integrations.snyk.create_custom_tenant_role_given_tenant_early_access
Full name: snyk.snyk_create_tenant_role

Parameter	Type	Required	Description
No parameters.

delete_specific_tenant_role_by_its_id_and_its_tenant_id_early_access Write

Delete a specific tenant role by its id and its tenant id. (Early Access) Official Snyk endpoint: DELETE /tenants/{tenant_id}/roles/{role_id} Delete a custom tenant role in a given tenant #### Required permissions - `...

Lua path: app.integrations.snyk.delete_specific_tenant_role_by_its_id_and_its_tenant_id_early_access
Full name: snyk.snyk_delete_tenant_role

Parameter	Type	Required	Description
No parameters.

return_specific_role_by_its_id_and_its_tenant_id_early_access Read

Return a specific role by its id and its tenant id. (Early Access) Official Snyk endpoint: GET /tenants/{tenant_id}/roles/{role_id} Return a role from a tenant by the tenant and role id with its details and permission...

Lua path: app.integrations.snyk.return_specific_role_by_its_id_and_its_tenant_id_early_access
Full name: snyk.snyk_get_tenant_role

Parameter	Type	Required	Description
No parameters.

update_specific_tenant_role_by_its_id_and_its_tenant_id_early_access Write

Update a specific tenant role by its id and its tenant id. (Early Access) Official Snyk endpoint: PATCH /tenants/{tenant_id}/roles/{role_id} Update attributes of a custom tenant role in a given tenant #### Required pe...

Lua path: app.integrations.snyk.update_specific_tenant_role_by_its_id_and_its_tenant_id_early_access
Full name: snyk.snyk_update_tenant_role

Parameter	Type	Required	Description
No parameters.