AIaikido

Export SBOM For Team

Only available for Scale plan workspaces! Returns an overview of all packages & licenses found in code repositories linked to a specified team

get/repositories/code/team/{team_id}/licenses/export

Request

  • Base URL
    https://app.aikido.dev/api/public/v1
  • URL
    https://app.aikido.dev/api/public/v1/repositories/code/team/{team_id}/licenses/export
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://app.aikido.io/api/oauth/token scopes: repositories:read

Path parameters

team_idinteger required

The ID of the team

Query parameters

format'csv' | 'sbom' | 'sbom_spdx'

The format of the export

locationstring

The path to filter on

Filter all locations by path ending with this value. For example client/package-lock.json

language'dotnet' | 'java' | 'js' | 'go' | 'rust' | 'dart' | 'swift' | 'ruby' | 'R' | 'php' | 'python' | 'elixir' | 'c++' | 'lua'

Filter on this programming language

include_risk_reasoninteger

Flag to include risk reason in CSV export. 1 or 0 indicating true or false

scope'all' | 'only_dev_deps' | 'exclude_dev_deps'

Filter on this scope. 'all' returns all packages, 'only_dev_deps' only dev dependency packages, 'exclude_dev_deps' excludes dev dependency packages

Response

An overview of all licenses and packages found in code repositories linked to a team

unknown required

Example response

{
  "bomFormat": "CycloneDX",
  "specVersion": "1.4",
  "version": 1,
  "metadata": {
    "timestamp": "1998-07-04T16:20:00.069Z"
  },
  "components": [
    {
      "type": "library",
      "group": "",
      "name": "ghc-ShellCheck",
      "version": "0.3.5-1.el7",
      "licenses": [
        {
          "expression": "AGPLv3+"
        }
      ],
      "purl": ""
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.