Version: 0.0.3
Waldorf is the governance (rulesets) microservice for the Ion Channel
| 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 |
| Operation | Description |
|---|---|
| GET /ruleset/getRules | Retrieve a list of rules given an account ID |
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 |
result of applying ruleset to scans
Unexpected error
the POST /ruleset/createRuleset creates a new ruleset.
ruleset object to create
An object containing the new ruleset
Invalid parameters provided
A property provided was not found
Missing a required param
Unexpected error
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 |
result of applying ruleset to scans
Unexpected error
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 |
An object containing the projects details
No ruleset details were found
Unexpected error
Rule used
Scan rule was run agains
Pass/Fail status for scan against rule
Reason for passed code
The url of the current request
The url of the resource that was created
Url of the next data object
Url of the previous data object
Url of the last data object
Url of the first data object
Copyright info
Authors
API version
Last update of source data (optional)
Unique identifier for a rule
Name of the rule
text describing what this rule is meant to govern
text used for grouping multiple rules together
similar to category but used to describe which scan type the data will come from
id of the analysis of ruleset plus scanset
Unique identifier representing a specific project
Name of the project?
Short description of the project
Account ID of project owner
Name of the project?
Short description of the project
Account ID of project owner
Unique identifier representing a specific project
Name of the project?
Short description of the project
Account ID of project owner