Tripwire Enterprise
The Tripwire Enterprise connector integrates with Swimlane to get reports, policies, tasks, rules, elements and system information from Tripwire.
Prerequisites
The Tripwire Enterprise connector requires a URL running the application, an Username, and a Password.
Capabilities
This plugin provides the following capabilities:
- Create Execute Task Requests
- Create Policies Run
- Create Tasks
- Delete User
- Get Elements
- Get Execute Task Request by ID
- Get Latest Policy Test Results
- Get Latest Task Run Contexts
- Get Log Messages
- Get Nodes
- Get Policies
- Get Policy Test Results
- Get Reports
- Get Rules
- Get Settings Licenses ... and so on
Asset Setup
The connector requires a Username and Password to get the Access Token to interact with actions.
Notes
This plugin was last tested against product version: v1.
Configurations
HTTP Basic Authentication
Authenticates using username and password.
Configuration Parameters
Parameter | Description | Type | Required |
|---|---|---|---|
url | A URL to the target host. | string | Required |
username | Username | string | Required |
password | Password | string | Required |
verify_ssl | Verify SSL certificate | boolean | Optional |
http_proxy | A proxy to route requests through. | string | Optional |
Actions
Create Execute Task Requests
Request to run a task.
Endpoint
- URL: /api/v1/tasks/executeTaskRequests
- Method: POST
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
completionTime | string | Optional | Time value |
creationTime | string | Optional | Time value |
id | string | Optional | Unique identifier |
requestData | object | Optional | Response data |
requestData.taskId | string | Required | Response data |
status | string | Optional | Status value |
statusMessage | object | Optional | Status value |
Input Example
{"json_body":{"completionTime":"string","creationTime":"string","id":"string","requestData":{"taskId":"string"},"status":"string","statusMessage":{}}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
creationTime | string | Time value |
id | string | Unique identifier |
requestData | object | Response data |
requestData.taskId | string | Response data |
status | string | Status value |
statusMessage | array | Status value |
statusMessage.file_name | string | Name of the resource |
statusMessage.file | string | Status value |
Output Example
{"status_code":202,"response_headers":{"Strict-Transport-Security":"max-age=31622400; includeSubDomains","X-Frame-Options":"SAMEORIGIN","X-Xss-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","Content-Security-Policy":"default-src https: data: 'self' 'unsafe-inline' 'unsafe-eval'; frame-ancestors '...","Content-Type":"application/json","Transfer-Encoding":"chunked","Date":"Tue, 05 Sep 2023 09:16:52 GMT","Keep-Alive":"timeout=60","Connection":"keep-alive","Server":"Tripwire Enterpri...
Create Policies Run
Allows evaluation of policy test criteria against previously harvested element versions for a specified set of policies and nodes.
Endpoint
- URL: /api/v1/policies/run
- Method: POST
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
nodes | array | Optional | Parameter for Create Policies Run |
policies | array | Optional | Parameter for Create Policies Run |
Input Example
{"json_body":{"nodes":[""],"policies":[""]}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
Output Example
{"status_code":204,"response_headers":{"connection":"keep-alive","content-security-policy":"default-src https: data: 'self' 'unsafe-inline' 'unsafe-eval'; frame-ancestors '...","content-type":"text/html","csrftoken":"{\"pageTokens\":{\"/api/v1/policies/run\":\"GNKD-4J9F-67L4-XH8K-X6O2-RZ4H-1KYA-JXH3\"}...","date":"Mon, 04 Sep 2023 09:57:52 GMT","keep-alive":"timeout=60","server":"Tripwire Enterprise","strict-transport-security":"max-age=31622400; includeSubDomains","x-content-type-options":"nosn...
Create Tasks
Creates a new task in the root task group.
Endpoint
- URL: /api/v1/tasks
- Method: POST
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
actionIds | array | Optional | Unique identifier |
additionalEmailAddresses | array | Optional | Parameter for Create Tasks |
archiveAuditEvents | boolean | Optional | Parameter for Create Tasks |
archiveLogsExceeding | number | Optional | Parameter for Create Tasks |
archiveLogsOlderThan | number | Optional | Parameter for Create Tasks |
archiveReports | boolean | Optional | Parameter for Create Tasks |
compactVersionsExceeding | number | Optional | Parameter for Create Tasks |
compactVersionsOlderThan | number | Optional | Parameter for Create Tasks |
description | string | Optional | Parameter for Create Tasks |
emailServer | string | Optional | Parameter for Create Tasks |
enabled | boolean | Optional | Parameter for Create Tasks |
id | string | Optional | Unique identifier |
ignoreEmptyReports | boolean | Optional | Parameter for Create Tasks |
lastDuration | number | Optional | Parameter for Create Tasks |
lastStart | string | Optional | Parameter for Create Tasks |
name | string | Optional | Name of the resource |
newBaselinesOnly | boolean | Optional | Parameter for Create Tasks |
checkNodeConnectionOnly | boolean | Optional | Parameter for Create Tasks |
offboardingOnly | boolean | Optional | Parameter for Create Tasks |
unlicenseDuration | number | Optional | Parameter for Create Tasks |
unlicenseDurationUnit | string | Optional | Parameter for Create Tasks |
deleteDuration | number | Optional | Parameter for Create Tasks |
deleteDurationUnit | string | Optional | Parameter for Create Tasks |
nextStart | string | Optional | Parameter for Create Tasks |
nodeId | string | Optional | Unique identifier |
Input Example
{"json_body":{"actionIds":[""],"additionalEmailAddresses":[""],"archiveAuditEvents":true,"archiveLogsExceeding":0,"archiveLogsOlderThan":0,"archiveReports":true,"compactVersionsExceeding":0,"compactVersionsOlderThan":0,"description":"","emailServer":"","enabled":true,"id":"","ignoreEmptyReports":true,"lastDuration":0,"lastStart":"","name":"","newBaselinesOnly":true,"checkNodeConnectionOnly":true,"offboardingOnly":true,"unlicenseDuration":0,"unlicenseDurationUnit":"NANOSECONDS","deleteDuration":0,"deleteDurationUnit":"NANOSECONDS","nextStart":"","nodeId":"","reportFormat":"","reportId":"","reportUserIds":[""],"ruleId":"","schedule":{"date":"","day":0,"daysOccurrence":"","daysOfWeek":[""],"minutes":0,"periodicTimeRange":"","time":"","type":""},"status":"","timeout":0,"timeoutMillis":0,"type":"","userId":""}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
Output Example
{"status_code":200,"response_headers":{"connection":"keep-alive","content-security-policy":"default-src https: data: 'self' 'unsafe-inline' 'unsafe-eval'; frame-ancestors '...","content-type":"text/html","csrftoken":"{\"pageTokens\":{\"/api/v1/policies/run\":\"GNKD-4J9F-67L4-XH8K-X6O2-RZ4H-1KYA-JXH3\"}...","date":"Mon, 04 Sep 2023 09:57:52 GMT","keep-alive":"timeout=60","server":"Tripwire Enterprise","strict-transport-security":"max-age=31622400; includeSubDomains","x-content-type-options":"nosn...
Delete User
Removes a user from the system.
Endpoint
- URL: /api/v1/users/{{rkUserId}}
- Method: DELETE
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
path_parameters.rkUserId | string | Required | Parameters for the Delete User action |
Input Example
{"path_parameters":{"rkUserId":""}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
Output Example
{"status_code":204,"response_headers":{"connection":"keep-alive","content-security-policy":"default-src https: data: 'self' 'unsafe-inline' 'unsafe-eval'; frame-ancestors '...","content-type":"application/json","date":"Mon, 04 Sep 2023 06:27:12 GMT","keep-alive":"timeout=60","server":"Tripwire Enterprise","strict-transport-security":"max-age=31622400; includeSubDomains","transfer-encoding":"chunked","x-content-type-options":"nosniff","x-frame-options":"SAMEORIGIN","x-xss-protection":"1; mode=blo...
Get Elements
Returns a list of all elements or those that match the provided criteria.
Endpoint
- URL: /api/v1/elements
- Method: GET
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
parameters.baselineVersionId | array | Optional | Parameters for the Get Elements action |
parameters.description | array | Optional | Parameters for the Get Elements action |
parameters.id | array | Optional | Parameters for the Get Elements action |
parameters.inScope | boolean | Optional | Parameters for the Get Elements action |
parameters.isRestorable | boolean | Optional | Parameters for the Get Elements action |
parameters.lastSuccessDate | array | Optional | Parameters for the Get Elements action |
parameters.lastVersionChangeSeverity | array | Optional | Parameters for the Get Elements action |
parameters.lastVersionChangeType | array | Optional | Parameters for the Get Elements action |
parameters.lastVersionId | array | Optional | Parameters for the Get Elements action |
parameters.lastVersionTime | array | Optional | Parameters for the Get Elements action |
parameters.name | array | Optional | Parameters for the Get Elements action |
parameters.nodeId | array | Optional | Parameters for the Get Elements action |
parameters.pageLimit | string | Optional | Parameters for the Get Elements action |
parameters.pageStart | string | Optional | Parameters for the Get Elements action |
parameters.previousId | string | Optional | Parameters for the Get Elements action |
parameters.sub_description | array | Optional | Parameters for the Get Elements action |
parameters.ruleId | array | Optional | Parameters for the Get Elements action |
Input Example
{"parameters":{"baselineVersionId":["string"],"description":[""],"id":[""],"inScope":true,"isRestorable":true,"lastSuccessDate":[""],"lastVersionChangeSeverity":[""],"lastVersionChangeType":[""],"lastVersionId":[""],"lastVersionTime":[""],"name":["Applocker Rules","Computer"],"nodeId":[""],"pageLimit":"","pageStart":"","previousId":"","sub_description":[""],"ruleId":[""]}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
Output Example
{"status_code":200,"response_headers":{"Strict-Transport-Security":"max-age=31622400; includeSubDomains","X-Frame-Options":"SAMEORIGIN","X-Xss-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","Content-Security-Policy":"default-src https: data: 'self' 'unsafe-inline' 'unsafe-eval'; frame-ancestors '...","Content-Type":"application/json","Content-Length":"1602","Date":"Tue, 05 Sep 2023 10:38:44 GMT","Keep-Alive":"timeout=60","Connection":"keep-alive","Server":"Tripwire Enterprise"},"...
Get Execute Task Request by ID
Returns the details of a single Task Execution Request.
Endpoint
- URL: /api/v1/tasks/executeTaskRequests/{{requestId}}
- Method: GET
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
path_parameters.requestId | string | Required | Parameters for the Get Execute Task Request by ID action |
Input Example
{"path_parameters":{"requestId":"36"}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
completionTime | string | Time value |
creationTime | string | Time value |
id | string | Unique identifier |
requestData | object | Response data |
requestData.taskId | string | Response data |
status | string | Status value |
statusMessage | array | Status value |
statusMessage.file_name | string | Name of the resource |
statusMessage.file | string | Status value |
Output Example
{"status_code":200,"response_headers":{"Strict-Transport-Security":"max-age=31622400; includeSubDomains","X-Frame-Options":"SAMEORIGIN","X-Xss-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","Content-Security-Policy":"default-src https: data: 'self' 'unsafe-inline' 'unsafe-eval'; frame-ancestors '...","Content-Type":"application/json","Transfer-Encoding":"chunked","Date":"Tue, 05 Sep 2023 10:48:00 GMT","Keep-Alive":"timeout=60","Connection":"keep-alive","Server":"Tripwire Enterpri...
Get Latest Policy Test Results
Returns a list of only those policy test results that are the latest result for a given policy test and node combination, or of those, the results that match the filter criteria.
Endpoint
- URL: /api/v1/policytestresults/latest
- Method: GET
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
parameters.id | string | Optional | Parameters for the Get Latest Policy Test Results action |
parameters.creationTime | array | Optional | Parameters for the Get Latest Policy Test Results action |
parameters.creationTimeRange | string | Optional | Parameters for the Get Latest Policy Test Results action |
parameters.elementId | array | Optional | Parameters for the Get Latest Policy Test Results action |
parameters.elementName | array | Optional | Parameters for the Get Latest Policy Test Results action |
parameters.elementVersionId | array | Optional | Parameters for the Get Latest Policy Test Results action |
parameters.nodeId | array | Optional | Parameters for the Get Latest Policy Test Results action |
parameters.nodeLabel | array | Optional | Parameters for the Get Latest Policy Test Results action |
parameters.pageLimit | string | Optional | Parameters for the Get Latest Policy Test Results action |
parameters.pageStart | string | Optional | Parameters for the Get Latest Policy Test Results action |
parameters.previousIds | string | Optional | Parameters for the Get Latest Policy Test Results action |
parameters.policyTestId | array | Optional | Parameters for the Get Latest Policy Test Results action |
parameters.policyTestName | array | Optional | Parameters for the Get Latest Policy Test Results action |
parameters.state | array | Optional | Parameters for the Get Latest Policy Test Results action |
Input Example
{"parameters":{"id":"","creationTime":[""],"creationTimeRange":"","elementId":[""],"elementName":[""],"elementVersionId":[""],"nodeId":[""],"nodeLabel":[""],"pageLimit":"20","pageStart":"0","previousIds":"","policyTestId":[""],"policyTestName":[""],"state":["PASSED"]}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
Output Example
{"status_code":200,"response_headers":{"Strict-Transport-Security":"max-age=31622400; includeSubDomains","X-Frame-Options":"SAMEORIGIN","X-Xss-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","Content-Security-Policy":"default-src https: data: 'self' 'unsafe-inline' 'unsafe-eval'; frame-ancestors '...","Content-Type":"application/json","Content-Length":"2","Date":"Tue, 05 Sep 2023 10:51:11 GMT","Keep-Alive":"timeout=60","Connection":"keep-alive","Server":"Tripwire Enterprise"},"rea...
Get Latest Task Run Contexts
Returns a list of the latest task run status record for each rule based task.
Endpoint
- URL: /api/v1/tasks/runContexts/latest
- Method: GET
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
parameters.endTime | array | Optional | Parameters for the Get Latest Task Run Contexts action |
parameters.endTimeRange | string | Optional | Parameters for the Get Latest Task Run Contexts action |
parameters.hasErrors | string | Optional | Parameters for the Get Latest Task Run Contexts action |
parameters.id | array | Optional | Parameters for the Get Latest Task Run Contexts action |
parameters.pageLimit | string | Optional | Parameters for the Get Latest Task Run Contexts action |
parameters.previousId | string | Optional | Parameters for the Get Latest Task Run Contexts action |
parameters.runType | string | Optional | Parameters for the Get Latest Task Run Contexts action |
parameters.startTime | array | Optional | Parameters for the Get Latest Task Run Contexts action |
parameters.stopType | string | Optional | Parameters for the Get Latest Task Run Contexts action |
parameters.taskId | array | Optional | Parameters for the Get Latest Task Run Contexts action |
Input Example
{"parameters":{"endTime":[""],"endTimeRange":"","hasErrors":false,"id":[""],"pageLimit":"20","previousId":"","runType":"CHECK","startTime":[""],"stopType":"NORMAL","taskId":[""]}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
Output Example
{"status_code":200,"response_headers":{"Strict-Transport-Security":"max-age=31622400; includeSubDomains","X-Frame-Options":"SAMEORIGIN","X-Xss-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","Content-Security-Policy":"default-src https: data: 'self' 'unsafe-inline' 'unsafe-eval'; frame-ancestors '...","Content-Type":"application/json","Content-Length":"522","Date":"Tue, 05 Sep 2023 11:02:12 GMT","Keep-Alive":"timeout=60","Connection":"keep-alive","Server":"Tripwire Enterprise"},"r...
Get Log Messages
List all log manager messages or those that match the filter criteria.
Endpoint
- URL: /api/v1/logMessages
- Method: GET
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
parameters.id | array | Optional | Parameters for the Get Log Messages action |
parameters.level | array | Optional | Parameters for the Get Log Messages action |
parameters.message | array | Optional | Parameters for the Get Log Messages action |
parameters.object | array | Optional | Parameters for the Get Log Messages action |
parameters.pageLimit | string | Optional | Parameters for the Get Log Messages action |
parameters.pageStart | string | Optional | Parameters for the Get Log Messages action |
parameters.sub_message | array | Optional | Parameters for the Get Log Messages action |
parameters.time | array | Optional | Parameters for the Get Log Messages action |
parameters.timeRange | string | Optional | Parameters for the Get Log Messages action |
parameters.type | array | Optional | Parameters for the Get Log Messages action |
parameters.username | array | Optional | Parameters for the Get Log Messages action |
Input Example
{"parameters":{"id":[""],"level":[""],"message":[""],"object":[""],"pageLimit":"20","pageStart":"0","sub_message":[""],"time":[""],"timeRange":"","type":[""],"username":[""]}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
Output Example
{"status_code":200,"response_headers":{"Strict-Transport-Security":"max-age=31622400; includeSubDomains","X-Frame-Options":"SAMEORIGIN","X-Xss-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","Content-Security-Policy":"default-src https: data: 'self' 'unsafe-inline' 'unsafe-eval'; frame-ancestors '...","Content-Type":"application/json","Content-Length":"571","Date":"Tue, 05 Sep 2023 11:04:59 GMT","Keep-Alive":"timeout=60","Connection":"keep-alive","Server":"Tripwire Enterprise"},"r...
Get Nodes
Returns a list of all nodes or those that match the provided filter criteria.
Endpoint
- URL: /api/v1/nodes
- Method: GET
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
parameters.agentVersion | array | Optional | Parameters for the Get Nodes action |
parameters.auditEnabled | boolean | Optional | Parameters for the Get Nodes action |
parameters.description | array | Optional | Parameters for the Get Nodes action |
parameters.commonAgentCapabilities | array | Optional | Parameters for the Get Nodes action |
parameters.commonAgentOsName | array | Optional | Parameters for the Get Nodes action |
parameters.commonAgentOsVersion | array | Optional | Parameters for the Get Nodes action |
parameters.commonAgentVersion | array | Optional | Parameters for the Get Nodes action |
parameters.commonAgentUuid | array | Optional | Parameters for the Get Nodes action |
parameters.customProperty | array | Optional | Parameters for the Get Nodes action |
parameters.elementCount | array | Optional | Parameters for the Get Nodes action |
parameters.eventGeneratorEnabled | boolean | Optional | Parameters for the Get Nodes action |
parameters.eventGeneratorInstalled | boolean | Optional | Parameters for the Get Nodes action |
parameters.hasFailures | boolean | Optional | Parameters for the Get Nodes action |
parameters.ic_name | array | Optional | Parameters for the Get Nodes action |
parameters.id | array | Optional | Parameters for the Get Nodes action |
parameters.importedTime | array | Optional | Parameters for the Get Nodes action |
parameters.importedTimeRange | string | Optional | Parameters for the Get Nodes action |
parameters.ipAddress | array | Optional | Parameters for the Get Nodes action |
parameters.isDisabled | boolean | Optional | Parameters for the Get Nodes action |
parameters.isSocksProxy | boolean | Optional | Parameters for the Get Nodes action |
parameters.isSSLSupported | boolean | Optional | Parameters for the Get Nodes action |
parameters.lastCheck | array | Optional | Parameters for the Get Nodes action |
parameters.lastRegistration | array | Optional | Parameters for the Get Nodes action |
parameters.licensedFeature | array | Optional | Parameters for the Get Nodes action |
parameters.macAddress | array | Optional | Parameters for the Get Nodes action |
Input Example
{"parameters":{"agentVersion":["9.0.0.b1"],"auditEnabled":true,"description":["Microsoft Windows Server 2019 10.0.17763, AMD64"],"commonAgentCapabilities":[""],"commonAgentOsName":[""],"commonAgentOsVersion":[""],"commonAgentVersion":[""],"commonAgentUuid":[""],"customProperty":[""],"elementCount":["2529"],"eventGeneratorEnabled":true,"eventGeneratorInstalled":true,"hasFailures":false,"ic_name":[""],"id":["-1y2p0ij32e8bl:-1y2p0ij32e79h"],"importedTime":["2023-08-29T21:26:50.002Z"],"importedTimeRange":"","ipAddress":["192.168.1.180"],"isDisabled":false,"isSocksProxy":false,"isSSLSupported":false,"lastCheck":["2023-09-04T06:00:00.000Z"],"lastRegistration":["2023-08-30T17:50:25.715Z"],"licensedFeature":["FSI","FSI-Policy","FSI-Remediation"],"macAddress":["00:0C:29:83:96:E9"],"make":["Microsoft"],"maxSeverity":["10000"],"model":["Windows Server 2019"],"modifiedTime":["2023-08-30T17:50:25.735Z"],"name":["win-6v8oe7d4sj6.mynetworksettings.com"],"oid":[""],"pageLimit":"20","pageStart":"0","proxyHost":[""],"proxyPort":[""],"realTimeEnabled":false,"rmiHost":["192.168.1.180"],"rmiPort":["9899"],"sub_description":[""],"sub_name":[""],"tags":["Operating System:Microsoft Windows Server 2019:SYSTEM"],"trackingId":["USR.2b7fd87e-2ce5-4002-a364-cba42f953942"],"type":["Windows Server"],"version":["10.0.17763"],"usingSSL":false}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
Output Example
{"status_code":200,"response_headers":{"Strict-Transport-Security":"max-age=31622400; includeSubDomains","X-Frame-Options":"SAMEORIGIN","X-Xss-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","Content-Security-Policy":"default-src https: data: 'self' 'unsafe-inline' 'unsafe-eval'; frame-ancestors '...","Content-Type":"application/json","Content-Length":"1373","Date":"Tue, 05 Sep 2023 11:07:58 GMT","Keep-Alive":"timeout=60","Connection":"keep-alive","Server":"Tripwire Enterprise"},"...
Get Policies
Returns a list of all policies or those that match the provided filter criteria.
Endpoint
- URL: /api/v1/policies
- Method: GET
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
parameters.description | array | Optional | Parameters for the Get Policies action |
parameters.id | array | Optional | Parameters for the Get Policies action |
parameters.importedTime | array | Optional | Parameters for the Get Policies action |
parameters.modifiedTime | array | Optional | Parameters for the Get Policies action |
parameters.name | array | Optional | Parameters for the Get Policies action |
parameters.nodeScope | array | Optional | Parameters for the Get Policies action |
parameters.pageLimit | string | Optional | Parameters for the Get Policies action |
parameters.pageStart | string | Optional | Parameters for the Get Policies action |
parameters.purgeDataOlderThanDays | array | Optional | Parameters for the Get Policies action |
parameters.purgeOldData | boolean | Optional | Parameters for the Get Policies action |
parameters.trackingId | array | Optional | Parameters for the Get Policies action |
parameters.sub_description | array | Optional | Parameters for the Get Policies action |
Input Example
{"parameters":{"description":[""],"id":[""],"importedTime":[""],"modifiedTime":[""],"name":[""],"nodeScope":[""],"pageLimit":"20","pageStart":"0","purgeDataOlderThanDays":["0"],"purgeOldData":false,"trackingId":[""],"sub_description":[""]}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
Output Example
{"status_code":200,"response_headers":{"Strict-Transport-Security":"max-age=31622400; includeSubDomains","X-Frame-Options":"SAMEORIGIN","X-Xss-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","Content-Security-Policy":"default-src https: data: 'self' 'unsafe-inline' 'unsafe-eval'; frame-ancestors '...","Content-Type":"application/json","Content-Length":"6708","Date":"Tue, 05 Sep 2023 11:10:08 GMT","Keep-Alive":"timeout=60","Connection":"keep-alive","Server":"Tripwire Enterprise"},"...
Get Policy Test Results
Returns a list of all policy test results or those that match the provided filter criteria.
Endpoint
- URL: /api/v1/policytestresults
- Method: GET
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
parameters.id | string | Optional | Parameters for the Get Policy Test Results action |
parameters.creationTime | array | Optional | Parameters for the Get Policy Test Results action |
parameters.creationTimeRange | string | Optional | Parameters for the Get Policy Test Results action |
parameters.elementId | array | Optional | Parameters for the Get Policy Test Results action |
parameters.elementName | array | Optional | Parameters for the Get Policy Test Results action |
parameters.elementVersionId | array | Optional | Parameters for the Get Policy Test Results action |
parameters.nodeId | array | Optional | Parameters for the Get Policy Test Results action |
parameters.nodeLabel | array | Optional | Parameters for the Get Policy Test Results action |
parameters.pageLimit | string | Optional | Parameters for the Get Policy Test Results action |
parameters.pageStart | string | Optional | Parameters for the Get Policy Test Results action |
parameters.previousIds | string | Optional | Parameters for the Get Policy Test Results action |
parameters.policyTestId | array | Optional | Parameters for the Get Policy Test Results action |
parameters.policyTestName | array | Optional | Parameters for the Get Policy Test Results action |
parameters.state | array | Optional | Parameters for the Get Policy Test Results action |
Input Example
{"parameters":{"id":"","creationTime":[""],"creationTimeRange":"","elementId":[""],"elementName":[""],"elementVersionId":[""],"nodeId":[""],"nodeLabel":[""],"pageLimit":"20","pageStart":"0","previousIds":"","policyTestId":[""],"policyTestName":[""],"state":["PASSED"]}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
Output Example
{"status_code":200,"response_headers":{"connection":"keep-alive","content-length":"2","content-security-policy":"default-src https: data: 'self' 'unsafe-inline' 'unsafe-eval'; frame-ancestors '...","content-type":"application/json","date":"Mon, 04 Sep 2023 10:00:43 GMT","keep-alive":"timeout=60","server":"Tripwire Enterprise","strict-transport-security":"max-age=31622400; includeSubDomains","x-content-type-options":"nosniff","x-frame-options":"SAMEORIGIN","x-xss-protection":"1; mode=block"},"rea...
Get Reports
Returns a list of all reports or those that match the filter criteria.
Endpoint
- URL: /api/v1/reports
- Method: GET
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
parameters.description | array | Optional | Parameters for the Get Reports action |
parameters.id | array | Optional | Parameters for the Get Reports action |
parameters.name | array | Optional | Parameters for the Get Reports action |
parameters.type | array | Optional | Parameters for the Get Reports action |
parameters.sub_description | array | Optional | Parameters for the Get Reports action |
Input Example
{"parameters":{"description":[""],"id":[""],"name":[""],"type":[""],"sub_description":[""]}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
Output Example
{"status_code":200,"response_headers":{"Strict-Transport-Security":"max-age=31622400; includeSubDomains","X-Frame-Options":"SAMEORIGIN","X-Xss-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","Content-Security-Policy":"default-src https: data: 'self' 'unsafe-inline' 'unsafe-eval'; frame-ancestors '...","Content-Type":"application/json","Content-Length":"5100","Date":"Tue, 05 Sep 2023 11:19:00 GMT","Keep-Alive":"timeout=60","Connection":"keep-alive","Server":"Tripwire Enterprise"},"...
Get Rules
Returns a list of all rules or those that match the provided filter criteria.
Endpoint
- URL: /api/v1/rules
- Method: GET
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
parameters.description | array | Optional | Parameters for the Get Rules action |
parameters.elementName | array | Optional | Parameters for the Get Rules action |
parameters.id | array | Optional | Parameters for the Get Rules action |
parameters.importedTime | array | Optional | Parameters for the Get Rules action |
parameters.importedTimeRange | string | Optional | Parameters for the Get Rules action |
parameters.isRealTime | boolean | Optional | Parameters for the Get Rules action |
parameters.modifiedTime | array | Optional | Parameters for the Get Rules action |
parameters.name | array | Optional | Parameters for the Get Rules action |
parameters.oid | array | Optional | Parameters for the Get Rules action |
parameters.pageLimit | string | Optional | Parameters for the Get Rules action |
parameters.pageStart | string | Optional | Parameters for the Get Rules action |
parameters.severity | array | Optional | Parameters for the Get Rules action |
parameters.sub_description | array | Optional | Parameters for the Get Rules action |
parameters.timeoutMillis | array | Optional | Parameters for the Get Rules action |
parameters.trackingId | array | Optional | Parameters for the Get Rules action |
parameters.type | array | Optional | Parameters for the Get Rules action |
Input Example
{"parameters":{"description":[""],"elementName":[""],"id":[""],"importedTime":[""],"importedTimeRange":"","isRealTime":false,"modifiedTime":[""],"name":[""],"oid":[""],"pageLimit":"20","pageStart":"0","severity":[""],"sub_description":[""],"timeoutMillis":[""],"trackingId":[""],"type":[""]}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
Output Example
{"status_code":200,"response_headers":{"Strict-Transport-Security":"max-age=31622400; includeSubDomains","X-Frame-Options":"SAMEORIGIN","X-Xss-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","Content-Security-Policy":"default-src https: data: 'self' 'unsafe-inline' 'unsafe-eval'; frame-ancestors '...","Content-Type":"application/json","Content-Length":"1417","Date":"Tue, 05 Sep 2023 11:27:23 GMT","Keep-Alive":"timeout=60","Connection":"keep-alive","Server":"Tripwire Enterprise"},"...
Get Settings Licenses
Returns a list of all licensed features in TE including the feature consumption.
Endpoint
- URL: /api/v1/settings/licenses
- Method: GET
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
Output Example
{"status_code":200,"response_headers":{"Strict-Transport-Security":"max-age=31622400; includeSubDomains","X-Frame-Options":"SAMEORIGIN","X-Xss-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","Content-Security-Policy":"default-src https: data: 'self' 'unsafe-inline' 'unsafe-eval'; frame-ancestors '...","Content-Type":"application/json","Transfer-Encoding":"chunked","Date":"Tue, 05 Sep 2023 11:28:58 GMT","Keep-Alive":"timeout=60","Connection":"keep-alive","Server":"Tripwire Enterpri...
Get Status
Returns a TE Status details object with the identifying information for the TE system that the API client is connecting to.
Endpoint
- URL: /api/v1/status
- Method: GET
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
apiVersion | string | Output field: apiVersion |
hostname | string | Name of the resource |
interfaces | array | Output field: interfaces |
interfaces.inetAddresses | array | Output field: interfaces.inetAddresses |
interfaces.macAddress | string | Output field: interfaces.macAddress |
serverAddress | string | Output field: serverAddress |
teUuid | string | Unique identifier |
teVersion | string | Output field: teVersion |
Output Example
{"status_code":200,"response_headers":{"Strict-Transport-Security":"max-age=31622400; includeSubDomains","X-Frame-Options":"SAMEORIGIN","X-Xss-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","Content-Security-Policy":"default-src https: data: 'self' 'unsafe-inline' 'unsafe-eval'; frame-ancestors '...","Content-Type":"application/json","Transfer-Encoding":"chunked","Date":"Tue, 05 Sep 2023 06:47:07 GMT","Keep-Alive":"timeout=60","Connection":"keep-alive","Server":"Tripwire Enterpri...
Get Task Run Contexts
Returns a list of task run status records.
Endpoint
- URL: /api/v1/tasks/runContexts
- Method: GET
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
parameters.endTime | array | Optional | Parameters for the Get Task Run Contexts action |
parameters.endTimeRange | string | Optional | Parameters for the Get Task Run Contexts action |
parameters.hasErrors | string | Optional | Parameters for the Get Task Run Contexts action |
parameters.id | array | Optional | Parameters for the Get Task Run Contexts action |
parameters.pageLimit | string | Optional | Parameters for the Get Task Run Contexts action |
parameters.previousId | string | Optional | Parameters for the Get Task Run Contexts action |
parameters.runType | string | Optional | Parameters for the Get Task Run Contexts action |
parameters.startTime | array | Optional | Parameters for the Get Task Run Contexts action |
parameters.stopType | string | Optional | Parameters for the Get Task Run Contexts action |
parameters.taskId | array | Optional | Parameters for the Get Task Run Contexts action |
Input Example
{"parameters":{"endTime":[""],"endTimeRange":"","hasErrors":false,"id":[""],"pageLimit":"20","previousId":"","runType":"CHECK","startTime":[""],"stopType":"NORMAL","taskId":[""]}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
Output Example
{"status_code":200,"response_headers":{"Strict-Transport-Security":"max-age=31622400; includeSubDomains","X-Frame-Options":"SAMEORIGIN","X-Xss-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","Content-Security-Policy":"default-src https: data: 'self' 'unsafe-inline' 'unsafe-eval'; frame-ancestors '...","Content-Type":"application/json","Content-Length":"522","Date":"Tue, 05 Sep 2023 11:31:56 GMT","Keep-Alive":"timeout=60","Connection":"keep-alive","Server":"Tripwire Enterprise"},"r...
Get Tasks
Returns a list of all tasks, or only those tasks that match the provided filter criteria. Search filters are supported for all fields except schedule.
Endpoint
- URL: /api/v1/tasks
- Method: GET
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
parameters.actionIds | array | Optional | Parameters for the Get Tasks action |
parameters.additionalEmailAddresses | array | Optional | Parameters for the Get Tasks action |
parameters.archiveAuditEvents | boolean | Optional | Parameters for the Get Tasks action |
parameters.archiveLogsExceeding | array | Optional | Parameters for the Get Tasks action |
parameters.archiveLogsOlderThan | array | Optional | Parameters for the Get Tasks action |
parameters.archiveReports | boolean | Optional | Parameters for the Get Tasks action |
parameters.compactVersionsExceeding | array | Optional | Parameters for the Get Tasks action |
parameters.compactVersionsOlderThan | array | Optional | Parameters for the Get Tasks action |
parameters.description | array | Optional | Parameters for the Get Tasks action |
parameters.emailServer | array | Optional | Parameters for the Get Tasks action |
parameters.enabled | boolean | Optional | Parameters for the Get Tasks action |
parameters.id | array | Optional | Parameters for the Get Tasks action |
parameters.ignoreEmptyReports | boolean | Optional | Parameters for the Get Tasks action |
parameters.lastDuration | array | Optional | Parameters for the Get Tasks action |
parameters.lastStart | array | Optional | Parameters for the Get Tasks action |
parameters.name | array | Optional | Parameters for the Get Tasks action |
parameters.newBaselinesOnly | boolean | Optional | Parameters for the Get Tasks action |
parameters.checkNodeConnectionOnly | boolean | Optional | Parameters for the Get Tasks action |
parameters.offboardingOnly | boolean | Optional | Parameters for the Get Tasks action |
parameters.nextStart | array | Optional | Parameters for the Get Tasks action |
parameters.nodeId | array | Optional | Parameters for the Get Tasks action |
parameters.pageLimit | string | Optional | Parameters for the Get Tasks action |
parameters.pageStart | string | Optional | Parameters for the Get Tasks action |
parameters.reportFormat | array | Optional | Parameters for the Get Tasks action |
parameters.reportId | array | Optional | Parameters for the Get Tasks action |
Input Example
{"parameters":{"actionIds":[""],"additionalEmailAddresses":[""],"archiveAuditEvents":false,"archiveLogsExceeding":[""],"archiveLogsOlderThan":[""],"archiveReports":false,"compactVersionsExceeding":[""],"compactVersionsOlderThan":[""],"description":[""],"emailServer":[""],"enabled":true,"id":[""],"ignoreEmptyReports":true,"lastDuration":[""],"lastStart":[""],"name":[""],"newBaselinesOnly":false,"checkNodeConnectionOnly":false,"offboardingOnly":true,"nextStart":[""],"nodeId":[""],"pageLimit":"20","pageStart":"0","reportFormat":[""],"reportId":[""],"reportUserIds":[""],"ruleId":[""],"status":[""],"sub_description":[""],"timeout":[""],"timeoutMillis":[""],"type":[""],"userId":[""]}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
Output Example
{"status_code":200,"response_headers":{"Strict-Transport-Security":"max-age=31622400; includeSubDomains","X-Frame-Options":"SAMEORIGIN","X-Xss-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","Content-Security-Policy":"default-src https: data: 'self' 'unsafe-inline' 'unsafe-eval'; frame-ancestors '...","Content-Type":"application/json","Content-Length":"1052","Date":"Tue, 05 Sep 2023 12:27:42 GMT","Keep-Alive":"timeout=60","Connection":"keep-alive","Server":"Tripwire Enterprise"},"...
Get Users
Returns a list of all users or those that match the filter criteria.
Endpoint
- URL: /api/v1/users
- Method: GET
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
parameters.builtin | boolean | Optional | Parameters for the Get Users action |
parameters.description | array | Optional | Parameters for the Get Users action |
parameters.email | array | Optional | Parameters for the Get Users action |
parameters.id | array | Optional | Parameters for the Get Users action |
parameters.lastLogin | array | Optional | Parameters for the Get Users action |
parameters.lastLogout | array | Optional | Parameters for the Get Users action |
parameters.name | array | Optional | Parameters for the Get Users action |
parameters.roleId | array | Optional | Parameters for the Get Users action |
parameters.sub_description | array | Optional | Parameters for the Get Users action |
Input Example
{"parameters":{"builtin":true,"description":[""],"email":[""],"id":[""],"lastLogin":[""],"lastLogout":[""],"name":[""],"roleId":[""],"sub_description":[""]}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
Output Example
{"status_code":200,"response_headers":{"Strict-Transport-Security":"max-age=31622400; includeSubDomains","X-Frame-Options":"SAMEORIGIN","X-Xss-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","Content-Security-Policy":"default-src https: data: 'self' 'unsafe-inline' 'unsafe-eval'; frame-ancestors '...","Content-Type":"application/json","Transfer-Encoding":"chunked","Date":"Tue, 05 Sep 2023 12:32:33 GMT","Keep-Alive":"timeout=60","Connection":"keep-alive","Server":"Tripwire Enterpri...
Response Headers
Header | Description | Example |
|---|---|---|
connection | HTTP response header: connection | keep-alive |
Content-Length | The length of the response body in bytes | 522 |
content-security-policy | HTTP response header: content-security-policy | default-src https: data: 'self' 'unsafe-inline' 'unsafe-eval'; frame-ancestors 'self' |
Content-Type | The media type of the resource | application/json |
csrftoken | HTTP response header: csrftoken | {"pageTokens":{"/api/v1/policies/run":"GNKD-4J9F-67L4-XH8K-X6O2-RZ4H-1KYA-JXH3"}} |
Date | The date and time at which the message was originated | Tue, 05 Sep 2023 11:02:12 GMT |
keep-alive | HTTP response header: keep-alive | timeout=60 |
Server | Information about the software used by the origin server | Tripwire Enterprise |
strict-transport-security | HTTP response header: strict-transport-security | max-age=31622400; includeSubDomains |
transfer-encoding | HTTP response header: transfer-encoding | chunked |
x-content-type-options | HTTP response header: x-content-type-options | nosniff |
X-Frame-Options | HTTP response header: X-Frame-Options | SAMEORIGIN |
x-xss-protection | HTTP response header: x-xss-protection | 1; mode=block |