UNPKG

@itentialopensource/adapter-tufin_securetrack

Version:

This adapter integrates with system: sample.

769 lines 581 kB
openapi: 3.0.0 info: title: Tufin-SecureTrack-R19-2-RC1 description: Tufin Orchestration Suite - Tufin SecureTrack APIs.<br>For detailed information about the APIs please see the documentation at:<br>https://your-securetrack-server/securetrack/apidoc contact: {} version: '1.0' servers: - url: http://example.com/securetrack/api variables: {} paths: /revisions/{revision_id}/additional_parameters: get: tags: - Additional Policy Fields summary: Getadditionalparametersidentitiesbyrevision description: 'Some firewall vendors use special fields in their security policy.<br>For example: Palo Alto uses Tags, Security Profiles and Log Profiles and Fortinet uses NAT Pools and other NAT configurations.<br>SecureTrack refers to these fields as “Additional Parameters”.<br>The additional parameters API retrieves the possible values of these fields.<br>This API is currently supported for Palo Alto Networks firewalls and Fortinet devices managed by Fortimanager.<br><br><u>Parameters:</u><br>context: Global MSSP context [optional]<br>revision_id: Revision ID<br>type: Additional parameter type [optional]<br><br><u>Usage Example</u><br>https://192.168.1.1/securetrack/api/revisions/162/additional_parameters?type=security_profile_group<br><br><u>Response Messages:</u><br>200: Successful<br>400: Invalid request' operationId: Getadditionalparametersidentitiesbyrevision parameters: - name: Accept in: header description: '' required: true style: simple schema: type: string example: application/json - name: revision_id in: path description: '' required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} deprecated: false /revisions/{revision_id}/additional_parameters/{ids}: get: tags: - Additional Policy Fields summary: Getspecificadditionalparameteridentity description: 'Some firewall vendors use special fields in their security policy.<br>For example: Palo Alto uses Tags, Security Profiles and Log Profiles and Fortinet uses NAT Pools and other NAT configurations.<br>SecureTrack refers to these fields as “Additional Parameters”.<br>The additional parameters API retrieves the possible values of these fields.<br>This API is currently supported for Palo Alto Networks firewalls and Fortinet devices managed by Fortimanager.<br><br><u>Parameters:</u><br>context: Global MSSP context [optional]<br>revision_id: Revision ID<br>ids: Additional parameter IDs separated by commas<br><br><u>Usage Example</u><br>https://192.168.1.1/securetrack/api/revisions/162/additional_parameters/242767,242768,242760<br>' operationId: Getspecificadditionalparameteridentity parameters: - name: Accept in: header description: '' required: true style: simple schema: type: string example: application/json - name: revision_id in: path description: '' required: true style: simple schema: type: string - name: ids in: path description: '' required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} deprecated: false /revisions/{revision_id}/url_categories/{ids}: get: tags: - Additional Policy Fields summary: GetaURLCategory. description: 'Fetches one or more URL Categories.<br>This API is supported for Panorama in advanced mode and Panorama Device Groups.<br><br><u>Parameters:</u><br>context: Global MSSP context [optional]<br>revision_id: Revision ID<br>ids: Url Category IDs separated by commas<br><br><u>Usage Example</u><br>https://192.168.1.1/securetrack/api/revisions/762/url_categories/242767,242768,242760<br>' operationId: GetaURLCategory. parameters: - name: Accept in: header description: '' required: true style: simple schema: type: string example: application/json - name: revision_id in: path description: '' required: true style: simple schema: type: string - name: ids in: path description: '' required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} deprecated: false /devices/{id}/applications: get: tags: - Application IDs summary: Getapplicationidentitiesbydevice description: 'Fetches list of applications defined on device given by ID.<br>This API is currently supported for Palo Alto Networks firewalls.<br>In Panorama NG, overrides property in returned ApplicationDTO will be set to true, if the application overrides an original value.<br>The default value for get_total is false. For API calls that have pagination, set get_total to true on the first call. Use the value to returned in total to determine how many additional calls are required to retrieve all the desired results. To improve performance, omit or set get_total to false on any subsequent calls.<br><br><br><u>Parameters:</u><br>context: Global MSSP context [optional]<br>id: Device ID<br>start: Starting page for query allowable values are numeric [optional]<br>count: Number of pages for query allowable values are numeric [optional]<br>get_total: Set to true to get the total number of items that can be retrieved [optional]<br><br><u>Usage Example</u><br><table><tr><td>URL</td><td>https://192.168.1.1/securetrack/api/devices/31/applications?get_total=true </td></tr><tr><td>OUTPUT</td><td> {<br>&nbsp;&nbsp;&nbsp;&nbsp;"applications": {<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"count": 50,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"total": 100,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"application": [{<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"@xsi.type": "singleApplicationDTO",<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id": 2095027,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"name": "any",<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"display_name": "any",<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"class_name": "application_object",<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"comment": "",<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"uid": "{61B7771C-8B0B-90D6-ED55-B6698691BEED}",<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"overrides": false,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"service": {<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id": 5048925,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"uid": "{4BC8F8B5-7671-A61B-5DD2-8CA235955162}",<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"display_name": "any",<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"name": "any"<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;}<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;}]<br>&nbsp;&nbsp;&nbsp;&nbsp;}<br>}</td></tr></table><br>' operationId: Getapplicationidentitiesbydevice parameters: - name: Accept in: header description: '' required: true style: simple schema: type: string example: application/json - name: id in: path description: '' required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} deprecated: false /devices/{id}/applications/{ids}: get: tags: - Application IDs summary: Getspecificapplicationidentity description: 'Fetches one or more applications defined by a device ID and Application Id or comma separated applications ids list.<br>This API is currently supported for Palo Alto Networks firewalls.<br><b>Note:</b> This API retrieves the information from the latest revision.<br>In Panorama NG, overrides property in returned ApplicationDTO will be set to true, if the application overrides an original value.<br><br><br><u>Parameters:</u><br>context: Global MSSP context [optional]<br>id: Device ID<br>ids: Application IDs separated by commas<br><br><u>Usage Example</u><br>https://192.168.1.1/securetrack/api/devices/1/applications/701<br>' operationId: Getspecificapplicationidentity parameters: - name: Accept in: header description: '' required: true style: simple schema: type: string example: application/json - name: id in: path description: '' required: true style: simple schema: type: string - name: ids in: path description: '' required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} deprecated: false /revisions/{id}/applications: get: tags: - Application IDs summary: Getapplicationsidentitiesbyrevision description: 'Fetches list of applications defined in a revision given by ID.<br>This API is currently supported for Palo Alto Networks firewalls.<br>In Panorama NG, overrides property in returned ApplicationDTO will be set to true, if the application overrides an original value.<br>The default value for get_total is false. For API calls that have pagination, set get_total to true on the first call. Use the value to returned in total to determine how many additional calls are required to retrieve all the desired results. To improve performance, omit or set get_total to false on any subsequent calls.<br><br><br><u>Parameters:</u><br>context: Global MSSP context [optional]<br>id: Revision id<br>start: Starting page for query allowable value is numeric [optional]<br>count: Number of pages for query starting from starting page, allowable type is numeric [optional]<br>get_total: Set to true to get the total number of items that can be retrieved [optional]<br><br><u>Usage Example</u><br><table><tr><td>URL</td><td>https://192.168.1.1/securetrack/api/revisions/762/applications?get_total=true </td></tr><tr><td>OUTPUT</td><td> {<br>&nbsp;&nbsp;&nbsp;&nbsp;"applications": {<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"count": 1,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"total": 100,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"application": [{<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"@xsi.type": "singleApplicationDTO",<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id": 2095027,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"name": "any",<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"display_name": "any",<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"class_name": "application_object",<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"comment": "",<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"uid": "{61B7771C-8B0B-90D6-ED55-B6698691BEED}",<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"overrides": false,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"service": {<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id": 5048925,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"uid": "{4BC8F8B5-7671-A61B-5DD2-8CA235955162}",<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"display_name": "any",<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"name": "any"<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;}<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;}]<br>&nbsp;&nbsp;&nbsp;&nbsp;}<br>}</td></tr></table><br>' operationId: Getapplicationsidentitiesbyrevision parameters: - name: Accept in: header description: '' required: true style: simple schema: type: string example: application/json - name: id in: path description: '' required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} deprecated: false /revisions/{revision_id}/applications/{ids}: get: tags: - Application IDs summary: Getspecificapplicationidentity1 description: 'Fetches one or more applications defined by a revision ID and Application Id or comma separated applications ids list.<br>This API is currently supported for Palo Alto Networks firewalls.<br>In Panorama NG, overrides property in returned ApplicationDTO will be set to true, if the application overrides an original value.<br><br><br><u>Parameters:</u><br>context: Global MSSP context [optional]<br>revision_id: Revision ID<br>ids: Application IDs separated by commas<br><br><u>Usage Example</u><br>https://192.168.1.1/securetrack/api/revisions/762/applications/242767,242768,242760<br>' operationId: Getspecificapplicationidentity1 parameters: - name: Accept in: header description: '' required: true style: simple schema: type: string example: application/json - name: revision_id in: path description: '' required: true style: simple schema: type: string - name: ids in: path description: '' required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} deprecated: false /change_authorization: get: tags: - Change Authorization summary: Determineifchangesbetweentworevisionsareauthorized description: 'This API checks for unauthorized changes between any two versions of a firewall policy.<br/>The API returns authorized if and only if all traffic changes between the two versions were authorized by SecureChange tickets.<br>The API returns unauthorized if there is at least one change that cannot be matched to a SecureChange ticket.<br><br>The API checks access that was granted (checked against access requests with action=Accept) as well as access that was removed (checked against access requests with action=Drop or Remove).<br>The API returns the authorization status, the relevant tickets in SecureChange and the rules that implement unauthorized access changes.<br><br>Note 1: To use this API you must enable “Authorize Revisions with Tickets” in SecureTrack/Configuration/Ticketing.<br>Note 2: Use the ID returned by the /revisions API for new_version and old_version.<br>Note 3: The default value for traffic_details and ignore_tickets is false.<br>Note 4: Traffic that is handled by an implicit rule will not have a rule ID.<br><br><u>Parameters:</u><br>new_version: New version ID<br>old_version: Old version ID<br>traffic_details: Return unauthorized traffic change details for all modified rules [optional]<br>ignore_tickets: Ignore SecureChange tickets and consider all traffic changes unauthorized [optional]<br><br><u>Usage Example</u><br>https://192.168.1.1/securetrack/api/change_authorization?old_version=1&new_version=2<br><br><u>Usage Example</u><br>https://192.168.1.1/securetrack/api/change_authorization?old_version=1&new_version=2&traffic_details=true&ignore_tickets=true<br><br><u>Response Messages:</u><br>200: Change authorization has been successfully calculated<br>400: Input parameters are not valid<br>400: Could not find the requested revisions for comparison' operationId: Determineifchangesbetweentworevisionsareauthorized parameters: - name: Accept in: header description: '' required: true style: simple schema: type: string example: application/json responses: '200': description: '' headers: {} content: {} deprecated: false /change_authorization/policyTrafficComparison: post: tags: - Change Authorization summary: Comparerevisionsontwodifferentdevicesintermsoftraffic. description: 'This API compares two arbitrary revisions from any devices. The comparison will be done in terms of allowed/denied traffic.<br/>The API returns authorized if and only if there are no differences between the traffic allowed/denied by the rules in the two revisions.<br>The API returns unauthorized if there is at least one difference in terms of allowed/denied traffic between the two revisions.<br>Note 1: To map policies from one revision to the other use oldId2newIdMap and provide the UIDs of the policies to be compared.<br>Note 2: Parameter in the request body specifies if the result will return traffic difference details for all incompatible rules <br>Note 3: The format of the result is the same as the one returned by /change_authorization <br>Note 4: The API accepts in request body only one pair of oldId - newId map <br>Note 5: The request is valid only if the mapping ids are found in the active policies<br><br><u>Parameters:</u><br>body: Request parameter containing the versions of the revisions to be compared and the policy mapping between the revisions.<br><br><u>Usage Example</u><br><table><tr><td>URL</td><td>https://192.168.1.1/securetrack/api/change_authorization/policyTrafficComparison</td></tr><tr><td>BODY</td><td>{<br>&nbsp;&nbsp;&nbsp;&nbsp;"policy_traffic_comparison_request": {<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"oldVersionId": "234",<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"newVersionId": "179",<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"oldId2newIdMap": [<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;{<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"oldId": "{037DEA62-A8D2-46F5-8DC9-DA404A60B96F}",<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"newId" : "{00-FACED0-00}"<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;}<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;],<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"withTraffic": true<br>&nbsp;&nbsp;&nbsp;&nbsp;}<br>}</td></tr></table><br><br><u>Response Messages:</u><br>200: Policies diff was successfully calculated<br>400: Could not find the requested revisions for comparison' operationId: Comparerevisionsontwodifferentdevicesintermsoftraffic. parameters: - name: Accept in: header description: '' required: true style: simple schema: type: string example: application/json requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/Comparerevisionsontwodifferentdevicesintermsoftraffic.Request' - example: policy_traffic_comparison_request: oldVersionId: '234' newVersionId: '179' oldId2newIdMap: - oldId: '{037DEA62-A8D2-46F5-8DC9-DA404A60B96F}' newId: '{00-FACED0-00}' withTraffic: true example: policy_traffic_comparison_request: oldVersionId: '234' newVersionId: '179' oldId2newIdMap: - oldId: '{037DEA62-A8D2-46F5-8DC9-DA404A60B96F}' newId: '{00-FACED0-00}' withTraffic: true required: true responses: '200': description: '' headers: {} content: {} deprecated: false /change_windows: get: tags: - Change Windows summary: Getnameandstatusforallchangewindows description: 'Retrieves a list of all change windows.<br>For valid pagination, both <b>start</b> and <b>count</b> should be provided. Otherwise, pagination is turned off. <br>The default value for <b>get_total</b> is false. For API calls that have pagination, set <b>get_total</b> to true on the first call. <br>Use the value to returned in total to determine how many additional calls are required to retrieve all the desired results. <br>To improve performance, omit or set <b>get_total</b> to false on any subsequent calls. <br><br><br><u>Parameters:</u><br>context: Global MSSP context [optional]<br>start: Starting result for query allowable value is numeric [optional]<br>count: Number of change windows for query starting from starting page, allowable type is numeric [optional]<br>get_total: Set to true to get the total number of items that can be retrieved [optional]<br><br><u>Usage Example</u><br><table><tr><td>URL</td><td>https://192.168.1.1/securetrack/api/change_windows?start=0&count=50&get_total=true </td></tr><tr><td>OUTPUT</td><td> {<br>&nbsp;&nbsp;&nbsp;&nbsp;"change_windows": {<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"count": 2,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"total": 2,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"change_window": [<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;{<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"uuid": "6ae41504-a95c-4f23-98a2-f18b2efadb9d",<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"name": "cw1",<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"domain_id": 1,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"enabled": true<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;{<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"uuid": "fc7b167c-29ea-49a1-9ee3-efb6d1351343",<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"name": "cw2",<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"domain_id": 1,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"enabled": true<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;}<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;]<br>&nbsp;&nbsp;&nbsp;&nbsp;}<br>}</td></tr></table><br><br><u>Response Messages:</u><br>200: OK <br>400: For correct pagination provide a value for the start and count parameters <br>400: Start parameter must be a non-negative value <br>400: Count parameter must be a positive value <br>401: Not permitted to access this context ' operationId: Getnameandstatusforallchangewindows parameters: - name: Accept in: header description: '' required: true style: simple schema: type: string example: application/json responses: '200': description: '' headers: {} content: {} deprecated: false /change_windows/{uid}/tasks/{task_id}: get: tags: - Change Windows summary: Getschedulinganddevicedetailsforaspecificchangewindow description: 'Retrieves scheduling and device details for a specific change window.<br><br><u>Parameters:</u><br>context: Global MSSP context [optional]<br>uid: Change window uuid<br>task_id: Task Id<br><br><u>Usage Example</u><br><table><tr><td>URL</td><td>https://192.168.1.1/securetrack/api/change_windows/fc7b167c-29ea-49a1-9ee3-efb6d1351343/tasks/1 </td></tr><tr><td>OUTPUT</td><td> {<br>&nbsp;&nbsp;&nbsp;&nbsp;"commit_task": {<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id": 1,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"start_date": "04-Nov-2018 01:30:00PM +0200",<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"end_date": "04-Nov-2018 01:32:01PM +0200",<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"errors": "",<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"device_commits": {<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"device_commit": [<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;{<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id": 1,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"result": {<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"errors": {<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"error": "got_error_from_dcs"<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"device": {<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id": 17,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"status": "FAILURE",<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"revision_id": 1,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"errors": {<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"error": "Login error"<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;}<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;}<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;}<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;{<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id": 2,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"result": {<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"errors": "",<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"device": {<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id": 19,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"status": "SUCCESS_WITH_WARNINGS",<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"revision_id": 1,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"warnings": {<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"warning": "Commit not performed: This device had no policies to install on its managed firewalls"<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;}<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;}<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;}<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;}<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;]<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;}<br>&nbsp;&nbsp;&nbsp;&nbsp;}<br>}</td></tr></table><br><br><u>Response Messages:</u><br>200: OK <br>400: For correct pagination provide a value for the start and count parameters <br>400: Start parameter must be a non-negative value <br>400: Count parameter must be a positive value <br>401: Not permitted to access this context <br>404: Change window with uuid was not found <br>404: Change window with uuid was not found in domain <br>404: Fail to find task for change window ' operationId: Getschedulinganddevicedetailsforaspecificchangewindow parameters: - name: Accept in: header description: '' required: true style: simple schema: type: string example: application/json - name: uid in: path description: '' required: true style: simple schema: type: string - name: task_id in: path description: '' required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} deprecated: false /change_windows/{uid}/tasks: get: tags: - Change Windows summary: Getalistofcompletedpolicychangesforaspecificchangewindow description: 'Retrieves a list of completed policy changes for a specific change window.<br>For valid pagination, both <b>start</b> and <b>count</b> should be provided. Otherwise, pagination is turned off. <br>The default value for <b>get_total</b> is false. For API calls that have pagination, set <b>get_total</b> to true on the first call. <br>Use the value to returned in total to determine how many additional calls are required to retrieve all the desired results. <br>To improve performance, omit or set <b>get_total</b> to false on any subsequent calls. <br><br><br><u>Parameters:</u><br>context: Global MSSP context [optional]<br>uid: Change window uuid<br>start: Starting result for query allowable value is numeric [optional]<br>count: Number of tasks for query starting from starting page, allowable type is numeric [optional]<br>get_total: Set to true to get the total number of items that can be retrieved [optional]<br><br><u>Usage Example</u><br><table><tr><td>URL</td><td>https://192.168.1.1/securetrack/api/change_windows/fc7b167c-29ea-49a1-9ee3-efb6d1351343/tasks?start=0&count=50&get_total=true </td></tr><tr><td>OUTPUT</td><td> {<br>&nbsp;&nbsp;&nbsp;&nbsp;"commit_tasks": {<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"count": 1,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"total": 1,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"commit_task": {<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id": 1,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"start_date": "04-Nov-2018 01:30:00PM +0200",<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"end_date": "04-Nov-2018 01:32:01PM +0200",<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"errors": ""<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;}<br>&nbsp;&nbsp;&nbsp;&nbsp;}<br>}</td></tr></table><br><br><u>Response Messages:</u><br>200: OK <br>400: For correct pagination provide a value for the start and count parameters <br>400: Start parameter must be a non-negative value <br>400: Count parameter must be a positive value <br>401: Not permitted to access this context <br>404: Change window with uuid was not found <br>404: Change window with uuid was not found in domain ' operationId: Getalistofcompletedpolicychangesforaspecificchangewindow parameters: - name: Accept in: header description: '' required: true style: simple schema: type: string example: application/json - name: uid in: path description: '' required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} deprecated: false /devices/{id}/interfaces: get: tags: - Device Interfaces and Zones summary: Getnetworkinterfacesbydevice description: 'Reflects static data from the running-config.<br>For dynamic information see the /topology_interfaces API.<br>This API is not applicable for Check Point.<br><br><u>Parameters:</u><br>context: Global MSSP context [optional]<br>id: Device ID<br><br><u>Usage Example</u><br>https://192.168.1.1/securetrack/api/devices/10/interfaces<br>' operationId: Getnetworkinterfacesbydevice parameters: - name: Accept in: header description: '' required: true style: simple schema: type: string example: application/json - name: id in: path description: '' required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} deprecated: false /revisions/{id}/interfaces: get: tags: - Device Interfaces and Zones summary: Getnetworkinterfacesbyrevision description: 'Reflects static data from the running-config.<br>For dynamic information see the /topology_interfaces API.<br>This API is not applicable for Check Point.<br><br><u>Parameters:</u><br>context: Global MSSP context [optional]<br>id: Revision ID<br><br><u>Usage Example</u><br>https://192.168.1.1/securetrack/api/revisions/227/interfaces<br>' operationId: Getnetworkinterfacesbyrevision parameters: - name: Accept in: header description: '' required: true style: simple schema: type: string example: application/json - name: id in: path description: '' required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} deprecated: false /revisions/{id}/zones: get: tags: - Device Interfaces and Zones summary: Getdevicezonesbyrevision description: 'Returns a list of the zones for the specified Juniper, Stonesoft, Fortinet or Palo Alto Networks revision.<br>Note: this API returns device zones, not Tufin zones.<br><br><u>Parameters:</u><br>context: Global MSSP context [optional]<br>id: Revision ID<br><br><u>Usage Example</u><br>https://192.168.1.1/securetrack/api/revisions/787/zones<br>' operationId: Getdevicezonesbyrevision parameters: - name: Accept in: header description: '' required: true style: simple schema: type: string example: application/json - name: id in: path description: '' required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} deprecated: false /devices/{id}/zones: get: tags: - Device Interfaces and Zones summary: Getdevicezonesbydevice description: 'Returns a list of the zones for the specified Juniper, Stonesoft, Fortinet or Palo Alto Networks device.<br>Note: this API returns device zones, not Tufin zones.<br><br><u>Parameters:</u><br>context: Global MSSP context [optional]<br>id: Device ID<br><br><u>Usage Example</u><br>https://192.168.1.1/securetrack/api/devices/104/zones<br>' operationId: Getdevicezonesbydevice parameters: - name: Accept in: header description: '' required: true style: simple schema: type: string example: application/json - name: id in: path description: '' required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} deprecated: false /devices/{id}/bindable_objects: get: tags: - Device Interfaces and Zones summary: Getzonesandnetworkinterfacesthatparticipateinsub-policies description: '<u>Parameters:</u><br>context: Global MSSP context [optional]<br>id: Device ID<br><br><u>Usage Example</u><br>https://192.168.1.1/securetrack/api/devices/104/bindable_objects<br>' operationId: Getzonesandnetworkinterfacesthatparticipateinsub-policies parameters: - name: Accept in: header description: '' required: true style: simple schema: type: string example: application/json - name: id in: path description: '' required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} deprecated: false /domains/{id}: get: tags: - Domains summary: Getdomain description: '<u>Parameters:</u><br>context: Global MSSP context [optional]<br>id: Domain id<br><br><u>Usage Example</u><br>https://192.168.1.1/securetrack/api/domains/1<br><br><u>Response Messages:</u><br>401: User not permitted to access domains<br>400: Domain with ID was not found' operationId: Getdomain parameters: - name: Accept in: header description: '' required: true style: simple schema: type: string example: application/json - name: id in: path description: '' required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} deprecated: false put: tags: - Domains summary: Updateadomain description: '<u>Parameters:</u><br>id: Domain id<br>body [optional]<br><br><u>Usage Example</u><br>https://192.168.1.1/securetrack/api/domains/1<br><br><u>Response Messages:</u><br>401: User not permitted to access domains<br>400: Domain with ID was not found<br>400: Domain with this name already exists<br>400: Domain name is empty<br>400: Default domain cannot be changed' operationId: Updateadomain parameters: - name: id in: path description: '' required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} deprecated: false /domains: post: tags: - Domains summary: Addadomain description: '<u>Parameters:</u><br>body [optional]<br><br><u>Usage Example</u><br>https://192.168.1.1/securetrack/api/domains<br><br><u>Response Messages:</u><br>401: User not permitted to access domains<br>400: Domain with this name already exists<br>400: Domain name is empty' operationId: Addadomain parameters: [] responses: '200': description: '' headers: {} content: {} deprecated: false get: tags: - Domains summary: Getalldomains description: '<br><br><u>Usage Example</u><br>https://192.168.1.1/securetrack/api/domains<br><br><u>Response Messages:</u><br>401: User not permitted to access domains' operationId: Getalldomains parameters: - name: Accept in: header description: '' required: true style: simple schema: type: string example: application/json responses: '200': description: '' headers: {} content: {} deprecated: false /properties: get: tags: - General Properties summary: Getgeneralproperties description: '<br><br><u>Usage Example</u><br><table><tr><td>URL</td><td>https://192.168.1.1/securetrack/api/properties</td></tr><tr><td>OUTPUT</td><td>{<br>&nbsp;&nbsp;&nbsp;&nbsp;"properties": {<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"sc_addresses": {<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"sc_address": [<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;{<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"ip_address": "127.0.0.1",<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"type": "external"<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;{<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"ip_address": "127.0.0.1",<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"type": "internal"<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;}<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;]<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;}<br>&nbsp;&nbsp;&nbsp;&nbsp;}<br>}</td></tr></table><br><br><u>Response Messages:</u><br>401: User not permitted to view properties' operationId: Getgeneralproperties parameters: - name: Accept in: header description: '' required: true style: simple schema: type: string example: application/json responses: '200': description: '' headers: {} content: {} deprecated: false /revisions/{id}/crypto_maps: get: tags: - IPsec VPN summary: GetCiscocryptographicmapsbyrevision description: '<u>Parameters:</u><br>context: Global MSSP context [optional]<br>id: Revision ID<br><br><u>Usage Example</u><br>https://191.168.1.1/securetrack/api/revisions/18/crypto_maps<br>' operationId: GetCiscocryptographicmapsbyrevision parameters: - name: Accept in: header description: '' required: true style: simple schema: type: string example: application/json - name: id in: path description: '' required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} deprecated: false /bindings/{device_id}/ipsec_tunnels: get: tags: - IPsec VPN summary: GetCiscoIPsecpolicyandpeers description: 'Get policy and peers defined on a Cisco crypto map which is applied to specific interface (provided through the outputInterfaceName parameter) in the running config.<br>You can retrieve the interface names by calling the /devices/id/interfaces API.<br><br><u>Parameters:</u><br>device_id: The unique identifier of target device<br>outputInterfaceName: Interface name<br><br><u>Usage Example</u><br>https://192.168.1.1/securetrack/api/bindings/32/ipsec_tunnels?outputInterfaceName=GigabitEthernet1<br>' operationId: GetCiscoIPsecpolicyandpeers parameters: - name: Accept in: header description: '' required: true style: simple schema: type: string example: application/json - name: device_id in: path description: '' required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} deprecated: false /bindings/{device_id}/ipsec_communities: get: tags: - IPsec VPN summary: GetCheckPointVPN(IPSec)communitiesandgateways description: 'Get Check Point VPN (IPSec) Communities and gateways that partcipant in those communities.<br>Works on clusters and gateways, not on management servers.<br><br><u>Parameters:</u><br>device_id: The unique identifier of target device<br><br><u>Usage Example</u><br>https://192.168.1.1/securetrack/api/bindings/20/ipsec_communities<br>' operationId: GetCheckPointVPN(IPSec)communitiesandgateways parameters: - name: Accept in: header description: '' required: true style: simple schema: type: string example: application/json - name: device_id in: path description: '' required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} deprecated: false /devices/{id}/crypto_maps: get: tags: - IPsec VPN summary: GetCiscocryptographicmapsbydevice description: '<u>Parameters:</u><br>context: Global MSSP context [optional]<br>id: Device ID<br><br><u>Usage Example</u><br>https://192.168.1.1/securetrack/api/devices/19/crypto_maps<br>' operationId: GetCiscocryptographicmapsbydevice parameters: - name: Accept in: header description: '' required: true style: simple schema: type: string example: application/json - name: id in: path description: '' required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} deprecated: false /internet_referral/{deviceId}/object: get: tags: - Internet Objects summary: GetresolvedInternetrepresentationfordevice description: 'The order of precedence used to resolve the Internet object is:<br>Step 1: Identify the Internet referral:<br>Search for a defined Internet referral on the specified device.<br>If it is not found on the device, search the parent and grandparents (up the device tree) for a defined Internet referral.<br>If a defined Internet referral is found, then match the name in the Internet referral to a network object, as defined in Step 2.<br>If an Internet referral is not found, it resolves to “Any”.<br>Step 2: Resolve the object by name:<br>Search the specified device for a defined network object that matches the name returned in Step 1.<br>If a matching network object is not found, an error will be returned.<br><br><u>Parameters:</u><br>deviceId: SecureTrack Device ID<br><br><u>Usage Example</u><br>https://192.168.1.1/secur