Skip to main content
Aikido
Previewv0.1.0
212 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.
2

Configure the Connector

Enable the connector and set up a Connector Profile in your project. See Setup Connector Profile.

Connector Profile · OAuth 2.0 - Client Credentials

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 (or via StackOne Hub).See the guide for the authentication type chosen in the Connector Profile:

Link Account · OAuth 2.0 - Client Credentials

4

Use Actions

Connect an AI platform to the linked account’s actions. See AI Platforms.Other ways to call actions are listed in Protocols & SDKs.

Actions

|
212 actions
Action
Description
Required scopes
Update Code Scanning Access Token
Update the access token used for code scanning.
Get Container AutoFix PR Creation Settings
Get the workspace container AutoFix PR creation settings. Container selection is returned as containers_scope (“all” or…
Get Dependency AutoFix PR Creation Settings
Get the workspace dependency AutoFix PR creation settings. Repository selection is returned as repos_scope (“all” or “se…
Get Pentest AutoFix PR Creation Settings
Get the workspace Pentest & AI Code Analysis AutoFix PR creation settings. Repository selection is returned as repos_sco…
Get SAST AutoFix Settings
Get the workspace SAST & IaC AutoFix PR creation settings. Repository selection is returned as repos_scope (“all” or “se…
List Aikido Images
Returns a paginated list of Aikido images in your account.
List AutoFix History
Returns a paginated list of autofix tasks in your account. Use the result’s next field for pagination.
List Issues Addressed By A Task
Returns the issues that an autofix task was trying to solve. Use the autofix task ID (the id field) from the /autofix/…
List Hardened Image Requests
Returns the list of hardened image requests that have been submitted for your account, including their current status.
Request Hardened Image
Request that a specific image tag be secured. The request is recorded and does not trigger an immediate rebuild.
Update Container AutoFix PR Creation Settings
Update the workspace container AutoFix PR creation settings. PRs are created and re-evaluated every day.
Update Dependency AutoFix PR Creation Settings
Update the workspace dependency AutoFix PR creation settings. PRs are created and re-evaluated every day. Use severity_f…
Update Pentest AutoFix PR Creation Settings
Update the workspace Pentest & AI Code Analysis AutoFix PR creation settings. PRs are created and re-evaluated every day…
Update SAST AutoFix Settings
Update the workspace SAST & IaC AutoFix PR creation settings. PRs are created and re-evaluated every day. Use severity_f…
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…
Delete Broker Resource URL
Removes a resource URL from a broker app
List Broker Apps
Returns a list of all broker apps in your account, including their mapped resource URLs.
Validate Bug Bounty Report
Validates a new bug bounty report for a given program.
Connect AWS Cloud
Connect a new AWS cloud environment
Connect Azure Cloud
Connect GCP Cloud
Create Kubernetes Cloud
Connect your Kubernetes cluster to Aikido. This will register a cluster and return the agent token needed for installati…
List Cloud Assets
Returns cloud assets for the connected clouds in your account. Supports pagination, filtering and search parameters simi…
List Connected Clouds
Returns a list of all the active clouds connected in your account
Remove Cloud
Removes a cloud with a specified id
Update Azure Cloud
Update the credentials for an Azure cloud
Get Code Coverage For A Repository
Returns the latest code coverage summary for a repository. Optionally filter by branch name. When no branch is provided,…
List All Code Coverage Repositories
Returns a paginated list of repositories that have code coverage results. Optionally filter by branch name. When no bran…
Ignore Code Quality Finding
Ignores an open code quality finding. Use the finding id returned by the repo-findings list endpoint.
List Code Quality Findings For A Pull Request
Returns a list of code quality findings for a specific pull request. Only the findings from the latest scan are returned…
List Code Quality Findings For A Repository
Returns a paginated list of code quality findings for a repository. Findings represent repository state across full-repo…
Get CIS AWS Compliance Overview
Returns the CIS AWS compliance overview in JSON format. This endpoint is available on all paid plans.
Get CIS Compliance Overview
Returns the CIS compliance overview in JSON format. This endpoint is available on all paid plans.
Get DORA Compliance Overview
Returns the DORA compliance overview in JSON format. This endpoint is available on all paid plans.
Get FedRAMP DAST Report
Returns the ‘Domains & API - FedRAMP report’ as an OSCAL v1.1.2 assessment-results (SAR) document, covering all domains…
Get GDPR Compliance Overview
Returns the GDPR compliance overview in JSON format. This endpoint is available on all paid plans.
Get ISO Compliance Overview
Returns the ISO compliance overview in JSON format. This endpoint is available on all paid plans.
Get NIS2 Compliance Overview
Returns the NIS2 compliance overview in JSON format. This endpoint is available on all paid plans.
Get PCI Compliance Overview
Returns the PCI compliance overview in JSON format. This endpoint is available on all paid plans.
Get SOC 2 Compliance Overview
Returns the SOC2 compliance overview in JSON format. This endpoint is available on all paid plans.
Activate Container
Activate container
Add Azure Container Registry
Add Azure container registry to Aikido to scan
Add Container Label
Add a label to a container repository
Add GCP Artifact Registry
Add GCP Artifact Registry to Aikido to scan
Add GitLab Self-Managed Container Registry
Add a GitLab Self-Managed (self-hosted) container registry to Aikido to scan
Add Public Container
Add public container image to Aikido to scan, such as nginx:latest
Clone Container
Clone container with a specific tag filter
Deactivate Container
Deactivate container
Delete Container
Delete public or self-reported SBOM container
Export Container Repo Licenses
Returns an overview of all packages & licenses found in a container
Export Raw SBOM
Returns the latest uploaded SBOM of a container with all metadata collected.
Generate Bulk SBOM
Returns an SBOM of all packages & licenses found in specified containers
Get Container Registry
Returns the requested container registry
Get Container
Returns the requested container repository
Link Code Repository To Container
Link code repository to container
List Container Runners
Returns a list of places where a container image runs, such as AWS lambdas, AWS ECS, Azure Jobs, Kubernetes pods,..
List Containers
Returns a list of all the active container repositories in your account
Remove Container Label
Remove a label from a container repository
Scan Container
Scan a container
Unlink Code Repository From Container
Unlink code repository from container
Update Container Internet Connection
Update container connectivity status
Update Container Label
Update a label for a container repository
Update Container Sensitivity
Update container sensitivity
Update Container Tag Filter
Update the tag filter used for the container scanning
Upload Container SBOM
Upload a self-generated SBOM
Create Custom Rule
Create a new custom semgrep rule
Edit Custom Rule
Edit a custom semgrep rule
Get Custom Rule
Get a custom semgrep rule
List Custom Rules
List custom semgrep rules
Remove Custom Rule
Remove a custom semgrep rule
Add Subdomain
Add a subdomain to a attack surface domain
Create Domain
Create a new domain
List Data Leaks
List leaked credentials (data leaks) found for an attack surface domain
List Domains
Returns a list of all the active domains connected in your account
List Subdomains
List all the subdomains for a attack surface domain
Remove Domain
Removes a domain with a specified id
Remove Subdomain
Removes a subdomain from a attack surface domain
Start Scan For A Domain
Start scan for a domain
Update Auth Headers
Update Authentication Headers for a Domain
Update Custom Scan Headers
Update Custom Scan Headers for a Domain
Update OpenAPI Spec
Updates the OpenAPI spec of a domain with a specified id
Update Scan Frequency
Sets how often Aikido scans a domain.
Add Endpoint Exception
Adds an exception to the endpoint protection settings
List Endpoint Activity Logs
Returns a paginated list of endpoint protection activity log items
List Endpoint Devices
Returns a list of all the endpoint protection devices
List Endpoint Exceptions
Returns a list of all the endpoint protection exceptions
List Installed Packages
Returns a list of all the installed packages
List Endpoint Permission Groups
Returns a list of all the endpoint protection permission groups
Remove Endpoint Device
Removes a device from endpoint protection
Remove Endpoint Exception
Removes an exception from the endpoint protection settings
Add Note To Issue Group
Add note to issue group
Adjust Severity Of An Issue Group
Adjust severity of an issue group to ‘critical’, ‘high’, ‘medium’ or ‘low’
Adjust Severity Of An Issue
Adjust severity of a single issue to ‘critical’, ‘high’, ‘medium’ or ‘low’
Export All Issues
Returns a list of all issues (open, ignored, snoozed, closed,..) in your account in JSON or CSV format
Get Issue
Returns the details of a single issue
Get Issue Counts
Returns the total number of open issues
Get Issue CVE Exploitability
Returns the CVE exploitability analysis results for a single issue
Get Issue CVE Exploitability Bulk
Returns the CVE exploitability analysis results for multiple issues
Get Issue Details Bulk
Returns the details of multiple issues. This feature needs to be enabled by Aikido support before it can be used.
Get Issue Group
Returns the details of an issue group
Get Issue Reachability
Returns the reachability of a single issue
Ignore Issue
Ignore an issue
Ignore Issue Group
Ignore an issue group
List Notes For Issue Group
List notes for an issue group
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…
Snooze Issue
Snooze an issue for a given period
Snooze Issue Group
Snooze an issue group for a given period
Solve Issue
Solve an issue
Unignore Issue
Unignore an issue
Unignore Issue Group
Unignore an issue group
Unsnooze Issue
Unsnooze an issue for a given period
Unsnooze Issue Group
Unsnooze an issue group
List Licenses
Returns a list of licenses
Mark License As Internal
Mark licenses for a package as internally developed. Aikido will no longer show these licenses as a risk.
Overwrite License
Overwrite License For Package
Get Latest Local Scanner Version
Returns information about the latest local scanner
Create Pentest Draft
Create a new draft pentest assessment. The project will be created if it doesn’t exist. You can either provide existing…
Get Attack Analysis
Get attack analysis for a specific pentest issue
Get Pentest Assessment
Get detailed information about a specific pentest assessment including status, progress, and issue count
List AI Code Analysis Assessments
Returns all AI Code Analysis (code audit) assessments in your account, newest first.
List Pentest Assessments
Returns all pentest assessments in your account, newest first. Draft assessments are not included.
Get CI Scan
Returns the details and results of a PR check.
Get Default PR Checks Configuration
Returns the workspace default PR Checks configuration. This configuration is applied to newly activated repositories tha…
List PR Check Manual Actions
Returns all manual ignores or snoozes actions taken on issues flagged in PRs
List PR Checks
Returns PR checks
List PR Checks Configurations
Returns a paginated list of all the CI checks configurations in your account
Configure Default PR Checks
Create or update the workspace default PR Checks configuration. This configuration is applied to newly activated reposit…
Configure PR Checks
Configure PR Checks
Configure PR Checks For All Repos
Configure PR Checks for all active repositories in the account. Currently only supports GitHub.
Export PDF Report
Returns a report as a pdf
List Activity Log
Returns the activity log items
List Cloud Rules
List cloud rules. Requires scope clouds:read
List IaC Rules
List IaC rules. Requires scope repositories:read
List Mobile Rules
List Mobile rules. Requires scope repositories:read
List SAST Rules
List SAST rules. Requires scope repositories:read
Add Exclude Path To A Code Repo
Add an exclude path to a code repo
Add Code Repo Label
Add a label to a code repository
Manage Private Registry
Add or update your private package registry connection, such as a private NPM or Maven package registry.
Clone Code Repo
Clone code repo for multi branch scanning
Deactivate Code Repo
Deactivate code repo
Delete Code Repo
Delete code repo. Only supported for selfscanned or cloned repositories.
Export Code Repo Licenses
Returns an overview of all packages & licenses found in a code repository
Export SBOM For Team
Only available for Scale plan workspaces! Returns an overview of all packages & licenses found in code repositories link…
Get Code Repo
Returns the details of a code repository
Import New Code Repositories
Triggers a code repositories sync with your Git provider
List Code Repositories
Returns a list of all the active code repositories in your account
Remove Exclude Path From A Code Repo
Remove an exclude path from a code repo
Remove Code Repo Label
Remove a label from a code repository
Scan Code Repo
Scan a code repository
Set Environment Variables
Add or update environment variables, including Gradle private registry variables such as ORG_GRADLE_PROJECT_*. An enviro…
Update Code Repo Connectivity
Update code repository connectivity
Manage Dev Dep Scanning
Update code repository dev dependency scanning
Update Code Repo Label
Update a label for a code repository
Update Code Repo Sensitivity
Update code repository sensitivity
List User Requests
Returns a paginated list of user requests in your account.
Review User Request
Reviews a user request
Get Changelog Summary
Get changelog summary for package
Get CVE Details
Get details about a CVE
Get Package Health Scores
Returns a health score and summary for each requested package version that has been scored. Packages must use the name@v…
List CWE Descriptions
Returns the CWE class and description for every CWE Aikido tracks.
List End-of-life Runtimes
Returns the global end-of-life catalog for runtimes, frameworks, and operating systems. This is reference data, not the…
List Malware Packages
Get malware packages
Get Task Tracking Project Mapping
Get project mapping
Link Existing Task To Issue
Link existing task to issue group
List Issue Group Tasks
Returns the tasks related to an issue group
List Task Tracking Integrations
List task tracking integrations
List Task Tracking Project Tasks
List tasks live from the integrated task tracker
List Task Tracking Projects
List task tracking projects
Map Code Repo To Task Tracking Projects
Map code repo to task tracking projects. Make sure the mapping mode is set to ‘repos’ in the task tracker settings.
Map Teams To Task Tracking Projects
Map teams to task tracking projects. Make sure the mapping mode is set to ‘teams’ in the task tracker settings.
Add User To Team
Add user to team
Create Team
Create a new team
Delete Team
Delete a non-imported team
Link Resource To Team
Link resource to team
List Teams
Returns a list of all the teams in your account
Remove User From Team
Remove user from team
Unlink Resource From Team
Unlink resource from team
Update Team
Update an existing team
Update Repository Path Limitation For A Team
Update the path limitations for a repository that is already linked to a team. This works for both manually created and…
Disable User
Disable (remove from the workspace) the specified user
Get User
Returns the specified user details
List IDE Adoption
Returns a list of all the users that have an active IDE token
List Pending Invites
Returns unused user invites that have not been accepted yet. Includes email invites and shareable link invites.
List User Login History
Returns a paginated list of user login events in your workspace, newest first.
List Users
Returns a list of all the users
Update User Rights
Update the specified user rights
Export Virtual Machine SBOM
Returns a SBOM of a virtual machine
List Virtual Machines
Returns a list of all the virtual machines in your account
Add Webhook
Add webhook
List Webhooks
List webhooks
Remove Webhook
Remove webhook
Get SLA Settings
Returns the SLA settings for the workspace
Get Wallet Balance
Returns the current credit balance of the workspace’s wallet
Get Workspace Configuration Errors
Returns the configuration errors of the workspace
Get Workspace Info
Returns information about the workspace of the client
Create Zen App
Create a new Zen app
Delete Zen App
Delete a Zen app
Get Zen App
Get a Zen app
Get Zen App Bot Lists
Get the bot lists configuration for an app
Get Zen App Countries
Get the country-based IP blocking configuration for an app
Get Zen App Event
Get a Zen event
Get Zen App IP Lists
Get the IP lists configuration for an app including known threat actors and Tor settings
List Zen App Users
List the users for a Zen app
List Zen Apps
List Zen apps
Rotate Zen App Token
Creates a new token and revokes the current token if it exists for a Zen app
Update Zen App
Update an existing Zen app
Update Zen App Blocking
Enable or disable blocking mode for a Zen app
Update Zen App Bot Lists
Update the bot lists configuration for an app
Update Zen App Countries
Update the country-based IP blocking configuration for an app
Update Zen App IP Blocklist
Set the custom IP blocklist for an app. This will replace the existing blocklist with the new one.
Update Zen App IP Lists
Update the IP lists configuration for an app including known threat actors and Tor settings. This endpoint supports part…
Update Zen App User
Update blocking status of a user