> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Aikido

> How to set up the Aikido connector, plus the actions that are available.

![Aikido](https://stackone-logos.com/api/aikido/filled/svg)

Previewv0.1.0[See changelog](https://docs.stackone.com/connectors/aikido/changelog.md)

[212 actions](#actions) · 1 auth method

Security

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and set up a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> **[Connector Profile · OAuth 2.0 - Client Credentials](https://docs.stackone.com/connectors/aikido/guides/connector-profile/oauth-2-0-client-credentials.md)**
>
> Requires a private REST API client created by an Aikido workspace admin. Access is limited to the scopes chosen on that...

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> **[Link Account · OAuth 2.0 - Client Credentials](https://docs.stackone.com/connectors/aikido/guides/link-account/oauth-2-0-client-credentials.md)**

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/connect/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

Scopes

Select all
|
Clear

access\_tokens:write

autofix:read

autofix:write

basics:read

broker:read

broker:write

bug\_bounty:write

clouds:read

clouds:write

code\_coverage:read

code\_quality:read

code\_quality:write

containers:read

containers:write

custom\_sast\_rules:read

custom\_sast\_rules:write

domains:read

domains:write

endpoint\_protection:read

endpoint\_protection:write

firewall:read

firewall:write

issues:read

issues:write

licenses:read

licenses:write

pentests:read

pentests:write

reports:read

repositories:read

repositories:write

request\_inbox:read

request\_inbox:write

research:read

task\_tracking:read

task\_tracking:write

teams:read

teams:write

users:read

users:write

virtual\_machines:read

webhooks:read

webhooks:write

No scopes found

212 actions

ActionDescriptionRequired scopes

Update Code Scanning Access Token`aikido_set_code_scanning_access_token`

Update the access token used for code scanning.

`access_tokens:write`

Get Container AutoFix PR Creation Settings`aikido_get_container_autofix_settings`

Get the workspace container AutoFix PR creation settings. Container selection is returned as containers\_scope ("all" or...

`autofix:read`

Get Dependency AutoFix PR Creation Settings`aikido_get_dependency_autofix_settings`

Get the workspace dependency AutoFix PR creation settings. Repository selection is returned as repos\_scope ("all" or "se...

`autofix:read`

Get Pentest AutoFix PR Creation Settings`aikido_get_pentest_autofix_settings`

Get the workspace Pentest & AI Code Analysis AutoFix PR creation settings. Repository selection is returned as repos\_sco...

`autofix:read`

Get SAST AutoFix Settings`aikido_get_sast_autofix_settings`

Get the workspace SAST & IaC AutoFix PR creation settings. Repository selection is returned as repos\_scope ("all" or "se...

`autofix:read`

List Aikido Images`aikido_list_aikido_images`

Returns a paginated list of Aikido images in your account.

`autofix:read`

List AutoFix History`aikido_list_autofix_history`

Returns a paginated list of autofix tasks in your account. Use the result's next field for pagination.

`autofix:read`

List Issues Addressed By A Task`aikido_list_autofix_task_issues`

Returns the issues that an autofix task was trying to solve. Use the autofix task ID (the `id` field) from the /autofix/...

`autofix:read`

List Hardened Image Requests`aikido_list_image_requests`

Returns the list of hardened image requests that have been submitted for your account, including their current status.

`autofix:read`

Request Hardened Image`aikido_request_container_image`

Request that a specific image tag be secured. The request is recorded and does not trigger an immediate rebuild.

`autofix:write`

Update Container AutoFix PR Creation Settings`aikido_update_container_autofix_settings`

Update the workspace container AutoFix PR creation settings. PRs are created and re-evaluated every day.

`autofix:write`

Update Dependency AutoFix PR Creation Settings`aikido_update_dependency_autofix_settings`

Update the workspace dependency AutoFix PR creation settings. PRs are created and re-evaluated every day. Use severity\_f...

`autofix:write`

Update Pentest AutoFix PR Creation Settings`aikido_update_pentest_autofix_settings`

Update the workspace Pentest & AI Code Analysis AutoFix PR creation settings. PRs are created and re-evaluated every day...

`autofix:write`

Update SAST AutoFix Settings`aikido_update_sast_autofix_settings`

Update the workspace SAST & IaC AutoFix PR creation settings. PRs are created and re-evaluated every day. Use severity\_f...

`autofix:write`

Add Broker Resource URL`aikido_add_broker_resource_url`

Adds an internal resource URL that a broker app can access. Only base URLs are allowed, without a path (for example http...

`broker:write`

Delete Broker Resource URL`aikido_delete_broker_resource_url`

Removes a resource URL from a broker app

`broker:write`

List Broker Apps`aikido_list_broker_apps`

Returns a list of all broker apps in your account, including their mapped resource URLs.

`broker:read`

Validate Bug Bounty Report`aikido_add_bug_bounty_report`

Validates a new bug bounty report for a given program.

`bug_bounty:write`

Connect AWS Cloud`aikido_connect_aws_cloud`

Connect a new AWS cloud environment

`clouds:write`

Connect Azure Cloud`aikido_connect_azure_cloud`

Connect a new Azure cloud environment. [https://help.aikido.dev/doc/get-required-values--set-up-configuration-to-connect-](https://help.aikido.dev/doc/get-required-values--set-up-configuration-to-connect-)...

`clouds:write`

Connect GCP Cloud`aikido_connect_gcp_cloud`

Connect a new Gcp cloud environment. [https://help.aikido.dev/cloud-scanning/connect-your-cloud/gcp/get-required-values-+](https://help.aikido.dev/cloud-scanning/connect-your-cloud/gcp/get-required-values-+)...

`clouds:write`

Create Kubernetes Cloud`aikido_create_kubernetes_cloud`

Connect your Kubernetes cluster to Aikido. This will register a cluster and return the agent token needed for installati...

`clouds:write`

List Cloud Assets`aikido_list_cloud_assets`

Returns cloud assets for the connected clouds in your account. Supports pagination, filtering and search parameters simi...

`clouds:read`

List Connected Clouds`aikido_list_clouds`

Returns a list of all the active clouds connected in your account

`clouds:read`

Remove Cloud`aikido_remove_cloud`

Removes a cloud with a specified id

`clouds:write`

Update Azure Cloud`aikido_update_azure_cloud_credentials`

Update the credentials for an Azure cloud

`clouds:write`

Get Code Coverage For A Repository`aikido_get_code_coverage_for_repository`

Returns the latest code coverage summary for a repository. Optionally filter by branch name. When no branch is provided,...

`code_coverage:read`

List All Code Coverage Repositories`aikido_list_all_code_coverage_repositories`

Returns a paginated list of repositories that have code coverage results. Optionally filter by branch name. When no bran...

`code_coverage:read`

Ignore Code Quality Finding`aikido_ignore_code_quality_repo_finding`

Ignores an open code quality finding. Use the finding id returned by the repo-findings list endpoint.

`code_quality:write`

List Code Quality Findings For A Pull Request`aikido_list_code_quality_findings_for_pull_request`

Returns a list of code quality findings for a specific pull request. Only the findings from the latest scan are returned...

`code_quality:read`

List Code Quality Findings For A Repository`aikido_list_code_quality_full_repo_findings`

Returns a paginated list of code quality findings for a repository. Findings represent repository state across full-repo...

`code_quality:read`

Get CIS AWS Compliance Overview`aikido_get_cis_aws_compliance_overview`

Returns the CIS AWS compliance overview in JSON format. This endpoint is available on all paid plans.

`reports:read`

Get CIS Compliance Overview`aikido_get_cis_compliance_overview`

Returns the CIS compliance overview in JSON format. This endpoint is available on all paid plans.

`reports:read`

Get DORA Compliance Overview`aikido_get_dora_compliance_overview`

Returns the DORA compliance overview in JSON format. This endpoint is available on all paid plans.

`reports:read`

Get FedRAMP DAST Report`aikido_get_fedramp_dast_report`

Returns the 'Domains & API - FedRAMP report' as an OSCAL v1.1.2 assessment-results (SAR) document, covering all domains...

`reports:read`

Get GDPR Compliance Overview`aikido_get_gdpr_compliance_overview`

Returns the GDPR compliance overview in JSON format. This endpoint is available on all paid plans.

`reports:read`

Get ISO Compliance Overview`aikido_get_iso_compliance_overview`

Returns the ISO compliance overview in JSON format. This endpoint is available on all paid plans.

`reports:read`

Get NIS2 Compliance Overview`aikido_get_nis2_compliance_overview`

Returns the NIS2 compliance overview in JSON format. This endpoint is available on all paid plans.

`reports:read`

Get PCI Compliance Overview`aikido_get_pci_compliance_overview`

Returns the PCI compliance overview in JSON format. This endpoint is available on all paid plans.

`reports:read`

Get SOC 2 Compliance Overview`aikido_get_soc2_compliance_overview`

Returns the SOC2 compliance overview in JSON format. This endpoint is available on all paid plans.

`reports:read`

Activate Container`aikido_activate_container`

Activate container

`containers:write`

Add Azure Container Registry`aikido_add_azure_container_registry`

Add Azure container registry to Aikido to scan

`containers:write`

Add Container Label`aikido_add_container_label`

Add a label to a container repository

`containers:write`

Add GCP Artifact Registry`aikido_add_gcp_artifact_registry`

Add GCP Artifact Registry to Aikido to scan

`containers:write`

Add GitLab Self-Managed Container Registry`aikido_add_gitlab_self_managed_container_registry`

Add a GitLab Self-Managed (self-hosted) container registry to Aikido to scan

`containers:write`

Add Public Container`aikido_add_public_container`

Add public container image to Aikido to scan, such as nginx:latest

`containers:write`

Clone Container`aikido_clone_container`

Clone container with a specific tag filter

`containers:write`

Deactivate Container`aikido_deactivate_container`

Deactivate container

`containers:write`

Delete Container`aikido_delete_container`

Delete public or self-reported SBOM container

`containers:write`

Export Container Repo Licenses`aikido_export_container_repo_licenses`

Returns an overview of all packages & licenses found in a container

`repositories:read`

Export Raw SBOM`aikido_export_raw_container_sbom`

Returns the latest uploaded SBOM of a container with all metadata collected.

`containers:read`

Generate Bulk SBOM`aikido_generate_container_sbom`

Returns an SBOM of all packages & licenses found in specified containers

`repositories:write`

Get Container Registry`aikido_get_container_registry`

Returns the requested container registry

`containers:read`

Get Container`aikido_get_container_repo`

Returns the requested container repository

`containers:read`

Link Code Repository To Container`aikido_link_code_repo_to_container`

Link code repository to container

`containers:write`

List Container Runners`aikido_list_container_repo_runners`

Returns a list of places where a container image runs, such as AWS lambdas, AWS ECS, Azure Jobs, Kubernetes pods,..

`containers:read`

List Containers`aikido_list_container_repos`

Returns a list of all the active container repositories in your account

`repositories:read`

Remove Container Label`aikido_remove_container_label`

Remove a label from a container repository

`containers:write`

Scan Container`aikido_scan_container`

Scan a container

`containers:write`

Unlink Code Repository From Container`aikido_unlink_code_repo_to_container`

Unlink code repository from container

`containers:write`

Update Container Internet Connection`aikido_update_container_internet_connection`

Update container connectivity status

`containers:write`

Update Container Label`aikido_update_container_label`

Update a label for a container repository

`containers:write`

Update Container Sensitivity`aikido_update_container_sensitivity`

Update container sensitivity

`containers:write`

Update Container Tag Filter`aikido_update_tag_filter`

Update the tag filter used for the container scanning

`containers:write`

Upload Container SBOM`aikido_upload_container_sbom`

Upload a self-generated SBOM

`containers:write`

Create Custom Rule`aikido_create_custom_rule`

Create a new custom semgrep rule

`custom_sast_rules:write`

Edit Custom Rule`aikido_edit_custom_rule`

Edit a custom semgrep rule

`custom_sast_rules:write`

Get Custom Rule`aikido_get_custom_rule`

Get a custom semgrep rule

`custom_sast_rules:read`

List Custom Rules`aikido_list_custom_rules`

List custom semgrep rules

`custom_sast_rules:read`

Remove Custom Rule`aikido_remove_custom_rule`

Remove a custom semgrep rule

`custom_sast_rules:write`

Add Subdomain`aikido_add_subdomain`

Add a subdomain to a attack surface domain

`domains:write`

Create Domain`aikido_create_domain`

Create a new domain

`domains:write`

List Data Leaks`aikido_list_dataleaks`

List leaked credentials (data leaks) found for an attack surface domain

`domains:read`

List Domains`aikido_list_domains`

Returns a list of all the active domains connected in your account

`domains:read`

List Subdomains`aikido_list_subdomains`

List all the subdomains for a attack surface domain

`domains:read`

Remove Domain`aikido_remove_domain`

Removes a domain with a specified id

`domains:write`

Remove Subdomain`aikido_remove_subdomain`

Removes a subdomain from a attack surface domain

`domains:write`

Start Scan For A Domain`aikido_start_domain_scan`

Start scan for a domain

`domains:write`

Update Auth Headers`aikido_update_domain_authentication_headers`

Update Authentication Headers for a Domain

`domains:write`

Update Custom Scan Headers`aikido_update_domain_custom_scan_headers`

Update Custom Scan Headers for a Domain

`domains:write`

Update OpenAPI Spec`aikido_update_domain_open_api_spec`

Updates the OpenAPI spec of a domain with a specified id

`domains:write`

Update Scan Frequency`aikido_update_domain_scan_frequency`

Sets how often Aikido scans a domain.

`domains:write`

Add Endpoint Exception`aikido_add_endpoint_protection_exception`

Adds an exception to the endpoint protection settings

`endpoint_protection:write`

List Endpoint Activity Logs`aikido_list_endpoint_protection_activity_logs`

Returns a paginated list of endpoint protection activity log items

`endpoint_protection:read`

List Endpoint Devices`aikido_list_endpoint_protection_devices`

Returns a list of all the endpoint protection devices

`endpoint_protection:read`

List Endpoint Exceptions`aikido_list_endpoint_protection_exceptions`

Returns a list of all the endpoint protection exceptions

`endpoint_protection:read`

List Installed Packages`aikido_list_endpoint_protection_installed_packages`

Returns a list of all the installed packages

`endpoint_protection:read`

List Endpoint Permission Groups`aikido_list_endpoint_protection_permission_groups`

Returns a list of all the endpoint protection permission groups

`endpoint_protection:read`

Remove Endpoint Device`aikido_remove_endpoint_protection_device`

Removes a device from endpoint protection

`endpoint_protection:write`

Remove Endpoint Exception`aikido_remove_endpoint_protection_exception`

Removes an exception from the endpoint protection settings

`endpoint_protection:write`

Add Note To Issue Group`aikido_add_note_to_issue_group`

Add note to issue group

`issues:write`

Adjust Severity Of An Issue Group`aikido_adjust_group_severity`

Adjust severity of an issue group to 'critical', 'high', 'medium' or 'low'

`issues:write`

Adjust Severity Of An Issue`aikido_adjust_severity`

Adjust severity of a single issue to 'critical', 'high', 'medium' or 'low'

`issues:write`

Export All Issues`aikido_export_issues`

Returns a list of all issues (open, ignored, snoozed, closed,..) in your account in JSON or CSV format

`issues:read`

Get Issue`aikido_get_issue`

Returns the details of a single issue

`issues:read`

Get Issue Counts`aikido_get_issue_counts`

Returns the total number of open issues

`issues:read`

Get Issue CVE Exploitability`aikido_get_issue_cve_exploitability`

Returns the CVE exploitability analysis results for a single issue

`issues:read`

Get Issue CVE Exploitability Bulk`aikido_get_issue_cve_exploitability_bulk`

Returns the CVE exploitability analysis results for multiple issues

`issues:read`

Get Issue Details Bulk`aikido_get_issue_details_bulk`

Returns the details of multiple issues. This feature needs to be enabled by Aikido support before it can be used.

`issues:read`

Get Issue Group`aikido_get_issue_group`

Returns the details of an issue group

`issues:read`

Get Issue Reachability`aikido_get_issue_reachability`

Returns the reachability of a single issue

`issues:read`

Ignore Issue`aikido_ignore_issue`

Ignore an issue

`issues:write`

Ignore Issue Group`aikido_ignore_issue_group`

Ignore an issue group

`issues:write`

List Notes For Issue Group`aikido_list_notes_for_issue_group`

List notes for an issue group

`issues:read`

List Open Issue Groups`aikido_list_open_issue_groups`

Returns a list of all the open issue groups in your account, as seen in the feed. Use the result's next field for pagina...

`issues:read`

Snooze Issue`aikido_snooze_issue`

Snooze an issue for a given period

`issues:write`

Snooze Issue Group`aikido_snooze_issue_group`

Snooze an issue group for a given period

`issues:write`

Solve Issue`aikido_solve_issue`

Solve an issue

`issues:write`

Unignore Issue`aikido_unignore_issue`

Unignore an issue

`issues:write`

Unignore Issue Group`aikido_unignore_issue_group`

Unignore an issue group

`issues:write`

Unsnooze Issue`aikido_unsnooze_issue`

Unsnooze an issue for a given period

`issues:write`

Unsnooze Issue Group`aikido_unsnooze_issue_group`

Unsnooze an issue group

`issues:write`

List Licenses`aikido_list_licenses`

Returns a list of licenses

`licenses:read`

Mark License As Internal`aikido_mark_license_as_internal_for_package`

Mark licenses for a package as internally developed. Aikido will no longer show these licenses as a risk.

`licenses:write`

Overwrite License`aikido_overwrite_license_for_package`

Overwrite License For Package

`licenses:write`

Get Latest Local Scanner Version`aikido_get_latest_local_scan_info`

Returns information about the latest local scanner

Create Pentest Draft`aikido_create_pentest_draft_assessment`

Create a new draft pentest assessment. The project will be created if it doesn't exist. You can either provide existing...

`pentests:write`

Get Attack Analysis`aikido_get_attack_analysis`

Get attack analysis for a specific pentest issue

`pentests:read`

Get Pentest Assessment`aikido_get_pentest_assessment`

Get detailed information about a specific pentest assessment including status, progress, and issue count

`pentests:read`

List AI Code Analysis Assessments`aikido_list_code_audits`

Returns all AI Code Analysis (code audit) assessments in your account, newest first.

`pentests:read`

List Pentest Assessments`aikido_list_pentest_assessments`

Returns all pentest assessments in your account, newest first. Draft assessments are not included.

`pentests:read`

Get CI Scan`aikido_get_ci_scan`

Returns the details and results of a PR check.

`reports:read`

Get Default PR Checks Configuration`aikido_get_default_pr_checks_configuration`

Returns the workspace default PR Checks configuration. This configuration is applied to newly activated repositories tha...

`repositories:read`

List PR Check Manual Actions`aikido_list_ci_scan_issue_actions`

Returns all manual ignores or snoozes actions taken on issues flagged in PRs

`reports:read`

List PR Checks`aikido_list_ci_scans`

Returns PR checks

`reports:read`

List PR Checks Configurations`aikido_list_pr_checks_configurations`

Returns a paginated list of all the CI checks configurations in your account

`repositories:read`

Configure Default PR Checks`aikido_save_default_pr_checks_configuration`

Create or update the workspace default PR Checks configuration. This configuration is applied to newly activated reposit...

`repositories:write`

Configure PR Checks`aikido_save_pr_checks_configuration`

Configure PR Checks

`repositories:write`

Configure PR Checks For All Repos`aikido_save_pr_checks_configuration_for_all_repos`

Configure PR Checks for all active repositories in the account. Currently only supports GitHub.

`repositories:write`

Export PDF Report`aikido_export_report_pdf`

Returns a report as a pdf

`reports:read`

List Activity Log`aikido_list_activity_log`

Returns the activity log items

`reports:read`

List Cloud Rules`aikido_list_cloud_rules`

List cloud rules. Requires scope clouds:read

`clouds:read`

List IaC Rules`aikido_list_iac_rules`

List IaC rules. Requires scope repositories:read

`repositories:read`

List Mobile Rules`aikido_list_mobile_rules`

List Mobile rules. Requires scope repositories:read

`repositories:read`

List SAST Rules`aikido_list_sast_rules`

List SAST rules. Requires scope repositories:read

`repositories:read`

Add Exclude Path To A Code Repo`aikido_add_code_repo_exclude_path`

Add an exclude path to a code repo

`repositories:write`

Add Code Repo Label`aikido_add_code_repo_label`

Add a label to a code repository

`repositories:write`

Manage Private Registry`aikido_add_private_registry`

Add or update your private package registry connection, such as a private NPM or Maven package registry.

`repositories:write`

Clone Code Repo`aikido_clone_code_repo`

Clone code repo for multi branch scanning

`repositories:write`

Deactivate Code Repo`aikido_deactivate_code_repo`

Deactivate code repo

`repositories:write`

Delete Code Repo`aikido_delete_code_repo`

Delete code repo. Only supported for selfscanned or cloned repositories.

`repositories:write`

Export Code Repo Licenses`aikido_export_code_repo_licenses`

Returns an overview of all packages & licenses found in a code repository

`repositories:read`

Export SBOM For Team`aikido_export_code_repo_licenses_for_team`

Only available for Scale plan workspaces! Returns an overview of all packages & licenses found in code repositories link...

`repositories:read`

Get Code Repo`aikido_get_code_repo`

Returns the details of a code repository

`repositories:read`

Import New Code Repositories`aikido_import_new_code_repositories`

Triggers a code repositories sync with your Git provider

`repositories:write`

List Code Repositories`aikido_list_code_repos`

Returns a list of all the active code repositories in your account

`repositories:read`

Remove Exclude Path From A Code Repo`aikido_remove_code_repo_exclude_path`

Remove an exclude path from a code repo

`repositories:write`

Remove Code Repo Label`aikido_remove_code_repo_label`

Remove a label from a code repository

`repositories:write`

Scan Code Repo`aikido_scan_code_repo`

Scan a code repository

`repositories:write`

Set Environment Variables`aikido_set_environment_variables`

Add or update environment variables, including Gradle private registry variables such as ORG\_GRADLE\_PROJECT\_\*. An enviro...

`repositories:write`

Update Code Repo Connectivity`aikido_update_code_repo_connectivity`

Update code repository connectivity

`repositories:write`

Manage Dev Dep Scanning`aikido_update_code_repo_dev_dep_scan`

Update code repository dev dependency scanning

`repositories:write`

Update Code Repo Label`aikido_update_code_repo_label`

Update a label for a code repository

`repositories:write`

Update Code Repo Sensitivity`aikido_update_code_repo_sensitivity`

Update code repository sensitivity

`repositories:write`

List User Requests`aikido_list_user_requests`

Returns a paginated list of user requests in your account.

`request_inbox:read`

Review User Request`aikido_review_user_request`

Reviews a user request

`request_inbox:write`

Get Changelog Summary`aikido_get_changelog_summary`

Get changelog summary for package

`research:read`

Get CVE Details`aikido_get_cve_details`

Get details about a CVE

`research:read`

Get Package Health Scores`aikido_get_package_health_bulk`

Returns a health score and summary for each requested package version that has been scored. Packages must use the name\@v...

`research:read`

List CWE Descriptions`aikido_list_cwe_descriptions`

Returns the CWE class and description for every CWE Aikido tracks.

`research:read`

List End-of-life Runtimes`aikido_list_eol_runtimes`

Returns the global end-of-life catalog for runtimes, frameworks, and operating systems. This is reference data, not the...

`research:read`

List Malware Packages`aikido_list_malware_packages`

Get malware packages

`research:read`

Get Task Tracking Project Mapping`aikido_get_task_tracking_project_mapping`

Get project mapping

`task_tracking:read`

Link Existing Task To Issue`aikido_link_task_to_issue_group`

Link existing task to issue group

`task_tracking:write`

List Issue Group Tasks`aikido_list_issue_group_tasks`

Returns the tasks related to an issue group

`issues:read`

List Task Tracking Integrations`aikido_list_task_tracking_integrations`

List task tracking integrations

`task_tracking:read`

List Task Tracking Project Tasks`aikido_list_task_tracking_project_tasks`

List tasks live from the integrated task tracker

`task_tracking:read`

List Task Tracking Projects`aikido_list_task_tracking_projects`

List task tracking projects

`task_tracking:read`

Map Code Repo To Task Tracking Projects`aikido_map_repos_to_project`

Map code repo to task tracking projects. Make sure the mapping mode is set to 'repos' in the task tracker settings.

`task_tracking:write`

Map Teams To Task Tracking Projects`aikido_map_teams_to_project`

Map teams to task tracking projects. Make sure the mapping mode is set to 'teams' in the task tracker settings.

`task_tracking:write`

Add User To Team`aikido_add_user_to_team`

Add user to team

`teams:write`

Create Team`aikido_create_team`

Create a new team

`teams:write`

Delete Team`aikido_delete_team`

Delete a non-imported team

`teams:write`

Link Resource To Team`aikido_link_resource_to_team`

Link resource to team

`teams:write`

List Teams`aikido_list_teams`

Returns a list of all the teams in your account

`teams:read`

Remove User From Team`aikido_remove_user_from_team`

Remove user from team

`teams:write`

Unlink Resource From Team`aikido_unlink_resource_from_team`

Unlink resource from team

`teams:write`

Update Team`aikido_update_team`

Update an existing team

`teams:write`

Update Repository Path Limitation For A Team`aikido_update_team_repo_path_limitation`

Update the path limitations for a repository that is already linked to a team. This works for both manually created and...

`teams:write`

Disable User`aikido_disable_user`

Disable (remove from the workspace) the specified user

`users:write`

Get User`aikido_get_user`

Returns the specified user details

`users:read`

List IDE Adoption`aikido_list_ide_adoption`

Returns a list of all the users that have an active IDE token

`users:read`

List Pending Invites`aikido_list_pending_invites`

Returns unused user invites that have not been accepted yet. Includes email invites and shareable link invites.

`users:read`

List User Login History`aikido_list_user_login_history`

Returns a paginated list of user login events in your workspace, newest first.

`users:read`

List Users`aikido_list_users`

Returns a list of all the users

`users:read`

Update User Rights`aikido_update_user_rights`

Update the specified user rights

`users:write`

Export Virtual Machine SBOM`aikido_export_virtual_machine_sbom`

Returns a SBOM of a virtual machine

`virtual_machines:read`

List Virtual Machines`aikido_list_virtual_machines`

Returns a list of all the virtual machines in your account

`virtual_machines:read`

Add Webhook`aikido_add_webhook`

Add webhook

`webhooks:write`

List Webhooks`aikido_list_webhooks`

List webhooks

`webhooks:read`

Remove Webhook`aikido_remove_webhook`

Remove webhook

`webhooks:write`

Get SLA Settings`aikido_get_sla_settings`

Returns the SLA settings for the workspace

`basics:read`

Get Wallet Balance`aikido_get_wallet_balance`

Returns the current credit balance of the workspace's wallet

`basics:read`

Get Workspace Configuration Errors`aikido_get_workspace_configuration_errors`

Returns the configuration errors of the workspace

`basics:read`

Get Workspace Info`aikido_get_workspace_info`

Returns information about the workspace of the client

`basics:read`

Create Zen App`aikido_create_zen_app`

Create a new Zen app

`firewall:write`

Delete Zen App`aikido_delete_zen_app`

Delete a Zen app

`firewall:write`

Get Zen App`aikido_get_zen_app`

Get a Zen app

`firewall:read`

Get Zen App Bot Lists`aikido_get_zen_app_bot_lists`

Get the bot lists configuration for an app

`firewall:read`

Get Zen App Countries`aikido_get_zen_app_countries`

Get the country-based IP blocking configuration for an app

`firewall:read`

Get Zen App Event`aikido_get_zen_app_event`

Get a Zen event

`firewall:read`

Get Zen App IP Lists`aikido_get_zen_app_ip_lists`

Get the IP lists configuration for an app including known threat actors and Tor settings

`firewall:read`

List Zen App Users`aikido_list_zen_app_users`

List the users for a Zen app

`firewall:read`

List Zen Apps`aikido_list_zen_apps`

List Zen apps

`firewall:read`

Rotate Zen App Token`aikido_rotate_zen_app_token`

Creates a new token and revokes the current token if it exists for a Zen app

`firewall:write`

Update Zen App`aikido_update_zen_app`

Update an existing Zen app

`firewall:write`

Update Zen App Blocking`aikido_update_zen_app_blocking`

Enable or disable blocking mode for a Zen app

`firewall:write`

Update Zen App Bot Lists`aikido_update_zen_app_bot_lists`

Update the bot lists configuration for an app

`firewall:write`

Update Zen App Countries`aikido_update_zen_app_countries`

Update the country-based IP blocking configuration for an app

`firewall:write`

Update Zen App IP Blocklist`aikido_update_zen_app_ip_blocklist`

Set the custom IP blocklist for an app. This will replace the existing blocklist with the new one.

`firewall:write`

Update Zen App IP Lists`aikido_update_zen_app_ip_lists`

Update the IP lists configuration for an app including known threat actors and Tor settings. This endpoint supports part...

`firewall:write`

Update Zen App User`aikido_update_zen_app_user`

Update blocking status of a user

`firewall:write`


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.