API Endpoints

The Ion Channel REST API provides full access to almost all of the features that exist within the user interface. This allows you to create your own applications, integrate your build tools, and obtain information or make changes directly from th...

These endpoints provide the ability to retrieve the results of analyses and perform new analyses. Analyze Project - Initiates a new analysis of a single project. Analyze Projects - Initiates new analyses of one or more projects. Get Analysi...

These endpoints provide the ability to search for products and get information about those products. Get Products - Returns detailed information about the specified product(s). Get Latest Version for Dependency - Returns the latest version o...

These endpoints allow you to create new projects, update existing projects, and retrieve information on existing projects. Create Project - Creates a new project. Get Project - Retrieve the data of a single project. Get Projects - Retrieve th...

The report endpoints provide the ability to generate various reports about your projects and analyses. Get Digests - Retrieve the data of an analysis' digests. Get Exported Data - Retrieve a report for the specified projects. Get Portfolio ...

These endpoints provide information about a team's rulesets and provide the ability to create new rulesets. Create Ruleset - Creates a new ruleset. Get Rules - Returns all Ion Channel rules and their IDs. Get Ruleset - Returns information ...

Add Component - Add a new component to an existing SBOM. Create SBOM - Creates a new blank SBOM. Get Entity Overview For Entity - Returns the overview of a given entity. Get Metrics For Entity - Returns the metrics for a given entity. Get O...

These endpoints allow you to update teams and users and invite new users to a team. Invite Team User - Invites a new user to an existing team. Invite Team User The v1/teamUsers/inviteTeamUser endpoint will invite someone to an existing team.  ...

The vulnerability endpoints provide data on known vulnerabilities and what vulnerabilities may affect a given product. Get Affected Projects - Returns all of a team's projects that are affected by a specified vulnerability. Get Vulnerability ...