AIaikido

List & Search SBOM

Returns a list of licenses

get/licenses

Request

  • Base URL
    https://app.aikido.dev/api/public/v1
  • URL
    https://app.aikido.dev/api/public/v1/licenses
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://app.aikido.io/api/oauth/token scopes: licenses:read

Query parameters

pageinteger

The page number

per_pageinteger

The number of items per page

searchstring

The search term to filter on

Filter on this package names

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

A list of licenses

package_namestring

The full package name including the version

license_typestring

The license type

languagestring

The programming language of the package

code_repo_idinteger

The code repository ID

container_repo_idinteger

The container repository ID

locationstring

The location

purlstring

The PURL

Example response

[
  {
    "package_name": "jsonpath@1.1.1",
    "license_type": "-",
    "language": "js",
    "code_repo_id": 1,
    "container_repo_id": -1,
    "location": "/testsuite/blib/yarn.lock",
    "purl": "pkg:npm/jsonpath@1.1.1"
  },
  {
    "package_name": "json-bigint@1.0.0",
    "license_type": "-",
    "language": "js",
    "code_repo_id": 1,
    "container_repo_id": -1,
    "location": "/testsuite/blib/yarn.lock",
    "purl": "pkg:npm/json-bigint@1.0.0"
  }
]

Changes

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