Ion Channel Statler API

Version: 0.0.3

Ion Channel's analysis reporting API

Schemes:

Summary

Path Operation Description
/analysis/getAccountSummary GET

List of AnalysisSummary objects for a given team_id

/analysis/getAnalysis GET

Project object with analysis details

/analysis/getAnalysisSummary GET

AnalysisSummary object for a given project_id

/analysis/getProjectSummaries GET

AnalysisSummaries object containing an array of Summary objects

Paths

List of AnalysisSummary objects for a given team_id

GET /analysis/getAccountSummary

Tags: Analysis

the /analysis/getAccountSummary endpoint returns an object containing a list of project's latest summaries.

id

the Account ID to get all project's latest summaries for

query string
200 OK

An object containing a list of summarized analyses for an account

404 Not Found

No analysis was found for the submitted analysis_id

default

Unexpected error

Project object with analysis details

GET /analysis/getAnalysis

Tags: Analysis

The /analysis endpoint returns an object containing the analysis for a given account's project. If no analysis_id is provide, the reponse will include the latest.

project_id

Project ID to get details for

query string
format

Format for the returned reports (JSON, YAML)

query string
team_id

Account ID to use for fetching the project details

query string
analysis_id

Analysis ID for specific run of data and ruleset, unset will return the latest

query string
200 OK

An Analysis object

404 Not Found

No analysis was found for the submitted project_id

default

Unexpected error

AnalysisSummary object for a given project_id

GET /analysis/getAnalysisSummary

Tags: Analysis

The /analysis/getAnalysisSummary endpoint returns an object containing analysis summaries for a given account's project. If no analysis_id is provided it will return the latest.

project_id

Project ID to get details for

query string
format

Format for the returned reports (JSON, YAML)

query string
team_id

Account ID to use for fetching the project details

query string
analysis_id

Analysis ID for specific run of data and ruleset, unset will return the latest

query string
200 OK

An AnalysisSummary object containing summarized analysis for a given run

404 Not Found

No analysis was found for the submitted analysis_id

default

Unexpected error

AnalysisSummaries object containing an array of Summary objects

GET /analysis/getProjectSummaries

Tags: Analysis

The /analysis/getProjectSummaries endpoint returns and array of summary objects for a given project_id.

project_id

Project ID to get details for

query string
format

Format for the returned reports (JSON, YAML)

query string
team_id

Account ID to use for fetching the project details

query string
limit

Limit the number of rows in the response. To receive all rows set limit to 0.

query integer 10
offset

Starting row for responses (for pagination)

query integer
200 OK

An AnalysisSummaries object containing and array of summarized analyses for a given project_id

404 Not Found

No analysis was found for the submitted analysis_id

default

Unexpected error

Schema definitions

AccountSummaries: object

data: object[]
meta: Meta
timestamps: Timestamps
links: Links

AccountSummary: object

data: object
project: Project
analysis_id: string

Unique identifier representing a specific summary

description: string

Description of analysis.

risk: string

The current risk indicator of this analysis

summary: string

Summary output of the project's content

updated_at: string (date-time)

Time of last updated

ruleset_id: string (uuid)

ID for the ruleset applied

ruleset_name: string

Simple name for the applied ruleset

duration: string

Time to complete analysis

trigger: string

Type of trigger for the analysis

trigger_hash: string

Hash of the source trigger (e.g. commit hash)

trigger_text: string

Summary explanation for the trigger (e.g. commit comment)

trigger_author: string

Username or name of person responsible for trigger

Analysis: object

team_id: string (uuid)

Account ID of analysis owner

project_id: string (uuid)

Id of the project this analysis belongs

id: string (uuid)

Unique identifier representing a specific analysis

name: string

Name of the analysis?

type: string

Source type for the analysis (git|file)

source: string

Source endpoint for the analysis (git repo)

branch: string

Source specifier for a source (git branch)

description: string

Short description of the analysis

risk: string

Ion Channel risk rating

scan_summaries: object[]
status: string

Code for the results of the scan [accepted|failed|finished]

meta: Meta
timestamps: Timestamps
links: Links

AnalysisSummaries: object

data: object
project: Project
analysis_summaries: object[]
meta: Meta
timestamps: Timestamps
links: Links

AnalysisSummary: object

data: object
analysis_id: string

Unique identifier representing a specific summary

description: string

Description of analysis.

risk: string

The current risk indicator of this analysis

summary: string

Summary output of the project's content

ruleset_id: string (uuid)

ID for the ruleset applied

ruleset_name: string

Simple name for the applied ruleset

duration: string

Time to complete analysis

trigger: string

Type of trigger for the analysis

trigger_hash: string

Hash of the source trigger (e.g. commit hash)

trigger_text: string

Summary explanation for the trigger (e.g. commit comment)

trigger_author: string

Username or name of person responsible for trigger

meta: Meta
timestamps: Timestamps
links: Links

Error: object

code: integer (int32)
message: string
fields: string

Meta: object

copyright: string

Copyright info

authors: string

Authors

version: string

API version

last_update: string

Last update of source data (optional)

Project: object

id: string (uuid)

Unique identifier representing a specific project

name: string

Name of the project?

active: boolean

Is the project active

type: string

Source type for the project (git|file)

source: string

Source endpoint for the project (git repo)

branch: string

Source specifier for a source (git branch)

description: string

Short description of the project

chat_channel: string

Group chat channel for the project

team_id: string (uuid)

Account ID of project owner

ruleset_id: string (uuid)

Governance ruleset ID associated with the project

meta: Meta
timestamps: Timestamps
links: Links

ScanResult: object

scan_id: integer

ID of the Scan

name: string

Name of the scan that was run

results: object

The data specific to the given scan defined by the name

ScanSummary: object

team_id: string (uuid)

Account ID of analysis owner

project_id: string (uuid)

Id of the project this scan belongs

analysis_id: string (uuid)

Unique identifier representing a specific analysis

id: string (uuid)

The unique id for a scan

description: string

Short human readable description of the results of the analysis

name: string

The name of the scan type that was run

summary: string

Summary of the scan result

risk: string

Ion Channel risk rating

results: ScanResult
meta: Meta
timestamps: Timestamps
links: Links

Timestamps: object

created: string

Time the object was created

updated: string

Time the object was last updated