Operations APIs
This topic describes the REST APIs for Operation Services in BMC Helix Automation Console.
The base URL for the Operations API is: https://<serverName>/api/v1
POST/api/v1/policies/operations
Creates remediation operation for a job.
Request body: No parameters
Sample request
{
"name": "string",
"type": "string",
"description": "string",
"filters": {
"severity": [
0
],
"os_type": [
"WINDOWS"
],
"cve_ids": [
"string"
]
},
"schedules": [
{
"once": {
"datetime": "string"
},
"daily": {
"time": "string"
},
"weekly": {
"days": [
"string"
],
"frequency": 0,
"time": "string"
},
"monthly": {
"week_day": "string",
"week_of_month": "string"
},
"interval": {
"days": 0,
"hours": 0,
"minutes": 0
},
"timezone": "string"
}
],
"prepared_operations": [
{
"name": "string",
"sub_type": "UNKNOWN",
"configurations": {
"array": true,
"bigDecimal": true,
"bigInteger": true,
"binary": true,
"boolean": true,
"containerNode": true,
"double": true,
"float": true,
"floatingPointNumber": true,
"int": true,
"integralNumber": true,
"long": true,
"missingNode": true,
"nodeType": "ARRAY",
"null": true,
"number": true,
"object": true,
"pojo": true,
"short": true,
"textual": true,
"valueNode": true
},
"asset_count": 0
}
],
"notifications": "string",
"execute_now": true
}
"name": "string",
"type": "string",
"description": "string",
"filters": {
"severity": [
0
],
"os_type": [
"WINDOWS"
],
"cve_ids": [
"string"
]
},
"schedules": [
{
"once": {
"datetime": "string"
},
"daily": {
"time": "string"
},
"weekly": {
"days": [
"string"
],
"frequency": 0,
"time": "string"
},
"monthly": {
"week_day": "string",
"week_of_month": "string"
},
"interval": {
"days": 0,
"hours": 0,
"minutes": 0
},
"timezone": "string"
}
],
"prepared_operations": [
{
"name": "string",
"sub_type": "UNKNOWN",
"configurations": {
"array": true,
"bigDecimal": true,
"bigInteger": true,
"binary": true,
"boolean": true,
"containerNode": true,
"double": true,
"float": true,
"floatingPointNumber": true,
"int": true,
"integralNumber": true,
"long": true,
"missingNode": true,
"nodeType": "ARRAY",
"null": true,
"number": true,
"object": true,
"pojo": true,
"short": true,
"textual": true,
"valueNode": true
},
"asset_count": 0
}
],
"notifications": "string",
"execute_now": true
}
Responses
Code | Description |
200 | OK |
201 | Created |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
POST/api/v1/policies/operations/prepare-list
Prepares an operation list.
Request body: No parameters
Sample request
{
"name": "string",
"filters": {
"severity": [
0
],
"os_type": [
"WINDOWS"
],
"cve_ids": [
"string"
]
}
}
"name": "string",
"filters": {
"severity": [
0
],
"os_type": [
"WINDOWS"
],
"cve_ids": [
"string"
]
}
}
Responses
Code | Description |
200 | OK |
201 | Created |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
Sample response
[
{
"name": "string",
"sub_type": "string",
"asset_count": "string"
}
]
{
"name": "string",
"sub_type": "string",
"asset_count": "string"
}
]
Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*