Azure DevOps Setup for Aikido CLI: Release Gating

The Aikido Security CI client allows you to integrate Aikido Security scans into CI pipelines. It helps ensure that security scans are part of your build process.

#1. Get API token

Go to the Continuous Integration Settings page.
Generate a token and copy. Note that you will only be able to view this token once.
Save this token as AIKIDO_CLIENT_API_KEY as a secret variable in your Azure DevOps pipeline by clicking Variables when editing the pipeline, adding a new variable and checking Keep this value secret.

#2. Create a new Azure DevOps pipeline

Navigate to Pipelines in the left hand navigation, click Pipelines and select New Pipeline or Create Pipeline. In the Configure step, select Starter Pipeline and replace its contents with this example:

Make sure that the scan is only triggered for your default branch. In the example below this is the 'main' branch. Adjust this if needed.

trigger:
  branches:
    include:
      - main

pool:
  vmImage: 'ubuntu-latest'

steps:
- task: UseNode@1
  displayName: 'Set up Node.js'
  inputs:
    version: '22.x'
    checkLatest: true

- bash: |
    npm install --global @aikidosec/ci-api-client
    aikido-api-client scan-release \
      "$(Build.Repository.Name)" \
      "$(Build.SourceVersion)" \
      --apikey "$AIKIDO_CLIENT_API_KEY" \
      --fail-on-sast-scan \
      --fail-on-iac-scan \
      --fail-on-secrets-scan
  workingDirectory: '$(Build.SourcesDirectory)'
  displayName: 'Run Aikido Scan'
  env:
    AIKIDO_CLIENT_API_KEY: $(AIKIDO_CLIENT_API_KEY)

Tweak the command if needed. Every flag is documented on the @aikidosec/ci-api-client package.

#3. Run your first scan

When a new change is pushed to your default branch, the pipeline will be triggered. A scan will run and fail if new issues have been detected.