/acceptRiskRule
Methods
Gets the list of Accept Risk Rules across all reps, plugins and orgs, unless filters are provided.
Fields Parameter
The fields parameter should be specified along the query string, and it takes the syntax
?fields=<field>,...
Allowed Fields
*id
**repository
**organization
**user
**plugin
**hostType
**hostValue
**port
**protocol
**expires
**status
comments
createdTime
modifiedTime
Legend
* = always comes back
** = comes back if fields list not specified on GET all
redFont = field is a JSON object ( e.g. "repository" :{ "id" : <id>, "name" : <name> } )
Filters
repositoryIDs=<number>,... DEFAULT 0 (i.e. all Repositories) pluginID=<number> | <string> "all" DEFAULT "all" (i.e. all Plugins) port=<number> | <string> "all" DEFAULT "all" (i.e. all Ports)
Session User is role "1" (administrator)
organizationIDs=<number>,... | <string> "all" DEFAULT "all" (i.e. all Organizations)
Session User is not role "1" (administrator)
organizationIDs=<number>,... | <string> "all" DEFAULT :sessionOrgID:
Example Response
{
"type" : "regular",
"response" : [
{
"id" : "3",
"hostType" : "all",
"hostValue" : "",
"port" : "any",
"protocol" : "any",
"expires" : "-1",
"status" : "0",
"repository" : {
"id" : "17",
"name" : "New Fields Repo",
"description" : "",
"type" : "Local",
"uuid" : "A2FF7E13-2C0E-470E-A3C9-E077FE065A54"
},
"organization" : {
"id" : "8",
"name" : "Org",
"description" : "Testing for Policies with New Schema",
"uuid" : "FF00F4D0-5B9F-4A26-998C-19430295284A"
},
"user" : {
"id" : "1",
"username" : "head",
"firstname" : "Security Manager",
"lastname" : "",
"uuid" : "96F2AD1B-1B83-462E-908A-84E6054F6B64"
},
"plugin" : {
"id" : "0",
"name" : "Open Port",
"description" : "",
"type" : "active"
}
}
],
"error_code" : 0,
"error_msg" : "",
"warnings" : [],
"timestamp" : 1410275054
}
Adds an Accept Risk Rule to one repository.
Request Parameters
{
"repositories" : [
{
"id" : <number>
}...
],
"plugin" : {
"id" : <number>
},
"hostType" : <string> "all" | "asset" | "ip" | "uuid" | "hostUUID",
"port" : <number:1..65535> | <string> "any" DEFAULT "any",
"protocol" : <number:1..> | <string> "any" DEFAULT "any",
"comments" : <string> DEFAULT "",
"expires" : <number> (integer >= -1) DEFAULT -1 (not set)
...
}
hostType "asset"
The "hostValue" parameter should contain a usable, accessible Asset ID.
...
"hostValue" : {
"id" : <number>
}
...
hostType "ip"
The "hostValue" parameter should contain a newline-separated and/or comma-separated list of IPs.
... "hostValue" : <string> ...
hostType "uuid"
The "hostValue" parameter should contain a newline-separated and/or comma-separated list of UUIDs.
... "hostValue" : <string> ...
hostType "hostUUID"
The "hostValue" parameter should contain a newline-separated and/or comma-separated list of UUIDs.
... "hostValue" : <string> ...
Example Response
{
"type" : "regular",
"response" : [
{
"id" : "3",
"hostType" : "all",
"hostValue" : "",
"port" : "any",
"protocol" : "any",
"comments" : "",
"expires" : "-1",
"status" : "0",
"createdTime" : "1410275013",
"modifiedTime" : "1410275013",
"repository" : {
"id" : "17",
"name" : "New Fields Repo",
"description" : "",
"type" : "Local",
"uuid" : "A2FF7E13-2C0E-470E-A3C9-E077FE065A54"
},
"organization" : {
"id" : "8",
"name" : "Org",
"description" : "Testing for Policies with New Schema",
"uuid" : "FF00F4D0-5B9F-4A26-998C-19430295284A"
},
"user" : {
"id" : "1",
"username" : "head",
"firstname" : "Security Manager",
"lastname" : "",
"uuid" : "96F2AD1B-1B83-462E-908A-84E6054F6B64"
},
"plugin" : {
"id" : "0",
"name" : "Open Port",
"description" : "",
"type" : "active"
}
}
],
"error_code" : 0,
"error_msg" : "",
"warnings" : [],
"timestamp" : 1410275013
}
/acceptRiskRule/{id}
Methods
Gets the Accept Risk Rule associated with {id}.
Fields Parameter
The fields parameter should be specified along the query string, and it takes the syntax
?fields=<field>,...
Allowed Fields
*id
**repository
**organization
**user
**plugin
**hostType
**hostValue
**port
**protocol
**expires
**status
comments
createdTime
modifiedTime
Legend
* = always comes back
** = comes back if fields list not specified on GET all
redFont = field is a JSON object ( e.g. "repository" :{ "id" : <id>, "name" : <name> } )
Request Query Parameters
None
Example Response
{
"type" : "regular",
"response" : {
"id" : "3",
"hostType" : "all",
"hostValue" : "",
"port" : "any",
"protocol" : "any",
"comments" : "",
"expires" : "-1",
"status" : "0",
"createdTime" : "1410275013",
"modifiedTime" : "1410275013",
"repository" : {
"id" : "17",
"name" : "New Fields Repo",
"description" : "",
"type" : "Local",
"uuid" : "A2FF7E13-2C0E-470E-A3C9-E077FE065A54"
},
"organization" : {
"id" : "8",
"name" : "Org",
"description" : "Testing for Policies with New Schema",
"uuid" : "FF00F4D0-5B9F-4A26-998C-19430295284A"
},
"user" : {
"id" : "1",
"username" : "head",
"firstname" : "Security Manager",
"lastname" : "",
"uuid" : "96F2AD1B-1B83-462E-908A-84E6054F6B64"
},
"plugin" : {
"id" : "0",
"name" : "Open Port",
"description" : "",
"type" : "active"
}
},
"error_code" : 0,
"error_msg" : "",
"warnings" : [],
"timestamp" : 1410275074
}
Deletes the Accept Risk Rule associated with {id}, depending on access and permissions.
Request Parameters
None
Example Response
{
"type" : "regular",
"response" : "",
"error_code" : 0,
"error_msg" : "",
"warnings" : [],
"timestamp" : 1403100582
}
/acceptRiskRule/apply
Methods
Applies all rules for the given repository or all (id: 0)
Request Query Parameters
{
"repository" : {
"id" : <number>
}
}
Example Response
{
"type" : "regular",
"response" : "",
"error_code" : 0,
"error_msg" : "",
"warnings" : [],
"timestamp" : 1410279161
}