Ion Channel API Documentation

AddAlias

AddAlias allows the user to attach an alias to a project. Consists of org, name, version. Requires team id and project id.

v1/project/addAlias

AnalysisGetAnalysis

AnalysisGetAnalysis returns a single raw analysis. Requires team id, project id and analysis id.

v1/animal/getAnalysis

AnalysisGetAnalyses

AnalysisGetAnalyses returns multiple raw analyses. Requires team id and project id.

v1/animal/getAnalyses

AnalysisGetLatestAnalysisIDs

AnalysisGetLatestAnalysisIDs returns the latest analysis summary. Requires team id, project ID(s) optional

v1/animal/getLatestAnalysisIDs

AnalysisGetLatestAnalysisSummary

AnalysisGetLatestAnalysisSummary returns the latest analysis summary. Requires team id and project id.

v1/animal/getLatestAnalysisSummary

AnalysisGetLatestAnalysisSummaries

AnalysisGetLatestAnalysisSummaries returns the latest analysis summaries for multiple projects. Requires team id and project id.

v1/animal/getLatestAnalysisSummaries

AnalysisGetPublicAnalysis

AnalysisGetPublicAnalysis returns a public analysis. Requires an analysis id.

v1/animal/getPublicAnalysis

AnalysisGetLatestPublicAnalysis

AnalysisGetLatestPublicAnalysis returns a public analysis. Requires an analysis id.

v1/animal/getLatestPublicAnalysisSummary

AnalysisGetLatestAnalysis

AnalysisGetLatestAnalysis returns the latest analysis. Requires team id and project id.

v1/animal/getLatestAnalysis

AnalysisGetScan

AnalysisGetScan returns a scan. Requires a team id, project id, analysis id and scan id.

v1/animal/getAnalysisExportData

GetRepo

GetRepo is a string representation of the current endpoint for getting repo

v1/repo/getRepo

GetReposInCommon

GetReposInCommon is a string representation of the current endpoint for getting repo

/v1/repo/getReposInCommon

GetReposForActor

GetReposForActor is a string representation of the current endpoint for getting repo

v1/repo/getReposForActor

SearchRepo

SearchRepo is a string representation of the current endpoint for searching repo

v1/repo/search

GetDestinations

GetDestinations returns all destinations for a team. Requires team id.

/v1/teams/getDeliveryDestinations

DeleteDestination

DeleteDestination markes a delivery destination as deleted. It requires a delivery destination id.

/v1/teams/deleteDeliveryDestination

CreateDestination

CreateDestination creates a destination. Requires team id, location, region, name, destination type, access key (empty string allowed), secret key (empty string allowed) and token.

/v1/teams/createDeliveryDestination

GetLatestVersionForDependency

GetLatestVersionForDependency - returns the latest single version for a dependency

v1/dependency/getLatestVersionForDependency

GetVersionsForDependency

GetVersionsForDependency - returns the list of known versions for a dependency

v1/dependency/getVersionsForDependency

ResolveDependenciesInFile

ResolveDependenciesInFile - given a dependency file and ecosystem name returns the full tree of known dependencie

v1/dependency/resolveDependenciesInFile

ResolveFromFile

Only supports Gemfile.lock.

v1/dependency/resolveFromFile

ResolveDependencySearch

ResolveDependencySearch is a string representation of the current endpoint for searching dependencie

v1/dependency/search

VulnerabilityStats

VulnerabilityStats is a string representation of the current endpoint for getting vulnerability statistic

v1/animal/getVulnerabilityStats

VulnerabilityList

VulnerabilityList is a string representation for getting a list of vulnerabilities by type.

v1/animal/getVulnerabilityList

VulnerabilityMetrics

VulnerabilityMetrics is a string representation for getting a list of vulnerability metrics.

v1/animal/getScanMetrics

PortfolioPassFailSummary

PortfolioPassFailSummary is a string representation for getting a portfolio status summary.

v1/ruleset/getStatuses

PortfolioStartedErroredSummary

PortfolioStartedErroredSummary is a string representation for getting the started and errored count for a list of project

v1/scanner/getStatuses

PortfolioGetAffectedProjectIds

PortfolioGetAffectedProjectIds is a string representation for getting a list of affected projects.

v1/animal/getAffectedProjectIds

PortfolioGetAffectedProjectsInfo

PortfolioGetAffectedProjectsInfo is a string representation for getting the name and version of projects from a list of project id

v1/project/getAffectedProjectsInfo

DependencyStats

DependencyStats is a string representation of the current endpoint for getting dependencies statistic

v1/animal/getDependencyStats

DependencyList

DependencyList is a string representation for getting a list of vulnerabilities by type.

v1/animal/getDependencyList

RulesetsGetStatusesHistory

RulesetsGetStatusesHistory is a string representation of the current endpoint for status history of project

v1/ruleset/getStatusesHistory

ReportsGetMttr

ReportsGetMttr is a string representation of the current endpoint for Mean Time of Remediation of project(s)

v1/report/getMttr

PortfolioGetProjectIdsByDependency

PortfolioGetProjectIdsByDependency is a string representation for getting a list of projects by dependency.

v1/animal/getProjectIdsByDependency

GetProduct

GetProduct is a string representation of the current endpoint for getting product

v1/vulnerability/getProducts

ProductSearch

ProductSearch is a string representation of the current endpoint for product search

v1/product/search

ProductGetProduct

ProductGetProduct is a string representation of the current endpoint for getting a product

v1/product/getProduct

GetProductVersions

GetProductVersions is a string representation of the current endpoint for getting a product’s version

v1/product/getProductVersions

CreateProject

CreateProject is a string representation of the current endpoint for creating project

v1/project/createProject

CreateProjectsFromCSV

CreateProjectsFromCSV is a string representation of the current endpoint for creating projects from CSV

v1/project/createProjectsCSV

GetProject

GetProject is a string representation of the current endpoint for getting project

v1/project/getProject

GetProjectByURL

GetProjectByURL is a string representation of the current endpoint for getting project by URL

v1/project/getProjectByUrl

GetProjects

GetProjects is a string representation of the current endpoint for getting project

v1/project/getProjects

UpdateProject

UpdateProject is a string representation of the current endpoint for updating project

v1/project/updateProject

GetUsedRulesetIds

GetUsedRulesetIds is a string representation of the current endpoint for getting list of a team’s in use ruleset

v1/project/getUsedRulesetIds

GetProjectsNames

GetProjectsNames is a string representation of the current endpoint for getting projects alaised names and version

v1/project/getProjectsNames

ReportGetAnalysisReport

ReportGetAnalysisReport is a string representation of the current endpoint for getting report analysi

v1/report/getAnalysis

ReportGetAnalysisNavigation

ReportGetAnalysisNavigation is a string representation of the current endpoint for getting report analysis navigation

v1/report/getAnalysisNav

ReportGetProjectReport

ReportGetProjectReport is a string representation of the current endpoint for getting project report

v1/report/getProject

ReportGetProjectsReport

ReportGetProjectsReport is a string representation of the current endpoint for getting project report

v1/report/getProjects

ReportGetScanReport

//ReportGetScanReport is a string representation of the current endpoint for getting scan report

v1/report/getScan

ReportGetExportedData

ReportGetExportedData is a string representation of the current endpoint for exporting projects data

v1/report/getExportedData

ReportGetExportedVulnerabilityData

ReportGetExportedVulnerabilityData is the endpoint for exporting vulnerability data from one or more project

v1/report/getExportedVulnerabilityData

ReportGetSBOM

ReportGetSBOM is the endpoint for generating SBOM

v1/report/getSBOM

GetProjectHistory

GetProjectHistory is a string representation of the current endpoint for getting a project’s history

v1/ruleset/getProjectHistory

CreateRuleSet

CreateRuleSet is a string representation of the current endpoint for creating ruleset

v1/ruleset/createRuleset

GetAppliedRuleSet

GetAppliedRuleSet is a string representation of the current endpoint for getting applied ruleset

v1/ruleset/getAppliedRulesetForProject

GetBatchAppliedRuleset

GetBatchAppliedRuleset is a string representation of the current endpoint for getting batched applied ruleset

v1/ruleset/getAppliedRulesets

GetRuleSet

GetRuleSet is a string representation of the current endpoint for getting ruleset

v1/ruleset/getRuleset

GetRuleSets

GetRuleSets is a string representation of the current endpoint for getting rulesets (plural)

v1/ruleset/getRulesets

RulesetsGetRules

//RulesetsGetRules is a string representation of the current endpoint for getting rules.

v1/ruleset/getRules

ScannerAnalyzeProject

ScannerAnalyzeProject is a string representation of the current endpoint for analyzing project

v1/scanner/analyzeProject

ScannerGetAnalysisStatus

ScannerGetAnalysisStatus is a string representation of the current endpoint for getting analysis statu

v1/scanner/getAnalysisStatus

ScannerGetLatestAnalysisStatus

ScannerGetLatestAnalysisStatus is a string representation of the current endpoint for getting latest analysis statu

v1/scanner/getLatestAnalysisStatus

ScannerGetLatestAnalysisStatuses

ScannerGetLatestAnalysisStatuses is a string representation of the current endpoint for getting latest analysis statuse

v1/scanner/getLatestAnalysisStatuses

ScannerAddScan

ScannerAddScan is a string representation of the current endpoint for scanner add scan

v1/scanner/addScanResult

ScanFindScans

ScanFindScans is the endpoint used to search for scan result

v1/animal/findScans

CreateTag

CreateTag is a string representation of the current endpoint for creating tag

v1/tag/createTag

GetTag

GetTag is a string representation of the current endpoint for getting tag

v1/tag/getTag

GetTags

GetTags is a string representation of the current endpoint for getting tag

v1/tag/getTags

UpdateTag

UpdateTag is a string representation of the current endpoint for update tag

v1/tag/updateTag

TeamsCreateTeam

TeamsCreateTeam is a string representation of the current endpoint for creating team

v1/teams/createTeam

TeamsGetTeam

TeamsGetTeam is a string representation of the current endpoint for getting team

v1/teams/getTeam

TeamsGetTeams

TeamsGetTeams is a string representation of the current endpoint for getting team

v1/teams/getTeams

TeamsCreateTeamUser

TeamsCreateTeamUser is a string representation of the current endpoint for creating team user

v1/teamUsers/createTeamUser

TeamsGetTeamUser

TeamsGetTeamUser is a string representation of the current endpoint for getting team user

v1/teamUsers/getTeamUser

TeamsUpdateTeamUser

TeamsUpdateTeamUser is a string representation of the current endpoint for updating team user

v1/teamUsers/updateTeamUser

TeamsDeleteTeamUser

TeamsDeleteTeamUser is a string representation of the current endpoint for deleting team user

v1/teamUsers/deleteTeamUser

UsersCreateUser

UsersCreateUser is a string representation of the current endpoint for creating user

v1/users/createUser

UsersGetSelf

UsersGetSelf is a string representation of the current endpoint for get user self

v1/users/getSelf

UsersGetUser

UsersGetUser is a string representation of the current endpoint for getting user

v1/users/getUser

GetVulnerabilities

GetVulnerabilities is a string representation of the current endpoint for getting vulnerabilitie

v1/vulnerability/getVulnerabilities

GetVulnerabilitiesInFile

GetVulnerabilitiesInFile is a string representation of the current endpoint for getting vulnerabilities in file

v1/vulnerability/getVulnerabilitiesInFile

GetVulnerability

GetVulnerability is a string representation of the current endpoint for getting vulnerability

v1/vulnerability/getVulnerability

PostVulnerability

PostVulnerability is a string representation of the current endpoint for adding vulnerability

v1/internal/vulnerability/addVulnerability

Updated: 2021-06-10 16:37:41 UTC