Ion Channel Waldorf API

Version: 0.0.3

Waldorf is the governance (rulesets) microservice for the Ion Channel

Schemes:

Summary

Tag: Ruleset

Operation Description
POST /ruleset/createRuleset

Create a new ruleset

GET /ruleset/getRuleset

Retrieve the ruleset details given a ruleset ID

GET /ruleset/getRulesets

Retrieve a list of ruleset details given an account ID

POST /ruleset/applyRuleset

Apply a ruleset to a given scanset

GET /ruleset/getAppliedRulesetForProject

Get results of ruleset applied for a specific project

Tag: Rules

Operation Description
GET /ruleset/getRules

Retrieve a list of rules given an account ID

Paths

Apply a ruleset to a given scanset

POST /ruleset/applyRuleset

Tags: Ruleset

the applyRuleset endpoint returns the result of applying a ruleset to a provided set of scan results.

The ScanSet of scan results to be processed by the RuleSet

id

The ID of the ruleset to apply

query string
account_id

The account_id of the ruleset to use

query string
200 OK

result of applying ruleset to scans

default

Unexpected error

Create a new ruleset

POST /ruleset/createRuleset

Tags: Ruleset

the POST /ruleset/createRuleset creates a new ruleset.

ruleset object to create

201 Created

An object containing the new ruleset

400 Bad Request

Invalid parameters provided

404 Not Found

A property provided was not found

422 Unprocessable Entity

Missing a required param

default

Unexpected error

Get results of ruleset applied for a specific project

GET /ruleset/getAppliedRulesetForProject

Tags: Ruleset

the getAppliedRulesetForProject endpoint returns the result of applying a ruleset to a set of scan results.

project_id

The ID of the project.

query string
account_id

The account_id of the ruleset to use

query string
analysis_id

The analysis_id to retrieve. If not specified, returns latest analysis for specified project.

query string
limit

The limit of items to return. Defaults to one.

query integer
offset

Offset for pagination.

query integer
200 OK

result of applying ruleset to scans

default

Unexpected error

Retrieve a list of rules given an account ID

GET /ruleset/getRules

Tags: Rules

the rules endpoint returns an object containing the list.

account_id

The ID of the account to request all ruleset for

query string
200 OK

An object containing a list of ruleset

404 Not Found

No ruleset details were found

default

Unexpected error

Retrieve the ruleset details given a ruleset ID

GET /ruleset/getRuleset

Tags: Ruleset

the ruleset/getRuleset endpoint returns an object containing the details for a given ruleset.

id

The ID of the ruleset to request details for

query string
account_id

The ID of the account to request details for

query string
200 OK

An object containing the projects details

404 Not Found

No ruleset details were found

default

Unexpected error

Retrieve a list of ruleset details given an account ID

GET /ruleset/getRulesets

Tags: Ruleset

the ruleset endpoint returns an object containing the details for a given ruleset.

account_id

The ID of the account to request all ruleset for

query string
200 OK

An object containing a list of ruleset

404 Not Found

No ruleset details were found

default

Unexpected error

Schema definitions

Error: object

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

Evaluation: object

rule_id: string (UUID)

Rule used

scan_id: string

Scan rule was run agains

passed: boolean

Pass/Fail status for scan against rule

reason: string

Reason for passed code

Meta: object

copyright: string

Copyright info

authors: string

Authors

version: string

API version

last_update: string

Last update of source data (optional)

Rule: object

id: string (UUID)

Unique identifier for a rule

name: string

Name of the rule

description: string

text describing what this rule is meant to govern

category: string

text used for grouping multiple rules together

scan_type: string

similar to category but used to describe which scan type the data will come from

RuleEvaluationSummary: object

data: object
id: string

id of the analysis of ruleset plus scanset

ruleresults: object[]
summary: string
meta: Meta
timestamps: Timestamps
links: Links

Rules: object

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

RuleSet: object

data: object
id: string

Unique identifier representing a specific project

name: string

Name of the project?

description: string

Short description of the project

account_id: string

Account ID of project owner

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

RuleSetInput: object

name: string

Name of the project?

description: string

Short description of the project

account_id: string

Account ID of project owner

rule_ids: string[]
string

RuleSets: object

data: object
id: string

Unique identifier representing a specific project

name: string

Name of the project?

description: string

Short description of the project

account_id: string

Account ID of project owner

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

ScanSet: object

data: string[]
string

Timestamps: object

created: string

Time the object was created

updated: string

Time the object was last updated